CompletionsUsage Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

CompletionsUsage.cs

Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and other consumers.

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

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

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

Inheritance

Object

CompletionsUsage

Implements

IJsonModel<CompletionsUsage> IPersistableModel<CompletionsUsage> IPersistableModel<T>

Properties

CompletionTokens	The number of tokens generated across all completions emissions.
PromptTokens	The number of tokens in the provided prompts for the completions request.
TotalTokens	The total number of tokens processed for the completions request and response.

Explicit Interface Implementations

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