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.
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.
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 D.
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: D[k] if k in D, else d. :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 D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :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 D.

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: D[k] if k in D, else d. :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	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D'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 D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :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 D's values

Attributes

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_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_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

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