Skip to content

Commit 351ece8

Browse files
committed
documentation update
1 parent 0dbae5f commit 351ece8

2 files changed

Lines changed: 15 additions & 25 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ It uses [Langchain4J](https://github.com/langchain4j/langchain4j) AI orchestrati
6969

7070
All the available architectures and implementations come with few options to start developing and running the application locally using dev containers or in the cloud using github codespaces. For more detailed instructions, please refer to the specific architecture implementation documentation:
7171
- [Azure Container Apps Getting Started](docs/aca/README-ACA.md#getting-started)
72-
- **Azure Kubernetes Service Getting Started** :sunny: :cloud: :construction_worker_man **WIP**
72+
- **Azure Kubernetes Service Getting Started** :sunny: :cloud: **WIP**
7373

7474

7575
## Guidance
7676
For platform specific guidance, please refer to the following documentation:
77-
- [Azure Container Apps Getting Started](docs/aca/README-ACA.md#guidance)
78-
- **Azure Kubernetes Service Getting Started** :sunny: :cloud: :construction_worker_man **WIP**
77+
- [Azure Container Apps Guidance](docs/aca/README-ACA.md#guidance)
78+
- **Azure Kubernetes Service Guidance** :sunny: :cloud: **WIP**
7979

8080

8181
This sample is designed to get you started quickly and let you experiment with Java RAG architectures on Azure. For production deployment, you can use the [Azure Application Landing Zones (LZA)](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/scenarios/app-platform/ready) to deploy the solution in production leveraging best practices for security, monitoring, networking and operational excellence.

docs/aca/README-ACA.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,17 @@ For detailed instructions, see [Getting Started](#getting-started) below.
3636
* [Deploying with existing Azure resources](#deploying-with-existing-azure-resources)
3737
* [Existing resource group](#existing-resource-group)
3838
* [Existing OpenAI resource](#existing-openai-resource)
39-
* [Existing Azure Azure AI Search resource](#existing-azure-ai-search-resource)
39+
* [Existing Azure AI Search resource](#existing-azure-ai-search-resource)
4040
* [Other existing Azure resources](#other-existing-azure-resources)
4141
* [Provision remaining resources](#provision-remaining-resources)
42-
* [Deploying again](#redeploying)
43-
* [Running locally](#running-locally)
42+
* [Redeploying](#redeploying)
4443
* [UI Navigation](#ui-navigation)
4544
* [Guidance](#guidance)
4645
* [Enabling Application Insights](#enabling-application-insights)
47-
* [Enabling authentication](#enabling-authentication)
46+
* [Enabling login and search filtering](#enabling-login-and-search-filtering)
47+
* [Enabling client-side chat history](#enabling-client-side-chat-history)
48+
* [Enabling persistent chat history with Azure Cosmos DB](#enabling-persistent-chat-history-with-azure-cosmos-db)
4849
* [App Continuous Integration](#app-continuous-integration)
49-
* [GitHub](#github)
50-
* [Azure DevOps](#azure-devops)
51-
* [Custom Data Ingestion and Indexing](#custom-data-ingestion-and-indexing)
5250
* [Productionizing](#productionizing)
5351
* [Cost estimation](#cost-estimation)
5452
* [Note](#note)
@@ -240,11 +238,11 @@ Under "Trace & Events" panel you can review custom Java informational logs to be
240238
241239
To see any exceptions and server errors, navigate to the "Investigate -> Failures" blade and use the filtering tools to locate a specific exception. You can see Java stack traces on the right-hand side.
242240
243-
### Enabling Login and User Access Control for Documents
241+
### Enabling login and search filtering
244242
245-
see [here](./login_and_acl.md) for detailed guidance.
243+
See [here](./login_and_acl.md) for detailed guidance.
246244
247-
## Enabling client-side chat history
245+
### Enabling client-side chat history
248246
249247
This feature allows users to view the chat history of their conversation, stored in the browser using [IndexedDB](https://developer.mozilla.org/docs/Web/API/IndexedDB_API). That means the chat history will be available only on the device where the chat was initiated. To enable browser-stored chat history, run:
250248
@@ -253,7 +251,7 @@ azd env set USE_CHAT_HISTORY_BROWSER true
253251
```
254252
This is useful especially for unauthenticated users. For authenticated ones see below.
255253
256-
## Enabling persistent chat history with Azure Cosmos DB
254+
### Enabling persistent chat history with Azure Cosmos DB
257255
258256
This feature allows authenticated users to view the chat history of their conversations, stored in the server-side storage using [Azure Cosmos DB](https://learn.microsoft.com/azure/cosmos-db/).This option requires that authentication be enabled. The chat history will be persistent and accessible from any device where the user logs in with the same account. To enable server-stored chat history, run:
259257
@@ -264,16 +262,7 @@ azd env set USE_CHAT_HISTORY_COSMOS true
264262
When both the browser-stored and Cosmos DB options are enabled, Cosmos DB will take precedence over browser-stored chat history.
265263
266264
### App Continuous Integration
267-
:sunny: :cloud: :construction_worker_man: WIP
268-
269-
### Custom Data Ingestion and Indexing
270-
The repository includes sample pdf documents in the data folder. They are ingested in blob container and then indexed in Azure AI Search during infra provisioning by Azure Developer CLI post provision hooks.
271-
272-
If you want to chat with your custom documents you can:
273-
1. Add your pdf documents in the [data folder](../../data).
274-
2. Open a terminal and cd to repo root folder for app service deployment. Example `cd path/to/your/custom/dir/azure-search-openai-demo-java/deploy/aca`
275-
3. Run `./scripts/prepdocs.ps1` if you are on windows or `./scripts/prepdocs.sh` on linux
276-
4. Wait few minutes after the script complete so that the ingestion process, running on the indexer app, will ingest all the documents. This is not a 'delta' process, it's not updating **only** the new files you've added. Instead, on each run, all documents in data folder will be ingested. Feel free to add new files you want to ingest and delete/move the old documents from the data folder. Once you've run the script and it completes successfully, Azure AI Search index has been updated and stored (until you want to manually delete it from your azure Azure AI Search instance)
265+
:sunny: :cloud: :construction_worker_man: **WIP**
277266
278267
### Productionizing
279268
@@ -325,8 +314,9 @@ However, you can try the [Azure pricing calculator](https://azure.com/e/8ffbe5b1
325314
- Azure Monitor: Pay-as-you-go tier. Costs based on data ingested. [Pricing](https://azure.microsoft.com/pricing/details/monitor/)
326315
- Azure Event Grid: Basic tier. Pricing per operation. [Pricing](https://azure.microsoft.com/pricing/details/event-grid/)
327316
- Azure Service Bus: Standard tier. Pricing per hour and operations. [Pricing](https://azure.microsoft.com/pricing/details/service-bus/)
317+
- Azure Cosmos DB: Only provisioned if you enabled [chat history with Cosmos DB](#enabling-persistent-chat-history-with-azure-cosmos-db). Serverless tier. Pricing per request unit and storage. [Pricing](https://azure.microsoft.com/pricing/details/cosmos-db/)
328318
329-
The first 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests each month are free for ACA. To reduce costs, you can switch to free SKUs Form Recognizer by changing the parameters file under the `infra` folder. There are some limits to consider; for example, the free Form Recognizer resource only analyzes the first 2 pages of each document. You can also reduce costs associated with the Form Recognizer by reducing the number of documents in the `data` folder, or changing the code to use the Itext document based parser, or by removing the postprovision hook in `azure.yaml` that runs the `indexer java cli`.
319+
The first 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests each month are free for ACA. To reduce costs, you can switch to free SKUs Document Intelligence by changing the parameters file under the `infra` folder. There are some limits to consider; for example, the free Document Intelligence resource only analyzes the first 2 pages of each document.
330320
331321
⚠️ To avoid unnecessary costs, remember to take down your app if it's no longer in use,
332322
either by deleting the resource group in the Portal or running `azd down`.

0 commit comments

Comments
 (0)