Package com.azure.ai.openai.models

Class ChatCompletions

java.lang.Object
com.azure.ai.openai.models.ChatCompletions
public final class ChatCompletions extends Object
Representation of the response data from a chat 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
    List<ChatChoice>
    getChoices()
    Get the choices property: The collection of completions choices associated with this completions response.
    int
    getCreated()
    Get the created 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 chat completions response.
    CompletionsUsage
    getUsage()
    Get the usage property: Usage information for tokens processed and generated as part of this completions operation.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getId

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

    • getCreated

      public int getCreated()
      Get the created 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 created value.

    • getChoices

      public List<ChatChoice> 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.