A11 TypeScript API - v0.7.26
A11 guides
Python API
C++ internals
Preparing search index...
UsageAccounting
Interface UsageAccounting
Native usage collector with the same class identity as the SDK helper.
interface
UsageAccounting
{
coverage
:
"disabled"
|
"collecting"
|
"incomplete"
|
"reported_sources"
;
enabled
:
boolean
;
errors
:
Map
<
string
,
Status
>
;
finished
:
boolean
;
ledgers
:
Map
<
string
,
UsageLedger
>
;
sources
:
Map
<
string
,
StreamReference
>
;
collect
()
:
Promise
<
Status
>
;
descendantUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
;
directUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
;
totalUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
Index
Properties
coverage
enabled
errors
finished
ledgers
sources
Methods
collect
descendant
Usage
direct
Usage
total
Usage
Properties
Readonly
coverage
coverage
:
"disabled"
|
"collecting"
|
"incomplete"
|
"reported_sources"
Readonly
enabled
enabled
:
boolean
Readonly
errors
errors
:
Map
<
string
,
Status
>
Readonly
finished
finished
:
boolean
Readonly
ledgers
ledgers
:
Map
<
string
,
UsageLedger
>
Readonly
sources
sources
:
Map
<
string
,
StreamReference
>
Methods
collect
collect
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
descendant
Usage
descendantUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
Returns
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
direct
Usage
directUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
Returns
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
total
Usage
totalUsage
()
:
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
Returns
StatusOr
<
{
cache_write_tokens
?:
number
|
null
;
cached_input_tokens
?:
number
|
null
;
complete
?:
boolean
;
context_invalidated
?:
boolean
;
context_only
?:
boolean
;
context_source
?:
"unknown"
|
"request_estimate"
|
"reported"
|
null
;
context_tokens
?:
number
|
null
;
input_tokens
?:
number
|
null
;
input_tokens_scope
?:
"context"
|
"incremental"
;
output_tokens
?:
number
|
null
;
reasoning_tokens
?:
number
|
null
;
total_tokens
?:
number
|
null
;
usage_id
?:
string
|
null
;
usage_revision
?:
number
;
usage_scope
?:
"request"
|
"turn"
;
[
key
:
string
]:
unknown
;
}
,
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
coverage
enabled
errors
finished
ledgers
sources
Methods
collect
descendant
Usage
direct
Usage
total
Usage
A11 guides
Python API
C++ internals
A11 TypeScript API - v0.7.26
Loading...
Native usage collector with the same class identity as the SDK helper.