ChatCompletion Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.0.0-preview.9.24556.5

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.

Represents the result of a chat completion request.

public ref class ChatCompletion

public class ChatCompletion

type ChatCompletion = class

Public Class ChatCompletion

Inheritance: Object
ChatCompletion

Derived: Microsoft.Extensions.AI.ChatCompletion<T>

Constructors

ChatCompletion(ChatMessage)	Initializes a new instance of the ChatCompletion class.
ChatCompletion(IList<ChatMessage>)	Initializes a new instance of the ChatCompletion class.

Properties

AdditionalProperties	Gets or sets any additional properties associated with the chat completion.
Choices	Gets or sets the list of chat completion choices.
CompletionId	Gets or sets the ID of the chat completion.
CreatedAt	Gets or sets a timestamp for the chat completion.
FinishReason	Gets or sets the reason for the chat completion.
Message	Gets the chat completion message.
ModelId	Gets or sets the model ID used in the creation of the chat completion.
RawRepresentation	Gets or sets the raw representation of the chat completion from an underlying implementation.
Usage	Gets or sets usage details for the chat completion.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object.

Applies to

Jaa