Class: OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

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

Instance Attribute Summary

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

  A list of additional fields to include in the response.

• #run_id ⇒ String
• #thread_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(thread_id: , run_id: , include: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see StepRetrieveParams 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: , run_id: , include: nil, request_options: {}) ⇒ Object

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

Parameters:

• thread_id (String) (defaults to: )
• run_id (String) (defaults to: )
• 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

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

# File 'lib/openai/models/beta/threads/runs/step_retrieve_params.rb', line 36

Instance Attribute Details

#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_retrieve_params.rb', line 33

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

#run_id ⇒ String

Returns:

• (String)

# File 'lib/openai/models/beta/threads/runs/step_retrieve_params.rb', line 21

required :run_id, String

#thread_id ⇒ String

Returns:

• (String)

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

required :thread_id, String