[ aws . transcribe ]

create-call-analytics-category

Description

Creates a new Call Analytics category.

All categories are automatically applied to your Call Analytics jobs. Note that in order to apply your categories to your jobs, you must create them before submitting your job request, as categories cannot be applied retroactively.

Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

To update an existing category, see .

To learn more about:

• Call Analytics categories, see Creating categories

• Using rules, see Rule criteria and refer to the data type

• Call Analytics, see Analyzing call center audio with Call Analytics

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-call-analytics-category
--category-name <value>
--rules <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--category-name (string)

A unique name, chosen by you, for your Call Analytics category. It’s helpful to use a detailed naming system that will make sense to you in the future. For example, it’s better to use sentiment-positive-last30seconds for a category over a generic name like test-category .

Category names are case sensitive.

--rules (list)

Rules define a Call Analytics category. When creating a new Call Analytics category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer’s sentiment was positive during the last 30 seconds of the call.

(structure)

A rule is a set of criteria you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and . To learn more about these parameters, refer to Rule criteria .

To learn more about Call Analytics categories, see Creating categories .

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics .

NonTalkTimeFilter -> (structure)

Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

Threshold -> (long)

Specify the duration, in milliseconds, of the period of silence you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Negate -> (boolean)

Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

InterruptionFilter -> (structure)

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

Threshold -> (long)

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10000 milliseconds of interruptions.

ParticipantRole -> (string)

Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying both participants.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Negate -> (boolean)

Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

TranscriptFilter -> (structure)

Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

TranscriptFilterType -> (string)

Flag the presence or absence of an exact match to the phrases you specify. For example, if you specify the phrase “speak to a manager” as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says “speak to the manager”, instead of “speak to a manager”, your content is not flagged.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

ParticipantRole -> (string)

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Negate -> (boolean)

Set to TRUE to flag the absence of the phrase you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

Targets -> (list)

Specify the phrases you want to flag.

(string)

SentimentFilter -> (structure)

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

Sentiments -> (list)

Specify the sentiments you want to flag.

(string)

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

ParticipantRole -> (string)

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Negate -> (boolean)

Set to TRUE to flag the sentiments you didn’t include in your request. Set to FALSE to flag the sentiments you specified in your request.

Shorthand Syntax:

NonTalkTimeFilter={Threshold=long,AbsoluteTimeRange={StartTime=long,EndTime=long,First=long,Last=long},RelativeTimeRange={StartPercentage=integer,EndPercentage=integer,First=integer,Last=integer},Negate=boolean},InterruptionFilter={Threshold=long,ParticipantRole=string,AbsoluteTimeRange={StartTime=long,EndTime=long,First=long,Last=long},RelativeTimeRange={StartPercentage=integer,EndPercentage=integer,First=integer,Last=integer},Negate=boolean},TranscriptFilter={TranscriptFilterType=string,AbsoluteTimeRange={StartTime=long,EndTime=long,First=long,Last=long},RelativeTimeRange={StartPercentage=integer,EndPercentage=integer,First=integer,Last=integer},ParticipantRole=string,Negate=boolean,Targets=[string,string]},SentimentFilter={Sentiments=[string,string],AbsoluteTimeRange={StartTime=long,EndTime=long,First=long,Last=long},RelativeTimeRange={StartPercentage=integer,EndPercentage=integer,First=integer,Last=integer},ParticipantRole=string,Negate=boolean} ...

JSON Syntax:

[
  {
    "NonTalkTimeFilter": {
      "Threshold": long,
      "AbsoluteTimeRange": {
        "StartTime": long,
        "EndTime": long,
        "First": long,
        "Last": long
      },
      "RelativeTimeRange": {
        "StartPercentage": integer,
        "EndPercentage": integer,
        "First": integer,
        "Last": integer
      },
      "Negate": true|false
    },
    "InterruptionFilter": {
      "Threshold": long,
      "ParticipantRole": "AGENT"|"CUSTOMER",
      "AbsoluteTimeRange": {
        "StartTime": long,
        "EndTime": long,
        "First": long,
        "Last": long
      },
      "RelativeTimeRange": {
        "StartPercentage": integer,
        "EndPercentage": integer,
        "First": integer,
        "Last": integer
      },
      "Negate": true|false
    },
    "TranscriptFilter": {
      "TranscriptFilterType": "EXACT",
      "AbsoluteTimeRange": {
        "StartTime": long,
        "EndTime": long,
        "First": long,
        "Last": long
      },
      "RelativeTimeRange": {
        "StartPercentage": integer,
        "EndPercentage": integer,
        "First": integer,
        "Last": integer
      },
      "ParticipantRole": "AGENT"|"CUSTOMER",
      "Negate": true|false,
      "Targets": ["string", ...]
    },
    "SentimentFilter": {
      "Sentiments": ["POSITIVE"|"NEGATIVE"|"NEUTRAL"|"MIXED", ...],
      "AbsoluteTimeRange": {
        "StartTime": long,
        "EndTime": long,
        "First": long,
        "Last": long
      },
      "RelativeTimeRange": {
        "StartPercentage": integer,
        "EndPercentage": integer,
        "First": integer,
        "Last": integer
      },
      "ParticipantRole": "AGENT"|"CUSTOMER",
      "Negate": true|false
    }
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

CategoryProperties -> (structure)

Provides you with the properties of your new category, including its associated rules.

CategoryName -> (string)

The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.

Rules -> (list)

The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.

(structure)

A rule is a set of criteria you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and . To learn more about these parameters, refer to Rule criteria .

To learn more about Call Analytics categories, see Creating categories .

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics .

NonTalkTimeFilter -> (structure)

Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

Threshold -> (long)

Specify the duration, in milliseconds, of the period of silence you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Negate -> (boolean)

Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

InterruptionFilter -> (structure)

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

Threshold -> (long)

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10000 milliseconds of interruptions.

ParticipantRole -> (string)

Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying both participants.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Negate -> (boolean)

Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

TranscriptFilter -> (structure)

Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

TranscriptFilterType -> (string)

Flag the presence or absence of an exact match to the phrases you specify. For example, if you specify the phrase “speak to a manager” as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says “speak to the manager”, instead of “speak to a manager”, your content is not flagged.

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

ParticipantRole -> (string)

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Negate -> (boolean)

Set to TRUE to flag the absence of the phrase you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

Targets -> (list)

Specify the phrases you want to flag.

(string)

SentimentFilter -> (structure)

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

Sentiments -> (list)

Specify the sentiments you want to flag.

(string)

AbsoluteTimeRange -> (structure)

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

StartTime -> (long)

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime .

EndTime -> (long)

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime .

First -> (long)

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (long)

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

RelativeTimeRange -> (structure)

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

StartPercentage -> (integer)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage .

EndPercentage -> (integer)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage .

First -> (integer)

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Last -> (integer)

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

ParticipantRole -> (string)

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Negate -> (boolean)

Set to TRUE to flag the sentiments you didn’t include in your request. Set to FALSE to flag the sentiments you specified in your request.

CreateTime -> (timestamp)

The date and time the specified Call Analytics category was created.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

LastUpdateTime -> (timestamp)

The date and time the specified Call Analytics category was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.