RubyGems - openai - Versions diffs - 0.91.0 → 0.93.0 - Mend

openai 0.91.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1351) hide show

data/sig/openai/models/beta/agents/session_update_params.rbs CHANGED Viewed

@@ -16,14 +16,25 @@ module OpenAI
           attr_accessor session_id: String
+          # Model settings for subsequent turns. Omitted fields stay unchanged.
           attr_reader agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent?
+          # Model settings for subsequent turns. Omitted fields stay unchanged.
           def agent=: (
             OpenAI::Beta::Agents::SessionUpdateParams::Agent
           ) -> OpenAI::Beta::Agents::SessionUpdateParams::Agent
+          # 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.
           attr_accessor metadata: ::Hash[Symbol, String]?
+          # @param agent
+          #   Model settings for subsequent turns. Omitted fields stay unchanged.
+          # @param metadata
+          #   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.
           def initialize: (
             session_id: String,
             ?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
@@ -46,18 +57,29 @@ module OpenAI
             }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The model for subsequent turns. Omit to keep the current model.
             attr_reader model: String?
+            # The model for subsequent turns. Omit to keep the current model.
             def model=: (String) -> String
+            # Reasoning settings to update. Omit to keep the current effort.
             attr_reader reasoning: OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning?
+            # Reasoning settings to update. Omit to keep the current effort.
             def reasoning=: (
               OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning
             ) -> OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning
+            # Omit to keep the current tier. Null resets it to auto.
             attr_accessor service_tier: OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::service_tier?
+            # @param model
+            #   The model for subsequent turns. Omit to keep the current model.
+            # @param reasoning
+            #   Reasoning settings to update. Omit to keep the current effort.
+            # @param service_tier
+            #   Omit to keep the current tier. Null resets it to auto.
             def initialize: (
               ?model: String,
               ?reasoning: OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning,
@@ -76,8 +98,11 @@ module OpenAI
               }
             class Reasoning < OpenAI::Internal::Type::BaseModel
+              # Omit to keep the current effort. Null selects the model's default effort.
               attr_accessor effort: OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning::effort?
+              # @param effort
+              #   Omit to keep the current effort. Null selects the model's default effort.
               def initialize: (
                 ?effort: OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning::effort?
               ) -> void

data/sig/openai/models/beta/agents/sessions/artifact_list_params.rbs CHANGED Viewed

@@ -19,18 +19,31 @@ module OpenAI
             attr_accessor session_id: String
+            # Return artifacts after this immutable artifact ID.
             attr_accessor after: String?
+            # Restrict the listing to artifacts produced by this environment.
             attr_accessor environment_id: String?
+            # The maximum number of artifacts to return, between 1 and 100.
             attr_accessor limit: Integer?
+            # Sort by creation time and ID. Defaults to descending.
             attr_reader order: OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order?
+            # Sort by creation time and ID. Defaults to descending.
             def order=: (
               OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order
             ) -> OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::order
