openai 0.88.0 → 0.90.0

data/rbi/openai/resources/beta/agents/sessions/events.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Events
+
+            # Submits message, cancellation, or tool-result events to a managed agent session.
+            # See
+            # [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
+            sig {
+              params(
+                session_id: String,
+                events: T::Array[
+                  T.any(
+                    OpenAI::Beta::AgentSessionInputParam::AgentSessionInputMessage::OrHash,
+                    OpenAI::Beta::AgentSessionInputParam::AgentSessionInputCancel::OrHash,
+                    OpenAI::Beta::AgentSessionInputParam::AgentSessionInputToolResult::OrHash
+                  )
+                ],
+                idempotency_key: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .void
+            }
+            def create(
+              # Path param: The ID of the session.
+              session_id,
+              # Body param: The input events to submit to the session.
+              events:,
+              # Header param: An optional client-generated key that makes retries of submitted
+              # messages idempotent.
+              idempotency_key: nil,
+              request_options: {}
+            )
+            end
+
+            # Streams live events for an agent session. See
+            # [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
+            sig {
+              params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Internal::Stream[OpenAI::Beta::AgentSessionEvent::Variants]
+              )
+            }
+            def stream_streaming(
+              # The ID of the session.
+              session_id,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/items.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Items
+
+            # Lists items produced by the session's root agent, including its interactions
+            # with subagents. Each subagent has its own item history. See
+            # [inspecting agent output](https://developers.openai.com/api/docs/guides/agents-api/observability).
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::ItemListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSessionItem::Variants])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/subagents/items.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Subagents
+
+            class Items
+
+              # Lists this subagent's own items across all of its turns. See
+              # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+              sig {
+                params(
+                  subagent_id: String,
+                  session_id: String,
+                  after: String,
+                  limit: Integer,
+                  order: OpenAI::Beta::Agents::Sessions::Subagents::ItemListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions::OrHash
+                )
+                  .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSessionItem::Variants])
+              }
+              def list(
+                # Path param: The ID of the subagent in this session.
+                subagent_id,
+                # Path param: The ID of the session.
+                session_id:,
+                # Query param: Return resources after this resource ID in the selected order.
+                after: nil,
+                # Query param: The maximum number of resources to return, between 1 and 100.
+                # Defaults to 20.
+                limit: nil,
+                # Query param: The order in which resources are returned. Defaults to `desc`.
+                order: nil,
+                request_options: {}
+              )
+              end
+
+              # @api private
+              sig { params(client: OpenAI::Client).returns(T.attached_class) }
+              def self.new(client:)
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/subagents/turns/items.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Subagents
+
+            class Turns
+
+              class Items
+
+                # Lists items belonging to one turn of this subagent. See
+                # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+                sig {
+                  params(
+                    turn_id: String,
+                    session_id: String,
+                    subagent_id: String,
+                    after: String,
+                    limit: Integer,
+                    order: OpenAI::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order::OrSymbol,
+                    request_options: OpenAI::RequestOptions::OrHash
+                  )
+                    .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSessionItem::Variants])
+                }
+                def list(
+                  # Path param: The ID of a turn belonging to this subagent.
+                  turn_id,
+                  # Path param: The ID of the session.
+                  session_id:,
+                  # Path param: The ID of the subagent in this session.
+                  subagent_id:,
+                  # Query param: Return resources after this resource ID in the selected order.
+                  after: nil,
+                  # Query param: The maximum number of resources to return, between 1 and 100.
+                  # Defaults to 20.
+                  limit: nil,
+                  # Query param: The order in which resources are returned. Defaults to `desc`.
+                  order: nil,
+                  request_options: {}
+                )
+                end
+
+                # @api private
+                sig { params(client: OpenAI::Client).returns(T.attached_class) }
+                def self.new(client:)
+                end
+              end
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/subagents/turns.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Subagents
+
+            class Turns
+
+              sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns::Items) }
+              attr_reader :items
+
+              # Retrieves a turn belonging to this subagent. See
+              # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+              sig {
+                params(
+                  turn_id: String,
+                  session_id: String,
+                  subagent_id: String,
+                  request_options: OpenAI::RequestOptions::OrHash
+                )
+                  .returns(OpenAI::Beta::Agents::Sessions::Turn)
+              }
+              def retrieve(
+                # The ID of a turn belonging to this subagent.
+                turn_id,
+                # The ID of the session.
+                session_id:,
+                # The ID of the subagent in this session.
+                subagent_id:,
+                request_options: {}
+              )
+              end
+
+              # Lists all turns of this subagent, including turns after a resume. See
+              # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+              sig {
+                params(
+                  subagent_id: String,
+                  session_id: String,
+                  after: String,
+                  limit: Integer,
+                  order: OpenAI::Beta::Agents::Sessions::Subagents::TurnListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions::OrHash
+                )
+                  .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::Turn])
+              }
+              def list(
+                # Path param: The ID of the subagent in this session.
+                subagent_id,
+                # Path param: The ID of the session.
+                session_id:,
+                # Query param: Return resources after this resource ID in the selected order.
+                after: nil,
+                # Query param: The maximum number of resources to return, between 1 and 100.
+                # Defaults to 20.
+                limit: nil,
+                # Query param: The order in which resources are returned. Defaults to `desc`.
+                order: nil,
+                request_options: {}
+              )
+              end
+
+              # @api private
+              sig { params(client: OpenAI::Client).returns(T.attached_class) }
+              def self.new(client:)
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/subagents.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Subagents
+
+            sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents::Items) }
+            attr_reader :items
+
+            sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns) }
+            attr_reader :turns
+
+            # Retrieves a subagent belonging to this session. See
+            # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+            sig {
+              params(subagent_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Subagent
+              )
+            }
+            def retrieve(
+              # The ID of the subagent in this session.
+              subagent_id,
+              # The ID of the session.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists subagents in a session, including nested and closed subagents. See
+            # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::SubagentListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Subagent])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/turns.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Turns
+
+            # Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if
+            # the turn does not belong to the session. See
+            # [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
+            sig {
+              params(turn_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::Turn
+              )
+            }
+            def retrieve(
+              # The ID of the turn.
+              turn_id,
+              # The ID of the session that owns the turn.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists turns by creation time and turn ID. The after cursor is exclusive in the
+            # selected order. See
+            # [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::TurnListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::Turn])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents) }
+          attr_reader :subagents
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Artifacts) }
+          attr_reader :artifacts
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Items) }
+          attr_reader :items
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Events) }
+          attr_reader :events
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Turns) }
+          attr_reader :turns
+
+          # See {OpenAI::Resources::Beta::Agents::Sessions#create_streaming} for streaming
+          # counterpart.
+          #
+          # Creates a managed agent session, optionally submits initial input, and returns
+          # the session or streams its events when stream is true. See
+          # [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
+          sig {
+            params(
+              environment: T.any(
+                OpenAI::Beta::EnvironmentParam::None::OrHash,
+                OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
+                OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
+              ),
+              agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
+              agent_id: String,
+              input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              vault_ids: T.nilable(T::Array[String]),
+              stream: T.noreturn,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Beta::AgentSession)
+          }
+          def create(
+            # An inline execution environment or a reference to an environment template.
+            environment:,
+            # Agent configuration. With `agent_id`, supplied fields override the saved agent
+            # for this session. Without `agent_id`, `model` is required.
+            agent: nil,
+            # The ID of a saved reusable agent. Omit `agent` to use its configuration
+            # unchanged.
+            agent_id: nil,
+            # Initial input submitted when creating a session.
+            input: nil,
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters. Omission or null defaults to an empty map.
+            metadata: nil,
+            # The IDs of vaults made available to the session.
+            vault_ids: nil,
+            # There is no need to provide `stream:`. Instead, use `#create_streaming` or
+            # `#create` for streaming and non-streaming use cases, respectively.
+            stream: false,
+            request_options: {}
+          )
+          end
+
+          # See {OpenAI::Resources::Beta::Agents::Sessions#create} for non-streaming
+          # counterpart.
+          #
+          # Creates a managed agent session, optionally submits initial input, and returns
+          # the session or streams its events when stream is true. See
+          # [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
+          sig {
+            params(
+              environment: T.any(
+                OpenAI::Beta::EnvironmentParam::None::OrHash,
+                OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
+                OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
+              ),
+              agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
+              agent_id: String,
+              input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              vault_ids: T.nilable(T::Array[String]),
+              stream: T.noreturn,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Internal::Stream[OpenAI::Beta::AgentSessionEvent::Variants])
+          }
+          def create_streaming(
+            # An inline execution environment or a reference to an environment template.
+            environment:,
+            # Agent configuration. With `agent_id`, supplied fields override the saved agent
+            # for this session. Without `agent_id`, `model` is required.
+            agent: nil,
+            # The ID of a saved reusable agent. Omit `agent` to use its configuration
+            # unchanged.
+            agent_id: nil,
+            # Initial input submitted when creating a session.
+            input: nil,
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters. Omission or null defaults to an empty map.
+            metadata: nil,
+            # The IDs of vaults made available to the session.
+            vault_ids: nil,
+            # There is no need to provide `stream:`. Instead, use `#create_streaming` or
+            # `#create` for streaming and non-streaming use cases, respectively.
+            stream: true,
+            request_options: {}
+          )
+          end
+
+          # Retrieves the current state of a managed agent session. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::AgentSession
+            )
+          }
+          def retrieve(
+            # The ID of the session.
+            session_id,
+            request_options: {}
+          )
+          end
+
+          # Updates session metadata. Omitted fields are unchanged. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(
+              session_id: String,
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Beta::AgentSession)
+          }
+          def update(
+            # The ID of the session.
+            session_id,
+            # Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters.
+            metadata: nil,
+            request_options: {}
+          )
+          end
+
+          # Lists managed agent sessions using ID-based pagination and the requested sort
+          # order. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(
+              after: String,
+              agent_id: String,
+              limit: T.nilable(Integer),
+              order: OpenAI::Beta::Agents::SessionListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSession])
+          }
+          def list(
+            # Return resources after this resource ID in the selected order.
+            after: nil,
+            # Only return sessions whose root agent has this ID. Omit to return sessions for
+            # all agents.
+            agent_id: nil,
+            # The maximum number of resources to return.
+            limit: nil,
+            # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+            # `desc` for descending order. Defaults to `desc`.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # Removes a managed agent session from the public API and returns a deletion
+          # confirmation. Physical cleanup may continue asynchronously. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::AgentSessionDeleted
+            )
+          }
+          def delete(
+            # The ID of the session.
+            session_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+
+      end
+
+    end
+
+  end
+end