Module: OpenAI::Models::Responses::ResponseOutputItem

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/responses/response_output_item.rb

Overview

An output message from the model.

Defined Under Namespace

Classes: ImageGenerationCall, LocalShellCall, McpApprovalRequest, McpCall, McpListTools

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ 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)

Instance Method Summary

• #initialize(input_schema: , name: , annotations: nil, description: nil) ⇒ Object

  Some parameter documentations has been truncated, see McpListTools::Tool for more details.

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_output_item.rb', line 106

.variants ⇒ 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)

Returns:

• (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))

# File 'lib/openai/models/responses/response_output_item.rb', line 437

Instance Method Details

#initialize(input_schema: , name: , annotations: nil, description: nil) ⇒ Object

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

A tool available on an MCP server.

Parameters:

• input_schema (Object) (defaults to: ) —

  The JSON schema describing the tool’s input.

• name (String) (defaults to: ) —

  The name of the tool.

• annotations (Object, nil) (defaults to: nil) —

  Additional annotations about the tool.

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

  The description of the tool.

# File 'lib/openai/models/responses/response_output_item.rb', line 275