Share via

UsageDetails Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.UsageDetails

Implements

JsonSerializable<UsageDetails>

public final class UsageDetails
implements JsonSerializable<UsageDetails>

Usage details.

Method Summary

Modifier and Type Method and Description
static UsageDetails fromJson(JsonReader jsonReader)

Reads an instance of UsageDetails from the JsonReader.
Double getAudioHours()

Get the audioHours property: The hours of audio processed.
Integer getContextualizationTokens()

Get the contextualizationTokens property: The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.
Integer getDocumentPagesBasic()

Get the documentPagesBasic property: The number of document pages processed at the basic level.
Integer getDocumentPagesMinimal()

Get the documentPagesMinimal property: The number of document pages processed at the minimal level.
Integer getDocumentPagesStandard()

Get the documentPagesStandard property: The number of document pages processed at the standard level.
Map<String,Integer> getTokens()

Get the tokens property: The number of LLM and embedding tokens consumed, grouped by model (ex.
Double getVideoHours()

Get the videoHours property: The hours of video processed.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static UsageDetails fromJson(JsonReader jsonReader)

Reads an instance of UsageDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of UsageDetails if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the UsageDetails.

getAudioHours

public Double getAudioHours()

Get the audioHours property: The hours of audio processed.

Returns:

the audioHours value.

getContextualizationTokens

public Integer getContextualizationTokens()

Get the contextualizationTokens property: The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.

Returns:

the contextualizationTokens value.

getDocumentPagesBasic

public Integer getDocumentPagesBasic()

Get the documentPagesBasic property: The number of document pages processed at the basic level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

Returns:

the documentPagesBasic value.

getDocumentPagesMinimal

public Integer getDocumentPagesMinimal()

Get the documentPagesMinimal property: The number of document pages processed at the minimal level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

Returns:

the documentPagesMinimal value.

getDocumentPagesStandard

public Integer getDocumentPagesStandard()

Get the documentPagesStandard property: The number of document pages processed at the standard level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

Returns:

the documentPagesStandard value.

getTokens

public Map<String,Integer> getTokens()

Get the tokens property: The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output).

Returns:

the tokens value.

getVideoHours

public Double getVideoHours()

Get the videoHours property: The hours of video processed.

Returns:

the videoHours value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to