Document/ivyportal 17735 stage 1 use internal open search of ivy engine as the vector store #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 25063ed.
- Handle feedback: correct grammar error - Handle feedback: explain more how to backup variable files - Handle feedback: update user guide
- Updated German version of README file
- Handled feedbacks for German version of README file
Checked documentation for german readme
…hub.com/axonivy-market/ai-assistant into document/IVYPORTAL-17735-Stage-1-Use-internal-OpenSearch-of-ivy-engine-as-the-vector-store
… vector store - Updated document to guide user setup external search - Created scripts for quick setup
ai-assistant-product/README.md
Outdated
|
|
||
| - `Name`: name of the AI assistant | ||
| - `Permissions`: a list of Ivy roles that can use the AI assistant | ||
| - `Model`: the AI model the assistant will use to perform its functions (for more details, please refer to [Configure AI Models](#configure-ai-models)) |
ai-assistant-product/README.md
Outdated
| - GPT model: [GPT-4o mini](https://platform.openai.com/docs/models/gpt-4o-mini) | ||
| - Text embedding model: [text-embedding-3-large](https://platform.openai.com/docs/guides/embeddings) | ||
|
|
||
| When you clicking on a model item in the AI Models list, you will be redirected to the details page of that model. There you can find more model informations and change the API Key to the OpenAI platform. Your API Key is encrypted and completely secured. |
ai-assistant-product/README.md
Outdated
|
|
||
| When you clicking on a model item in the AI Models list, you will be redirected to the details page of that model. There you can find more model informations and change the API Key to the OpenAI platform. Your API Key is encrypted and completely secured. | ||
|
|
||
| Furthermore, you can test to connection to OpenAI platform by clicking the button **Test Connection**. If something went wrong, we will show the details error |
There was a problem hiding this comment.
you can test the connection to OpenAI platform
|
|
||
| - **Switch**: decision-making element that guide AI in selecting the appropriate next action based on specific conditions. | ||
|
|
||
| - **Ivy Tool**: directs AI to use specific Ivy tools (Ivy callable) in its decision-making process. |
There was a problem hiding this comment.
the style is not consistent between the explanations, capitalize or lowercase, directs or Directs , displays or display or Display
ai-assistant-product/README.md
Outdated
|
|
||
| The **Rephrase step** is designed to help AI refine user input before executing specific actions or using tools. This is particularly useful when the user's message is vague, incomplete, or not structured in a way that the AI can immediately process. By rephrasing the input, the AI ensures that the information is more precise, making it easier to use with target tools or functions. | ||
|
|
||
| - **toolId**: Refers to the tool the AI will use as the target. AI should use JSON schema of the corresponding tool to rephrase the message. By defining this attribute, you ensures that the rephrased input is compatible with the tool’s requirements. |
There was a problem hiding this comment.
The explanations for keywords in JSON file have inconsistent style. Capitalize and lowercase the explanation
… vector store - Handled feedback: correct grammar errors - Handled feedback: unified capitalize style
… vector store - Updated scripts to run the standalone OpenSearch instance better
… vector store - Updated script: only create files and folders if not existed
- Updated the German version of README.md
- Fixed document errors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.