Class: OpenAI::Models::Evals::RunListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Evals::RunListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/evals/run_list_params.rb,
sig/openai/models/evals/run_list_params.rbs

Overview

See Also:

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

Defined Under Namespace

Modules: Order, Status

Instance Attribute Summary

• #after ⇒ String^?

  Identifier for the last run from the previous pagination request.

• #eval_id ⇒ String
• #limit ⇒ Integer^?

  Number of runs to retrieve.

• #order ⇒ OpenAI::Models::Evals::RunListParams::order^?

  Sort order for runs by timestamp.

• #status ⇒ OpenAI::Models::Evals::RunListParams::status^?

  Filter runs by status.

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(eval_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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:, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• after (defaults to: nil) —

  Identifier for the last run from the previous pagination request.

• limit (defaults to: nil) —

  Number of runs to retrieve.

• order (defaults to: nil) —

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

• status (defaults to: nil) —

  Filter runs by status. One of queued | in_progress | failed | completed | canceled.

# File 'lib/openai/models/evals/run_list_params.rb', line 42

Instance Attribute Details

#after ⇒ String^?

Identifier for the last run from the previous pagination request.

Returns:

• (String, nil)

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

optional :after, String

#eval_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/evals/run_list_params.rb', line 14

required :eval_id, String

#limit ⇒ Integer^?

Number of runs to retrieve.

Returns:

• (Integer, nil)

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

optional :limit, Integer

#order ⇒ OpenAI::Models::Evals::RunListParams::order^?

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

Returns:

• (OpenAI::Models::Evals::RunListParams::order, nil)

# File 'lib/openai/models/evals/run_list_params.rb', line 33

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

#status ⇒ OpenAI::Models::Evals::RunListParams::status^?

Filter runs by status. One of queued | in_progress | failed | completed | canceled.

Returns:

• (OpenAI::Models::Evals::RunListParams::status, nil)

# File 'lib/openai/models/evals/run_list_params.rb', line 40

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/evals/run_list_params.rb', line 69

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/evals/run_list_params.rbs', line 71

def to_hash: -> {