Skip to content

Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

docs: Update JSONSearchTool and RagTool configuration parameter from 'embedder' to 'embedding_model' (#2311)

Lorenze Jay2155acb3a360
diff --git a/docs/tools/jsonsearchtool.mdx b/docs/tools/jsonsearchtool.mdx
index 38267ff73..d7f8b853e 100644
--- a/docs/tools/jsonsearchtool.mdx
+++ b/docs/tools/jsonsearchtool.mdx
@@ -7,8 +7,10 @@ icon: file-code
# `JSONSearchTool`
<Note>
- The JSONSearchTool is currently in an experimental phase. This means the tool is under active development, and users might encounter unexpected behavior or changes.
- We highly encourage feedback on any issues or suggestions for improvements.
+ The JSONSearchTool is currently in an experimental phase. This means the tool
+ is under active development, and users might encounter unexpected behavior or
+ changes. We highly encourage feedback on any issues or suggestions for
+ improvements.
</Note>
## Description
@@ -60,7 +62,7 @@ tool = JSONSearchTool(
# stream=true,
},
},
- "embedder": {
+ "embedding_model": {
"provider": "google", # or openai, ollama, ...
"config": {
"model": "models/embedding-001",
@@ -70,4 +72,4 @@ tool = JSONSearchTool(
},
}
)
-```
\ No newline at end of file
+```
diff --git a/docs/tools/ragtool.mdx b/docs/tools/ragtool.mdx
index 841a2a278..b03059152 100644
--- a/docs/tools/ragtool.mdx
+++ b/docs/tools/ragtool.mdx
@@ -8,8 +8,8 @@ icon: vector-square
## Description
-The `RagTool` is designed to answer questions by leveraging the power of Retrieval-Augmented Generation (RAG) through EmbedChain.
-It provides a dynamic knowledge base that can be queried to retrieve relevant information from various data sources.
+The `RagTool` is designed to answer questions by leveraging the power of Retrieval-Augmented Generation (RAG) through EmbedChain.
+It provides a dynamic knowledge base that can be queried to retrieve relevant information from various data sources.
This tool is particularly useful for applications that require access to a vast array of information and need to provide contextually relevant answers.
## Example
@@ -138,7 +138,7 @@ config = {
"model": "gpt-4",
}
},
- "embedder": {
+ "embedding_model": {
"provider": "openai",
"config": {
"model": "text-embedding-ada-002"
@@ -151,4 +151,4 @@ rag_tool = RagTool(config=config, summarize=True)
## Conclusion
-The `RagTool` provides a powerful way to create and query knowledge bases from various data sources. By leveraging Retrieval-Augmented Generation, it enables agents to access and retrieve relevant information efficiently, enhancing their ability to provide accurate and contextually appropriate responses.
\ No newline at end of file
+The `RagTool` provides a powerful way to create and query knowledge bases from various data sources. By leveraging Retrieval-Augmented Generation, it enables agents to access and retrieve relevant information efficiently, enhancing their ability to provide accurate and contextually appropriate responses.