MDX RAG 搜索

MDXSearchTool 用于搜索 MDX 文件并返回最相关的结果。

`MDXSearchTool`

NOTE

MDXSearchTool 仍在持续开发中。随着我们对工具的改进，可能会新增或移除功能，其行为也可能发生不可预期的变化。

描述

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

安装

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

shell

pip install 'crewai[tools]'

用法示例

要使用 MDX 搜索工具，你必须先设置必要的环境变量。然后，将该工具集成到你的 crewAI 项目中以开始你的市场调研。下面是一个基本示例：

python

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 进行嵌入和摘要。如需自定义，请使用如下所示的配置字典：

python

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

MDX RAG 搜索

MDXSearchTool

描述

安装

用法示例

参数

模型与嵌入的自定义

友情链接

`MDXSearchTool`