Class: Telnyx::Resources::AI

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai.rb,
lib/telnyx/resources/ai/chat.rb,
lib/telnyx/resources/ai/audio.rb,
lib/telnyx/resources/ai/tools.rb,
lib/telnyx/resources/ai/openai.rb,
lib/telnyx/resources/ai/clusters.rb,
lib/telnyx/resources/ai/missions.rb,
lib/telnyx/resources/ai/assistants.rb,
lib/telnyx/resources/ai/embeddings.rb,
lib/telnyx/resources/ai/fine_tuning.rb,
lib/telnyx/resources/ai/mcp_servers.rb,
lib/telnyx/resources/ai/openai/chat.rb,
lib/telnyx/resources/ai/integrations.rb,
lib/telnyx/resources/ai/conversations.rb,
lib/telnyx/resources/ai/missions/runs.rb,
lib/telnyx/resources/ai/missions/tools.rb,
lib/telnyx/resources/ai/assistants/tags.rb,
lib/telnyx/resources/ai/assistants/tests.rb,
lib/telnyx/resources/ai/assistants/tools.rb,
lib/telnyx/resources/ai/fine_tuning/jobs.rb,
lib/telnyx/resources/ai/openai/embeddings.rb,
lib/telnyx/resources/ai/embeddings/buckets.rb,
lib/telnyx/resources/ai/missions/runs/plan.rb,
lib/telnyx/resources/ai/assistants/versions.rb,
lib/telnyx/resources/ai/missions/mcp_servers.rb,
lib/telnyx/resources/ai/missions/runs/events.rb,
lib/telnyx/resources/ai/assistants/tests/runs.rb,
lib/telnyx/resources/ai/conversations/insights.rb,
lib/telnyx/resources/ai/conversations/messages.rb,
lib/telnyx/resources/ai/integrations/connections.rb,
lib/telnyx/resources/ai/missions/knowledge_bases.rb,
lib/telnyx/resources/ai/assistants/canary_deploys.rb,
lib/telnyx/resources/ai/assistants/scheduled_events.rb,
lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb,
lib/telnyx/resources/ai/assistants/tests/test_suites.rb,
lib/telnyx/resources/ai/conversations/insight_groups.rb,
lib/telnyx/resources/ai/assistants/tests/test_suites/runs.rb,
lib/telnyx/resources/ai/conversations/insight_groups/insights.rb

Overview

Generate text with LLMs

Defined Under Namespace

Classes: Assistants, Audio, Chat, Clusters, Conversations, Embeddings, FineTuning, Integrations, McpServers, Missions, OpenAI, Tools

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AI

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AI.

Parameters:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/telnyx/resources/ai.rb', line 144

def initialize(client:)
  @client = client
  @assistants = Telnyx::Resources::AI::Assistants.new(client: client)
  @audio = Telnyx::Resources::AI::Audio.new(client: client)
  @chat = Telnyx::Resources::AI::Chat.new(client: client)
  @clusters = Telnyx::Resources::AI::Clusters.new(client: client)
  @conversations = Telnyx::Resources::AI::Conversations.new(client: client)
  @embeddings = Telnyx::Resources::AI::Embeddings.new(client: client)
  @fine_tuning = Telnyx::Resources::AI::FineTuning.new(client: client)
  @integrations = Telnyx::Resources::AI::Integrations.new(client: client)
  @mcp_servers = Telnyx::Resources::AI::McpServers.new(client: client)
  @missions = Telnyx::Resources::AI::Missions.new(client: client)
  @openai = Telnyx::Resources::AI::OpenAI.new(client: client)
  @tools = Telnyx::Resources::AI::Tools.new(client: client)
end

Instance Attribute Details

#assistants ⇒ Telnyx::Resources::AI::Assistants (readonly)

Configure AI assistant specifications

Returns:



9
10
11
 
# File 'lib/telnyx/resources/ai.rb', line 9

def assistants
  @assistants
end

#audio ⇒ Telnyx::Resources::AI::Audio (readonly)

Returns:



12
13
14
 
# File 'lib/telnyx/resources/ai.rb', line 12

def audio
  @audio
end

#chat ⇒ Telnyx::Resources::AI::Chat (readonly)

Generate text with LLMs

Returns:



16
17
18
 
# File 'lib/telnyx/resources/ai.rb', line 16

def chat
  @chat
end

#clusters ⇒ Telnyx::Resources::AI::Clusters (readonly)

Identify common themes and patterns in your embedded documents

