Class: OpenAI::Models::Responses::Response

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response.rb

Overview

See Also:

Defined Under Namespace

Modules: Instructions, ServiceTier, ToolChoice, Truncation Classes: IncompleteDetails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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, 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(id: , created_at: , error: , incomplete_details: , instructions: , metadata: , model: , output: , parallel_tool_calls: , temperature: , tool_choice: , tools: , top_p: , background: nil, max_output_tokens: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, status: nil, text: nil, truncation: nil, usage: nil, user: nil, object: :response) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::Response for more details.

Parameters:




# File 'lib/openai/models/responses/response.rb', line 240

Instance Attribute Details

#background ⇒ Boolean?

Whether to run the model response in the background. [Learn more](platform.openai.com/docs/guides/background).

Returns:



140
 
# File 'lib/openai/models/responses/response.rb', line 140

optional :background, OpenAI::Internal::Type::Boolean, nil?: true

#created_at ⇒ Float

Unix timestamp (in seconds) of when this Response was created.

Returns:

  • (Float) 


20
 
# File 'lib/openai/models/responses/response.rb', line 20

required :created_at, Float

#error ⇒ OpenAI::Models::Responses::ResponseError?

An error object returned when the model fails to generate a Response.

Returns:



26
 
# File 'lib/openai/models/responses/response.rb', line 26

required :error, -> { OpenAI::Responses::ResponseError }, nil?: true

#id ⇒ String

Unique identifier for this Response.

Returns:

  • (String) 


14
 
# File 'lib/openai/models/responses/response.rb', line 14

required :id, String

#incomplete_details ⇒ OpenAI::Models::Responses::Response::IncompleteDetails?

Details about why the response is incomplete.

Returns:



32
 
# File 'lib/openai/models/responses/response.rb', line 32

required :incomplete_details, -> { OpenAI::Responses::Response::IncompleteDetails }, nil?: true

#instructions ⇒ String, ...

A system (or developer) message inserted into the model’s context.

When using along with ‘previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

Returns:



42
 
# File 'lib/openai/models/responses/response.rb', line 42

required :instructions, union: -> { OpenAI::Responses::Response::Instructions }, nil?: true

#max_output_tokens ⇒ Integer?

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](platform.openai.com/docs/guides/reasoning).

Returns:

  • (Integer, nil) 


148
 
# File 'lib/openai/models/responses/response.rb', line 148

optional :max_output_tokens, Integer, nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

  • (Hash{Symbol=>String}, nil) 


53
 
# File 'lib/openai/models/responses/response.rb', line 53

required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#model ⇒ String, ...

Model ID used to generate the response, like ‘gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](platform.openai.com/docs/models) to browse and compare available models.

Returns:



63
 
# File 'lib/openai/models/responses/response.rb', line 63

required :model, union: -> { OpenAI::ResponsesModel }

#object ⇒ Symbol, :response

The object type of this resource - always set to ‘response`.

Returns:

  • (Symbol, :response) 


69
 
# File 'lib/openai/models/responses/response.rb', line 69

required :object, const: :response

#output ⇒ Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest>

An array of content items generated by the model.

  • The length and order of items in the ‘output` array is dependent on the model’s response.

  • Rather than accessing the first item in the ‘output` array and assuming it’s an ‘assistant` message with the content generated by the model, you might consider using the `output_text` property where supported in SDKs.

Returns:



81
 
# File 'lib/openai/models/responses/response.rb', line 81

required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }

#parallel_tool_calls ⇒ Boolean

Whether to allow the model to run tool calls in parallel.

Returns:



87
 
# File 'lib/openai/models/responses/response.rb', line 87

required :parallel_tool_calls, OpenAI::Internal::Type::Boolean

#previous_response_id ⇒ String?

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](platform.openai.com/docs/guides/conversation-state).

Returns:

  • (String, nil) 


156
 
