Class: OpenAI::Models::Beta::BetaResponseItem::McpCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_item.rb

Defined Under Namespace

Modules: Status Classes: Agent

Instance Attribute 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, meta_info, 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(agent_name:) ⇒ Object

The agent that produced this item.

Parameters:

  • agent_name (String) —

    The canonical name of the agent that produced this item.




# File 'lib/openai/models/beta/beta_response_item.rb', line 1373

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseItem::McpCall::Agent?

The agent that produced this item.

Returns:



1344
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1344

optional :agent, -> { OpenAI::Beta::BetaResponseItem::McpCall::Agent }, nil?: true

#approval_request_id ⇒ String?

Unique identifier for the MCP tool call approval request. Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.

Returns:

  • (String, nil) 


1352
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1352

optional :approval_request_id, String, nil?: true

#arguments ⇒ String

A JSON string of the arguments passed to the tool.

Returns:

  • (String) 


1320
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1320

required :arguments, String

#error ⇒ String?

The error from the tool call, if any.

Returns:

  • (String, nil) 


1358
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1358

optional :error, String, nil?: true

#id ⇒ String

The unique ID of the tool call.

Returns:

  • (String) 


1314
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1314

required :id, String

#name ⇒ String

The name of the tool that was run.

Returns:

  • (String) 


1326
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1326

required :name, String

#output ⇒ String?

The output from the tool call.

Returns:

  • (String, nil) 


1364
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1364

optional :output, String, nil?: true

#server_label ⇒ String

The label of the MCP server running the tool.

Returns:

  • (String) 


1332
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1332

required :server_label, String

#status ⇒ Symbol, ...

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

Returns:



1371
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1371

optional :status, enum: -> { OpenAI::Beta::BetaResponseItem::McpCall::Status }

#type ⇒ Symbol, :mcp_call

The type of the item. Always mcp_call.

Returns:

  • (Symbol, :mcp_call) 


1338
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 1338

required :type, const: :mcp_call