Returns:



20
21
22
 
# File 'lib/telnyx/resources/ai.rb', line 20

def clusters
  @clusters
end

#conversations ⇒ Telnyx::Resources::AI::Conversations (readonly)

Manage historical AI assistant conversations

Returns:



24
25
26
 
# File 'lib/telnyx/resources/ai.rb', line 24

def conversations
  @conversations
end

#embeddings ⇒ Telnyx::Resources::AI::Embeddings (readonly)

Embed documents and perform text searches

Returns:



28
29
30
 
# File 'lib/telnyx/resources/ai.rb', line 28

def embeddings
  @embeddings
end

#fine_tuning ⇒ Telnyx::Resources::AI::FineTuning (readonly)

Returns:



31
32
33
 
# File 'lib/telnyx/resources/ai.rb', line 31

def fine_tuning
  @fine_tuning
end

#integrations ⇒ Telnyx::Resources::AI::Integrations (readonly)

Returns:



34
35
36
 
# File 'lib/telnyx/resources/ai.rb', line 34

def integrations
  @integrations
end

#mcp_servers ⇒ Telnyx::Resources::AI::McpServers (readonly)

Returns:



37
38
39
 
# File 'lib/telnyx/resources/ai.rb', line 37

def mcp_servers
  @mcp_servers
end

#missions ⇒ Telnyx::Resources::AI::Missions (readonly)

Returns:



40
41
42
 
# File 'lib/telnyx/resources/ai.rb', line 40

def missions
  @missions
end

#openai ⇒ Telnyx::Resources::AI::OpenAI (readonly)

Returns:



43
44
45
 
# File 'lib/telnyx/resources/ai.rb', line 43

def openai
  @openai
end

#tools ⇒ Telnyx::Resources::AI::Tools (readonly)

Configure AI assistant specifications

Returns:



47
48
49
 
# File 'lib/telnyx/resources/ai.rb', line 47

def tools
  @tools
end

Instance Method Details

#create_response(body:, request_options: {}) ⇒ Hash{Symbol=>Object}

Deprecated.

Deprecated: Use ‘POST /v2/ai/openai/responses` instead. Chat with a language model. This endpoint is consistent with the [OpenAI Responses API](platform.openai.com/docs/api-reference/responses) and may be used with the OpenAI JS or Python SDK. Response id parameter is not supported at the moment. Use ’conversation’ parameter to leverage persistent conversations feature.

Parameters:

Returns:

  • (Hash{Symbol=>Object})

See Also:



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/telnyx/resources/ai.rb', line 66

def create_response(params)
  parsed, options = Telnyx::AICreateResponseParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ai/responses",
    body: parsed[:body],
    model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
    options: options
  )
end

#retrieve_models(request_options: {}) ⇒ Telnyx::Models::AIRetrieveModelsResponse

Deprecated.

Deprecated: Use ‘GET /v2/ai/openai/models` instead.

Returns the same ‘ModelsResponse` payload as the OpenAI-compatible endpoint —open-source LLMs hosted on Telnyx (e.g. `moonshotai/Kimi-K2.6`, `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`), embedding models, and fine-tuned models — kept around for backwards compatibility. New integrations should use `/v2/ai/openai/models`.

Model ids follow the ‘organization/model_name` convention from Hugging Face.

Parameters:

Returns:

See Also:



96
97
98
99
100
101
102
103
 
# File 'lib/telnyx/resources/ai.rb', line 96

def retrieve_models(params = {})
  @client.request(
    method: :get,
    path: "ai/models",
    model: Telnyx::Models::AIRetrieveModelsResponse,
    options: params[:request_options]
  )
end

#summarize(bucket:, filename:, system_prompt: nil, request_options: {}) ⇒ Telnyx::Models::AISummarizeResponse

Generate a summary of a file’s contents.

Supports the following text formats:

  • PDF, HTML, txt, json, csv

Supports the following media formats (billed for both the transcription and summary):

  • flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm

  • Up to 100 MB

Parameters:

  • bucket (String) —

    The name of the bucket that contains the file to be summarized.

  • filename (String) —

    The name of the file to be summarized.

  • system_prompt (String) —

    A system prompt to guide the summary generation.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/telnyx/resources/ai.rb', line 130

def summarize(params)
  parsed, options = Telnyx::AISummarizeParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ai/summarize",
    body: parsed,
    model: Telnyx::Models::AISummarizeResponse,
    options: options
  )
end