# File 'lib/openai/models/responses/response.rb', line 156

optional :previous_response_id, String, nil?: true

#prompt ⇒ OpenAI::Models::Responses::ResponsePrompt?

Reference to a prompt template and its variables. [Learn more](platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).

Returns:



163
 
# File 'lib/openai/models/responses/response.rb', line 163

optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true

#reasoning ⇒ OpenAI::Models::Reasoning?

**o-series models only**

Configuration options for [reasoning models](platform.openai.com/docs/guides/reasoning).

Returns:



172
 
# File 'lib/openai/models/responses/response.rb', line 172

optional :reasoning, -> { OpenAI::Reasoning }, nil?: true

#service_tier ⇒ Symbol, ...

Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to ‘auto’, and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.

  • If set to ‘auto’, and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • If set to ‘default’, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • If set to ‘flex’, the request will be processed with the Flex Processing service tier. [Learn more](platform.openai.com/docs/guides/flex-processing).

  • When not set, the default behavior is ‘auto’.

When this parameter is set, the response body will include the ‘service_tier` utilized.

Returns:



194
 
# File 'lib/openai/models/responses/response.rb', line 194

optional :service_tier, enum: -> { OpenAI::Responses::Response::ServiceTier }, nil?: true

#status ⇒ Symbol, ...

The status of the response generation. One of ‘completed`, `failed`, `in_progress`, `cancelled`, `queued`, or `incomplete`.

Returns:



201
 
# File 'lib/openai/models/responses/response.rb', line 201

optional :status, enum: -> { OpenAI::Responses::ResponseStatus }

#temperature ⇒ Float?

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or ‘top_p` but not both.

Returns:

  • (Float, nil) 


96
 
# File 'lib/openai/models/responses/response.rb', line 96

required :temperature, Float, nil?: true

#text ⇒ OpenAI::Models::Responses::ResponseTextConfig?

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

Returns:



211
 
# File 'lib/openai/models/responses/response.rb', line 211

optional :text, -> { OpenAI::Responses::ResponseTextConfig }

#tool_choice ⇒ Symbol, ...

How the model should select which tool (or tools) to use when generating a response. See the ‘tools` parameter to see how to specify which tools the model can call.

Returns:



104
 
# File 'lib/openai/models/responses/response.rb', line 104

required :tool_choice, union: -> { OpenAI::Responses::Response::ToolChoice }

#tools ⇒ Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>

An array of tools the model may call while generating a response. You can specify which tool to use by setting the ‘tool_choice` parameter.

The two categories of tools you can provide the model are:

Returns:



123
 
# File 'lib/openai/models/responses/response.rb', line 123

required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }

#top_p ⇒ Float?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or ‘temperature` but not both.

Returns:

  • (Float, nil) 


133
 
# File 'lib/openai/models/responses/response.rb', line 133

required :top_p, Float, nil?: true

#truncation ⇒ Symbol, ...

The truncation strategy to use for the model response.

  • ‘auto`: If the context of this response and previous ones exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping input items in the middle of the conversation.

  • ‘disabled` (default): If a model response will exceed the context window size for a model, the request will fail with a 400 error.

Returns:



223
 
# File 'lib/openai/models/responses/response.rb', line 223

optional :truncation, enum: -> { OpenAI::Responses::Response::Truncation }, nil?: true

#usage ⇒ OpenAI::Models::Responses::ResponseUsage?

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Returns:



230
 
# File 'lib/openai/models/responses/response.rb', line 230

optional :usage, -> { OpenAI::Responses::ResponseUsage }

#user ⇒ String?

A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](platform.openai.com/docs/guides/safety-best-practices#end-user-ids).

Returns:

  • (String, nil) 


238
 
# File 'lib/openai/models/responses/response.rb', line 238

optional :user, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response.rb', line 316

.variants ⇒ Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction)

Returns:




# File 'lib/openai/models/responses/response.rb', line 372