综合介绍
Prompt Smith 是一个提示工程解决方案,旨在帮助用户轻松管理生成式 AI 提示。该平台提供了自托管选项,用户可以完全控制自己的数据。通过 Docker 化部署,用户可以轻松启动和运行服务。Prompt Smith 还提供了 RESTful API 和适用于 Python 和 Node.js 的 SDK,方便用户集成和使用。
功能列表
- 自托管选项:用户可以完全控制自己的数据。
- Docker 化部署:简化了服务的启动和运行过程。
- RESTful API:方便用户集成和获取提示。
- SDK 支持:提供适用于 Python 和 Node.js 的 SDK。
- API 密钥管理:通过集中式 UI 进行 API 密钥管理。
- 提示管理:通过集中式 UI 进行提示管理。
- 版本控制:在数据库级别进行版本控制。
使用帮助
安装流程
- 本地启动服务:
- 使用命令
docker-compose up --build
启动服务。 - 访问
http://localhost:3000
进行管理。
- 使用命令
- 默认登录凭证:
- 电子邮件:
admin@localhost.lan
- 密码:
AwesomePromptsManagement
- 请勿在生产环境中使用默认凭证。
- 电子邮件:
功能操作
- 创建提示:
- 访问
http://localhost:3000/prompt
创建新的提示。 - 输入提示内容并保存。
- 访问
- 创建 API 密钥:
- 访问
http://localhost:3000/key
创建新的 API 密钥。 - 使用生成的 API 密钥进行身份验证。
- 访问
- 获取提示:
- 通过 RESTful API 获取提示:
curl "http://localhost:3000/api/bff/api/sdk/prompt/{prompt-key}" \ -H 'Authorization: Bearer {api-key}' \ -H 'Content-Type: application/json; charset=utf-8'
- 通过 SDK 获取提示:
- Python SDK:
from promptsmith_sdk import PromptSmith client = PromptSmith(api_key="your_api_key") prompt = client.get_prompt("prompt_key") print(prompt)
- Node.js SDK:
const PromptSmith = require('promptsmith-sdk'); const client = new PromptSmith('your_api_key'); client.getPrompt('prompt_key').then(prompt => console.log(prompt));
- Python SDK:
- 通过 RESTful API 获取提示:
注意事项
- 数据持久性:请注意,Demo 实例中的数据可能不会保留,并且将按计划删除。
- 贡献指南:欢迎用户通过 issue 或 PR 提出功能请求或错误报告。