​
CodeDocsSearchTool

实验性: 我们仍在改进工具，因此未来可能会出现意外行为或变化。

​
描述

CodeDocsSearchTool 是一个强大的 RAG（检索增强生成）工具，专为代码文档中的语义搜索而设计。 它使用户能够高效地在代码文档中找到特定信息或主题。通过在初始化时提供 docs_url， 该工具将搜索范围缩小到该特定文档站点。或者，如果没有特定的 docs_url， 它会在其执行过程中已知或发现的各种代码文档中进行广泛搜索，使其适用于各种文档搜索需求。

​
安装

要开始使用CodeDocsSearchTool，首先通过pip安装crewai_tools包：

pip install 'crewai[tools]'

​
示例

使用CodeDocsSearchTool如下在代码文档中进行搜索：

Code
from crewai_tools import CodeDocsSearchTool

# To search any code documentation content 
# if the URL is known or discovered during its execution:
tool = CodeDocsSearchTool()

# OR

# To specifically focus your search on a given documentation site 
# by providing its URL:
tool = CodeDocsSearchTool(docs_url='https://docs.example.com/reference')

将‘https://docs.example.com/reference’替换为您的目标文档URL 并将‘How to use search tool’替换为与您需求相关的搜索查询。

​
参数

以下参数可用于自定义CodeDocsSearchTool的行为：

参数类型描述
docs_urlstring可选. 指定要搜索的代码文档的URL。

​
自定义模型和嵌入

默认情况下，该工具使用OpenAI进行嵌入和摘要生成。要自定义模型，您可以使用如下配置字典：

Code
tool = CodeDocsSearchTool(
    config=dict(
        llm=dict(
            provider="ollama", # or google, openai, anthropic, llama2, ...
            config=dict(
                model="llama2",
                # temperature=0.5,
                # top_p=1,
                # stream=true,
            ),
        ),
        embedder=dict(
            provider="google", # or openai, ollama, ...
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)

这个页面有帮助吗？

Browserbase Web LoaderCode Interpreter