跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
浏览器与自动化

telnyx-ai-assistants-ruby

AI voice assistants with custom instructions, knowledge bases, and tool integrations.

team-telnyx · 已有 AI 审核记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add team-telnyx/ai --skill telnyx-ai-assistants-ruby

技能说明


name: telnyx-ai-assistants-ruby description: >- AI voice assistants with custom instructions, knowledge bases, and tool integrations. metadata: author: telnyx product: ai-assistants language: ruby generated_by: telnyx-openapi-pipeline contract: v2

Telnyx AI Assistants - Ruby

Installation

gem install telnyx

Setup

require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

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

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

  • Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
  • Pagination: Use .auto_paging_each for automatic iteration: page.auto_paging_each { |item| puts item.id }.

Reference Use Rules

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

  • If the parameter, enum, or response field you need is not shown inline in this skill, read references/api-details.md before writing code.
  • Before using any operation in ## Additional Operations, read the optional-parameters section and the response-schemas section.

Core Tasks

Create an assistant

Assistant creation is the entrypoint for any AI assistant integration. Agents need the exact creation method and the top-level fields returned by the SDK.

client.ai.assistants.create() — POST /ai/assistants

ParameterTypeRequiredDescription
namestringYes
instructionsstringYesSystem instructions for the assistant.
tagsarray[string]NoTags associated with the assistant.
modelstringNoID of the model to use when external_llm is not set.
toolsarray[object]NoDeprecated for new integrations.
...+23 optional params in references/api-details.md
assistant = client.ai.assistants.create(instructions: "You are a helpful assistant.", name: "my-resource", model: "openai/gpt-4o")
puts(assistant)

Primary response fields:

  • assistant.id
  • assistant.name
  • assistant.model
  • assistant.instructions
  • assistant.created_at
  • assistant.conversation_flow

Chat with an assistant

Chat is the primary runtime path. Agents need the exact assistant method and the response content field.

client.ai.assistants.chat() — POST /ai/assistants/{assistant_id}/chat

ParameterTypeRequiredDescription
contentstringYesThe message content sent by the client to the assistant
conversation_idstring (UUID)YesA unique identifier for the conversation thread, used to mai...
assistant_idstring (UUID)YesUnique identifier of the assistant.
namestringNoThe optional display name of the user sending the message
response = client.ai.assistants.chat(
  "assistant_id",
  content: "Tell me a joke about cats",
  conversation_id: "42b20469-1215-4a9a-8964-c36f66b406f4"
)

puts(response)

Primary response fields:

  • response.content

Create an assistant test

Test creation is the main validation path for production assistant behavior before deployment.

client.ai.assistants.tests.create() — POST /ai/assistants/tests

ParameterTypeRequiredDescription
namestringYesA descriptive name for the assistant test.
destinationstringYesThe target destination for the test conversation.
instructionsstringYesDetailed instructions that define the test scenario and what...
rubricarray[object]YesEvaluation criteria used to assess the assistant's performan...
descriptionstringNoOptional detailed description of what this test evaluates an...
telnyx_conversation_channelobjectNoThe communication channel through which the test will be con...
max_duration_secondsintegerNoMaximum duration in seconds that the test conversation shoul...
...+1 optional params in references/api-details.md
assistant_test = client.ai.assistants.tests.create(
  destination: "+15551234567",
  instructions: "Act as a frustrated customer who received a damaged product. Ask for a refund and escalate if not satisfied with the initial response.",
  name: "Customer Support Bot Test",
  rubric: [
    {criteria: "Assistant responds within 30 seconds", name: "Response Time"},
    {criteria: "Provides correct product information", name: "Accuracy"}
  ]
)

puts(assistant_test)

Primary response fields:

  • assistant_test.test_id
  • assistant_test.name
  • assistant_test.destination
  • assistant_test.created_at
  • assistant_test.instructions
  • assistant_test.description

Important Supporting Operations

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

Get an assistant

Fetch the current state before updating, deleting, or making control-flow decisions.

client.ai.assistants.retrieve() — `GET /ai/assistants/{assi

阅读完整来源 ↗