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

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

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:



124
125
126
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 124

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:

Returns:

  • (Object)

See Also:



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

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

Delete a knowledge base from a mission

Parameters:

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

Returns:

  • (nil)

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 38

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

Get a specific knowledge base by ID

Parameters:

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

Returns:

  • (Object)

See Also:



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

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

List all knowledge bases for a mission

Parameters:

Returns:

  • (Object)

See Also:



87
88
89
90
91
92
93
94
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 87

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

Update a knowledge base definition

Parameters:

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

Returns:

  • (Object)

See Also:



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/telnyx/resources/ai/missions/knowledge_bases.rb', line 107

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