Module: OpenAI::Models::Beta::BetaResponseIncludable

Extended by:
Internal::Type::Enum
Defined in:
lib/openai/models/beta/beta_response_includable.rb

Overview

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

  • web_search_call.results: Include the search results of the web search tool call.
  • web_search_call.action.sources: Include the sources of the web search tool call.
  • code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
  • computer_call_output.output.image_url: Include image urls from the computer call output.
  • 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.
  • message.output_text.logprobs: Include logprobs with assistant messages.
  • 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 collapse

FILE_SEARCH_CALL_RESULTS = 
:"file_search_call.results"
WEB_SEARCH_CALL_RESULTS = 
:"web_search_call.results"
WEB_SEARCH_CALL_ACTION_SOURCES = 
:"web_search_call.action.sources"
MESSAGE_INPUT_IMAGE_IMAGE_URL = 
:"message.input_image.image_url"
COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = 
:"computer_call_output.output.image_url"
CODE_INTERPRETER_CALL_OUTPUTS = 
:"code_interpreter_call.outputs"
REASONING_ENCRYPTED_CONTENT = 
:"reasoning.encrypted_content"
MESSAGE_OUTPUT_TEXT_LOGPROBS = 
:"message.output_text.logprobs"

Method Summary

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, 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, meta_info, new_coerce_state, type_info