Latitude-LLM 快速开发指南:TypeScript SDK 入门实践
前言
Latitude-LLM 是一个功能强大的 AI 开发平台,其 TypeScript SDK 为开发者提供了便捷的接口来管理和执行 AI 提示词(prompt)。本文将带你快速上手使用该 SDK,实现从环境配置到实际应用的全流程。
环境准备
在开始之前,请确保满足以下条件:
- 有效的 Latitude 账户(可以是自托管实例)
- 至少接入了一个 AI 服务提供商(如 OpenAI、Anthropic 或 Google 等)
- 本地已安装 Node.js(v16 或更高版本)
SDK 安装与初始化
安装方式
根据你的包管理器选择以下任一命令安装 SDK:
# npm 用户
npm install @latitude-data/sdk
# yarn 用户
yarn add @latitude-data/sdk
# pnpm 用户
pnpm add @latitude-data/sdk
初始化配置
在你的 TypeScript 项目中初始化 SDK 客户端:
import { Latitude } from '@latitude-data/sdk'
// 基础初始化
const latitude = new Latitude('your_api_key')
// 自托管实例的进阶配置
const latitude = new Latitude('your_api_key', {
projectId: 123,
// 其他自定义选项...
})
提示词管理
创建或获取提示词
使用 getOrCreate
方法可以智能地处理提示词资源:
const prompt = await latitude.prompts.getOrCreate('/support/assistant', {
prompt: {
name: '客服助手',
content: `
---
provider: Latitude
model: gpt-4o
---
你是一家软件公司的专业客服助手。
客户问题:{{query}}
产品名称:{{product}}
请提供友好、专业的回答,必要时包含相关产品细节。`,
provider: 'openai',
// 其他提示词属性...
},
})
获取现有提示词
const existingPrompt = await latitude.prompts.get('/support/assistant')
执行提示词与结果处理
基本执行
const response = await latitude.prompts.run('/support/assistant', {
parameters: {
query: '如何重置密码?',
product: '云管理专业版',
},
})
流式响应处理
对于需要实时显示结果的场景,可以使用流式处理:
const stream = await latitude.prompts.run('/support/assistant', {
parameters: {
query: 'API 集成指南',
product: 'Latitude SDK',
},
stream: true,
})
for await (const chunk of stream) {
if (chunk.type === 'text-delta' && chunk.content) {
// 实时处理文本片段
process.stdout.write(chunk.content)
}
}
高级功能
自定义元数据与日志
const response = await latitude.prompts.run('/support/assistant', {
parameters: {
query: "2.0版本有哪些新功能?",
product: '云管理专业版',
},
customIdentifier: '用户查询_20240615',
onFinished: (data) => {
console.log(`执行完成,ID: ${data.uuid}`)
},
})
程序化触发评估
const evaluation = await latitude.evaluations.trigger('会话ID', {
evaluationUuids: ['评估ID1', '评估ID2'],
})
最佳实践建议
- 环境隔离:为不同环境(开发/测试/生产)配置不同的项目ID
- 错误处理:对所有异步操作添加 try-catch 块
- 性能监控:利用 onFinished 回调记录执行时间等指标
- 模板管理:将常用提示词路径标准化,便于团队协作
后续学习路径
掌握基础使用后,你可以进一步探索:
- 深入了解 SDK 的高级功能
- 实现基于事件的自动化工作流
- 配置全面的日志记录系统
- 建立团队专属的 API 鉴权机制
通过本指南,你应该已经掌握了 Latitude-LLM TypeScript SDK 的核心使用方法。这个工具的强大之处在于它简化了 AI 应用的开发流程,让开发者可以更专注于业务逻辑的实现。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考