ChatCompletions Class

Reference

Definition

Namespace:: Azure.AI.Inference

Assembly:: Azure.AI.Inference.dll

Package:: Azure.AI.Inference v1.0.0-beta.2

Source:: ChatCompletions.cs

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.Inference.ChatCompletions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.ChatCompletions>

type ChatCompletions = class
    interface IJsonModel<ChatCompletions>
    interface IPersistableModel<ChatCompletions>

Public Class ChatCompletions
Implements IJsonModel(Of ChatCompletions), IPersistableModel(Of ChatCompletions)

Inheritance: Object
ChatCompletions

Implements: IJsonModel<ChatCompletions> IPersistableModel<ChatCompletions> IPersistableModel<T>

Properties

Content	The contents of the message.
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.
FinishReason	The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.
Id	A unique identifier associated with this chat completions response.
Model	The model used for the chat completion.
Role	The role of the author of this message.
ToolCalls	The tool calls.
Usage	Usage information for tokens processed and generated as part of this completions operation.

Methods

ToString()

Returns text representation of the first part of the first choice.

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

Share via