BAIZE AI RESOURCE

自然语言转结构化数据工具

TypeChat

TypeChat 是面向开发者的工具,可将用户的自然语言请求转换为符合预设类型的结构化数据,并进行验证。它帮助应用识别用户意图,减少直接处理自由文本时的不确定性。

TypeChat

资源介绍

TypeChat 适合希望为应用加入自然语言交互的开发者。开发者先定义应用能够处理的数据类型或操作,再让 TypeChat 将用户输入转换为对应的结构化结果,并验证结果是否符合定义。这样,应用可以接收日常语言表达,同时获得便于后续处理的数据。仓库提供 Python 示例,展示情感分类、咖啡店点单、日历操作、数学计算等用法,也提供将请求路由到不同示例应用的演示。运行示例需要配置 OpenAI 或 Azure OpenAI 接口;它更适合作为应用开发和试验自然语言交互的工具,而不是无需配置即可使用的独立聊天产品。

应用能力

自然语言转结构化结果

将用户请求映射为预定义类型对应的数据;示例展示了把日历安排转换为操作列表、把咖啡订单转换为商品条目。

结果验证

示例将自然语言输入转换为经过验证的 JSON,便于应用按预期的数据形式处理用户意图。

按请求选择处理场景

MultiSchema 示例可将用户请求路由到日历、点单、情感分类等不同的子应用。

根据操作定义生成计算程序

数学示例将自然语言计算请求转换为调用四则运算 API 的简单程序,并执行得到结果。

资源配置

应用版本

commit-50c9c40ab282

运行环境

Windows

安装方式

命令安装源码运行包管理器安装

依赖环境

PythonAPI KeyNode.js其他

安装与使用

  1. 准备 Python 3.11 或更高版本,并获取仓库中的 Python 示例。

  2. 使用 hatch,或创建 Python 虚拟环境并通过 pip 安装示例所需包。

  3. 配置 OpenAI 的模型名称与 API Key,或配置 Azure OpenAI 的接口地址与 API Key。

  4. 运行所需示例的 demo.py,在交互提示中输入自然语言请求,查看转换结果。

使用案例

将预约描述转为日历操作

使用场景开发日历应用时,用户用一句话说明事项、日期和时间。

使用 Calendar 示例解析输入,得到包含添加日历事件、日期、时间段及事项描述的结构化操作。

将咖啡点单转为商品条目

使用场景咖啡店点单应用需要理解顾客对饮品和配料的口语描述。

使用 Coffee Shop 示例,将顾客请求转换为包含饮品、选项和数量的订单数据。

将文字计算转为可执行步骤

使用场景用户用自然语言提出多步四则运算。

使用 Math 示例,把计算描述转换为调用预定义数学 API 的程序,并获得计算结果。

包含内容

typechat-source.zip
README-中文安装说明.md
LICENSE-MIT.txt
SHA256.txt

常见问题

TypeChat 的 Calendar 示例能处理什么请求?
它可以把自然语言中的日程安排意图转换为操作,例如添加日历事件或搜索事件。
Coffee Shop 示例如何处理点单内容?
它会把自然语言订单转换为商品和选项组成的结构化结果;不匹配已有商品类型的输入也可用 UnknownText 记录。
Health Data Agent 示例适合什么场景?
它通过对话收集用药或健康状况等信息。该示例要求使用 GPT-4。
运行 Music 示例需要哪些 Spotify 配置?
需要 Spotify Premium 账户,并创建 Spotify 应用、设置本地授权回调地址,再配置 Client ID、Client Secret 和对应的本地回调端口。
TypeChat 有 .NET 和 C# 版本吗?
有;.NET 和 C# 版本位于单独的 TypeChat.NET 仓库。