From f426caf5f04cfebc1a345e8b25adbd4ea2cd9ca4 Mon Sep 17 00:00:00 2001 From: Esther Fan Date: Thu, 21 Nov 2024 19:16:08 -0800 Subject: [PATCH] Edit pass and replace hardcoded URLs with redirect links --- .../chat-with-documents-ai/manifest.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/accelerator-index-retrieve-ai-sharepoint-aisearch/chat-with-documents-ai/manifest.json b/accelerator-index-retrieve-ai-sharepoint-aisearch/chat-with-documents-ai/manifest.json index 3a53e63..5ea7c17 100644 --- a/accelerator-index-retrieve-ai-sharepoint-aisearch/chat-with-documents-ai/manifest.json +++ b/accelerator-index-retrieve-ai-sharepoint-aisearch/chat-with-documents-ai/manifest.json @@ -1,7 +1,7 @@ { - "title": "RAG - Chat with your documents", - "description": "This is a retrieval workflow (based on RAG) and takes in prompt and System Message and returns answer to the prompt.", - "prerequisites": "Before you use this template, you need to ensure the following pre-requisites are configured. \n- Azure OpenAI instance with an [embedding model](https://learn.microsoft.com/azure/ai-services/openai/concepts/models?tabs=python-secure#embeddings-models) and a [chat model](https://learn.microsoft.com/azure/ai-services/openai/concepts/models?tabs=python-secure). \n- Azure AI Search instance with your documents and the corresponding [index](https://learn.microsoft.com/en-us/azure/search/search-how-to-create-search-index?tabs=portal) . The index needs to be loaded with the documents, which can be done in [AI Search](https://learn.microsoft.com/en-us/azure/search/search-how-to-load-search-index?tabs=sdk-dotnet) or using [Logic Apps](https://techcommunity.microsoft.com/t5/azure-integration-services-blog/document-ingestion-for-gen-ai-applications-using-logic-apps-from/ba-p/4250675) ", + "title": "Chat with your documents - RAG", + "description": "Based on the retrieval-augmented generation (RAG) pattern, this workflow accepts a prompt and a system message and then returns an answer to the prompt.", + "prerequisites": "Before you use this template, you must have the following requirements: \n- An Azure OpenAI instance with an [embedding model](https://go.microsoft.com/fwlink/?linkid=2297656) and a [chat model](https://go.microsoft.com/fwlink/?linkid=2298129). \n- An Azure AI Search instance with your documents and the corresponding [search index](https://go.microsoft.com/fwlink/?linkid=2297764). Make sure to [load the index with your documents](https://go.microsoft.com/fwlink/?linkid=2298130), which you can accomplish using Azure AI Search or by using the [actions that can parse content and chunk text in Standard workflows from Azure Logic Apps](https://go.microsoft.com/fwlink/?linkid=2297765).", "tags": [ "RAG-Document-Ingestion" ], @@ -12,7 +12,7 @@ "stateful", "stateless" ], - "detailsDescription": "Based on the retrieval-augmented generation (RAG) pattern, this workflow template is triggered via a Request. The request should include the prompt or the question and the System Message. The prompt is in text so using Azure OpenAI embedding model, the prompt is converted to vector and then used to query vectors from AI Search. The retreived results are provided as an input along with System message to Azure OpenAI Chat completions API, along with the Chat model. The response from OpenAI is returned back.", + "detailsDescription": "This workflow runs when the trigger receives an inbound request. The trigger expects the request to include the prompt or question and the system message. The prompt is in text format, so the Azure OpenAI embedding model converts the prompt into [vector format](https://go.microsoft.com/fwlink/?linkid=2297887), which is used to search the [vector database](https://go.microsoft.com/fwlink/?linkid=2297657) using Azure AI Search. The returned results, along with the system message and chat model, are provided as input to the chat completions API in Azure OpenAI. Finally, the API returns a response with the result.", "details": { "By": "Microsoft", "Type": "Workflow", @@ -34,7 +34,7 @@ "name": "AISearchIndex_#workflowname#", "displayName": "Azure AI Search index name", "type": "String", - "description": "Provide the index name to use for mapping OpenAI embeddings. You create index in AI Search", + "description": "Provide the index name to use for mapping Azure OpenAI embeddings. You create the index in AI Search.", "required": true }, { @@ -62,4 +62,4 @@ "kind": "inapp" } } -} \ No newline at end of file +}