Package com.openai.models

Class Run

  • All Implemented Interfaces:
    
public final class Run

    Represents an execution run on a thread.

    • Constructor Detail

    • Method Detail

      • id

         final String id()

        The identifier, which can be referenced in API endpoints.

      • createdAt

         final Long createdAt()

        The Unix timestamp (in seconds) for when the run was created.

      • expiresAt

         final Optional<Long> expiresAt()

        The Unix timestamp (in seconds) for when the run will expire.

      • maxCompletionTokens

         final Optional<Long> maxCompletionTokens()

        The maximum number of completion tokens specified to have been used over the course of the run.

      • maxPromptTokens

         final Optional<Long> maxPromptTokens()

        The maximum number of prompt tokens specified to have been used over the course of the run.

      • _metadata

         final JsonValue _metadata()

        Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

      • responseFormat

         final Optional<AssistantResponseFormatOption> responseFormat()

        Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 * Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

        Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

        Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

        Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

      • startedAt

         final Optional<Long> startedAt()

        The Unix timestamp (in seconds) for when the run was started.

      • status

         final RunStatus status()

        The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

      • toolChoice

         final Optional<AssistantToolChoiceOption> toolChoice()

        Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

      • usage

         final Optional<Run.Usage> usage()

        Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

      • topP

         final Optional<Double> topP()

        The nucleus sampling value used for this run. If not set, defaults to 1.

      • _id

         final JsonField<String> _id()

        The identifier, which can be referenced in API endpoints.

      • _maxPromptTokens

         final JsonField<Long> _maxPromptTokens()

        The maximum number of prompt tokens specified to have been used over the course of the run.

      • _responseFormat

         final JsonField<AssistantResponseFormatOption> _responseFormat()

        Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 * Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

        Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

        Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

        Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

      • _status

         final JsonField<RunStatus> _status()

        The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

      • _toolChoice

         final JsonField<AssistantToolChoiceOption> _toolChoice()

        Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

      • _usage

         final JsonField<Run.Usage> _usage()

        Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

      • _topP

         final JsonField<Double> _topP()

        The nucleus sampling value used for this run. If not set, defaults to 1.