ChatCompletions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public class ChatCompletions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatCompletions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatCompletions>
type ChatCompletions = class
interface IJsonModel<ChatCompletions>
interface IPersistableModel<ChatCompletions>
Public Class ChatCompletions
Implements IJsonModel(Of ChatCompletions), IPersistableModel(Of ChatCompletions)
- Inheritance
-
ChatCompletions
- Implements
Remarks
Chat completions can contain one or more chat choices, each holding a message with string content and an associated role. When requesting more than one completion, a corresponding number of additional choices will appear in the chat completions result.
Properties
Choices |
The collection of completions choices associated with this completions response.
Generally, |
Created |
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. |
Id |
A unique identifier associated with this chat completions response. |
Model |
The model name used for this completions request. |
PromptFilterResults |
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. |
SystemFingerprint |
Can be used in conjunction with the |
Usage |
Usage information for tokens processed and generated as part of this completions operation. |
Explicit Interface Implementations
IJsonModel<ChatCompletions>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<ChatCompletions>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<ChatCompletions>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<ChatCompletions>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<ChatCompletions>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Applies to
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for