Class: Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb,
sig/anthropic/models/beta/organization/beta_analytics_usage_users_item.rbs

Defined Under Namespace

Modules: InferenceGeo, Speed

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(actor:, cache_creation:, cache_read_input_tokens:, claude_tag_category:, claude_tag_user_id:, context_window:, ending_at:, inference_geo:, model:, output_tokens:, product:, rbac_group_id:, requests:, server_tool_use:, slack_channel_id:, speed:, starting_at:, total_tokens:, uncached_input_tokens:) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem for more details.

`group_

Parameters:

  • actor (Anthropic::Models::Beta::Organization::BetaAnalyticsUserActor) —

    The user this row's usage or cost is attributed to. Always a user_actor.

  • cache_creation (Anthropic::Models::Beta::BetaCacheCreation) —

    The number of input tokens for cache creation.

  • cache_read_input_tokens (Integer) —

    The number of input tokens read from the cache.

  • claude_tag_category (Symbol, Anthropic::Models::Beta::Organization::BetaAnalyticsClaudeTagCategory, nil) —

    Claude Tag (Claude in Slack) spend category: engaged (a person addressed Claud

  • claude_tag_user_id (String, nil) —

    Slack user ID (for example U0123ABCDEF) of the member the Claude Tag (Claude i

  • context_window (Symbol, Anthropic::Models::Beta::Organization::BetaAnalyticsContextWindow, nil) —

    Context-window pricing tier of the usage or cost. Null unless context_window i

  • ending_at (Time, nil) —

    End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to

  • inference_geo (Symbol, Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem::InferenceGeo, nil) —

    Inference region of the usage or cost. Null unless inference_geo is in

  • model (String, nil) —

    Model that produced the usage or cost, as a model name in the form the `models

  • output_tokens (Integer) —

    The number of output tokens generated.

  • product (String, nil) —

    Product surface that produced the usage or cost. Null unless product is in `grou

  • rbac_group_id (String, nil) —

    RBAC group (team) the usage is attributed to, in the public tagged `rbacgroup.

  • requests (Integer, nil) —

    Number of API requests in this row's scope. For sandbox / code-execution events,

  • server_tool_use (Anthropic::Models::Beta::Organization::BetaAnalyticsServerToolUse) —

    Server-side tool usage metrics.

  • slack_channel_id (String, nil) —

    Slack channel the usage originated from. Populated only when slack_channel_id

  • speed (Symbol, Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem::Speed, nil) —

    Inference speed mode of the usage or cost: fast or standard. Null unless `sp

  • starting_at (Time, nil) —

    Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null u

  • total_tokens (Integer) —

    Total token count across all token types. This is the value the default `order_b

  • uncached_input_tokens (Integer) —

    The number of uncached input tokens processed.




# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 172

Instance Attribute Details

#actor ⇒ Anthropic::Models::Beta::Organization::BetaAnalyticsUserActor

The user this row's usage or cost is attributed to. Always a user_actor.

Parameters:

  • value (Anthropic::Beta::Organization::BetaAnalyticsUserActor)

Returns:



12
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 12

required :actor, -> { Anthropic::Beta::Organization::BetaAnalyticsUserActor }

#cache_creation ⇒ Anthropic::Models::Beta::BetaCacheCreation

The number of input tokens for cache creation.

Parameters:

  • value (Anthropic::Beta::BetaCacheCreation)

Returns:



18
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 18

required :cache_creation, -> { Anthropic::Beta::BetaCacheCreation }

#cache_read_input_tokens ⇒ Integer

The number of input tokens read from the cache.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


24
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 24

required :cache_read_input_tokens, Integer

#claude_tag_category ⇒ Symbol, ...

Claude Tag (Claude in Slack) spend category: engaged (a person addressed Claude in a channel or thread), proactive (Claude responded without being addressed), scheduled (a scheduled routine ran), monitoring (Claude watching a channel it was asked to monitor), or dm (direct messages with Claude). Populated only when claude_tag_category is in group_by[]; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under claude-tag. New categories may be added over time.

Parameters:

  • value (Anthropic::Models::Beta::Organization::beta_analytics_claude_tag_category, nil)

Returns:



37
38
39
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 37

