Promptable 项目使用教程

1. 项目介绍

Promptable 是一个用于构建大型语言模型（LLM）应用的 TypeScript/JavaScript 库。它允许开发者结合 LLM 和嵌入式提供商（如 OpenAI、Hugging Face、Cohere 和 Anthropic）来创建强大的 AI 应用。Promptable 提供了一个灵活且可扩展的 API，使得组合 LLM 与其他工具和数据源变得简单，从而快速构建复杂的应用。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm。然后，通过以下命令安装 Promptable：

npm install promptable

示例代码

以下是一个简单的示例，展示如何使用 Promptable 创建一个基本的聊天机器人：

import { Promptable } from 'promptable';

// 初始化 Promptable
const promptable = new Promptable({
  apiKey: 'your-openai-api-key',
});

// 创建一个简单的聊天机器人
const chatbot = promptable.createChatbot({
  model: 'gpt-3.5-turbo',
  prompt: 'You are a helpful assistant.',
});

// 与聊天机器人交互
chatbot.sendMessage('Hello, can you help me?').then(response => {
  console.log(response);
});

运行示例

1. 克隆项目仓库：

git clone https://github.com/cfortuner/promptable.git
cd promptable

2. 复制环境变量示例文件：

cp apps/web/.env.example apps/web/.env
cp examples/.env.example examples/.env

3. 在 .env 文件中添加你的 OpenAI API Key。

4. 安装依赖并运行示例：

pnpm install
pnpm dev

5. 在另一个终端窗口/标签中运行特定示例：

pnpm run example <example-name>

3. 应用案例和最佳实践

应用案例

• 聊天机器人与对话式 AI：使用 Promptable 构建智能聊天机器人，提供自然语言交互。
• 问答机器人：创建能够回答用户问题的 AI 系统。
• 写作应用：利用 LLM 生成高质量的文本内容。
• Copilot 应用：构建基于 Chrome 扩展和 VSCode 扩展的 AI 助手。
• AI 语义搜索应用：实现基于语义的文本搜索功能。
• AI 自动化工具：创建自动化工作流和工具，提升工作效率。

最佳实践

• 模块化设计：将复杂的应用拆分为多个模块，便于维护和扩展。
• 调试与追踪：使用 Promptable 提供的调试工具，确保应用的稳定性和性能。
• 数据集成：结合数据库和 API，增强 AI 应用的功能和数据处理能力。

4. 典型生态项目

• NextJS 与 Promptable 集成：提供了一个 NextJS 的启动套件，包含流式聊天机器人和问答机器人等功能。
• Promptable Web SDK：用于 Promptable 网站的 Web SDK，提供丰富的功能和接口。
• Twilio GPT SMS Chat Bot：结合 Twilio 和 GPT 的 SMS 聊天机器人项目。
• GPT3 Interview Chatbot：使用 GPT-3 构建的面试聊天机器人。

通过以上模块，你可以快速了解并开始使用 Promptable 项目。