Class ChatCompletion

  • All Implemented Interfaces:

    
    public final class ChatCompletion
    
                        

    Represents a chat completion response returned by model, based on the provided input.

    • Constructor Detail

    • Method Detail

      • id

         final String id()

        A unique identifier for the chat completion.

      • created

         final Long created()

        The Unix timestamp (in seconds) of when the chat completion was created.

      • model

         final String model()

        The model used for the chat completion.

      • _object_

         final JsonValue _object_()

        The object type, which is always chat.completion.

        Expected to always return the following:

        JsonValue.from("chat.completion")

        However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).

      • serviceTier

         final Optional<ChatCompletion.ServiceTier> serviceTier()

        Specifies the processing type used for serving the request.

        • If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.

        • If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

        • If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier.

        • When not set, the default behavior is 'auto'.

        When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

      • systemFingerprint

        @Deprecated(message = "deprecated") final Optional<String> systemFingerprint()

        This fingerprint represents the backend configuration that the model runs with.

        Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

      • _id

         final JsonField<String> _id()

        Returns the raw JSON value of id.

        Unlike id, this method doesn't throw if the JSON field has an unexpected type.

      • _model

         final JsonField<String> _model()

        Returns the raw JSON value of model.

        Unlike model, this method doesn't throw if the JSON field has an unexpected type.

      • validate

         final ChatCompletion validate()

        Validates that the types of all values in this object match their expected types recursively.

        This method is not forwards compatible with new types from the API for existing fields.