UsageDetails Class

Usage details.

Constructor

UsageDetails(*args: Any, **kwargs: Any)

Variables

Name	Description
document_pages_minimal	int 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.
document_pages_basic	int 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.
document_pages_standard	int 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.
document_pages_minimal_inline	int The number of document pages processed at the minimal level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.
document_pages_basic_inline	int The number of document pages processed at the basic level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.
document_pages_standard_inline	int The number of document pages processed at the standard level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.
audio_hours	float The hours of audio processed.
video_hours	float The hours of video processed.
contextualization_tokens	int The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.
advanced_contextualization_tokens	int The number of advanced contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.
tokens	dict[str, int] The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output).

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

advanced_contextualization_tokens

The number of advanced contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.

advanced_contextualization_tokens: int | None

audio_hours

The hours of audio processed.

audio_hours: float | None

contextualization_tokens

The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.

contextualization_tokens: int | None

document_pages_basic

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.

document_pages_basic: int | None

document_pages_basic_inline

The number of document pages processed at the basic level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

document_pages_basic_inline: int | None

document_pages_minimal

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.

document_pages_minimal: int | None

document_pages_minimal_inline

The number of document pages processed at the minimal level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

document_pages_minimal_inline: int | None

document_pages_standard

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.

document_pages_standard: int | None

document_pages_standard_inline

The number of document pages processed at the standard level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.

document_pages_standard_inline: int | None

tokens

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

tokens: dict[str, int] | None

video_hours

The hours of video processed.

video_hours: float | None