ChatTokenLogProbabilityResult Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

ChatTokenLogProbabilityResult.cs

A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.

public class ChatTokenLogProbabilityResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatTokenLogProbabilityResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatTokenLogProbabilityResult>

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

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

Inheritance

Object

ChatTokenLogProbabilityResult

Implements

IJsonModel<ChatTokenLogProbabilityResult> IPersistableModel<ChatTokenLogProbabilityResult> IPersistableModel<T>

Properties

LogProbability	The log probability of the message content token.
Token	The message content token.
TopLogProbabilityEntries	The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.
Utf8ByteValues	A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

Explicit Interface Implementations

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