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

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai/missions/knowledge_bases.rb,
sig/telnyx/resources/ai/missions/knowledge_bases.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ KnowledgeBases

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

Parameters:



135
136
137
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 135

def initialize(client:)
  @client = client
end

Instance Method Details

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

Create a new knowledge base for a mission

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

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

Returns:

  • (Object)

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 19

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

#delete_knowledge_base(knowledge_base_id, mission_id:, request_options: {}) ⇒ nil

Detaches the specified knowledge base from the mission so its content is no longer available to agents in subsequent runs.

Parameters:

  • knowledge_base_id (String) —

    Unique identifier of the knowledge base.

  • mission_id (String) —

    Unique identifier of the mission.

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

Returns:

  • (nil)

See Also:



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 42

def delete_knowledge_base(knowledge_base_id, params)
  parsed, options = Telnyx::AI::Missions::KnowledgeBaseDeleteKnowledgeBaseParams.dump_request(params)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["ai/missions/%1$s/knowledge-bases/%2$s", mission_id, knowledge_base_id],
    model: NilClass,
    options: options
  )
end

#get_knowledge_base(knowledge_base_id, mission_id:, request_options: {}) ⇒ Object

Returns the details of a single knowledge base attached to the specified mission.

Parameters:

  • knowledge_base_id (String) —

    Unique identifier of the knowledge base.

  • mission_id (String) —

    Unique identifier of the mission.

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

Returns:

  • (Object)

See Also:



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 70

def get_knowledge_base(knowledge_base_id, params)
  parsed, options = Telnyx::AI::Missions::KnowledgeBaseGetKnowledgeBaseParams.dump_request(params)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["ai/missions/%1$s/knowledge-bases/%2$s", mission_id, knowledge_base_id],
    model: Telnyx::Internal::Type::Unknown,
    options: options
  )
end

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

Returns the knowledge bases attached to the specified mission. Knowledge bases provide reference content agents can draw on during runs.

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

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

Returns:

  • (Object)

See Also:



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

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

#update_knowledge_base(knowledge_base_id, mission_id:, request_options: {}) ⇒ Object

Replaces the definition of the specified knowledge base on this mission.

Parameters:

  • knowledge_base_id (String) —

    Unique identifier of the knowledge base.

  • mission_id (String) —

    Unique identifier of the mission.

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

Returns:

  • (Object)

See Also:



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 118

def update_knowledge_base(knowledge_base_id, params)
  parsed, options = Telnyx::AI::Missions::KnowledgeBaseUpdateKnowledgeBaseParams.dump_request(params)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["ai/missions/%1$s/knowledge-bases/%2$s", mission_id, knowledge_base_id],
    model: Telnyx::Internal::Type::Unknown,
    options: options
  )
end