+            # @param after
+            #   Return artifacts after this immutable artifact ID.
+            # @param environment_id
+            #   Restrict the listing to artifacts produced by this environment.
+            # @param limit
+            #   The maximum number of artifacts to return, between 1 and 100.
+            # @param order
+            #   Sort by creation time and ID. Defaults to descending.
             def initialize: (
               session_id: String,
               ?after: String?,

data/sig/openai/models/beta/agents/sessions/event_create_params.rbs CHANGED Viewed

@@ -17,12 +17,15 @@ module OpenAI
             attr_accessor session_id: String
+            # The input events to submit to the session.
             attr_accessor events: ::Array[OpenAI::Models::Beta::agent_session_input_param]
             attr_reader idempotency_key: String?
             def idempotency_key=: (String) -> String
+            # @param events
+            #   The input events to submit to the session.
             def initialize: (
               session_id: String,
               events: ::Array[OpenAI::Models::Beta::agent_session_input_param],

data/sig/openai/models/beta/agents/sessions/item_list_params.rbs CHANGED Viewed

@@ -18,20 +18,32 @@ module OpenAI
             attr_accessor session_id: String
+            # Return resources after this resource ID in the selected order.
             attr_reader after: String?
+            # Return resources after this resource ID in the selected order.
             def after=: (String) -> String
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             attr_reader limit: Integer?
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             def limit=: (Integer) -> Integer
+            # The order in which resources are returned. Defaults to `desc`.
             attr_reader order: OpenAI::Models::Beta::Agents::Sessions::ItemListParams::order?
+            # The order in which resources are returned. Defaults to `desc`.
             def order=: (
               OpenAI::Models::Beta::Agents::Sessions::ItemListParams::order
             ) -> OpenAI::Models::Beta::Agents::Sessions::ItemListParams::order
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
             def initialize: (
               session_id: String,
               ?after: String,

data/sig/openai/models/beta/agents/sessions/session_artifact.rbs CHANGED Viewed

@@ -18,22 +18,46 @@ module OpenAI
             }
           class SessionArtifact < OpenAI::Internal::Type::BaseModel
+            # The immutable artifact ID.
             attr_accessor id: String
+            # The Unix timestamp, in seconds, when the artifact was published.
             attr_accessor created_at: Integer
+            # The ID of the environment that produced the artifact.
             attr_accessor environment_id: String
+            # The object type. Always `agent.session.artifact`.
             attr_accessor object: :"agent.session.artifact"
+            # The original absolute file path in the execution environment.
             attr_accessor path: String
+            # The ID of the session that owns the artifact.
             attr_accessor session_id: String
+            # The immutable artifact size in bytes.
             attr_accessor size_bytes: Integer
+            # The ID of the completed turn that published the artifact.
             attr_accessor turn_id: String
+            # @param id
+            #   The immutable artifact ID.
+            # @param created_at
+            #   The Unix timestamp, in seconds, when the artifact was published.
+            # @param environment_id
+            #   The ID of the environment that produced the artifact.
+            # @param path
+            #   The original absolute file path in the execution environment.
+            # @param session_id
+            #   The ID of the session that owns the artifact.
+            # @param size_bytes
+            #   The immutable artifact size in bytes.
+            # @param turn_id
+            #   The ID of the completed turn that published the artifact.
+            # @param object
+            #   The object type. Always `agent.session.artifact`.
             def initialize: (
               id: String,
               created_at: Integer,

data/sig/openai/models/beta/agents/sessions/session_artifact_deleted.rbs CHANGED Viewed

@@ -13,12 +13,21 @@ module OpenAI
             }
           class SessionArtifactDeleted < OpenAI::Internal::Type::BaseModel
+            # The ID of the deleted session artifact.
             attr_accessor id: String
+            # Whether the session artifact was deleted. Always `true`.
             attr_accessor deleted: bool
+            # The object type. Always `agent.session.artifact.deleted`.
             attr_accessor object: :"agent.session.artifact.deleted"
+            # @param id
+            #   The ID of the deleted session artifact.
+            # @param deleted
+            #   Whether the session artifact was deleted. Always `true`.
+            # @param object
+            #   The object type. Always `agent.session.artifact.deleted`.
             def initialize: (
               id: String,
               deleted: bool,

data/sig/openai/models/beta/agents/sessions/subagent_list_params.rbs CHANGED Viewed

@@ -18,20 +18,32 @@ module OpenAI
             attr_accessor session_id: String
+            # Return resources after this resource ID in the selected order.
             attr_reader after: String?
+            # Return resources after this resource ID in the selected order.
             def after=: (String) -> String
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             attr_reader limit: Integer?
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             def limit=: (Integer) -> Integer
+            # The order in which resources are returned. Defaults to `desc`.
             attr_reader order: OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::order?
+            # The order in which resources are returned. Defaults to `desc`.
             def order=: (
               OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::order
             ) -> OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::order
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
             def initialize: (
               session_id: String,
               ?after: String,

data/sig/openai/models/beta/agents/sessions/subagents/item_list_params.rbs CHANGED Viewed

@@ -22,20 +22,32 @@ module OpenAI
               attr_accessor subagent_id: String
+              # Return resources after this resource ID in the selected order.
               attr_reader after: String?
+              # Return resources after this resource ID in the selected order.
               def after=: (String) -> String
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
               attr_reader limit: Integer?
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
               def limit=: (Integer) -> Integer
+              # The order in which resources are returned. Defaults to `desc`.
               attr_reader order: OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::order?
+              # The order in which resources are returned. Defaults to `desc`.
               def order=: (
                 OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::order
               ) -> OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::order
+              # @param after
+              #   Return resources after this resource ID in the selected order.
+              # @param limit
+              #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              # @param order
+              #   The order in which resources are returned. Defaults to `desc`.
               def initialize: (
                 session_id: String,
                 subagent_id: String,

data/sig/openai/models/beta/agents/sessions/subagents/turn_list_params.rbs CHANGED Viewed

@@ -22,20 +22,32 @@ module OpenAI
               attr_accessor subagent_id: String
+              # Return resources after this resource ID in the selected order.
               attr_reader after: String?
+              # Return resources after this resource ID in the selected order.
               def after=: (String) -> String
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
               attr_reader limit: Integer?
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
               def limit=: (Integer) -> Integer
+              # The order in which resources are returned. Defaults to `desc`.
               attr_reader order: OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::order?
+              # The order in which resources are returned. Defaults to `desc`.
               def order=: (
                 OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::order
               ) -> OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::order
+              # @param after
+              #   Return resources after this resource ID in the selected order.
+              # @param limit
+              #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              # @param order
+              #   The order in which resources are returned. Defaults to `desc`.
               def initialize: (
                 session_id: String,
                 subagent_id: String,

data/sig/openai/models/beta/agents/sessions/subagents/turns/item_list_params.rbs CHANGED Viewed

@@ -26,20 +26,32 @@ module OpenAI
                 attr_accessor turn_id: String
+                # Return resources after this resource ID in the selected order.
                 attr_reader after: String?
+                # Return resources after this resource ID in the selected order.
                 def after=: (String) -> String
+                # The maximum number of resources to return, between 1 and 100. Defaults to 20.
                 attr_reader limit: Integer?
+                # The maximum number of resources to return, between 1 and 100. Defaults to 20.
                 def limit=: (Integer) -> Integer
+                # The order in which resources are returned. Defaults to `desc`.
                 attr_reader order: OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::order?
+                # The order in which resources are returned. Defaults to `desc`.
                 def order=: (
                   OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::order
                 ) -> OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::order
+                # @param after
+                #   Return resources after this resource ID in the selected order.
+                # @param limit
+                #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+                # @param order
+                #   The order in which resources are returned. Defaults to `desc`.
                 def initialize: (
                   session_id: String,
                   subagent_id: String,

data/sig/openai/models/beta/agents/sessions/turn.rbs CHANGED Viewed

@@ -19,28 +19,67 @@ module OpenAI
             }
           class Turn < OpenAI::Internal::Type::BaseModel
+            # The ID of the turn.
             attr_accessor id: String
+            # The ID of the agent that ran the turn.
             attr_accessor agent_id: String
+            # The Unix timestamp, in seconds, when the turn reached a terminal state.
             attr_accessor completed_at: Integer?
+            # The Unix timestamp, in seconds, used to order the turn by creation time.
+            # Subagent turns use their start time, falling back to completion time or the
+            # subagent opening time when the preceding timestamps are unavailable.
             attr_accessor created_at: Integer
+            # A customer-safe error. Non-null only for a failed turn.
             attr_accessor error: OpenAI::Beta::SessionTurnError?
+            # The object type. Always `agent.session.turn`.
             attr_accessor object: :"agent.session.turn"
+            # The ID of the session that owns the turn.
             attr_accessor session_id: String
+            # The Unix timestamp, in seconds, when the turn started.
             attr_accessor started_at: Integer?
+            # The current status of the turn.
             attr_accessor status: OpenAI::Models::Beta::Agents::Sessions::Turn::status
+            # The ID of the subagent that ran the turn, if applicable.
             attr_accessor subagent_id: String?
+            # Best-effort token usage for the turn, or null if unknown. Recorded usage may
+            # change.
             attr_accessor usage: OpenAI::Beta::TokenUsage?
+            # @param id
+            #   The ID of the turn.
+            # @param agent_id
+            #   The ID of the agent that ran the turn.
+            # @param completed_at
+            #   The Unix timestamp, in seconds, when the turn reached a terminal state.
+            # @param created_at
+            #   The Unix timestamp, in seconds, used to order the turn by creation time.
+            #   Subagent turns use their start time, falling back to completion time or the
+            #   subagent opening time when the preceding timestamps are unavailable.
+            # @param error
+            #   A customer-safe error. Non-null only for a failed turn.
+            # @param session_id
+            #   The ID of the session that owns the turn.
+            # @param started_at
+            #   The Unix timestamp, in seconds, when the turn started.
+            # @param status
+            #   The current status of the turn.
+            # @param subagent_id
+            #   The ID of the subagent that ran the turn, if applicable.
+            # @param usage
+            #   Best-effort token usage for the turn, or null if unknown. Recorded usage may
+            #   change.
+            # @param object
+            #   The object type. Always `agent.session.turn`.
             def initialize: (
               id: String,
               agent_id: String,

data/sig/openai/models/beta/agents/sessions/turn_list_params.rbs CHANGED Viewed

@@ -18,20 +18,32 @@ module OpenAI
             attr_accessor session_id: String
+            # Return resources after this resource ID in the selected order.
             attr_reader after: String?
+            # Return resources after this resource ID in the selected order.
             def after=: (String) -> String
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             attr_reader limit: Integer?
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             def limit=: (Integer) -> Integer
+            # The order in which resources are returned. Defaults to `desc`.
             attr_reader order: OpenAI::Models::Beta::Agents::Sessions::TurnListParams::order?
+            # The order in which resources are returned. Defaults to `desc`.
             def order=: (
               OpenAI::Models::Beta::Agents::Sessions::TurnListParams::order
             ) -> OpenAI::Models::Beta::Agents::Sessions::TurnListParams::order
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
             def initialize: (
               session_id: String,
               ?after: String,

data/sig/openai/models/beta/agents/vault.rbs CHANGED Viewed

@@ -12,16 +12,33 @@ module OpenAI
           }
         class Vault < OpenAI::Internal::Type::BaseModel
+          # The ID of the vault.
           attr_accessor id: String
+          # The Unix timestamp, in seconds, when the vault was created.
           attr_accessor created_at: Integer
+          # Key-value pairs associated with the vault, such as an application or team
+          # identifier.
           attr_accessor metadata: ::Hash[Symbol, String]
+          # The human-readable name of the vault, if set.
           attr_accessor name: String?
+          # The object type. Always `vault`.
           attr_accessor object: :vault
+          # @param id
+          #   The ID of the vault.
+          # @param created_at
+          #   The Unix timestamp, in seconds, when the vault was created.
+          # @param metadata
+          #   Key-value pairs associated with the vault, such as an application or team
+          #   identifier.
+          # @param name
+          #   The human-readable name of the vault, if set.
+          # @param object
+          #   The object type. Always `vault`.
           def initialize: (
             id: String,
             created_at: Integer,

data/sig/openai/models/beta/agents/vault_create_params.rbs CHANGED Viewed

@@ -13,12 +13,24 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # Key-value pairs to associate with the vault, such as an application or team
+          # identifier.
           attr_accessor metadata: ::Hash[Symbol, String]?
+          # The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+          # trimming.
           attr_reader name: String?
+          # The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+          # trimming.
           def name=: (String) -> String
+          # @param metadata
+          #   Key-value pairs to associate with the vault, such as an application or team
+          #   identifier.
+          # @param name
+          #   The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+          #   trimming.
           def initialize: (
             ?metadata: ::Hash[Symbol, String]?,
             ?name: String,

data/sig/openai/models/beta/agents/vault_deleted.rbs CHANGED Viewed

@@ -6,12 +6,21 @@ module OpenAI
           { id: String, deleted: bool, ?object: :"vault.deleted" }
         class VaultDeleted < OpenAI::Internal::Type::BaseModel
+          # The ID of the deleted vault.
           attr_accessor id: String
+          # Whether the resource was deleted. Always `true`.
           attr_accessor deleted: bool
+          # The object type. Always `vault.deleted`.
           attr_accessor object: :"vault.deleted"
+          # @param id
+          #   The ID of the deleted vault.
+          # @param deleted
+          #   Whether the resource was deleted. Always `true`.
+          # @param object
+          #   The object type. Always `vault.deleted`.
           def initialize: (
             id: String,
             deleted: bool,

data/sig/openai/models/beta/agents/vault_list_params.rbs CHANGED Viewed

@@ -15,24 +15,47 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # Return resources after this resource ID in the selected order.
           attr_reader after: String?
+          # Return resources after this resource ID in the selected order.
           def after=: (String) -> String
+          # The maximum number of resources to return. Defaults to 20. Values are clamped
+          # between 1 and 100.
           attr_accessor limit: Integer?
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `desc`.
           attr_reader order: OpenAI::Models::Beta::Agents::VaultListParams::order?
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `desc`.
           def order=: (
             OpenAI::Models::Beta::Agents::VaultListParams::order
           ) -> OpenAI::Models::Beta::Agents::VaultListParams::order
+          # Filter by one status or a list, such as `status=active` or
+          # `status[]=active&status[]=archived`. Both statuses are included by default.
           attr_reader status: OpenAI::Models::Beta::Agents::vault_status_filter?
+          # Filter by one status or a list, such as `status=active` or
+          # `status[]=active&status[]=archived`. Both statuses are included by default.
           def status=: (
             OpenAI::Models::Beta::Agents::vault_status_filter
           ) -> OpenAI::Models::Beta::Agents::vault_status_filter
+          # @param after
+          #   Return resources after this resource ID in the selected order.
+          # @param limit
+          #   The maximum number of resources to return. Defaults to 20. Values are clamped
+          #   between 1 and 100.
+          # @param order
+          #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `desc`.
+          # @param status
+          #   Filter by one status or a list, such as `status=active` or
+          #   `status[]=active&status[]=archived`. Both statuses are included by default.
           def initialize: (
             ?after: String,
             ?limit: Integer?,

data/sig/openai/models/beta/agents/vaults/credential.rbs CHANGED Viewed

@@ -15,20 +15,41 @@ module OpenAI
             }
           class Credential < OpenAI::Internal::Type::BaseModel
+            # The ID of the credential.
             attr_accessor id: String
+            # The authentication method and non-secret configuration of the credential.
             attr_accessor auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth
+            # The Unix timestamp, in seconds, when the credential was created.
             attr_accessor created_at: Integer
+            # The human-readable name of the credential.
             attr_accessor name: String
+            # The object type. Always `vault.credential`.
             attr_accessor object: :"vault.credential"
+            # The Unix timestamp, in seconds, when the credential was last updated.
             attr_accessor updated_at: Integer
+            # The ID of the vault containing this credential.
             attr_accessor vault_id: String
+            # @param id
+            #   The ID of the credential.
+            # @param auth
+            #   The authentication method and non-secret configuration of the credential.
+            # @param created_at
+            #   The Unix timestamp, in seconds, when the credential was created.
+            # @param name
+            #   The human-readable name of the credential.
+            # @param updated_at
+            #   The Unix timestamp, in seconds, when the credential was last updated.
+            # @param vault_id
+            #   The ID of the vault containing this credential.
+            # @param object
+            #   The object type. Always `vault.credential`.
             def initialize: (
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,