diff --git a/README.md b/README.md index e26963b4..13002610 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # TypeChat +
+ English · 简体中文 +
+ TypeChat is a library that makes it easy to build natural language interfaces using types. Building natural language interfaces has traditionally been difficult. These apps often relied on complex decision trees to determine intent and collect the required inputs to take action. Large language models (LLMs) have made this easier by enabling us to take natural language input from a user and match to intent. This has introduced its own challenges including the need to constrain the model's reply for safety, structure responses from the model for further processing, and ensuring that the reply from the model is valid. Prompt engineering aims to solve these problems, but comes with a steep learning curve and increased fragility as the prompt increases in size. @@ -150,8 +154,8 @@ inactive copy button should be hidden. ## Trademarks -This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft -trademarks or logos is subject to and must follow +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft +trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 00000000..1c1ea173 --- /dev/null +++ b/README.zh.md @@ -0,0 +1,101 @@ +# TypeChat + ++ English · 简体中文 +
+ +TypeChat 是一个通过类型系统轻松构建自然语言交互界面的核心库。 + +构建自然语言交互界面历来是一项极具挑战的任务。传统应用往往依赖复杂的决策树来判定用户意图并收集执行操作所需的输入参数。大语言模型(LLM)的出现降低了这一门槛,使我们能够直接接收用户的自然语言输入并匹配其意图。然而,这同时也带来了新的挑战,包括:需要约束模型的回复以确保安全性、将模型的响应结构化以便后续程序处理,以及确保模型返回的内容切实合法有效。提示词工程(Prompt Engineering)旨在解决这些问题,但伴随着陡峭的学习曲线,且随着提示词规模的膨胀,系统脆弱性会显著增加。 + +TypeChat 提出了革新理念:用**模式工程(Schema Engineering)**替代**提示词工程(Prompt Engineering)**。 + +您只需定义表示自然语言应用所支持意图的类型(Types)。它可以简单到一个用于情感分类的接口,也可以复杂到面向购物车或音乐流媒体应用的完整类型定义。例如,若要在模式(Schema)中追加新的意图,开发者只需向可辨识联合类型(Discriminated Union)中添加类型定义即可。若要构建分层模式,开发者可以通过“元模式(Meta-schema)”根据用户输入动态选择一个或多个子模式。 + +在定义好类型之后,TypeChat 会自动处理后续所有复杂流程: + +1. 利用类型定义自动为 LLM 构建提示词(Prompt)。 +2. 严格校验 LLM 的响应是否符合类型模式(Schema)。若校验失败,通过与语言模型进一步交互自动修复不合规的输出。 +3. (无需再次调用 LLM)对生成的实例进行简洁摘要,并确认其符合用户意图。 + +类型定义即是一切(Types are all you need)! + +# 快速入门 (Getting Started) + +TypeScript/JavaScript 软件包要求使用 [Node.js 24.22.1 或更新版本](https://nodejs.org/en/download)。开发环境使用的 Node.js 24.22.1 已固定在 [.nvmrc](./.nvmrc) 中,该版本包含 [2026年10月21日的安全修复](https://nodejs.org/en/blog/vulnerability/october-2026-security-releases)。 + +通过 npm 安装适用于 TypeScript/JavaScript 的 TypeChat: + +``` +npm install typechat +``` + + + +您也可以直接通过源码体验 TypeChat: + +* [Python 实现](./python/README.md) +* [TypeScript 实现](./typescript/README.md) +* [C#/.NET 实现](https://github.com/microsoft/TypeChat.net) + +若想直观查看 TypeChat 的实际运行效果,建议探索 [TypeChat 示例项目](./typescript/examples)。您可以在本地机器或 GitHub Codespaces 中直接运行它们。 + +欲了解有关 TypeChat 的更多信息,欢迎访问[官方文档站点](https://microsoft.github.io/TypeChat),其中包含更详尽的技术指南与入门教程。 + +## 项目方向 (Project direction) + +[GOALS.md](./GOALS.md) 明确了哪些内容属于 TypeChat 的范围、哪些不属于,以及哪些仍在考虑之中,是本仓库关于产品范围的首要政策文件。对该政策的变更必须获得项目所有者团队 `@microsoft/typechat` 中的人类成员明确批准;社区关注或 AI 建议不会改变该政策。提出新的项目方向前,请先阅读该文件。范围内的常规维护仍遵循正常的贡献流程。 + +## 仓库自动化实验 (Repository automation experiment) + +我们正在试验逐步过渡到半自动化的仓库维护流程。初期的智能体辅助工作流程仍保留人类参与;长期目标是减少人工协调工作,让社区提案能够从讨论推进为获接受并经过审查的变更。有关实验及参与方式,请参阅[自动化实验说明](./AUTOMATION.md)。 + +自动化的[实施状态与历史](./AUTOMATION.md#status-and-implementation-history)和[工作流程模型配置](./AUTOMATION.md#model-selection)会持续更新,请以这些英文文档为准,本译文不重复维护状态表。实施日期不代表相关功能已在 GitHub 上启用;现有维护和部署工作流程保持不变。 + +## 参与贡献 (Contributing) + +请先阅读[项目目标与非目标](./GOALS.md)。如果提案会改变这些边界,必须先完成经项目所有者批准的政策变更,才能接受相关实现。 + +**仓库自动化实验:** 我们正在试验逐步过渡到半自动化的仓库维护流程。初期的智能体辅助工作流程仍保留人类参与;长期目标是减少人工协调工作,让社区提案能够从讨论推进为获接受并经过审查的变更。有关实验及参与方式,请参阅[自动化实验说明](./AUTOMATION.md)。 + +本项目诚挚欢迎社区贡献与建议。绝大多数贡献都需要您签署一份贡献者许可协议(CLA),声明您有权且确实授予我们使用您所贡献内容的权利。详情请访问