Class: Telnyx::Resources::AI::Missions

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai/missions.rb,
lib/telnyx/resources/ai/missions/runs.rb,
lib/telnyx/resources/ai/missions/tools.rb,
lib/telnyx/resources/ai/missions/runs/plan.rb,
lib/telnyx/resources/ai/missions/mcp_servers.rb,
lib/telnyx/resources/ai/missions/runs/events.rb,
lib/telnyx/resources/ai/missions/knowledge_bases.rb,
lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb

Defined Under Namespace

Classes: KnowledgeBases, McpServers, Runs, Tools

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Missions

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 Missions.

Parameters:



186
187
188
189
190
191
192
 
# File 'lib/telnyx/resources/ai/missions.rb', line 186

def initialize(client:)
  @client = client
  @runs = Telnyx::Resources::AI::Missions::Runs.new(client: client)
  @knowledge_bases = Telnyx::Resources::AI::Missions::KnowledgeBases.new(client: client)
  @mcp_servers = Telnyx::Resources::AI::Missions::McpServers.new(client: client)
  @tools = Telnyx::Resources::AI::Missions::Tools.new(client: client)
end

Instance Attribute Details

#knowledge_bases ⇒ Telnyx::Resources::AI::Missions::KnowledgeBases (readonly)

Returns:



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

def knowledge_bases
  @knowledge_bases
end

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

Returns:



14
15
16
 
# File 'lib/telnyx/resources/ai/missions.rb', line 14

def mcp_servers
  @mcp_servers
end

#runs ⇒ Telnyx::Resources::AI::Missions::Runs (readonly)

Returns:



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

def runs
  @runs
end

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

Returns:



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

def tools
  @tools
end

Instance Method Details

#clone_mission(mission_id, request_options: {}) ⇒ Object

Clone an existing mission

Parameters:

Returns:

  • (Object)

See Also:



100
101
102
103
104
105
106
107
 
# File 'lib/telnyx/resources/ai/missions.rb', line 100

def clone_mission(mission_id, params = {})
  @client.request(
    method: :post,
    path: ["ai/missions/%1$s/clone", mission_id],
    model: Telnyx::Internal::Type::Unknown,
    options: params[:request_options]
  )
end

#create(name:, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, request_options: {}) ⇒ Telnyx::Models::AI::MissionCreateResponse

Create a new mission definition

Parameters:

Returns:

See Also:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/telnyx/resources/ai/missions.rb', line 34

def create(params)
  parsed, options = Telnyx::AI::MissionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ai/missions",
    body: parsed,
    model: Telnyx::Models::AI::MissionCreateResponse,
    options: options
  )
end

#delete_mission(mission_id, request_options: {}) ⇒ nil

Delete a mission

Parameters:

Returns:

  • (nil)

See Also:



119
120
121
122
123
124
125
126
 
# File 'lib/telnyx/resources/ai/missions.rb', line 119

def delete_mission(mission_id, params = {})
  @client.request(
    method: :delete,
    path: ["ai/missions/%1$s", mission_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::MissionData>

List all missions for the organization

Parameters:

  • page_number (Integer) —

    Page number (1-based)

  • page_size (Integer) —

    Number of items per page

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

Returns:

See Also:



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/telnyx/resources/ai/missions.rb', line 77

def list(params = {})
  parsed, options = Telnyx::AI::MissionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ai/missions",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::AI::MissionData,
    options: options
  )
end

#list_events(page_number: nil, page_size: nil, type: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Missions::Runs::EventData>

List recent events across all missions

Parameters:

  • page_number (Integer) —

    Page number (1-based)

  • page_size (Integer) —

    Number of items per page

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

Returns:

See Also:



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/telnyx/resources/ai/missions.rb', line 143

def list_events(params = {})
  parsed, options = Telnyx::AI::MissionListEventsParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ai/missions/events",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::AI::Missions::Runs::EventData,
    options: options
  )
end

#retrieve(mission_id, request_options: {}) ⇒ Telnyx::Models::AI::MissionRetrieveResponse

Get a mission by ID (includes tools, knowledge_bases, mcp_servers)

Parameters:

Returns:

See Also:



55
56
57
58
59
60
61
62
 
# File 'lib/telnyx/resources/ai/missions.rb', line 55

def retrieve(mission_id, params = {})
  @client.request(
    method: :get,
    path: ["ai/missions/%1$s", mission_id],
    model: Telnyx::Models::AI::MissionRetrieveResponse,
    options: params[:request_options]
  )
end

#update_mission(mission_id, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, name: nil, request_options: {}) ⇒ Telnyx::Models::AI::MissionUpdateMissionResponse

Update a mission definition

Parameters:

Returns:

See Also:



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/telnyx/resources/ai/missions.rb', line 172

def update_mission(mission_id, params = {})
  parsed, options = Telnyx::AI::MissionUpdateMissionParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["ai/missions/%1$s", mission_id],
    body: parsed,
    model: Telnyx::Models::AI::MissionUpdateMissionResponse,
    options: options
  )
end