This documentation supports the 20.02 version of BMC Helix Platform.

To view the documentation for the current version, select 20.08 from the Product version menu.

Measuring the cognitive service consumption

The BMC Helix Platform Cognitive Service consumption is measured by the API calls made for Classification, Summarization, and Tone Analyzer services. BMC Helix Chatbot service consumption has been changed from conversation-based to user-based. BMC SaaS Operations and administrators can monitor the consumption of cognitive service for these parameters, download the consumption reports, and configure email notifications that are sent when the consumption exceeds the specified threshold.  

Note

User based consumption for chatbot is not monitored in the telemetry dashboard for the 20.02 release.

By monitoring the cognitive service consumption, you can get answers to the following questions and make informed decisions:

  • How much of a service am I using?
  • How much of a service is overused?
  • Is there a need to purchase more capacity?

Cognitive service operations and their measure 

OperationParameter measured
Chat

Number of cognitive service chat conversations

The following actions are considered as a chat conversation:

  • When a chat session times out
  • When a developer clears the chat session to mark the session complete
  • When a conversation has 50 responses
ClassificationNumber of API calls made for Classification
SummarizationNumber of API calls made for Summarization
Tone AnalyzerNumber of API calls made for Tone Analyzer

Note

The cognitive search service consumption is not available in the 20.02 release.

Methods for monitoring cognitive service consumption

You can monitor the cognitive service consumption in the following ways:

  • View the Telemetry dashboard.
    The Telemetry dashboard displays cognitive service consumption statistics that enable an administrator to obtain a usage report for their company. 
    For more information about downloading the consumption statistics, see To download the cognitive service usage report from the Telemetry dashboard.
  • Configure the threshold and email notifications when the cognitive service usage exceeds a specified threshold.
    You can configure the email addresses and three thresholds each for API calls, document storage capacity, and conversation capacity.  For more information about configuring the threshold and email addresses for notifications, see 
    To configure thresholds and email notifications.

  • View the notification history
    The notification history displays the list of notifications that are triggered when the cognitive service usage exceeds the specified threshold. The notification history displays entries only after
    notifications are triggered. For more information, see To view the notifications history.

 To download the cognitive service usage report from the Telemetry dashboard

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Configure My Server > Telemetry
  3. The Telemetry dashboard displays statistics for each operation—Cognitive Service Chatbot Conversation, Cognitive Service Automation API Calls, and Cognitive Service Advanced Training Documents.

  4. Download the cognitive service usage report.

    1. Click Download.

    2. In the Download CSV File dialog box, select a predefined time or enter a specific period.
    3. Click Download.

The CSV report is downloaded. The following image shows a sample report:

Report details
Operation - Cognitive Service Chatbot and Cognitive Service Automation
Application – Name of the application that performed the operation
Period – Selected time period
Count – Total count of operations

 To configure thresholds and email notifications for cognitive service usage

The administrator can configure up to three thresholds and 10 email addresses.

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Configure My Server > Telemetry.
  3. Click the Notifications icon  that corresponds to the operation for which you want to configure the thresholds.
  4. Configure the capacity and threshold.
    1. In the Capacity section, enter the total capacity. 
      Example: In the Capacity section for Number of Conversations (N), enter 10,000. 
    2. In the Threshold 1 (%) field, enter the threshold for when you want to trigger the first notification. 
      Example: 50.  If the total capacity is 10,000 conversations, the first notification is triggered when the number of conversations exceed 5,000. 
    3. In the Threshold 2 (%) field, enter the threshold for when you want to trigger the second notification.
      Example: 75. If your total capacity is 10,000 conversations, then the second notification is triggered when the number of conversations exceed 7,500.
    4. In the Threshold 3 (%) field, enter the threshold for when you want to trigger the third notification. 
      Example: 90. If your total capacity is 10,000 conversations, then the third notification is triggered when the number of conversations exceed 9,000.

    Note

    If you change BMC Helix Chatbot consumption from conversation-based measurement to user-based measurement, you cannot update the thresholds and email notifications recipients list for BMC Helix Chatbot service. The thresholds and email notifications recipients list is updated for conversation-based measurement.

    You must contact BMC Support to update the thresholds and email notifications recipients list for user-based measurement.


  5. Configure the email addresses.
    1. From the Available Email Notifications recipients list, which displays the email addresses of all the users created in the Foundation data for a tenant, select the email addresses to which you want to send the cognitive service consumption notifications. You can select up to 10 email addresses. To add people to the Foundation data, see Creating or modifying Person data.
    2. To add the email addresses to the Selected Email Notifications Recipients list, click 
    3. Click Save. 

 To view the notification history

  1. Log in to BMC Helix Innovation Studio and navigate to Administration tab. 
  2. Select Configure My Server Telemetry.
  3. Click the Notifications icon  that corresponds to the operation for which you want to view the notifications history. 
  4. Click Notification History

Related Topics

BMC Helix Platform licensing model

Was this page helpful? Yes No Submitting... Thank you

Comments