com.azure.ai.openai.models.ChatCompletions.yml

### YamlMime:JavaType
uid: "com.azure.ai.openai.models.ChatCompletions"
fullName: "com.azure.ai.openai.models.ChatCompletions"
name: "ChatCompletions"
nameWithType: "ChatCompletions"
summary: "Representation of the response data from a chat completions request."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ChatCompletions**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.openai.models.ChatCompletions?alt=com.azure.ai.openai.models.ChatCompletions&text=ChatCompletions\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.ai.openai.models.ChatCompletions.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.ai.openai.models.ChatCompletions.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ChatCompletions.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Chat<wbr>Completions from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ChatCompletions fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of ChatCompletions from the JsonReader."
  returns:
    description: "An instance of ChatCompletions if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.ai.openai.models.ChatCompletions?alt=com.azure.ai.openai.models.ChatCompletions&text=ChatCompletions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.ChatCompletions.getChoices()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getChoices()"
  name: "getChoices()"
  nameWithType: "ChatCompletions.getChoices()"
  summary: "Get the choices property: The collection of completions choices associated with this completions response."
  syntax: "public List<ChatChoice> getChoices()"
  desc: "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:
    description: "the choices value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.ai.openai.models.ChatChoice?alt=com.azure.ai.openai.models.ChatChoice&text=ChatChoice\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.ai.openai.models.ChatCompletions.getCreatedAt()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getCreatedAt()"
  name: "getCreatedAt()"
  nameWithType: "ChatCompletions.getCreatedAt()"
  summary: "Get the created<wbr>At 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."
  syntax: "public OffsetDateTime getCreatedAt()"
  desc: "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:
    description: "the createdAt value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.ai.openai.models.ChatCompletions.getId()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getId()"
  name: "getId()"
  nameWithType: "ChatCompletions.getId()"
  summary: "Get the id property: A unique identifier associated with this chat completions response."
  syntax: "public String getId()"
  desc: "Get the id property: A unique identifier associated with this chat completions response."
  returns:
    description: "the id value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.ChatCompletions.getModel()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getModel()"
  name: "getModel()"
  nameWithType: "ChatCompletions.getModel()"
  summary: "Get the model property: The model name used for this completions request."
  syntax: "public String getModel()"
  desc: "Get the model property: The model name used for this completions request."
  returns:
    description: "the model value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.ChatCompletions.getPromptFilterResults()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getPromptFilterResults()"
  name: "getPromptFilterResults()"
  nameWithType: "ChatCompletions.getPromptFilterResults()"
  summary: "Get the prompt<wbr>Filter<wbr>Results property: Content filtering results for zero or more prompts in the request."
  syntax: "public List<ContentFilterResultsForPrompt> getPromptFilterResults()"
  desc: "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:
    description: "the promptFilterResults value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.ai.openai.models.ContentFilterResultsForPrompt?alt=com.azure.ai.openai.models.ContentFilterResultsForPrompt&text=ContentFilterResultsForPrompt\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.ai.openai.models.ChatCompletions.getSystemFingerprint()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getSystemFingerprint()"
  name: "getSystemFingerprint()"
  nameWithType: "ChatCompletions.getSystemFingerprint()"
  summary: "Get the system<wbr>Fingerprint property: Can be used in conjunction with the \\`seed\\` request parameter to understand when backend changes have been made that might impact determinism."
  syntax: "public String getSystemFingerprint()"
  desc: "Get the systemFingerprint property: Can be used in conjunction with the \\`seed\\` request parameter to understand when backend changes have been made that might impact determinism."
  returns:
    description: "the systemFingerprint value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.ChatCompletions.getUsage()"
  fullName: "com.azure.ai.openai.models.ChatCompletions.getUsage()"
  name: "getUsage()"
  nameWithType: "ChatCompletions.getUsage()"
  summary: "Get the usage property: Usage information for tokens processed and generated as part of this completions operation."
  syntax: "public CompletionsUsage getUsage()"
  desc: "Get the usage property: Usage information for tokens processed and generated as part of this completions operation."
  returns:
    description: "the usage value."
    type: "<xref href=\"com.azure.ai.openai.models.CompletionsUsage?alt=com.azure.ai.openai.models.CompletionsUsage&text=CompletionsUsage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.ChatCompletions.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.ai.openai.models.ChatCompletions.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ChatCompletions.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "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."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.openai.models.ChatCompletions?alt=com.azure.ai.openai.models.ChatCompletions&text=ChatCompletions\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.ai.openai.models"
artifact: com.azure:azure-ai-openai:1.0.0-beta.9