Class: Cadenya::Models::ModelListParams

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

Overview

Defined Under Namespace

Modules: Status

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(workspace_id:, ai_provider_key_id: nil, bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::ModelListParams for more details.

Parameters:

  • workspace_id (String)
  • ai_provider_key_id (String) (defaults to: nil)

    Filter to models provisioned on a specific AI provider key. Accepts the

  • bundle_key (String) (defaults to: nil)

    Filter by bundle_key — return only resources owned by this bundle.

  • cursor (String) (defaults to: nil)

    Pagination cursor from previous response

  • include_info (Boolean) (defaults to: nil)

    When true, populate each item’s info (e.g. the AI provider), at the cost of

  • limit (Integer) (defaults to: nil)

    Maximum number of results to return

  • prefix (String) (defaults to: nil)

    Filter by name prefix

  • query (String) (defaults to: nil)

    Free-form search query

  • sort_order (String) (defaults to: nil)

    Sort order for results (asc or desc by creation time)

  • status (Symbol, Cadenya::Models::ModelListParams::Status) (defaults to: nil)

    Filter by model status

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


# File 'lib/cadenya/models/model_list_params.rb', line 71

Instance Attribute Details

#ai_provider_key_idString?

Filter to models provisioned on a specific AI provider key. Accepts the key’s id or an “external_id:”-prefixed slug.

Returns:

  • (String, nil)


20
# File 'lib/cadenya/models/model_list_params.rb', line 20

optional :ai_provider_key_id, String

#bundle_keyString?

Filter by bundle_key — return only resources owned by this bundle.

Returns:

  • (String, nil)


26
# File 'lib/cadenya/models/model_list_params.rb', line 26

optional :bundle_key, String

#cursorString?

Pagination cursor from previous response

Returns:

  • (String, nil)


32
# File 'lib/cadenya/models/model_list_params.rb', line 32

optional :cursor, String

#include_infoBoolean?

When true, populate each item’s info (e.g. the AI provider), at the cost of extra lookups.

Returns:

  • (Boolean, nil)


39
# File 'lib/cadenya/models/model_list_params.rb', line 39

optional :include_info, Cadenya::Internal::Type::Boolean

#limitInteger?

Maximum number of results to return

Returns:

  • (Integer, nil)


45
# File 'lib/cadenya/models/model_list_params.rb', line 45

optional :limit, Integer

#prefixString?

Filter by name prefix

Returns:

  • (String, nil)


51
# File 'lib/cadenya/models/model_list_params.rb', line 51

optional :prefix, String

#queryString?

Free-form search query

Returns:

  • (String, nil)


57
# File 'lib/cadenya/models/model_list_params.rb', line 57

optional :query, String

#sort_orderString?

Sort order for results (asc or desc by creation time)

Returns:

  • (String, nil)


63
# File 'lib/cadenya/models/model_list_params.rb', line 63

optional :sort_order, String

#statusSymbol, ...

Filter by model status



69
# File 'lib/cadenya/models/model_list_params.rb', line 69

optional :status, enum: -> { Cadenya::ModelListParams::Status }

#workspace_idString

Returns:

  • (String)


13
# File 'lib/cadenya/models/model_list_params.rb', line 13

required :workspace_id, String