MDXSearchTool

实验性

MDXSearchTool正在持续开发中。功能可能会增加或删除，随着我们优化工具，功能可能会不可预测地变化。

描述

MDX搜索工具是crewai_tools包的一个组件，旨在促进高级Markdown语言提取。它使用基于查询的搜索，使用户能够有效地从MD文件中搜索和提取相关信息。这个工具对于数据分析、信息管理和研究任务非常有价值，简化了在大型文档集合中查找特定信息的过程。

安装

在使用MDX搜索工具之前，请确保已安装crewai_tools包。如果没有安装，可以使用以下命令进行安装：

pip install 'crewai[tools]'

使用示例

要使用MDX搜索工具，您必须首先设置必要的环境变量。然后，将工具集成到您的crewAI项目中，开始市场研究。以下是如何做到这一点的基本示例：

from crewai_tools import MDXSearchTool

# 初始化工具以搜索执行过程中了解到的任何MDX内容
tool = MDXSearchTool()

# 或者

# 初始化工具并指定MDX文件路径，以便在该文档中进行专属搜索
tool = MDXSearchTool(mdx='path/to/your/document.mdx')

参数

• mdx: 可选。指定搜索的MDX文件路径。可以在初始化时提供。

自定义模型和嵌入

工具默认使用OpenAI进行嵌入和总结。如需自定义，请使用如下配置字典：

tool = MDXSearchTool(
    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",
            ),
        ),
    )
)

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",
            ),
        ),
    )
)