You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to [project-title]
1
+
# Contributing to ARGUS
2
2
3
3
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4
4
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
@@ -51,12 +51,12 @@ chances of your issue being dealt with quickly:
51
51
***Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
52
52
causing the problem (line of code or commit)
53
53
54
-
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
54
+
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/Azure-Samples/ARGUS/issues/new.
55
55
56
56
### <aname="submit-pr"></a> Submitting a Pull Request (PR)
57
57
Before you submit your Pull Request (PR) consider the following guidelines:
58
58
59
-
* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
59
+
* Search the repository (https://github.com/Azure-Samples/ARGUS/pulls) for an open or closed PR
60
60
that relates to your submission. You don't want to duplicate effort.
*Named after Argus Panoptes, the mythological giant with a hundred eyes—ARGUS never misses a detail in your documents.*
@@ -13,7 +14,7 @@
13
14
14
15
## 🚀 Transform Document Processing with AI Intelligence
15
16
16
-
**ARGUS** revolutionizes how organizations extract, understand, and act on document data. By combining the precision of **Azure Document Intelligence** with the contextual reasoning of **GPT-4 Vision**, ARGUS doesn't just read documents—it *understands* them.
17
+
**ARGUS** revolutionizes how organizations extract, understand, and act on document data. By combining the precision of **Azure Document Intelligence** with the contextual reasoning of **GPT-5.4**, ARGUS doesn't just read documents—it *understands* them.
17
18
18
19
### 💡 Why ARGUS?
19
20
@@ -41,10 +42,11 @@ Traditional OCR solutions extract text but miss the context. AI-only approaches
41
42
-**Zero-Shot Learning**: Works on new document types without training
42
43
43
44
### ⚡ **Enterprise-Ready Performance**
44
-
-**Cloud-Native Architecture**: Built on Azure Container Apps
45
+
-**Cloud-Native Architecture**: Built on Azure Container Apps with VNet integration
45
46
-**Scalable Processing**: Handle document floods with confidence
46
47
-**Real-Time Processing**: API-driven workflows for immediate results
47
48
-**Event-Driven Automation**: Automatic processing on document upload
49
+
-**Zero-Credential Security**: Managed identity authentication with no API keys
48
50
49
51
</td>
50
52
<tdwidth="50%">
@@ -85,7 +87,7 @@ graph TB
85
87
D --> E{🔍 OCR Provider}
86
88
E -->|Azure| E1[Azure Document Intelligence]
87
89
E -->|Mistral| E2[Mistral Document AI]
88
-
D --> F[🤖 GPT-4 Vision]
90
+
D --> F[🤖 GPT-5.4]
89
91
E1 --> G[⚙️ Hybrid Processing Pipeline]
90
92
E2 --> G
91
93
F --> G
@@ -101,7 +103,7 @@ graph TB
101
103
G --> K[🗄️ Azure Cosmos DB]
102
104
J --> K
103
105
I --> K
104
-
K --> L[📱 Streamlit Frontend]
106
+
K --> L[📱 Next.js Frontend]
105
107
end
106
108
107
109
style A fill:#e3f2fd,stroke:#1976d2,stroke-width:2px
Datasets are managed through the Streamlit frontend interface (deployed automatically with azd):
407
+
Datasets are managed through the web frontend interface (deployed automatically with azd):
376
408
377
409
1.**Access the frontend** (URL provided after azd deployment)
378
410
2.**Navigate to the Process Files tab**
@@ -456,6 +488,8 @@ az containerapp update \
456
488
457
489
The Streamlit frontend is **automatically deployed** with `azd up` and provides a user-friendly interface for document management.
458
490
491
+
> **Note**: ARGUS ships with two frontends: a modern **Next.js** interface (default, deployed as `ca-frontend`) and a legacy **Streamlit** interface. The Next.js frontend is recommended for production use.
-**API Keys**: OpenAI API key configured via environment variables
15
+
-**Azure Services**: Managed identity authentication via `DefaultAzureCredential` — no API keys
16
+
-**Service-to-Service**: User-assigned managed identity with RBAC role assignments
17
+
-**Local Auth**: Disabled on all Azure services (`disableLocalAuth: true`)
17
18
-**CORS**: Enabled for frontend integration
18
19
19
20
---
@@ -470,29 +471,28 @@ Get diagnostic information about Logic App Manager setup.
470
471
### GET `/api/openai-settings`
471
472
**Get OpenAI Settings**
472
473
473
-
Retrieve current OpenAI configuration from environment variables (read-only).
474
+
Retrieve current OpenAI configuration from environment variables (read-only). Authentication uses managed identity — no API keys are stored or transmitted.
0 commit comments