openai 0.89.0 → 0.90.0

data/lib/openai/models/beta/agent_session_turn_cancelled_event.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnCancelledEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn
+        #   The cancelled turn.
+        #
+        #   @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.cancelled`.
+        #
+        #   @return [Symbol, :"agent.session.turn.cancelled"]
+        required :type, const: :"agent.session.turn.cancelled"
+
+        # @!attribute usage
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage, nil]
+        required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
+
+        # @!method initialize(event_id:, session_id:, turn:, turn_id:, usage:, type: :"agent.session.turn.cancelled")
+        #   Emitted when a turn is cancelled.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        #     The cancelled turn.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn associated with the event.
+        #
+        #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
+        #     Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param type [Symbol, :"agent.session.turn.cancelled"]
+        #     The type of the object. Always `agent.session.turn.cancelled`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_completed_event.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn
+        #   The completed turn.
+        #
+        #   @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.completed`.
+        #
+        #   @return [Symbol, :"agent.session.turn.completed"]
+        required :type, const: :"agent.session.turn.completed"
+
+        # @!attribute usage
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage, nil]
+        required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
+
+        # @!method initialize(event_id:, session_id:, turn:, turn_id:, usage:, type: :"agent.session.turn.completed")
+        #   Emitted when a turn completes.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        #     The completed turn.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn associated with the event.
+        #
+        #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
+        #     Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param type [Symbol, :"agent.session.turn.completed"]
+        #     The type of the object. Always `agent.session.turn.completed`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_content_part_added_event.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnContentPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part in the message.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the message item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The initial content part.
+        #
+        #   @return [OpenAI::Models::Beta::OutputText]
+        required :part, -> { OpenAI::Beta::OutputText }
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.content_part.added`.
+        #
+        #   @return [Symbol, :"agent.session.turn.content_part.added"]
+        required :type, const: :"agent.session.turn.content_part.added"
+
+        # @!method initialize(content_index:, event_id:, item_id:, output_index:, part:, session_id:, turn_id:, type: :"agent.session.turn.content_part.added")
+        #   Emitted when an output text content part is added.
+        #
+        #   @param content_index [Integer]
+        #     The index of the content part in the message.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the message item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param part [OpenAI::Models::Beta::OutputText]
+        #     The initial content part.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.content_part.added"]
+        #     The type of the object. Always `agent.session.turn.content_part.added`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_content_part_done_event.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part in the message.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the message item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The completed content part.
+        #
+        #   @return [OpenAI::Models::Beta::OutputText]
+        required :part, -> { OpenAI::Beta::OutputText }
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.content_part.done`.
+        #
+        #   @return [Symbol, :"agent.session.turn.content_part.done"]
+        required :type, const: :"agent.session.turn.content_part.done"
+
+        # @!method initialize(content_index:, event_id:, item_id:, output_index:, part:, session_id:, turn_id:, type: :"agent.session.turn.content_part.done")
+        #   Emitted when an output content part is complete.
+        #
+        #   @param content_index [Integer]
+        #     The index of the content part in the message.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the message item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param part [OpenAI::Models::Beta::OutputText]
+        #     The completed content part.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.content_part.done"]
+        #     The type of the object. Always `agent.session.turn.content_part.done`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_created_event.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn
+        #   The turn at the time it was created.
+        #
+        #   @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.created`.
+        #
+        #   @return [Symbol, :"agent.session.turn.created"]
+        required :type, const: :"agent.session.turn.created"
+
+        # @!method initialize(event_id:, session_id:, turn:, turn_id:, type: :"agent.session.turn.created")
+        #   Emitted when a turn is created.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        #     The turn at the time it was created.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn associated with the event.
+        #
+        #   @param type [Symbol, :"agent.session.turn.created"]
+        #     The type of the object. Always `agent.session.turn.created`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_failed_event.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn
+        #   The failed turn.
+        #
+        #   @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.failed`.
+        #
+        #   @return [Symbol, :"agent.session.turn.failed"]
+        required :type, const: :"agent.session.turn.failed"
+
+        # @!attribute usage
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage, nil]
+        required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
+
+        # @!method initialize(event_id:, session_id:, turn:, turn_id:, usage:, type: :"agent.session.turn.failed")
+        #   Emitted when a turn fails.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        #     The failed turn.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn associated with the event.
+        #
+        #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
+        #     Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param type [Symbol, :"agent.session.turn.failed"]
+        #     The type of the object. Always `agent.session.turn.failed`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_in_progress_event.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn
+        #   The turn at the time it started running.
+        #
+        #   @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.in_progress`.
+        #
+        #   @return [Symbol, :"agent.session.turn.in_progress"]
+        required :type, const: :"agent.session.turn.in_progress"
+
+        # @!method initialize(event_id:, session_id:, turn:, turn_id:, type: :"agent.session.turn.in_progress")
+        #   Emitted when a turn starts running.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn [OpenAI::Models::Beta::Agents::Sessions::Turn]
+        #     The turn at the time it started running.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn associated with the event.
+        #
+        #   @param type [Symbol, :"agent.session.turn.in_progress"]
+        #     The type of the object. Always `agent.session.turn.in_progress`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_item_added_event.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item
+        #   The item that was added.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem]
+        required :item, union: -> { OpenAI::Beta::AgentSessionItem }
+
+        # @!attribute output_index
+        #   The index of the item in the turn output, when the item is agent output.
+        #
+        #   @return [Integer, nil]
+        required :output_index, Integer, nil?: true
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.item.added`.
+        #
+        #   @return [Symbol, :"agent.session.turn.item.added"]
+        required :type, const: :"agent.session.turn.item.added"
+
+        # @!method initialize(event_id:, item:, output_index:, session_id:, turn_id:, type: :"agent.session.turn.item.added")
+        #   Emitted when an item is added to a turn.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item [OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem]
+        #     The item that was added.
+        #
+        #   @param output_index [Integer, nil]
+        #     The index of the item in the turn output, when the item is agent output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.item.added"]
+        #     The type of the object. Always `agent.session.turn.item.added`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_session_turn_item_done_event.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item
+        #   The completed output item.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSessionAssistantMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem]
+        required :item, union: -> { OpenAI::Beta::AgentOutputItem }
+
+        # @!attribute output_index
+        #   The index of the output item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.item.done`.
+        #
+        #   @return [Symbol, :"agent.session.turn.item.done"]
+        required :type, const: :"agent.session.turn.item.done"
+
+        # @!method initialize(event_id:, item:, output_index:, session_id:, turn_id:, type: :"agent.session.turn.item.done")
+        #   Emitted when an output item is complete.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item [OpenAI::Models::Beta::AgentSessionAssistantMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem]
+        #     The completed output item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the output item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.item.done"]
+        #     The type of the object. Always `agent.session.turn.item.done`.
+      end
+    end
+  end
+end