TypeAI 项目介绍
什么是 TypeAI?
TypeAI 是一个专为 TypeScript 设计的人工智能框架,致力于简化 AI 应用的开发。它使用工具包构建支持 AI 功能的应用,使得运用大型语言模型(LLM)就像写普通代码一样简单。通过 TypeAI,只需定义类型和函数原型,系统就会自动生成实现,这使得开发过程如同魔法一般。
核心功能
安装与设置
要使用 TypeAI,首先需要安装相应的包。安装命令如下:
npm install @typeai/core @deepkit/core
需要注意的是,TypeAI 依赖 DeepKit 提供运行时的类型信息。在某些设置中,可能需要安装特定版本的 DeepKit 包。
AI 函数
TypeAI 的关键在于生成回以 AI 支持的函数。例如,可以通过定义一个函数原型,然后用 toAIFunction()
包装,即可得到一个功能齐全的 AI 函数:
/** @description 给定 `text`,返回一个介于 -1 和 1 之间的分数作为情感评分。 */
function sentimentSpec(text: string): number | void {}
const sentiment = toAIFunction(sentimentSpec)
const score = await sentiment('That was surprisingly easy!')
这种方法支持复杂的数据类型,能轻松处理 TypeScript 的类型系统,并生成符合预期的行为。
AI "工具函数" 辅助
TypeAI 可以将自定义函数提供给大型语言模型(LLM)进行函数调用。以下是如何使用 TypeAI 将自定义函数暴露给 OpenAI 的 LLM:
import { ToolFunction, handleToolUse } from '@typeai/core'
// 生成 JSON 架构并注册你的函数
const getCurrentWeatherTool = ToolFunction.from(getCurrentWeather)
const messages = [{
role: ChatCompletionRequestMessageRoleEnum.User,
content: "What's the weather like in Boston? Say it like a weather reporter.",
}]
const request = {
model: 'gpt-3.5-turbo',
messages,
functions: [getCurrentWeatherTool.schema],
max_tokens: 1000,
}
const { data: response } = await openai.createChatCompletion(request)
const responseData = await handleToolUse(openai, request, response)
const result = responseData?.choices[0].message
使用注意事项
TypeAI 依赖于 DeepKit 的类型系统,由于某些运行时环境的特性,可能会出现兼容性问题。例如,tsx
运行环境就不兼容 DeepKit。
工作原理
TypeAI 通过 @deepkit/type
提供的 TypeScript 运行时类型信息,能够替换和生成新的函数。具体来说,它会生成与函数原型相匹配的备用函数,并创建相应的 JSON Schema 描述,以便于与 OpenAI 的 API 交互。
未来发展
- 持续改进和优化框架功能
- 增加更多对 AI 模型的支持
- 不断完善用户体验和开发流程
贡献与致谢
TypeAI 的开发灵感来自 Prefect / Marvin 团队,他们开创性的工作为该框架的诞生奠定了基础。此外,王辰宇的代码贡献也为 TypeAI 的 JSON Schema 生成提供了支持。
TypeAI 是一个自带魔力的框架,它使开发者能够以最少的工作量构建出功能强大的 AI 支持应用。如果这听起来像是你梦寐以求的工具,那么 TypeAI 就是你的不二之选!在这一旅程中,TypeAI 期待与你一同探索技术的无限可能。