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

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Documents

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

Parameters:



180
181
182
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 180

def initialize(client:)
  @client = client
end

Instance Method Details

#create(kb_id, sender_id:, content:, title:, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBases::DocumentCreateResponse

Add a document to a knowledge base. The document will be automatically processed for RAG.

Parameters:

  • kb_id (String) —

    Path param

  • sender_id (String) —

    Path param

  • content (String) —

    Body param

  • title (String) —

    Body param

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 27

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

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

Delete a document from a knowledge base.

Parameters:

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

Returns:

  • (nil)

See Also:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 88

def delete(doc_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBases::DocumentDeleteParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  kb_id =
    parsed.delete(:kb_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/documents/%3$s", sender_id, kb_id, doc_id],
    model: NilClass,
    options: options
  )
end

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

List documents in a knowledge base.

Parameters:

  • kb_id (String) —

    Path param

  • sender_id (String) —

    Path param

  • cursor (String) —

    Query param

  • limit (Integer) —

    Query param

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

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 59

def list(kb_id, params)
  parsed, options = Zavudev::Senders::Agent::KnowledgeBases::DocumentListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  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/documents", sender_id, kb_id],
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::Senders::Agent::AgentDocument,
    options: options
  )
end

#retrieve_document(doc_id, sender_id:, kb_id:, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBases::DocumentRetrieveDocumentResponse

Get a single document from a knowledge base.

Parameters:

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

Returns:

See Also:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 118

def retrieve_document(doc_id, params)
  parsed, options =
    Zavudev::Senders::Agent::KnowledgeBases::DocumentRetrieveDocumentParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  kb_id =
    parsed.delete(:kb_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/documents/%3$s", sender_id, kb_id, doc_id],
    model: Zavudev::Models::Senders::Agent::KnowledgeBases::DocumentRetrieveDocumentResponse,
    options: options
  )
end

#update_document(doc_id, sender_id:, kb_id:, content: nil, title: nil, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::KnowledgeBases::DocumentUpdateDocumentResponse

Update a document's title or content. Updating content reprocesses the document for RAG.

Parameters:

  • doc_id (String) —

    Path param

  • sender_id (String) —

    Path param

  • kb_id (String) —

    Path param

  • content (String) —

    Body param

  • title (String) —

    Body param

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

Returns:

See Also:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zavudev/resources/senders/agent/knowledge_bases/documents.rb', line 157

def update_document(doc_id, params)
  parsed, options =
    Zavudev::Senders::Agent::KnowledgeBases::DocumentUpdateDocumentParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  kb_id =
    parsed.delete(:kb_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/documents/%3$s", sender_id, kb_id, doc_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::KnowledgeBases::DocumentUpdateDocumentResponse,
    options: options
  )
end