CreateCallAnalyticsCategory - Amazon Transcribe

CreateCallAnalyticsCategory

Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.

Request Syntax

{ "CategoryName": "string", "Rules": [ { "InterruptionFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "NonTalkTimeFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "SentimentFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Sentiments": [ "string" ] }, "TranscriptFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Targets": [ "string" ], "TranscriptFilterType": "string" } } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CategoryName

The name that you choose for your category when you create it.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

Rules

To create a category, you must specify between 1 and 20 rules. For each rule, you specify a filter to be applied to the attributes of the call. For example, you can specify a sentiment filter to detect if the customer's sentiment was negative or neutral.

Type: Array of Rule objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax

{ "CategoryProperties": { "CategoryName": "string", "CreateTime": number, "LastUpdateTime": number, "Rules": [ { "InterruptionFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "NonTalkTimeFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "SentimentFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Sentiments": [ "string" ] }, "TranscriptFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Targets": [ "string" ], "TranscriptFilterType": "string" } } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CategoryProperties

The rules and associated metadata used to create a category.

Type: CategoryProperties object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

HTTP Status Code: 400

ConflictException

There is already a resource with that name.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message and try your request again.

HTTP Status Code: 500

LimitExceededException

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: