Class: Mindee::V2::Search::RAGDocuments::RAGDocumentSearchParameters

Inherits:
ClientOptions::BaseSearchParameters show all
Defined in:
lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb,
sig/mindee/v2/search/rag_documents/rag_document_search_parameters.rbs

Overview

Search parameters for RAG Documents.

Instance Attribute Summary collapse

Attributes inherited from ClientOptions::BaseSearchParameters

#page, #per_page

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ClientOptions::BaseSearchParameters

#slug

Constructor Details

#initialize(model_id:, filename: nil, page: nil, per_page: nil) ⇒ RAGDocumentSearchParameters

Returns a new instance of RAGDocumentSearchParameters.

Parameters:

  • model_id (String) —

    Model identifier to search in.

  • filename (String, nil) (defaults to: nil) —

    Case-insensitive substring search on filename.

  • page (Integer, nil) (defaults to: nil) —

    1-based page index.

  • per_page (Integer, nil) (defaults to: nil) —

    Number of items per page.

  • model_id: (String)
  • filename: (String, nil) (defaults to: nil)
  • page: (Integer, nil) (defaults to: nil)
  • per_page: (Integer, nil) (defaults to: nil)

Raises:



19
20
21
22
23
24
25
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 19

def initialize(model_id:, filename: nil, page: nil, per_page: nil)
  super(page: page, per_page: per_page)
  raise Error::MindeeInputError, 'Model ID is required.' if model_id.nil? || model_id.empty?

  @model_id = model_id
  @filename = filename
end

Instance Attribute Details

#filename ⇒ String? (readonly)

Returns Case-insensitive substring search on filename.

Returns:

  • (String, nil) —

    Case-insensitive substring search on filename.



13
14
15
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 13

def filename
  @filename
end

#model_id ⇒ String (readonly)

Returns Model identifier to search in.

Returns:

  • (String) —

    Model identifier to search in.



10
11
12
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 10

def model_id
  @model_id
end

Class Method Details

.response_class ⇒ Class<Mindee::V2::Search::RAGDocuments::RAGDocumentSearchResponse>

Returns Response class for the search.

Returns:



33
34
35
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 33

def self.response_class
  RAGDocumentSearchResponse
end

.slug ⇒ String

Returns Slug of searchable resources.

Returns:

  • (String) —

    Slug of searchable resources.



28
29
30
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 28

def self.slug
  'rag-documents'
end

Instance Method Details

#request_parameters ⇒ Hash{String => String, Array<String>}

Gets the request parameters for the search request.

Returns:

  • (Hash{String => String, Array<String>}) 


39
40
41
42
43
44
45
46
47
 
# File 'lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb', line 39

def request_parameters
  params = super

  params['model_id'] = @model_id
  filename = @filename
  params['filename'] = filename unless filename.nil?

  params
end

#response_class ⇒ singleton(RAGDocumentSearchResponse)

Returns:



15
 
# File 'sig/mindee/v2/search/rag_documents/rag_document_search_parameters.rbs', line 15

def response_class: -> singleton(RAGDocumentSearchResponse)