Module: OpenAI::Models::Responses::ResponseItem

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/responses/response_item.rb

Overview

Content item used to generate a response.

Defined Under Namespace

Classes: ImageGenerationCall, LocalShellCall, LocalShellCallOutput, McpApprovalRequest, McpApprovalResponse, McpCall, McpListTools

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

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_item.rb', line 111

.variants ⇒ Array(OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall)

Returns:




# File 'lib/openai/models/responses/response_item.rb', line 544

Instance Method Details

#initialize(id: , approval_request_id: , approve: , reason: nil, type: :mcp_approval_response) ⇒ Object

Some parameter documentations has been truncated, see McpApprovalResponse for more details.

A response to an MCP approval request.

Parameters:

  • id (String) (defaults to: ) —

    The unique ID of the approval response

  • approval_request_id (String) (defaults to: ) —

    The ID of the approval request being answered.

  • approve (Boolean) (defaults to: ) —

    Whether the request was approved.

  • reason (String, nil) (defaults to: nil) —

    Optional reason for the decision.

  • type (Symbol, :mcp_approval_response) (defaults to: :mcp_approval_response) —

    The type of the item. Always ‘mcp_approval_response`.




# File 'lib/openai/models/responses/response_item.rb', line 368