required :claude_tag_category,
enum: -> { Anthropic::Beta::Organization::BetaAnalyticsClaudeTagCategory },
nil?: true

#claude_tag_user_id ⇒ String?

Slack user ID (for example U0123ABCDEF) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when claude_tag_user_id is in group_by[]; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example monitoring, and proactive usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with group_by[]=rbac_group_id or the rbac_group_ids[] filter.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


51
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 51

required :claude_tag_user_id, String, nil?: true

#context_window ⇒ Symbol, ...

Context-window pricing tier of the usage or cost. Null unless context_window is in group_by[]; it can also be null on grouped rows with no context-window tier, such as code execution.

Parameters:

  • value (Anthropic::Models::Beta::Organization::beta_analytics_context_window, nil)

Returns:



59
60
61
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 59

required :context_window,
enum: -> { Anthropic::Beta::Organization::BetaAnalyticsContextWindow },
nil?: true

#ending_at ⇒ Time?

End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to starting_at plus one bucket_width. Null unless bucket_width is set.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


68
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 68

required :ending_at, Time, nil?: true

#inference_geo ⇒ Symbol, ...

Inference region of the usage or cost. Null unless inference_geo is in group_by[]; it can also be null on grouped rows where the region is not set (the rows that inference_geos[]=not_available matches).

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem::inference_geo, nil)

Returns:



76
77
78
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 76

required :inference_geo,
enum: -> { Anthropic::Beta::Organization::BetaAnalyticsUsageUsersItem::InferenceGeo },
nil?: true

#model ⇒ String?

Model that produced the usage or cost, as a model name in the form the models[] filter accepts (for example, claude-opus-5). Null unless model is in group_by[]; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


87
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 87

required :model, String, nil?: true

#output_tokens ⇒ Integer

The number of output tokens generated.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


93
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 93

required :output_tokens, Integer

#product ⇒ String?

Product surface that produced the usage or cost. Null unless product is in group_by[]; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include chat, claude_code, cowork, office_agent, claude_in_chrome, claude_design, and claude-tag. claude-tag is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as "other".

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


104
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 104

required :product, String, nil?: true

#rbac_group_id ⇒ String?

RBAC group (team) the usage is attributed to, in the public tagged rbac_group_... spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an rbac_group_ids[] filter value. Populated only when rbac_group_id is in group_by[]. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without group_by[].

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


118
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 118

required :rbac_group_id, String, nil?: true

#requests ⇒ Integer?

Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with product: null).

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


126
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 126

required :requests, Integer, nil?: true

#server_tool_use ⇒ Anthropic::Models::Beta::Organization::BetaAnalyticsServerToolUse

Server-side tool usage metrics.

Parameters:

  • value (Anthropic::Beta::Organization::BetaAnalyticsServerToolUse)

Returns:



132
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 132

required :server_tool_use, -> { Anthropic::Beta::Organization::BetaAnalyticsServerToolUse }

#slack_channel_id ⇒ String?

Slack channel the usage originated from. Populated only when slack_channel_id is in group_by[]; null for usage outside Slack (and for rows recorded before channel attribution was enabled).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


140
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 140

required :slack_channel_id, String, nil?: true

#speed ⇒ Symbol, ...

Inference speed mode of the usage or cost: fast or standard. Null unless speed is in group_by[].

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaAnalyticsUsageUsersItem::speed, nil)

Returns:



147
148
149
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 147

required :speed,
enum: -> { Anthropic::Beta::Organization::BetaAnalyticsUsageUsersItem::Speed },
nil?: true

#starting_at ⇒ Time?

Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless bucket_width is set; without bucket_width, each row aggregates the full requested range.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


157
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 157

required :starting_at, Time, nil?: true

#total_tokens ⇒ Integer

Total token count across all token types. This is the value the default order_by (total_tokens) sorts on.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


164
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 164

required :total_tokens, Integer

#uncached_input_tokens ⇒ Integer

The number of uncached input tokens processed.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


170
 
# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 170

required :uncached_input_tokens, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/anthropic/models/beta/organization/beta_analytics_usage_users_item.rb', line 227

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


89
 
# File 'sig/anthropic/models/beta/organization/beta_analytics_usage_users_item.rbs', line 89

def to_hash: -> {