Skip to content

Commit 0301d80

Browse files
authored
fix agent framework document (opensearch-project#2385)
Signed-off-by: Yaliang Wu <ylwu@amazon.com>
1 parent aa3616d commit 0301d80

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

docs/tutorials/agent_framework/Chatbot_with_RAG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Topic
22

3-
> Agent Framework is an experimental feature released in OpenSearch 2.12 and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161).
3+
> Agent Framework is GA released in OpenSearch 2.13. To read more details, see the OpenSearch document [Agents and tools](https://opensearch.org/docs/latest/ml-commons-plugin/agents-tools/index/).
44
5-
> This tutorial doesn't explain what retrieval-augmented generation (RAG) is.
5+
Read this AWS [retrieval-augmented-generation](https://aws.amazon.com/what-is/retrieval-augmented-generation/) doc to learn more details about RAG.
66

77
One of the known limitations of large language models (LLMs) is that their knowledge base only contains information up to the time when the LLMs were trained.
88
LLMs have no knowledge of recent events or your internal data.

docs/tutorials/agent_framework/RAG_with_conversational_flow_agent.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Topic
22

3-
> Agent Framework is an experimental feature released in OpenSearch 2.12 and not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161).
3+
> Agent Framework is GA released in OpenSearch 2.13. To read more details, see the OpenSearch document [Agents and tools](https://opensearch.org/docs/latest/ml-commons-plugin/agents-tools/index/).
44
5-
> This tutorial doesn't explain what retrieval-augmented generation(RAG) is.
5+
Read this AWS [retrieval-augmented-generation](https://aws.amazon.com/what-is/retrieval-augmented-generation/) doc to learn more details about RAG.
66

77
This tutorial explains how to use a conversational flow agent to build a RAG application by using your
88
OpenSearch data as knowledge base.
99

1010
Note: You should replace the placeholders with prefix `your_` with your own value
1111

12+
The other way to build RAG/conversational search is using RAG pipeline, see [conversational_search_with_Cohere_Command](../conversational_search/conversational_search_with_Cohere_Command.md)
13+
1214
# Steps
1315

1416
## 0. Preparation

docs/tutorials/agent_framework/build_your_own_chatbot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Topic
22

3-
> Agent Framework is an experimental feature released in OpenSearch 2.12 and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161).
3+
> Agent Framework is GA released in OpenSearch 2.13. To read more details, see the OpenSearch document [Agents and tools](https://opensearch.org/docs/latest/ml-commons-plugin/agents-tools/index/).
44
55
Some questions require more than one call to an LLM to produce an answer. For example, an LLM can't answer how many errors there are in your log index for last week because its knowledge base does not contain your proprietary data.
66
You can use an agent to solve such complex problems. The agent can run tools to obtain more information and send it to the LLM as context.

docs/tutorials/conversational_search/conversational_search_with_Cohere_Command.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This tutorial explains how to use conversational search with the Cohere Command
44

55
Note: Replace the placeholders that start with `your_` with your own values.
66

7+
The other way to build RAG/conversational search is using Agent Framework, see [RAG_with_conversational_flow_agent](../agent_framework/RAG_with_conversational_flow_agent.md)
8+
79
# Steps
810

911
## 0. Preparation

0 commit comments

Comments
 (0)