MySQLSearchTool

描述

该工具旨在促进MySQL数据库表中的语义搜索。利用RAG(检索与生成)技术,MySQLSearchTool为用户提供了一种高效查询数据库表内容的方法,特别适用于MySQL数据库。它通过语义搜索查询简化了查找相关数据的过程,使其成为需要在MySQL数据库中对大量数据集执行高级查询的用户的宝贵资源。

安装

要安装crewai_tools包并使用MySQLSearchTool,请在终端中执行以下命令:

pip install 'crewai[tools]'

示例

以下是一个示例,展示如何使用 MySQLSearchTool 在 MySQL 数据库中的表上进行语义搜索:

Code
from crewai_tools import MySQLSearchTool

# Initialize the tool with the database URI and the target table name
tool = MySQLSearchTool(
    db_uri='mysql://user:password@localhost:3306/mydatabase',
    table_name='employees'
)

参数

MySQLSearchTool 需要以下参数来运行:

  • db_uri: 一个字符串,表示要查询的MySQL数据库的URI。此参数是必需的,必须包括必要的认证信息和数据库的位置。
  • table_name: 一个字符串,指定将在数据库中进行语义搜索的表的名称。此参数是必需的。

自定义模型和嵌入

默认情况下,该工具使用OpenAI进行嵌入和摘要生成。要自定义模型,您可以使用如下配置字典:

Code
tool = MySQLSearchTool(
    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",
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)

这个页面有帮助吗?