跳转到主要内容

XMLSearchTool

我们仍在努力改进工具,因此未来可能会出现意外行为或变更。

描述

XMLSearchTool 是一款尖端的 RAG 工具,专为在 XML 文件中进行语义搜索而设计。对于需要高效解析和提取 XML 内容中信息的用户来说,该工具非常理想。它支持输入搜索查询和可选的 XML 文件路径。通过指定 XML 路径,用户可以更精确地将其搜索目标定位到该文件的内容,从而获得更相关的搜索结果。

安装

要开始使用 XMLSearchTool,您必须首先安装 crewai_tools 包。这可以通过以下命令轻松完成:
pip install 'crewai[tools]'

示例

以下是两个演示如何使用 XMLSearchTool 的示例。第一个示例展示了在特定 XML 文件中进行搜索,而第二个示例则说明了在不预定义 XML 路径的情况下启动搜索,提供了搜索范围的灵活性。
代码
from crewai_tools import XMLSearchTool

# Allow agents to search within any XML file's content 
#as it learns about their paths during execution
tool = XMLSearchTool()

# OR

# Initialize the tool with a specific XML file path 
#for exclusive search within that document
tool = XMLSearchTool(xml='path/to/your/xmlfile.xml')

参数

  • xml:这是您希望搜索的 XML 文件的路径。它在工具初始化时是可选参数,但必须在初始化时或作为 run 方法的参数之一提供,才能执行搜索。

自定义模型和嵌入

默认情况下,该工具使用 OpenAI 进行嵌入和摘要。要自定义模型,您可以使用如下所示的配置字典:
代码
tool = XMLSearchTool(
    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",
            ),
        ),
    )
)