Class: Cerca::Models::ContextSearchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cerca/models/context_search_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(agent_id:, q:, cursor: nil, limit: nil, prefix: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cerca::Models::ContextSearchParams for more details.

Parameters:

  • agent_id (String)
  • q (String) —

    Search query.

  • cursor (String) (defaults to: nil) —

    Opaque pagination cursor returned by a previous request.

  • limit (String) (defaults to: nil) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

  • prefix (String) (defaults to: nil) —

    Optional key prefix filter.

  • request_options (Cerca::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/cerca/models/context_search_params.rb', line 40

Instance Attribute Details

#agent_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/cerca/models/context_search_params.rb', line 13

required :agent_id, String

#cursor ⇒ String?

Opaque pagination cursor returned by a previous request.

Returns:

  • (String, nil) 


25
 
# File 'lib/cerca/models/context_search_params.rb', line 25

optional :cursor, String

#limit ⇒ String?

Maximum number of items to return. Defaults to 20 and preserves parseInt semantics.

Returns:

  • (String, nil) 


32
 
# File 'lib/cerca/models/context_search_params.rb', line 32

optional :limit, String

#prefix ⇒ String?

Optional key prefix filter.

Returns:

  • (String, nil) 


38
 
# File 'lib/cerca/models/context_search_params.rb', line 38

optional :prefix, String

#q ⇒ String

Search query.

Returns:

  • (String) 


19
 
# File 'lib/cerca/models/context_search_params.rb', line 19

required :q, String