Python SDK 快速入门
介绍
AskTable Python SDK 提供了一套简洁的接口,让您能够轻松地将数据分析和问答能力集成到您的应用中。通过本指南,您将了解如何使用 SDK 完成从数据源创建到智能问答的全流程操作。
其他参考:
注意
- 若未安装 AskTable 的 Python SDK,请先安装 SDK,参考安装指南。
使用示例
AskTable支持两种类型的数据源:文件类型(Excel或CSV)和数据库类型(如MySQL, PostgreSQL等)。
包含以下步骤:
- 初始化SDK客户端
- 添加数据源
- 构建元数据
- 创建AI 数据助手(Bot)
- 创建对话(Chat)
- 发送问题并获取回答
完整代码示例
- 初始化SDK
from asktable import Asktable
# 初始化SDK
api_key = 'API_KEY'
# 如果使用 SaaS
client = Asktable(api_key=api_key)
# # 如果是私有部署
# client = Asktable(base_url='http://192.168.3.5:8000/api', api_key=api_key)
其中,API_KEY 是 访问AskTable API 的密钥。
- 添加数据源
-
文件类型
添加数据源:
datasource = client.datasources.create(
engine="excel",
name="example_excel"
)向数据源中添加文件:
with open(file_path, "rb") as file_obj:
file_id = client.datasources.add_file(
datasource_id=datasource.id,
file=file_obj
) -
数据库类型
添加数据库类型的数据源:
datasource = client.datasources.create(
engine="mysql",
name="example_mysql",
access_config={
"host": "your_mysql_host",
"port": 3306,
"user": "your_username",
"password": "your_password",
"db": "your_database",
},
)
- 创建元数据
meta = client.datasources.meta.create(
datasource_id=datasource.id,
name="example_meta"
)
- 创建AI 数据助手
bot = client.bots.create(
datasource_ids=[datasource.id],
name="example_bot"
)
- 创建对话
chat = client.chats.create(
bot_id=bot.id
)
- 发送问题获取回答
message = client.chats.messages.create(
chat_id=chat.id,
question="张三的成绩"
)
print(message.content.text)