Skip to content

Commit 656c635

Browse files
committed
chore: fix typos in readmes
1 parent 0e41cdb commit 656c635

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

blazor/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The project showcases 3 demos.
77
1. PDFViewer Smart (AI) Assistant.
88

99
### Smart Search
10-
ComboBox and Grid search demos are relying on similarity search calculate the vector distance between search query and the grid data items using the SmartComponents.LocalEmbeddings package. The solution works great with small to medium amaound of data.
10+
ComboBox and Grid search demos rely on similarity search to calculate the vector distance between the search query and the grid data items using the SmartComponents.LocalEmbeddings package. The solution works great with small to medium amounts of data.
1111

1212
#### How to run
1313
To run search demos, start the project and navigate to the Grid Smart Search AI or ComboBox Search AI pages from the sidebar.
@@ -16,13 +16,13 @@ To run search demos, start the project and navigate to the Grid Smart Search AI
1616
The PDFViewer Assistant splits the text pages into chunks and embeds each chunk when the document is loaded. The entire document is then processed to dynamically generate relevant questions, which are used as PromptSuggestions. Users can ask any of these predefined questions or type their own in the AIPrompt input. Once a question is asked, the prompt is matched with similar pages from the document, and the AI Service is used to answer the question, augmenting it with relevant documents. This technique, known as RAG (Retrieval-Augmented Generation), allows you to chat with your documents and summarize, explain, or answer questions based on the context of your own data.
1717

1818
#### Consideration before using in production
19-
Keep in mind, that for the purpuse of the demo,
20-
- we split the document and create chunks exacyly one page long.
19+
Keep in mind, that for the purpose of the demo,
20+
- we split the document and create chunks exactly one page long.
2121
- We send the whole document document to extract the relevant questions.
2222

23-
You will need to experiment and see what is the optimal chunk size for your document and usecase. Additionally, sending whole document on each load may be suboptimal (or it may break) for documents that are large due to the cost of the AI API and context length. In these cases, you may need to use different model (with larger context size) to summarize the document or do it in batches.
23+
You will need to experiment and see what is the optimal chunk size for your document and use case. Additionally, sending the whole document on each load may be suboptimal (or it may break) for large documents due to the cost of the AI API and context length. In these cases, you may need to use a different model (with a larger context size) to summarize the document or do it in batches.
2424

2525
#### How to run
2626
To run the PDFViewer Assistant demo, replace your Azure/Open AI credentials inside `PdfViewerSmartAIAssistant.razor` file, then run the project and navigate to PDFViewer Smart AI Assistant from the sidebar.
2727

28-
If you want to use different AI Service, you will need to rewrite the `CallOpenAIApi()` method and call API to your prefered model.
28+
If you want to use a different AI Service, you will need to rewrite the `CallOpenAIApi()` method and call API to your preferred model.

core/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The project showcases 3 demos.
77
1. PDFViewer Smart (AI) Assistant.
88

99
### Smart Search
10-
ComboBox and Grid search demos are relying on similarity search calculate the vector distance between search query and the grid data items using the SmartComponents.LocalEmbeddings package. The solution works great with small to medium amaound of data.
10+
ComboBox and Grid search demos rely on similarity search to calculate the vector distance between the search query and the grid data items using the SmartComponents.LocalEmbeddings package. The solution works great with small to medium amounts of data.
1111

1212
#### How to run
1313
To run search demos, start the project and navigate to the Grid Smart Search AI or ComboBox Search AI pages.
@@ -16,13 +16,13 @@ To run search demos, start the project and navigate to the Grid Smart Search AI
1616
The PDFViewer Assistant splits the text pages into chunks and embeds each chunk when the document is loaded. The entire document is then processed to dynamically generate relevant questions, which are used as PromptSuggestions. Users can ask any of these predefined questions or type their own in the AIPrompt input. Once a question is asked, the prompt is matched with similar pages from the document, and the AI Service is used to answer the question, augmenting it with relevant documents. This technique, known as RAG (Retrieval-Augmented Generation), allows you to chat with your documents and summarize, explain, or answer questions based on the context of your own data.
1717

1818
#### Consideration before using in production
19-
Keep in mind, that for the purpuse of the demo,
20-
- we split the document and create chunks exacyly one page long.
19+
Keep in mind, that for the purpose of the demo,
20+
- we split the document and create chunks exactly one page long.
2121
- We send the whole document document to extract the relevant questions.
2222

23-
You will need to experiment and see what is the optimal chunk size for your document and usecase. Additionally, sending whole document on each load may be suboptimal (or it may break) for documents that are large due to the cost of the AI API and context length. In these cases, you may need to use different model (with larger context size) to summarize the document or do it in batches.
23+
You will need to experiment and see what is the optimal chunk size for your document and use case. Additionally, sending the whole document on each load may be suboptimal (or it may break) for large documents that due to the cost of the AI API and context length. In these cases, you may need to use a different model (with a larger context size) to summarize the document or do it in batches.
2424

2525
#### How to run
2626
To run the PDFViewer Assistant demo, replace your Azure/Open AI credentials inside `PDFViewer_AI_AssistantController.cs` file, then run the project and navigate to the PDFViewer Smart AI Assistant page.
2727

28-
If you want to use different AI Service, you will need to rewrite the `CallOpenAIApi()` method and call API to your prefered model.
28+
If you want to use a different AI Service, you will need to rewrite the `CallOpenAIApi()` method and call API to your preferred model.

0 commit comments

Comments
 (0)