Class: Mindee::V2::Search::Models::ModelSearchParameters

Inherits:
ClientOptions::BaseSearchParameters show all
Defined in:
lib/mindee/v2/search/models/model_search_parameters.rb

Overview

Search for models within the organization linked to the API key. All search filters are optional. If no search filters are given, all models belonging to the organization are returned. Results are paginated.

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

#response_class, #slug

Constructor Details

#initialize(name: nil, model_type: nil, page: nil, per_page: nil) ⇒ ModelSearchParameters

Returns a new instance of ModelSearchParameters.

Parameters:

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

    Filter models by partial name match, case-insensitive.

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

    Filter by an exact model type.

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

    1-based page index.

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

    Number of items per page.



22
23
24
25
26
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 22

def initialize(name: nil, model_type: nil, page: nil, per_page: nil)
  super(page: page, per_page: per_page)
  @name = name
  @model_type = model_type
end

Instance Attribute Details

#model_type ⇒ String? (readonly)

Returns Filter by an exact model type.

Returns:

  • (String, nil) —

    Filter by an exact model type.



16
17
18
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 16

def model_type
  @model_type
end

#name ⇒ String? (readonly)

Returns Filter models by partial name match, case-insensitive.

Returns:

  • (String, nil) —

    Filter models by partial name match, case-insensitive.



13
14
15
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 13

def name
  @name
end

Class Method Details

.response_class ⇒ Class<Mindee::V2::Search::Models::ModelSearchResponse>

Returns Response class for the search.

Returns:



34
35
36
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 34

def self.response_class
  ModelSearchResponse
end

.slug ⇒ String

Returns Slug of searchable resources.

Returns:

  • (String) —

    Slug of searchable resources.



29
30
31
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 29

def self.slug
  'models'
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>}) 


40
41
42
43
44
45
46
47
48
49
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 40

def request_parameters
  params = super

  name = @name
  model_type = @model_type
  params['name'] = name unless name.nil?
  params['model_type'] = model_type unless model_type.nil?

  params
end