跳转到主要内容

​
MDXSearchTool

MDXSearchTool 正在持续开发中。功能可能会增加或删除，并且在我们完善工具时，功能可能会不可预测地发生变化。

​
描述

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

​
安装

在使用 MDX 搜索工具之前，请确保已安装 crewai_tools 包。如果尚未安装，可以使用以下命令进行安装 
pip install 'crewai[tools]'

​
使用示例

要使用 MDX 搜索工具，您必须首先设置必要的环境变量。然后，将该工具集成到您的 crewAI 项目中，以开始您的市场研究。下面是一个基本示例，说明如何执行此操作
代码
from crewai_tools import MDXSearchTool

# Initialize the tool to search any MDX content it learns about during execution
tool = MDXSearchTool()

# OR

# Initialize the tool with a specific MDX file path for an exclusive search within that document
tool = MDXSearchTool(mdx='path/to/your/document.mdx')

​
参数

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

​
模型和嵌入的自定义

该工具默认使用 OpenAI 进行嵌入和摘要。要进行自定义，请使用如下所示的配置字典
代码
from chromadb.config import Settings

tool = MDXSearchTool(
    config={
        "embedding_model": {
            "provider": "openai",
            "config": {
                "model": "text-embedding-3-small",
                # "api_key": "sk-...",
            },
        },
        "vectordb": {
            "provider": "chromadb",  # or "qdrant"
            "config": {
                # "settings": Settings(persist_directory="/content/chroma", allow_reset=True, is_persistent=True),
                # from qdrant_client.models import VectorParams, Distance
                # "vectors_config": VectorParams(size=384, distance=Distance.COSINE),
            }
        },
    }
)