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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Evals::Runs::OutputItemListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/evals/runs/output_item_list_params.rb

Overview

See Also:

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

Defined Under Namespace

Modules: Order, Status

Instance Attribute Summary

• #after ⇒ String^?

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

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

  Number of output items to retrieve.

• #order ⇒ Symbol, ...

  Sort order for output items by timestamp.

• #status ⇒ Symbol, ...

  Filter output items by status.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  Some parameter documentations has been truncated, see OutputItemListParams for more details.

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, 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

Some parameter documentations has been truncated, see OpenAI::Models::Evals::Runs::OutputItemListParams for more details.

Parameters:

• eval_id (String) (defaults to: )
• after (String) (defaults to: nil) —

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

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

  Number of output items to retrieve.

• order (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Order) (defaults to: nil) —

  Sort order for output items by timestamp. Use ‘asc` for ascending order or `desc

• status (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Status) (defaults to: nil) —

  Filter output items by status. Use ‘failed` to filter by failed output

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

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

Instance Attribute Details

#after ⇒ String^?

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

Returns:

• (String, nil)

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

optional :after, String

#eval_id ⇒ String

Returns:

• (String)

# 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)

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

optional :limit, Integer

#order ⇒ Symbol, ...

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

Returns:

• (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Order, nil)

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

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

#status ⇒ Symbol, ...

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

Returns:

• (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Status, nil)

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

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 67