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_eachfor 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
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | |
instructions | string | Yes | System instructions for the assistant. |
tags | array[string] | No | Tags associated with the assistant. |
model | string | No | ID of the model to use when external_llm is not set. |
tools | array[object] | No | Deprecated 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.idassistant.nameassistant.modelassistant.instructionsassistant.created_atassistant.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
| Parameter | Type | Required | Description |
|---|---|---|---|
content | string | Yes | The message content sent by the client to the assistant |
conversation_id | string (UUID) | Yes | A unique identifier for the conversation thread, used to mai... |
assistant_id | string (UUID) | Yes | Unique identifier of the assistant. |
name | string | No | The 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
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A descriptive name for the assistant test. |
destination | string | Yes | The target destination for the test conversation. |
instructions | string | Yes | Detailed instructions that define the test scenario and what... |
rubric | array[object] | Yes | Evaluation criteria used to assess the assistant's performan... |
description | string | No | Optional detailed description of what this test evaluates an... |
telnyx_conversation_channel | object | No | The communication channel through which the test will be con... |
max_duration_seconds | integer | No | Maximum 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_idassistant_test.nameassistant_test.destinationassistant_test.created_atassistant_test.instructionsassistant_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