Module: OpenAI::Models::Responses::ResponseIncludable

Extended by:

Internal::Type::Enum

Defined in:

lib/openai/models/responses/response_includable.rb

Overview

Specify additional output data to include in the model response. Currently supported values are:

• ‘file_search_call.results`: Include the search results of the file search tool call.

• ‘message.input_image.image_url`: Include image urls from the input message.

• ‘computer_call_output.output.image_url`: Include image urls from the computer call output.

• ‘reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).

Constant Summary

FILE_SEARCH_CALL_RESULTS =

:"file_search_call.results"

MESSAGE_INPUT_IMAGE_IMAGE_URL =

:"message.input_image.image_url"

COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL =

:"computer_call_output.output.image_url"

REASONING_ENCRYPTED_CONTENT =

:"reasoning.encrypted_content"

Class Method Summary

• .values ⇒ Array<Symbol>

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/responses/response_includable.rb', line 27