telnyx-ai-assistants-ruby

用途

该技能面向使用 Ruby 开发、需要集成 Telnyx AI Assistants 的开发者，用于以编程方式构建和管理 AI 语音助手。助手支持自定义指令、知识库与工具集成，可通过 Telnyx API 进行对话交互。

主要能力

• 创建与管理助手：通过 client.ai.assistants.create() 创建助手，可设置 name、instructions、tags、model 等参数；支持 retrieve、update、list、delete、clone_ 等操作。
• 对话运行：通过 client.ai.assistants.chat() 发送消息，需提供 content、conversation_id 等参数，响应内容在 response.content 字段。还支持通过 SMS 进行聊天（send_sms）。
• 助手测试：通过 client.ai.assistants.tests.create() 创建测试，需设置 name、destination、instructions、rubric 等，用于部署前验证助手行为；支持测试的查询、更新、删除，以及测试套件运行与历史记录查看。
• 外部导入：可从 elevenlabs、vapi、retell 等外部提供商导入助手（imports）。
• 其他操作：标签管理、定时事件（scheduled_events）、工具添加/移除/测试（tools）、指令增强（instructions.enhance）、版本管理（versions）、金丝雀部署（canary_deploys）、获取 texml。

使用方式

安装：gem install telnyx。

初始化：

require "telnyx"
client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"],
)

创建助手示例：

assistant = client.ai.assistants.create(instructions: "You are a helpful assistant.", name: "my-resource", model: "openai/gpt-4o")

对话示例：

response = client.ai.assistants.chat(
  "assistant_id",
  content: "Tell me a joke about cats",
  conversation_id: "42b20469-1215-4a9a-8964-c36f66b406f4"
)

错误处理：所有 API 调用可能因网络错误、限流（429）、验证错误（422）或认证错误（401）失败，生产代码需处理这些错误；429 建议使用指数退避重试。

分页：使用 .auto_paging_each 自动迭代，例如 page.auto_paging_each { |item| puts item.id }。

注意：电话号码必须为 E.164 格式（如 +13125550001），包含 + 前缀和国家代码，不含空格、短横线或括号。文档提示不要自行创造参数、枚举、响应字段或 webhook 字段；未内联给出的参数应查阅 references/api-details.md。

适用场景

需要在 Ruby 应用中集成 AI 语音助手、通过 API 驱动助手对话、对助手行为进行自动化测试、从外部平台迁移助手，或管理助手版本与部署的开发者场景。

限制

该资料未提供关于收费、价格、平台可用性或效果保证的信息。部分操作（如工具集成、金丝雀部署、定时事件等）的具体可选参数与响应结构需参考其 api-details.md 文档，超出本资料范围。