Package com.azure.ai.openai.models

Class Completions

java.lang.Object
com.azure.ai.openai.models.Completions
All Implemented Interfaces:
com.azure.json.JsonSerializable<Completions>
public final class Completions extends Object implements com.azure.json.JsonSerializable<Completions>
Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Completions
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of Completions from the JsonReader.
    List<Choice>
    getChoices()
    Get the choices property: The collection of completions choices associated with this completions response.
    OffsetDateTime
    getCreatedAt()
    Get the createdAt property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
    String
    getId()
    Get the id property: A unique identifier associated with this completions response.
    List<ContentFilterResultsForPrompt>
    getPromptFilterResults()
    Get the promptFilterResults property: Content filtering results for zero or more prompts in the request.
    String
    getSystemFingerprint()
    Get the systemFingerprint property: This fingerprint represents the backend configuration that the model runs with.
    CompletionsUsage
    getUsage()
    Get the usage property: Usage information for tokens processed and generated as part of this completions operation.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getId

      public String getId()
      Get the id property: A unique identifier associated with this completions response.
      Returns:
      the id value.

    • getChoices

      public List<Choice> getChoices()
      Get the choices property: The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.
      Returns:
      the choices value.

    • getUsage

      public CompletionsUsage getUsage()
      Get the usage property: Usage information for tokens processed and generated as part of this completions operation.
      Returns:
      the usage value.

    • getPromptFilterResults

      public List<ContentFilterResultsForPrompt> getPromptFilterResults()
      Get the promptFilterResults property: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.
      Returns:
      the promptFilterResults value.

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      Get the createdAt property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
      Returns:
      the createdAt value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<Completions>
      Throws:
      IOException

    • fromJson

      public static Completions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of Completions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of Completions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the Completions.

    • getSystemFingerprint

      public String getSystemFingerprint()
      Get the systemFingerprint property: 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.
      Returns:
      the systemFingerprint value.