Skip to content
Credits

Fundamentals of credits data modelling

Definitions

Section titled “Definitions”
  • Application ID — a unique identifier that defines the application consuming credits.
  • Application Name — the name of the application consuming credits. For example: Sketchup Web, Sketchup Mobile, Positioning Hub, and so on.
  • Feature ID — a unique identifier that defines an application’s feature.
  • Feature Name — the name of the feature consuming credits. For example: AI Image Generation, AI Vector Search, Point Cloud Generation, and so on.
  • Usage Event — whenever a feature is consumed by a user, the application sends a usage event to reduce the credit balance. This is detailed in the Ingest Usage Event API.
  • Event Type — describes the type of operation the feature consumes.
  • Event Measure — how much quantity of the event type was consumed by the usage event.
  • Rate Card — the number of credits consumed by one event measure, based on the feature ID and event type.
Section titled “Recommended naming convention for credits data modelling”
  • Feature ID — FEA_{TRIMBLE_BUSINESS_UNIT_ACRONYM}_{SUBJECT}
  • Event Type — EV_{UNIT_OF_MEASURE}_{VERSION}

Definitions:

  • Trimble Business Unit Acronym — a short 3- or 4-letter representation of the application’s business unit. For example, SKP for Sketchup, TAP for Trimble Advanced Positioning.
  • Subject — a short one- or two-word description of the feature. For example, AI_SUPPORT_CHAT, AI_IMAGE.
  • Unit of measure — a single unit that can be used to rate usage. For example, 1 IMAGE, 1 INPUT TOKEN, 1 OUTPUT TOKEN, 1 OBJECT.
  • Version — a standard version to allow uniqueness and seamless migration. For example, V1, V2.