openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class TokenUsage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of input tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   A breakdown of the agent's input token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::Beta::TokenUsage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of output tokens generated by the agent.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute output_tokens_details
+        #   A breakdown of the agent's output token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        required :output_tokens_details, -> { OpenAI::Beta::TokenUsage::OutputTokensDetails }
+
+        # @!attribute total_tokens
+        #   The total number of input and output tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param input_tokens [Integer]
+        #     The number of input tokens used by the agent.
+        #
+        #   @param input_tokens_details [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        #     A breakdown of the agent's input token usage.
+        #
+        #   @param output_tokens [Integer]
+        #     The number of output tokens generated by the agent.
+        #
+        #   @param output_tokens_details [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        #     A breakdown of the agent's output token usage.
+        #
+        #   @param total_tokens [Integer]
+        #     The total number of input and output tokens used by the agent.
+
+        # @see OpenAI::Models::Beta::TokenUsage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute cached_tokens
+          #   The number of input tokens retrieved from the prompt cache.
+          #
+          #   @return [Integer]
+          required :cached_tokens, Integer
+
+          # @!method initialize(cached_tokens:)
+          #   A breakdown of the agent's input token usage.
+          #
+          #   @param cached_tokens [Integer]
+          #     The number of input tokens retrieved from the prompt cache.
+        end
+
+        # @see OpenAI::Models::Beta::TokenUsage#output_tokens_details
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute reasoning_tokens
+          #   The number of output tokens used for reasoning.
+          #
+          #   @return [Integer]
+          required :reasoning_tokens, Integer
+
+          # @!method initialize(reasoning_tokens:)
+          #   A breakdown of the agent's output token usage.
+          #
+          #   @param reasoning_tokens [Integer]
+          #     The number of output tokens used for reasoning.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # An action performed by the web search tool.
+      module WebSearchAction
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A search query or group of search queries.
+        variant :search, -> { OpenAI::Beta::WebSearchAction::Search }
+
+        # Opens a web page.
+        variant :open_page, -> { OpenAI::Beta::WebSearchAction::OpenPage }
+
+        # Finds text within a web page.
+        variant :find_in_page, -> { OpenAI::Beta::WebSearchAction::FindInPage }
+
+        # Another web search action.
+        variant :other, -> { OpenAI::Beta::WebSearchAction::Other }
+
+        class Search < OpenAI::Internal::Type::BaseModel
+          # @!attribute queries
+          #   The search queries, when multiple queries were used.
+          #
+          #   @return [Array<String>, nil]
+          required :queries, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute query
+          #   The search query, when a single query was used.
+          #
+          #   @return [String, nil]
+          required :query, String, nil?: true
+
+          # @!attribute type
+          #   The type of the object. Always `search`.
+          #
+          #   @return [Symbol, :search]
+          required :type, const: :search
+
+          # @!method initialize(queries:, query:, type: :search)
+          #   A search query or group of search queries.
+          #
+          #   @param queries [Array<String>, nil]
+          #     The search queries, when multiple queries were used.
+          #
+          #   @param query [String, nil]
+          #     The search query, when a single query was used.
+          #
+          #   @param type [Symbol, :search]
+          #     The type of the object. Always `search`.
+        end
+
+        class OpenPage < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `open_page`.
+          #
+          #   @return [Symbol, :open_page]
+          required :type, const: :open_page
+
+          # @!attribute url
+          #   The URL of the page that was opened.
+          #
+          #   @return [String, nil]
+          required :url, String, nil?: true
+
+          # @!method initialize(url:, type: :open_page)
+          #   Opens a web page.
+          #
+          #   @param url [String, nil]
+          #     The URL of the page that was opened.
+          #
+          #   @param type [Symbol, :open_page]
+          #     The type of the object. Always `open_page`.
+        end
+
+        class FindInPage < OpenAI::Internal::Type::BaseModel
+          # @!attribute pattern
+          #   The text pattern that was searched for.
+          #
+          #   @return [String, nil]
+          required :pattern, String, nil?: true
+
+          # @!attribute type
+          #   The type of the object. Always `find_in_page`.
+          #
+          #   @return [Symbol, :find_in_page]
+          required :type, const: :find_in_page
+
+          # @!attribute url
+          #   The URL of the page that was searched.
+          #
+          #   @return [String, nil]
+          required :url, String, nil?: true
+
+          # @!method initialize(pattern:, url:, type: :find_in_page)
+          #   Finds text within a web page.
+          #
+          #   @param pattern [String, nil]
+          #     The text pattern that was searched for.
+          #
+          #   @param url [String, nil]
+          #     The URL of the page that was searched.
+          #
+          #   @param type [Symbol, :find_in_page]
+          #     The type of the object. Always `find_in_page`.
+        end
+
+        class Other < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `other`.
+          #
+          #   @return [Symbol, :other]
+          required :type, const: :other
+
+          # @!method initialize(type: :other)
+          #   Another web search action.
+          #
+          #   @param type [Symbol, :other]
+          #     The type of the object. Always `other`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other)]
+      end
+    end
+  end
+end

