Class: OpenAI::Models::Beta::Threads::Runs::StepListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::Threads::Runs::StepListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/beta/threads/runs/step_list_params.rb

Overview

See Also:

• Resources::Beta::Threads::Runs::Steps#list

Defined Under Namespace

Modules: Order

Instance Attribute Summary

• #after ⇒ String^?

  A cursor for use in pagination.

• #before ⇒ String^?

  A cursor for use in pagination.

• #include ⇒ Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>^?

  A list of additional fields to include in the response.

• #limit ⇒ Integer^?

  A limit on the number of objects to be returned.

• #order ⇒ Symbol, ...

  Sort order by the ‘created_at` timestamp of the objects.

• #thread_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(thread_id: , after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see StepListParams 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(thread_id: , after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::Threads::Runs::StepListParams for more details.

Parameters:

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

  A cursor for use in pagination. ‘after` is an object ID that defines your place

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

  A cursor for use in pagination. ‘before` is an object ID that defines your place

• include (Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>) (defaults to: nil) —

  A list of additional fields to include in the response. Currently the only suppo

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

  A limit on the number of objects to be returned. Limit can range between 1 and 1

• order (Symbol, OpenAI::Models::Beta::Threads::Runs::StepListParams::Order) (defaults to: nil) —

  Sort order by the ‘created_at` timestamp of the objects. `asc` for ascending ord

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

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 63

Instance Attribute Details

#after ⇒ String^?

A cursor for use in pagination. ‘after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Returns:

• (String, nil)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 25

optional :after, String

#before ⇒ String^?

A cursor for use in pagination. ‘before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Returns:

• (String, nil)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 34

optional :before, String

#include ⇒ Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>^?

A list of additional fields to include in the response. Currently the only supported value is ‘step_details.tool_calls[].file_search.results[].content` to fetch the file search result content.

See the [file search tool documentation](platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.

Returns:

• (Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>, nil)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 46

optional :include,
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::Threads::Runs::RunStepInclude] }

#limit ⇒ Integer^?

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Returns:

• (Integer, nil)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 54

optional :limit, Integer

#order ⇒ Symbol, ...

Sort order by the ‘created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

Returns:

• (Symbol, OpenAI::Models::Beta::Threads::Runs::StepListParams::Order, nil)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 61

optional :order, enum: -> { OpenAI::Beta::Threads::Runs::StepListParams::Order }

#thread_id ⇒ String

Returns:

• (String)

# File 'lib/openai/models/beta/threads/runs/step_list_params.rb', line 16

required :thread_id, String