Class: OpenAI::Models::Evals::Runs::OutputItemListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/evals/runs/output_item_list_params.rb,
sig/openai/models/evals/runs/output_item_list_params.rbs

Overview

See Also:

  • OpenAI::Resources::Evals::Runs::OutputItems#list

Defined Under Namespace

Modules: Order, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

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

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(eval_id:, run_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

  • after (defaults to: nil) —

    Identifier for the last output item from the previous pagination request.

  • limit (defaults to: nil) —

    Number of output items to retrieve.

  • order (defaults to: nil) —

    Sort order for output items by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc.

  • status (defaults to: nil) —

    Filter output items by status. Use failed to filter by failed output items or pass to filter by passed output items.



# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 48

Instance Attribute Details

#after ⇒ String?

Identifier for the last output item from the previous pagination request.

Returns:

  • (String, nil)


26
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 26

optional :after, String

#eval_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String)


15
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 15

required :eval_id, String

#limit ⇒ Integer?

Number of output items to retrieve.

Returns:

  • (Integer, nil)


32
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 32

optional :limit, Integer

#order ⇒ OpenAI::Models::Evals::Runs::OutputItemListParams::order?

Sort order for output items by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc.

Returns:

  • (OpenAI::Models::Evals::Runs::OutputItemListParams::order, nil)


39
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 39

optional :order, enum: -> { OpenAI::Evals::Runs::OutputItemListParams::Order }

#run_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String)


20
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 20

required :run_id, String

#status ⇒ OpenAI::Models::Evals::Runs::OutputItemListParams::status?

Filter output items by status. Use failed to filter by failed output items or pass to filter by passed output items.

Returns:

  • (OpenAI::Models::Evals::Runs::OutputItemListParams::status, nil)


46
# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 46

optional :status, enum: -> { OpenAI::Evals::Runs::OutputItemListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/openai/models/evals/runs/output_item_list_params.rb', line 77

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({)


76
# File 'sig/openai/models/evals/runs/output_item_list_params.rbs', line 76

def to_hash: -> {