data/lib/openai/models/chat/completion_create_params.rb

@@ -1080,7 +1080,7 @@ module OpenAI
           # An {OpenAI::BaseModel} can be provided and implicitly converted into {OpenAI::Models::ResponseFormatJSONSchema}.
           # See examples for more details.
           #
-          # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+          # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
           variant -> { OpenAI::StructuredOutput::JsonSchemaConverter }
 
           # JSON object response format. An older method of generating JSON responses.

data/lib/openai/resources/beta/agents/environments/files.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        class Environments
+          class Files
+            # Copies inline bytes or a Files API file into a connected execution environment.
+            # See
+            # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+            #
+            # @overload create(environment_id, hosted_environment_file_param:, request_options: {})
+            #
+            # @param environment_id [String]
+            #   The ID of the environment.
+            #
+            # @param hosted_environment_file_param [OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline]
+            #   A file materialized in an OpenAI-hosted execution environment.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentFile]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::FileCreateParams
+            def create(environment_id, params)
+              parsed, options = OpenAI::Beta::Agents::Environments::FileCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["agents/environments/%1$s/files", environment_id],
+                body: parsed[:hosted_environment_file_param],
+                model: OpenAI::Beta::Agents::Environments::EnvironmentFile,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # Lists live files on a connected execution environment with optional directory
+            # filtering and opaque cursor pagination. See
+            # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+            #
+            # @overload list(environment_id, limit: nil, order: nil, page: nil, path: nil, request_options: {})
+            #
+            # @param environment_id [String]
+            #   The ID of the environment.
+            #
+            # @param limit [Integer, nil]
+            #   The maximum number of files to return, between 1 and 100.
+            #
+            # @param order [Symbol, OpenAI::Models::Beta::Agents::Environments::FileListParams::Order]
+            #   Sort by case-sensitive path components. Defaults to descending.
+            #
+            # @param page [String]
+            #   The opaque token from the previous page. Keep the same path, order, and limit.
+            #
+            # @param path [String, nil]
+            #   Restrict the listing to this absolute workspace directory.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::TokenPage<OpenAI::Models::Beta::Agents::Environments::EnvironmentFile>]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::FileListParams
+            def list(environment_id, params = {})
+              parsed, options = OpenAI::Beta::Agents::Environments::FileListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["agents/environments/%1$s/files", environment_id],
+                query: query,
+                page: OpenAI::Internal::TokenPage,
+                model: OpenAI::Beta::Agents::Environments::EnvironmentFile,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/beta/agents/environments/templates.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+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).
+            #
+            # @overload create(capability_directories: nil, env: nil, files: nil, name: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, request_options: {})
+            #
+            # @param capability_directories [Array<String>, nil]
+            #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+            #   list.
+            #
+            # @param env [Hash{Symbol=>String}, nil]
+            #   Environment variables made available to the agent.
+            #
+            # @param files [Array<OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline>, nil]
+            #   Files available before the agent starts. Defaults to an empty list.
+            #
+            # @param name [String, nil]
+            #   An optional human-readable display name for the template.
+            #
+            # @param network [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network, nil]
+            #   Network access for an OpenAI-hosted environment.
+            #
+            # @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Packages, nil]
+            #   Packages to install in an OpenAI-hosted environment.
+            #
+            # @param plugins [Array<OpenAI::Models::Beta::HostedPluginParam>, nil]
+            #   Plugins provided as inline ZIP archives. Defaults to an empty list.
+            #
+            # @param setup_commands [Array<OpenAI::Models::Beta::SetupCommandParam>, nil]
+            #   Ordered, confidential setup commands. Command bodies are never returned.
+            #
+            # @param skills [Array<OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline>, nil]
+            #   Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+            #   list.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams
+            def create(params = {})
+              parsed, options = OpenAI::Beta::Agents::Environments::TemplateCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: "agents/environments/templates",
+                body: parsed,
+                model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **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).
+            #
+            # @overload retrieve(environment_template_id, request_options: {})
+            #
+            # @param environment_template_id [String]
+            #   The ID of the reusable environment template.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::TemplateRetrieveParams
+            def retrieve(environment_template_id, params = {})
+              @client.request(
+                method: :get,
+                path: ["agents/environments/templates/%1$s", environment_template_id],
+                model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+              )
+            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).
+            #
+            # @overload update(environment_template_id, capability_directories: nil, env: nil, files: nil, name: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, request_options: {})
+            #
+            # @param environment_template_id [String]
+            #   The ID of the reusable environment template.
+            #
+            # @param capability_directories [Array<String>, nil]
+            #   Directories that expose capabilities to the agent.
+            #
+            # @param env [Hash{Symbol=>String}, nil]
+            #   Replacement confidential environment values.
+            #
+            # @param files [Array<OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline>, nil]
+            #   Replacement file configuration materialized for each new session.
+            #
+            # @param name [String, nil]
+            #   A replacement human-readable display name, or `null` to clear the name.
+            #
+            # @param network [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network, nil]
+            #   Network access for an OpenAI-hosted environment.
+            #
+            # @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Packages, nil]
+            #   Packages to install in an OpenAI-hosted environment.
+            #
+            # @param plugins [Array<OpenAI::Models::Beta::HostedPluginParam>, nil]
+            #   Replacement plugin configuration installed for each new session.
+            #
+            # @param setup_commands [Array<OpenAI::Models::Beta::SetupCommandParam>, nil]
+            #   Replacement confidential setup commands, never included in returned resources.
+            #
+            # @param skills [Array<OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline>, nil]
+            #   Replacement skill configuration installed for each new session.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams
+            def update(environment_template_id, params = {})
+              parsed, options = OpenAI::Beta::Agents::Environments::TemplateUpdateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["agents/environments/templates/%1$s", environment_template_id],
+                body: parsed,
+                model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **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).
+            #
+            # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+            #
+            # @param after [String]
+            #   Return resources after this resource ID in the selected order.
+            #
+            # @param limit [Integer]
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            # @param order [Symbol, OpenAI::Models::Beta::Agents::Environments::TemplateListParams::Order]
+            #   The order in which resources are returned. Defaults to `desc`.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate>]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::TemplateListParams
+            def list(params = {})
+              parsed, options = OpenAI::Beta::Agents::Environments::TemplateListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: "agents/environments/templates",
+                query: query,
+                page: OpenAI::Internal::CursorPage,
+                model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **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).
+            #
+            # @overload delete(environment_template_id, request_options: {})
+            #
+            # @param environment_template_id [String]
+            #   The ID of the reusable environment template.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplateDeleted]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::TemplateDeleteParams
+            def delete(environment_template_id, params = {})
+              @client.request(
+                method: :delete,
+                path: ["agents/environments/templates/%1$s", environment_template_id],
+                model: OpenAI::Beta::Agents::Environments::EnvironmentTemplateDeleted,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/beta/agents/environments.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        class Environments
+          # @return [OpenAI::Resources::Beta::Agents::Environments::Files]
+          attr_reader :files
+
+          # @return [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).
+          #
+          # @overload retrieve(environment_id, request_options: {})
+          #
+          # @param environment_id [String]
+          #   The ID of the environment.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Beta::Agents::EnvironmentInfo]
+          #
+          # @see OpenAI::Models::Beta::Agents::EnvironmentRetrieveParams
+          def retrieve(environment_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["agents/environments/%1$s", environment_id],
+              model: OpenAI::Beta::Agents::EnvironmentInfo,
+              security: {bearer_auth: true},
+              options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+            @files = OpenAI::Resources::Beta::Agents::Environments::Files.new(client: client)
+            @templates = OpenAI::Resources::Beta::Agents::Environments::Templates.new(client: client)
+          end
+        end
+      end
+    end
+  end
+end