Class: OpenAI::Models::Live::ResponseItemCreateEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Live::ResponseItemCreateEvent

Defined in:

lib/openai/models/live/response_item_create_event.rb,
sig/openai/models/live/response_item_create_event.rbs

Instance Attribute Summary

• #event_id ⇒ String^?

  Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.

• #item ⇒ OpenAI::Models::Responses::EasyInputMessage, ...

  An input item to append to the Responses backend conversation, such as a user message or a function tool result.

• #type ⇒ Symbol, :"response.item.create"

  The Live client event type.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(item:, event_id: nil, type: :"response.item.create") ⇒ Object constructor

  Add an input item to the Live session’s Responses backend.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(item:, event_id: nil, type: :"response.item.create") ⇒ Object

Add an input item to the Live session’s Responses backend. Requires Responses delegation; use response.create to request a response.

Parameters:

• item (OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput) —

  An input item to append to the Responses backend conversation, such as a user message or a function tool result.

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

  Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.

• type (Symbol, :"response.item.create") (defaults to: :"response.item.create") —

  The Live client event type. Always response.item.create.

# File 'lib/openai/models/live/response_item_create_event.rb', line 27

Instance Attribute Details

#event_id ⇒ String^?

Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/live/response_item_create_event.rb', line 25

optional :event_id, String, nil?: true

#item ⇒ OpenAI::Models::Responses::EasyInputMessage, ...

An input item to append to the Responses backend conversation, such as a user message or a function tool result.

Parameters:

• value (OpenAI::Models::Responses::response_input_item)

Returns:

• (OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput)

# File 'lib/openai/models/live/response_item_create_event.rb', line 12

required :item, union: -> { OpenAI::Responses::ResponseInputItem }

#type ⇒ Symbol, :"response.item.create"

The Live client event type. Always response.item.create.

Parameters:

• value (:"response.item.create")

Returns:

• (Symbol, :"response.item.create")

# File 'lib/openai/models/live/response_item_create_event.rb', line 18

required :type, const: :"response.item.create"

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/live/response_item_create_event.rbs', line 24

def to_hash: -> {