Skip to content

Commit

Permalink
docs: update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
sinedied committed Apr 10, 2024
1 parent 9cc4c3e commit 782d963
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Our API is composed of two main endpoints:

- `/chat`: This endpoint receives a list of messages, the last being the user query and returns a response generated by the LLM. It uses the documents stored in the database to generate the response. We use LangChain.js components to connect to the database, load the documents and perform a vector search after vectorizing the user query. After that, the most relevant documents are injected into the prompt, and we generate the response. While this process seems complex, LangChain.js does all the heavy lifting for us so we can focus on the application flow.

The `/documents` endpoint is used to ingest the documents after the application is deployed, using `curl` commands (have a look at the `postup` hook in the `azure.yaml` file).
The `/documents` endpoint is used to ingest the documents after the application is deployed by uploading the PDFs, using either `curl` commands or the Node.js script we built (have a look at the `postup` hook in the `azure.yaml` file).

The web app is a simple chat interface that sends the user queries to the `/chat` endpoint and displays the responses.
We use the [HTTP protocol for AI chat apps](https://github.com/Azure-Samples/ai-chat-app-protocol) to communicate between the web app and the API.
Expand Down

0 comments on commit 782d963

Please sign in to comment.