Class: Zavudev::Resources::Senders::Agent::KnowledgeBases

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/senders/agent/knowledge_bases.rb,
lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb

Defined Under Namespace

Classes: Documents

Instance Attribute Summary collapse

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:



144
145
146
147
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 144

def initialize(client:)
  @client = client
  @documents = Zavudev::Resources::Senders::Agent::KnowledgeBases::Documents.new(client: client)
end

Instance Attribute Details

#documents ⇒ Zavudev::Resources::Senders::Agent::KnowledgeBases::Documents (readonly)

Returns:



9
10
11
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 9

def documents
  @documents
end

Instance Method Details

#create(sender_id, name:, description: nil, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBaseCreateResponse

Create a new knowledge base for an agent.

Parameters:

  • sender_id (String)
  • name (String)
  • description (String)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 23

def create(sender_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBaseCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/senders/%1$s/agent/knowledge-bases", sender_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::KnowledgeBaseCreateResponse,
    options: options
  )
end

#delete(kb_id, sender_id:, request_options: {}) ⇒ nil

Delete a knowledge base and all its documents.

Parameters:

Returns:

  • (nil)

See Also:



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 127

def delete(kb_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBaseDeleteParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/senders/%1$s/agent/knowledge-bases/%2$s", sender_id, kb_id],
    model: NilClass,
    options: options
  )
end

#list(sender_id, cursor: nil, limit: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::Senders::Agent::AgentKnowledgeBase>

List knowledge bases for an agent.

Parameters:

  • sender_id (String)
  • cursor (String)
  • limit (Integer)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 103

def list(sender_id, params = {})
  parsed, options = Zavudev::Senders::Agent::KnowledgeBaseListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/senders/%1$s/agent/knowledge-bases", sender_id],
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::Senders::Agent::AgentKnowledgeBase,
    options: options
  )
end

#retrieve(kb_id, sender_id:, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBaseRetrieveResponse

Get a specific knowledge base.

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 45

def retrieve(kb_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBaseRetrieveParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/senders/%1$s/agent/knowledge-bases/%2$s", sender_id, kb_id],
    model: Zavudev::Models::Senders::Agent::KnowledgeBaseRetrieveResponse,
    options: options
  )
end

#update(kb_id, sender_id:, description: nil, name: nil, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBaseUpdateResponse

Update a knowledge base.

Parameters:

  • kb_id (String) —

    Path param

  • sender_id (String) —

    Path param

  • description (String, nil) —

    Body param

  • name (String) —

    Body param

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

Returns:

See Also:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases.rb', line 76

def update(kb_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBaseUpdateParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["v1/senders/%1$s/agent/knowledge-bases/%2$s", sender_id, kb_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::KnowledgeBaseUpdateResponse,
    options: options
  )
end