Skip to content

Commit 65f3bc4

Browse files
authored
Merge pull request #4 from hyoshioka0128/patch-1
Typo "azure open AI"→"Azure OpenAI"
2 parents b4aa18f + a5a95fe commit 65f3bc4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ The repo includes sample data so it's ready to try end to end. In this sample ap
1919
![Chat screen](docs/chatscreen.png)
2020

2121
## Python Conversion Status
22-
This repo is focused to showcase different options to implement semantic search using RAG patterns with java, azure open AI and semantic kernel.
22+
This repo is focused to showcase different options to implement semantic search using RAG patterns with Java, Azure OpenAI and Semantic Kernel.
2323
It is still under active development. Below you can find the status of the python original repo convertion and the planned features.
2424

2525
RAG Approach | Description | Java Open AI SDK | Java Semantic Kernel |
2626
:------------ |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------| :-------------|
2727
RetrieveThenRead | Use Cognitive Search and OpenAI APIs directly. It first retrieves top documents from search and use them to build a prompt. Then, it uses OpenAI to generate an answer (completion) for the user question | :white_check_mark: | :x:
28-
ChatReadRetrieveRead| Use Cognitive Search and OpenAI APIs directly. It first uses Open AI to generate a search keyword for the chat history and then answer to the last chat question replicating RetrieveThenRead same steps. | :white_check_mark: | :x:
29-
ReadRetrieveRead | Use java Semantic Kernel framework to orchestrate Cognitive Search and Open AI as native and semantic functions respectively. A sequential planner is used to generate steps orchestation for answering the user question. | :x: | :white_check_mark:
28+
ChatReadRetrieveRead| Use Cognitive Search and OpenAI APIs directly. It first uses OpenAI to generate a search keyword for the chat history and then answer to the last chat question replicating RetrieveThenRead same steps. | :white_check_mark: | :x:
29+
ReadRetrieveRead | Use java Semantic Kernel framework to orchestrate Cognitive Search and OpenAI as native and semantic functions respectively. A sequential planner is used to generate steps orchestation for answering the user question. | :x: | :white_check_mark:
3030
ReadDecomposeAsk | Like ReadRetrieveRead but use Java Semantic Kernel built-in vector storage and search capabilities to simplify RAG implementation when vector similarity search is used to retrieve relevant documents to answer a question. | :x: | :soon:
3131

3232

3333

3434
## Getting Started
3535

36-
> **IMPORTANT:** In order to deploy and run this example, you'll need an **Azure subscription with access enabled for the Azure OpenAI service**. You can request access [here](https://aka.ms/oaiapply). You can also visit [here](https://azure.microsoft.com/free/cognitive-search/) to get some free Azure credits to get you started.
36+
> **IMPORTANT:** In order to deploy and run this example, you'll need an **Azure subscription with access enabled for the Azure OpenAI Service**. You can request access [here](https://aka.ms/oaiapply). You can also visit [here](https://azure.microsoft.com/free/cognitive-search/) to get some free Azure credits to get you started.
3737
3838
> **AZURE RESOURCE COSTS** by default this sample will create Azure App Service and Azure Cognitive Search resources that have a monthly cost, as well as Form Recognizer resource that has cost per document page. You can switch them to free versions of each of them if you want to avoid this cost by changing the parameters file under the infra folder (though there are some limits to consider; for example, you can have up to 1 free Cognitive Search resource per subscription, and the free Form Recognizer resource only analyzes the first 2 pages of each document.)
3939
@@ -190,7 +190,7 @@ To upload more PDFs, put them in the data/ folder and run `./scripts/prepdocs.sh
190190

191191
Here are the most common failure scenarios and solutions:
192192

193-
1. The subscription (`AZURE_SUBSCRIPTION_ID`) doesn't have access to the Azure OpenAI service. Please ensure `AZURE_SUBSCRIPTION_ID` matches the ID specified in the [OpenAI access request process](https://aka.ms/oai/access).
193+
1. The subscription (`AZURE_SUBSCRIPTION_ID`) doesn't have access to the Azure OpenAI Service. Please ensure `AZURE_SUBSCRIPTION_ID` matches the ID specified in the [OpenAI access request process](https://aka.ms/oai/access).
194194

195195
1. You're attempting to create resources in regions not enabled for Azure OpenAI (e.g. East US 2 instead of East US), or where the model you're trying to use isn't enabled. See [this matrix of model availability](https://aka.ms/oai/models).
196196

0 commit comments

Comments
 (0)