XMLSearchTool

实验性

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

描述

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

安装

要开始使用 XMLSearchTool，您必须首先安装 crewai_tools 包。可以通过以下命令轻松完成：

pip install 'crewai[tools]'

示例

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

from crewai_tools import XMLSearchTool

# 允许代理在执行过程中了解其路径的任何 XML 文件内容中进行搜索
tool = XMLSearchTool()

# 或者

# 使用特定的 XML 文件路径初始化工具，以便仅在该文档中进行搜索
tool = XMLSearchTool(xml='path/to/your/xmlfile.xml')

参数

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

自定义模型和嵌入

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

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