IFS.ai Token Consumption Report🆕¶
Related Links¶
Overview¶
The IFS.ai Token Consumption Report gives insights into customer token usage. This includes information about which entitlements were used, when they were used, and how many tokens were consumed etc. As token usage is not monitored by IFS for customers who maintain their solutions remotely, this report is only visible for customers who have set the deployment model as Cloud.
Definitions¶
Tokens: A token is a unit of value that represents a specific activity or service utilized by the Customer when accessing and using the IFS.ai Service. Tokens are consumed when users access or use certain features or services within the AI platform.
Batch of Tokens: A collective group of tokens that are active / valid between a specific date range.
AI Entitlements: Customer specific access to AI use cases / AI classes (e.g- IFS.ai).
AI Class: A specific category of IFS.ai functionality that allows IFS to group solutions or use cases. (e.g- The AI Class of the use case AI Copilot is Contextual Knowledge).
AI Use Case: A specific situation in which IFS.ai will assist a customer in an expected outcome. AI Use Cases are grouped by their AI Class.
Call Type: The call type refers to the method of communication with IFS.ai, which varies for each use case.
About the Report¶
Once you click Go to Service Insight Studio in a Build Place, you will be navigated to the Usage Report of the customer whose Build Place you are in. Once the IFS.ai Token Consumption option is selected from the left navigator, you will be navigated to the IFS.ai Token Consumption Report (Figure 1).
![]() |
---|
Figure 1 - IFS.ai Token Consumption Report |
In this report, the user can view the following:
- Tokens Available For Consumption: Total number of IFS.ai tokens that are available for the period.
- % of Active Tokens Consumed: IFS.ao tokens consumed as a percentage of total tokens available for the period.
- Forecasted Date of Active Tokens Running Out or Expiring: Based on the current usage, the forecasted date the tokens will run out or reach expiry.
- Expired Unused Tokens: Total number of unused IFS.ai tokens which are expired in a batch of tokens.
- Token Usage: A graph depicting the accumulated used and expired tokens, accumulated entitled tokens, accumulated expired unused tokens, and the projection of consumed tokens.
- Tokens Entitled By Batch: Batch-wise breakdown of total number of tokens purchased for a period with the effective date (valid from) and expiry date (valid until).
- Entitled Use Cases: The use cases which you are entitled to with the purchase of IFS.ai are depicted in green.
- Token Usage by AI class: This bar chart depicts the breakdown of token usage by AI class.
The report consists of two pages. The second page (Figure 2) can be accessed by clicking the Details button (Figure 1 - highlighted in red).
| |
| :----------------------------------------------------------: |
| Figure 2 - IFS.ai Token Consumption Report (Details page) |
In the detailed view, you can filter the graphs and statistics based on environment type, AI Class, AI Use Case, Call Type, and time period.
-
Token Usage Rate/day during active entitlement batch(es): The rate at which tokens are consumed per day for the active period.
-
Total Tokens Entitled By Batch: The original number of tokens purchased and the tokens currently remaining per batch. The validity period of the batch is also mentioned here.
-
Entitled Use Cases: Entitled use cases along with their call type.
-
Token Usage by Use Case: This graph shows the number of tokens used in each use case monthly.
Won't see the Report? Why?¶
There could be several reasons for this:
-
The deployment model of the logged in Build Place is remote - This means that the usage of such Build Places are not monitored by IFS. Hence, such customers will not see a token usage report generated by IFS. In such instances, you may see the following error message (Figure 3).
Figure 3 - IFS.ai Token Consumption Report Not Available for Remote BPs -
Data is not available to show - There could be instances where the usage data for the selected customer is not available at the moment. In such an instance, you are required to contact the IFS Support team to resolve the matter.
Note
If you don't have an IFS.ai subscription in place and try to execute an AI use case, you might encounter an error.