openai 0.89.0 → 0.90.0

data/rbi/openai/resources/beta/agents/environments/templates.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Environments
+
+          class Templates
+
+            # Creates reusable environment configuration without returning confidential setup
+            # commands or environment values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                capability_directories: T.nilable(T::Array[String]),
+                env: T.nilable(T::Hash[Symbol, String]),
+                files: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedEnvironmentFileParam::FileID::OrHash,
+                      OpenAI::Beta::HostedEnvironmentFileParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                name: T.nilable(String),
+                network: T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network::OrHash),
+                packages: T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages::OrHash),
+                plugins: T.nilable(T::Array[OpenAI::Beta::HostedPluginParam::OrHash]),
+                setup_commands: T.nilable(T::Array[OpenAI::Beta::SetupCommandParam::OrHash]),
+                skills: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedSkillParam::SkillReference::OrHash,
+                      OpenAI::Beta::HostedSkillParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Environments::EnvironmentTemplate)
+            }
+            def create(
+              # Directories that contain capabilities exposed to the agent. Defaults to an empty
+              # list.
+              capability_directories: nil,
+              # Environment variables made available to the agent.
+              env: nil,
+              # Files available before the agent starts. Defaults to an empty list.
+              files: nil,
+              # An optional human-readable display name for the template.
+              name: nil,
+              # Network access for an OpenAI-hosted environment.
+              network: nil,
+              # Packages to install in an OpenAI-hosted environment.
+              packages: nil,
+              # Plugins provided as inline ZIP archives. Defaults to an empty list.
+              plugins: nil,
+              # Ordered, confidential setup commands. Command bodies are never returned.
+              setup_commands: nil,
+              # Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+              # list.
+              skills: nil,
+              request_options: {}
+            )
+            end
+
+            # Retrieves reusable environment configuration without returning confidential
+            # values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(environment_template_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Environments::EnvironmentTemplate
+              )
+            }
+            def retrieve(
+              # The ID of the reusable environment template.
+              environment_template_id,
+              request_options: {}
+            )
+            end
+
+            # Updates reusable environment configuration without returning confidential
+            # values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                environment_template_id: String,
+                capability_directories: T.nilable(T::Array[String]),
+                env: T.nilable(T::Hash[Symbol, String]),
+                files: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedEnvironmentFileParam::FileID::OrHash,
+                      OpenAI::Beta::HostedEnvironmentFileParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                name: T.nilable(String),
+                network: T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network::OrHash),
+                packages: T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Packages::OrHash),
+                plugins: T.nilable(T::Array[OpenAI::Beta::HostedPluginParam::OrHash]),
+                setup_commands: T.nilable(T::Array[OpenAI::Beta::SetupCommandParam::OrHash]),
+                skills: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedSkillParam::SkillReference::OrHash,
+                      OpenAI::Beta::HostedSkillParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Environments::EnvironmentTemplate)
+            }
+            def update(
+              # The ID of the reusable environment template.
+              environment_template_id,
+              # Directories that expose capabilities to the agent.
+              capability_directories: nil,
+              # Replacement confidential environment values.
+              env: nil,
+              # Replacement file configuration materialized for each new session.
+              files: nil,
+              # A replacement human-readable display name, or `null` to clear the name.
+              name: nil,
+              # Network access for an OpenAI-hosted environment.
+              network: nil,
+              # Packages to install in an OpenAI-hosted environment.
+              packages: nil,
+              # Replacement plugin configuration installed for each new session.
+              plugins: nil,
+              # Replacement confidential setup commands, never included in returned resources.
+              setup_commands: nil,
+              # Replacement skill configuration installed for each new session.
+              skills: nil,
+              request_options: {}
+            )
+            end
+
+            # Lists reusable environment templates without returning confidential values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Environments::TemplateListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Environments::EnvironmentTemplate])
+            }
+            def list(
+              # 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
+
+            # Deletes reusable environment configuration and all confidential template inputs.
+            # See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(environment_template_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Environments::EnvironmentTemplateDeleted
+              )
+            }
+            def delete(
+              # The ID of the reusable environment template.
+              environment_template_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/environments.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Environments
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Environments::Files) }
+          attr_reader :files
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Environments::Templates) }
+          attr_reader :templates
+
+          # Retrieves an execution environment's connection status and safe installed
+          # metadata. See
+          # [environment lifecycle](https://developers.openai.com/api/docs/guides/agents-api/environments/lifecycle).
+          sig {
+            params(environment_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::Agents::EnvironmentInfo
+            )
+          }
+          def retrieve(
+            # The ID of the environment.
+            environment_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

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

@@ -0,0 +1,105 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Artifacts
+
+            # Retrieves immutable metadata for one durable session artifact. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::SessionArtifact
+              )
+            }
+            def retrieve(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists immutable artifacts published by completed hosted session turns. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(
+                session_id: String,
+                after: T.nilable(String),
+                environment_id: T.nilable(String),
+                limit: T.nilable(Integer),
+                order: OpenAI::Beta::Agents::Sessions::ArtifactListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::SessionArtifact])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # Return artifacts after this immutable artifact ID.
+              after: nil,
+              # Restrict the listing to artifacts produced by this environment.
+              environment_id: nil,
+              # The maximum number of artifacts to return, between 1 and 100.
+              limit: nil,
+              # Sort by creation time and ID. Defaults to descending.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Deletes an immutable session artifact without deleting its live environment file
+            # or original Files API object. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::SessionArtifactDeleted
+              )
+            }
+            def delete(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Downloads immutable session artifact bytes after the execution environment
+            # expires. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                T.all(StringIO, OpenAI::ResponseCarrier)
+              )
+            }
+            def content(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              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/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