ChatFinishDetails Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

ChatFinishDetails.cs

An abstract representation of structured information about why a chat completions response terminated. Please note ChatFinishDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MaxTokensFinishDetails and StopFinishDetails.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownChatFinishDetails))]
public abstract class ChatFinishDetails : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatFinishDetails>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatFinishDetails>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownChatFinishDetails))>]
type ChatFinishDetails = class
    interface IJsonModel<ChatFinishDetails>
    interface IPersistableModel<ChatFinishDetails>

Public MustInherit Class ChatFinishDetails
Implements IJsonModel(Of ChatFinishDetails), IPersistableModel(Of ChatFinishDetails)

Inheritance

Object

ChatFinishDetails

Derived

Azure.AI.OpenAI.MaxTokensFinishDetails

Azure.AI.OpenAI.StopFinishDetails

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<ChatFinishDetails> IPersistableModel<ChatFinishDetails> IPersistableModel<T>

Constructors

ChatFinishDetails()

Initializes a new instance of ChatFinishDetails.

Explicit Interface Implementations

IJsonModel<ChatFinishDetails>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ChatFinishDetails>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatFinishDetails>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ChatFinishDetails>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ChatFinishDetails>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.