Amazon Transcribe Service

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

{'CategoryProperties': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Creates a new Call Analytics category.

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

When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

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 for post-call transcriptions and Creating categories for real-time transcriptions.

See also: AWS API Documentation

Request Syntax

client.create_call_analytics_category(
    CategoryName='string',
    Rules=[
        {
            'NonTalkTimeFilter': {
                'Threshold': 123,
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'Negate': True|False
            },
            'InterruptionFilter': {
                'Threshold': 123,
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'Negate': True|False
            },
            'TranscriptFilter': {
                'TranscriptFilterType': 'EXACT',
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'Negate': True|False,
                'Targets': [
                    'string',
                ]
            },
            'SentimentFilter': {
                'Sentiments': [
                    'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                ],
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'Negate': True|False
            }
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    InputType='REAL_TIME'|'POST_CALL'
)

type CategoryName:

string

param CategoryName:

[REQUIRED]

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.

type Rules:

list

param Rules:

[REQUIRED]

Rules define a Call Analytics category. When creating a new 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.

• (dict) --

  A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

  • NonTalkTimeFilter (dict) --

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

    • Threshold (integer) --

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

    • AbsoluteTimeRange (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • Negate (boolean) --

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

  • InterruptionFilter (dict) --

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

    • Threshold (integer) --

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

    • ParticipantRole (string) --

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

    • AbsoluteTimeRange (dict) --

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

      • StartTime (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • Negate (boolean) --

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

  • TranscriptFilter (dict) --

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

    • TranscriptFilterType (string) -- [REQUIRED]

      Flag the presence or absence of an exact match to the phrases that 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 (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • ParticipantRole (string) --

      Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

    • Targets (list) -- [REQUIRED]

      Specify the phrases that you want to flag.

      • (string) --

  • SentimentFilter (dict) --

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

    • Sentiments (list) -- [REQUIRED]

      Specify the sentiments that you want to flag.

      • (string) --

    • AbsoluteTimeRange (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • ParticipantRole (string) --

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

    • Negate (boolean) --

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

type Tags:

list

param Tags:

Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

• (dict) --

  Adds metadata, in the form of a key:value pair, to the specified resource.

  For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

  To learn more about tagging, see Tagging resources.

  • Key (string) -- [REQUIRED]

    The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

  • Value (string) -- [REQUIRED]

    The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

    Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

type InputType:

string

param InputType:

Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

If you do not include InputType, your category is created as a post-call category by default.

rtype:

dict

returns:

Response Syntax

{
    'CategoryProperties': {
        'CategoryName': 'string',
        'Rules': [
            {
                'NonTalkTimeFilter': {
                    'Threshold': 123,
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'InterruptionFilter': {
                    'Threshold': 123,
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'TranscriptFilter': {
                    'TranscriptFilterType': 'EXACT',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False,
                    'Targets': [
                        'string',
                    ]
                },
                'SentimentFilter': {
                    'Sentiments': [
                        'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                    ],
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False
                }
            },
        ],
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'InputType': 'REAL_TIME'|'POST_CALL'
    }
}

Response Structure

• (dict) --

  • CategoryProperties (dict) --

    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.

      • (dict) --

        A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

        • NonTalkTimeFilter (dict) --

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

          • Threshold (integer) --

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

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • InterruptionFilter (dict) --

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

          • Threshold (integer) --

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

          • ParticipantRole (string) --

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

          • AbsoluteTimeRange (dict) --

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

            • StartTime (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • TranscriptFilter (dict) --

          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 that 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 (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

            Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

          • Targets (list) --

            Specify the phrases that you want to flag.

            • (string) --

        • SentimentFilter (dict) --

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

          • Sentiments (list) --

            Specify the sentiments that you want to flag.

            • (string) --

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

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

          • Negate (boolean) --

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

    • CreateTime (datetime) --

      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 (datetime) --

      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.

    • Tags (list) --

      The tags, each in the form of a key:value pair, assigned to the specified call analytics category.

      • (dict) --

        Adds metadata, in the form of a key:value pair, to the specified resource.

        For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

        To learn more about tagging, see Tagging resources.

        • Key (string) --

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

        • Value (string) --

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

          Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

    • InputType (string) --

      The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

{'CategoryProperties': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Provides information about the specified Call Analytics category.

To get a list of your Call Analytics categories, use the operation.

See also: AWS API Documentation

Request Syntax

client.get_call_analytics_category(
    CategoryName='string'
)

type CategoryName:

string

param CategoryName:

[REQUIRED]

The name of the Call Analytics category you want information about. Category names are case sensitive.

rtype:

dict

returns:

Response Syntax

{
    'CategoryProperties': {
        'CategoryName': 'string',
        'Rules': [
            {
                'NonTalkTimeFilter': {
                    'Threshold': 123,
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'InterruptionFilter': {
                    'Threshold': 123,
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'TranscriptFilter': {
                    'TranscriptFilterType': 'EXACT',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False,
                    'Targets': [
                        'string',
                    ]
                },
                'SentimentFilter': {
                    'Sentiments': [
                        'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                    ],
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False
                }
            },
        ],
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'InputType': 'REAL_TIME'|'POST_CALL'
    }
}

Response Structure

• (dict) --

  • CategoryProperties (dict) --

    Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.

    • 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.

      • (dict) --

        A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

        • NonTalkTimeFilter (dict) --

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

          • Threshold (integer) --

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

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • InterruptionFilter (dict) --

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

          • Threshold (integer) --

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

          • ParticipantRole (string) --

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

          • AbsoluteTimeRange (dict) --

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

            • StartTime (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • TranscriptFilter (dict) --

          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 that 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 (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

            Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

          • Targets (list) --

            Specify the phrases that you want to flag.

            • (string) --

        • SentimentFilter (dict) --

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

          • Sentiments (list) --

            Specify the sentiments that you want to flag.

            • (string) --

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

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

          • Negate (boolean) --

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

    • CreateTime (datetime) --

      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 (datetime) --

      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.

    • Tags (list) --

      The tags, each in the form of a key:value pair, assigned to the specified call analytics category.

      • (dict) --

        Adds metadata, in the form of a key:value pair, to the specified resource.

        For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

        To learn more about tagging, see Tagging resources.

        • Key (string) --

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

        • Value (string) --

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

          Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

    • InputType (string) --

      The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

{'CallAnalyticsJob': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Provides information about the specified Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

To get a list of your Call Analytics jobs, use the operation.

See also: AWS API Documentation

Request Syntax

client.get_call_analytics_job(
    CallAnalyticsJobName='string'
)

type CallAnalyticsJobName:

string

param CallAnalyticsJobName:

[REQUIRED]

The name of the Call Analytics job you want information about. Job names are case sensitive.

rtype:

dict

returns:

Response Syntax

{
    'CallAnalyticsJob': {
        'CallAnalyticsJobName': 'string',
        'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'CallAnalyticsJobDetails': {
            'Skipped': [
                {
                    'Feature': 'GENERATIVE_SUMMARIZATION',
                    'ReasonCode': 'INSUFFICIENT_CONVERSATION_CONTENT'|'FAILED_SAFETY_GUIDELINES',
                    'Message': 'string'
                },
            ]
        },
        'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm'|'m4a',
        'Media': {
            'MediaFileUri': 'string',
            'RedactedMediaFileUri': 'string'
        },
        'Transcript': {
            'TranscriptFileUri': 'string',
            'RedactedTranscriptFileUri': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'CompletionTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'DataAccessRoleArn': 'string',
        'IdentifiedLanguageScore': ...,
        'Settings': {
            'VocabularyName': 'string',
            'VocabularyFilterName': 'string',
            'VocabularyFilterMethod': 'remove'|'mask'|'tag',
            'LanguageModelName': 'string',
            'ContentRedaction': {
                'RedactionType': 'PII',
                'RedactionOutput': 'redacted'|'redacted_and_unredacted',
                'PiiEntityTypes': [
                    'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'ALL',
                ]
            },
            'LanguageOptions': [
                'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
            ],
            'LanguageIdSettings': {
                'string': {
                    'VocabularyName': 'string',
                    'VocabularyFilterName': 'string',
                    'LanguageModelName': 'string'
                }
            },
            'Summarization': {
                'GenerateAbstractiveSummary': True|False
            }
        },
        'ChannelDefinitions': [
            {
                'ChannelId': 123,
                'ParticipantRole': 'AGENT'|'CUSTOMER'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • CallAnalyticsJob (dict) --

    Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

    • CallAnalyticsJobName (string) --

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

    • CallAnalyticsJobStatus (string) --

      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

    • CallAnalyticsJobDetails (dict) --

      Provides detailed information about a call analytics job, including information about skipped analytics features.

      • Skipped (list) --

        Contains information about any skipped analytics features during the analysis of a call analytics job.

        This array lists all the analytics features that were skipped, along with their corresponding reason code and message.

        • (dict) --

          Represents a skipped analytics feature during the analysis of a call analytics job.

          The Feature field indicates the type of analytics feature that was skipped.

          The Message field contains additional information or a message explaining why the analytics feature was skipped.

          The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.

          • Feature (string) --

            Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.

          • ReasonCode (string) --

            Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.

          • Message (string) --

            Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.

    • LanguageCode (string) --

      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

    • MediaSampleRateHertz (integer) --

      The sample rate, in hertz, of the audio track in your input media file.

    • MediaFormat (string) --

      The format of the input media file.

    • Media (dict) --

      Provides the Amazon S3 location of the media file you used in your Call Analytics request.

      • MediaFileUri (string) --

        The Amazon S3 location of the media file you want to transcribe. For example:

        • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

        • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

        Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

      • RedactedMediaFileUri (string) --

        The Amazon S3 location of the media file you want to redact. For example:

        • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

        • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

        Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

    • Transcript (dict) --

      Provides you with the Amazon S3 URI you can use to access your transcript.

      • TranscriptFileUri (string) --

        The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

        If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

        If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

      • RedactedTranscriptFileUri (string) --

        The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.

        If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

        If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

    • StartTime (datetime) --

      The date and time the specified Call Analytics job began processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • CreationTime (datetime) --

      The date and time the specified Call Analytics job request was made.

      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 a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • CompletionTime (datetime) --

      The date and time the specified Call Analytics job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

    • FailureReason (string) --

      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

      • The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

    • DataAccessRoleArn (string) --

      The Amazon Resource Name (ARN) you included in your request.

    • IdentifiedLanguageScore (float) --

      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

    • Settings (dict) --

      Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

      • VocabularyName (string) --

        The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

      • VocabularyFilterName (string) --

        The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

        Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

      • VocabularyFilterMethod (string) --

        Specify how you want your custom vocabulary filter applied to your transcript.

        To replace words with ***, choose mask.

        To delete words, choose remove.

        To flag words without changing them, choose tag.

      • LanguageModelName (string) --

        The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

        The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

      • ContentRedaction (dict) --

        Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

        • RedactionType (string) --

          Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

        • RedactionOutput (string) --

          Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

          When you choose redacted Amazon Transcribe creates only a redacted transcript.

          When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

        • PiiEntityTypes (list) --

          Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

          • (string) --

      • LanguageOptions (list) --

        You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

        Including language options can improve the accuracy of language identification.

        For a list of languages supported with Call Analytics, refer to the Supported languages table.

        To transcribe speech in Modern Standard Arabic ( ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

        • (string) --

      • LanguageIdSettings (dict) --

        If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

        LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

        It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

        If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

        For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

        • (string) --

          • (dict) --

            If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models.

            LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

            It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

            If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

            • VocabularyName (string) --

              The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.

              The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

            • VocabularyFilterName (string) --

              The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.

              The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

              Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

            • LanguageModelName (string) --

              The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

              The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

      • Summarization (dict) --

        Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

        • GenerateAbstractiveSummary (boolean) --

          Enables Generative call summarization in your Call Analytics request

          Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

          For more information, see Enabling generative call summarization.

    • ChannelDefinitions (list) --

      Indicates which speaker is on which channel.

      • (dict) --

        Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

        • ChannelId (integer) --

          Specify the audio channel you want to define.

        • ParticipantRole (string) --

          Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

    • Tags (list) --

      The tags, each in the form of a key:value pair, assigned to the specified call analytics job.

      • (dict) --

        Adds metadata, in the form of a key:value pair, to the specified resource.

        For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

        To learn more about tagging, see Tagging resources.

        • Key (string) --

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

        • Value (string) --

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

          Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

{'Categories': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Provides a list of Call Analytics categories, including all rules that make up each category.

To get detailed information about a specific Call Analytics category, use the operation.

See also: AWS API Documentation

Request Syntax

client.list_call_analytics_categories(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

type MaxResults:

integer

param MaxResults:

The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Categories': [
        {
            'CategoryName': 'string',
            'Rules': [
                {
                    'NonTalkTimeFilter': {
                        'Threshold': 123,
                        'AbsoluteTimeRange': {
                            'StartTime': 123,
                            'EndTime': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'RelativeTimeRange': {
                            'StartPercentage': 123,
                            'EndPercentage': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'Negate': True|False
                    },
                    'InterruptionFilter': {
                        'Threshold': 123,
                        'ParticipantRole': 'AGENT'|'CUSTOMER',
                        'AbsoluteTimeRange': {
                            'StartTime': 123,
                            'EndTime': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'RelativeTimeRange': {
                            'StartPercentage': 123,
                            'EndPercentage': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'Negate': True|False
                    },
                    'TranscriptFilter': {
                        'TranscriptFilterType': 'EXACT',
                        'AbsoluteTimeRange': {
                            'StartTime': 123,
                            'EndTime': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'RelativeTimeRange': {
                            'StartPercentage': 123,
                            'EndPercentage': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'ParticipantRole': 'AGENT'|'CUSTOMER',
                        'Negate': True|False,
                        'Targets': [
                            'string',
                        ]
                    },
                    'SentimentFilter': {
                        'Sentiments': [
                            'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                        ],
                        'AbsoluteTimeRange': {
                            'StartTime': 123,
                            'EndTime': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'RelativeTimeRange': {
                            'StartPercentage': 123,
                            'EndPercentage': 123,
                            'First': 123,
                            'Last': 123
                        },
                        'ParticipantRole': 'AGENT'|'CUSTOMER',
                        'Negate': True|False
                    }
                },
            ],
            'CreateTime': datetime(2015, 1, 1),
            'LastUpdateTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'InputType': 'REAL_TIME'|'POST_CALL'
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

  • Categories (list) --

    Provides detailed information about your Call Analytics categories, including all the rules associated with each category.

    • (dict) --

      Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

      • 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.

        • (dict) --

          A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

          • NonTalkTimeFilter (dict) --

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

            • Threshold (integer) --

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

            • AbsoluteTimeRange (dict) --

              Makes it possible 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 (integer) --

                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 (integer) --

                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 (integer) --

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

              • Last (integer) --

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

            • RelativeTimeRange (dict) --

              Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

              • Last (integer) --

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

            • Negate (boolean) --

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

          • InterruptionFilter (dict) --

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

            • Threshold (integer) --

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

            • ParticipantRole (string) --

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

            • AbsoluteTimeRange (dict) --

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

              • StartTime (integer) --

                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 (integer) --

                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 (integer) --

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

              • Last (integer) --

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

            • RelativeTimeRange (dict) --

              Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

              • Last (integer) --

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

            • Negate (boolean) --

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

          • TranscriptFilter (dict) --

            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 that 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 (dict) --

              Makes it possible 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 (integer) --

                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 (integer) --

                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 (integer) --

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

              • Last (integer) --

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

            • RelativeTimeRange (dict) --

              Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

              • Last (integer) --

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

            • ParticipantRole (string) --

              Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

            • Targets (list) --

              Specify the phrases that you want to flag.

              • (string) --

          • SentimentFilter (dict) --

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

            • Sentiments (list) --

              Specify the sentiments that you want to flag.

              • (string) --

            • AbsoluteTimeRange (dict) --

              Makes it possible 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 (integer) --

                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 (integer) --

                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 (integer) --

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

              • Last (integer) --

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

            • RelativeTimeRange (dict) --

              Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

              • Last (integer) --

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

            • ParticipantRole (string) --

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

            • Negate (boolean) --

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

      • CreateTime (datetime) --

        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 (datetime) --

        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.

      • Tags (list) --

        The tags, each in the form of a key:value pair, assigned to the specified call analytics category.

        • (dict) --

          Adds metadata, in the form of a key:value pair, to the specified resource.

          For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

          To learn more about tagging, see Tagging resources.

          • Key (string) --

            The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

          • Value (string) --

            The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

            Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

      • InputType (string) --

        The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

{'CallAnalyticsJob': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.

If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

Note that job queuing is enabled by default for Call Analytics jobs.

You must include the following parameters in your StartCallAnalyticsJob request:

• region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

• CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.

• DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

• Media ( MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

See also: AWS API Documentation

Request Syntax

client.start_call_analytics_job(
    CallAnalyticsJobName='string',
    Media={
        'MediaFileUri': 'string',
        'RedactedMediaFileUri': 'string'
    },
    OutputLocation='string',
    OutputEncryptionKMSKeyId='string',
    DataAccessRoleArn='string',
    Settings={
        'VocabularyName': 'string',
        'VocabularyFilterName': 'string',
        'VocabularyFilterMethod': 'remove'|'mask'|'tag',
        'LanguageModelName': 'string',
        'ContentRedaction': {
            'RedactionType': 'PII',
            'RedactionOutput': 'redacted'|'redacted_and_unredacted',
            'PiiEntityTypes': [
                'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'ALL',
            ]
        },
        'LanguageOptions': [
            'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
        ],
        'LanguageIdSettings': {
            'string': {
                'VocabularyName': 'string',
                'VocabularyFilterName': 'string',
                'LanguageModelName': 'string'
            }
        },
        'Summarization': {
            'GenerateAbstractiveSummary': True|False
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ChannelDefinitions=[
        {
            'ChannelId': 123,
            'ParticipantRole': 'AGENT'|'CUSTOMER'
        },
    ]
)

type CallAnalyticsJobName:

string

param CallAnalyticsJobName:

[REQUIRED]

A unique name, chosen by you, for your Call Analytics job.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

type Media:

dict

param Media:

[REQUIRED]

Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.

• MediaFileUri (string) --

  The Amazon S3 location of the media file you want to transcribe. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

• RedactedMediaFileUri (string) --

  The Amazon S3 location of the media file you want to redact. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

type OutputLocation:

string

param OutputLocation:

The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:

• s3://DOC-EXAMPLE-BUCKET

• s3://DOC-EXAMPLE-BUCKET/my-output-folder/

• s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

If you do not specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

type OutputEncryptionKMSKeyId:

string

param OutputEncryptionKMSKeyId:

The KMS key you want to use to encrypt your Call Analytics output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

• Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Use an alias for the KMS key ID. For example, alias/ExampleAlias.

• Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

• Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the role making the request must have permission to use the specified KMS key.

type DataAccessRoleArn:

string

param DataAccessRoleArn:

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

type Settings:

dict

param Settings:

Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

• VocabularyName (string) --

  The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

• VocabularyFilterName (string) --

  The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

  Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

• VocabularyFilterMethod (string) --

  Specify how you want your custom vocabulary filter applied to your transcript.

  To replace words with ***, choose mask.

  To delete words, choose remove.

  To flag words without changing them, choose tag.

• LanguageModelName (string) --

  The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

  The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

• ContentRedaction (dict) --

  Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

  • RedactionType (string) -- [REQUIRED]

    Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

  • RedactionOutput (string) -- [REQUIRED]

    Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

    When you choose redacted Amazon Transcribe creates only a redacted transcript.

    When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

  • PiiEntityTypes (list) --

    Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

    • (string) --

• LanguageOptions (list) --

  You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

  Including language options can improve the accuracy of language identification.

  For a list of languages supported with Call Analytics, refer to the Supported languages table.

  To transcribe speech in Modern Standard Arabic ( ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

  • (string) --

• LanguageIdSettings (dict) --

  If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

  LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

  It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

  If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

  For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

  • (string) --

    • (dict) --

      If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models.

      LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

      It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

      If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

      • VocabularyName (string) --

        The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.

        The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

      • VocabularyFilterName (string) --

        The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.

        The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

        Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

      • LanguageModelName (string) --

        The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

        The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

• Summarization (dict) --

  Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

  • GenerateAbstractiveSummary (boolean) -- [REQUIRED]

    Enables Generative call summarization in your Call Analytics request

    Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

    For more information, see Enabling generative call summarization.

type Tags:

list

param Tags:

Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

• (dict) --

  Adds metadata, in the form of a key:value pair, to the specified resource.

  For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

  To learn more about tagging, see Tagging resources.

  • Key (string) -- [REQUIRED]

    The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

  • Value (string) -- [REQUIRED]

    The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

    Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

type ChannelDefinitions:

list

param ChannelDefinitions:

Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

• (dict) --

  Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

  • ChannelId (integer) --

    Specify the audio channel you want to define.

  • ParticipantRole (string) --

    Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

rtype:

dict

returns:

Response Syntax

{
    'CallAnalyticsJob': {
        'CallAnalyticsJobName': 'string',
        'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'CallAnalyticsJobDetails': {
            'Skipped': [
                {
                    'Feature': 'GENERATIVE_SUMMARIZATION',
                    'ReasonCode': 'INSUFFICIENT_CONVERSATION_CONTENT'|'FAILED_SAFETY_GUIDELINES',
                    'Message': 'string'
                },
            ]
        },
        'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm'|'m4a',
        'Media': {
            'MediaFileUri': 'string',
            'RedactedMediaFileUri': 'string'
        },
        'Transcript': {
            'TranscriptFileUri': 'string',
            'RedactedTranscriptFileUri': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'CompletionTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'DataAccessRoleArn': 'string',
        'IdentifiedLanguageScore': ...,
        'Settings': {
            'VocabularyName': 'string',
            'VocabularyFilterName': 'string',
            'VocabularyFilterMethod': 'remove'|'mask'|'tag',
            'LanguageModelName': 'string',
            'ContentRedaction': {
                'RedactionType': 'PII',
                'RedactionOutput': 'redacted'|'redacted_and_unredacted',
                'PiiEntityTypes': [
                    'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'ALL',
                ]
            },
            'LanguageOptions': [
                'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
            ],
            'LanguageIdSettings': {
                'string': {
                    'VocabularyName': 'string',
                    'VocabularyFilterName': 'string',
                    'LanguageModelName': 'string'
                }
            },
            'Summarization': {
                'GenerateAbstractiveSummary': True|False
            }
        },
        'ChannelDefinitions': [
            {
                'ChannelId': 123,
                'ParticipantRole': 'AGENT'|'CUSTOMER'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • CallAnalyticsJob (dict) --

    Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.

    • CallAnalyticsJobName (string) --

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

    • CallAnalyticsJobStatus (string) --

      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

    • CallAnalyticsJobDetails (dict) --

      Provides detailed information about a call analytics job, including information about skipped analytics features.

      • Skipped (list) --

        Contains information about any skipped analytics features during the analysis of a call analytics job.

        This array lists all the analytics features that were skipped, along with their corresponding reason code and message.

        • (dict) --

          Represents a skipped analytics feature during the analysis of a call analytics job.

          The Feature field indicates the type of analytics feature that was skipped.

          The Message field contains additional information or a message explaining why the analytics feature was skipped.

          The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.

          • Feature (string) --

            Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.

          • ReasonCode (string) --

            Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.

          • Message (string) --

            Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.

    • LanguageCode (string) --

      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

    • MediaSampleRateHertz (integer) --

      The sample rate, in hertz, of the audio track in your input media file.

    • MediaFormat (string) --

      The format of the input media file.

    • Media (dict) --

      Provides the Amazon S3 location of the media file you used in your Call Analytics request.

      • MediaFileUri (string) --

        The Amazon S3 location of the media file you want to transcribe. For example:

        • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

        • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

        Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

      • RedactedMediaFileUri (string) --

        The Amazon S3 location of the media file you want to redact. For example:

        • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

        • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

        Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

    • Transcript (dict) --

      Provides you with the Amazon S3 URI you can use to access your transcript.

      • TranscriptFileUri (string) --

        The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

        If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

        If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

      • RedactedTranscriptFileUri (string) --

        The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.

        If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

        If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

    • StartTime (datetime) --

      The date and time the specified Call Analytics job began processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • CreationTime (datetime) --

      The date and time the specified Call Analytics job request was made.

      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 a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • CompletionTime (datetime) --

      The date and time the specified Call Analytics job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

    • FailureReason (string) --

      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

      • The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

    • DataAccessRoleArn (string) --

      The Amazon Resource Name (ARN) you included in your request.

    • IdentifiedLanguageScore (float) --

      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

    • Settings (dict) --

      Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

      • VocabularyName (string) --

        The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

      • VocabularyFilterName (string) --

        The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

        Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

      • VocabularyFilterMethod (string) --

        Specify how you want your custom vocabulary filter applied to your transcript.

        To replace words with ***, choose mask.

        To delete words, choose remove.

        To flag words without changing them, choose tag.

      • LanguageModelName (string) --

        The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

        The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

      • ContentRedaction (dict) --

        Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

        • RedactionType (string) --

          Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

        • RedactionOutput (string) --

          Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

          When you choose redacted Amazon Transcribe creates only a redacted transcript.

          When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

        • PiiEntityTypes (list) --

          Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

          • (string) --

      • LanguageOptions (list) --

        You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

        Including language options can improve the accuracy of language identification.

        For a list of languages supported with Call Analytics, refer to the Supported languages table.

        To transcribe speech in Modern Standard Arabic ( ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

        • (string) --

      • LanguageIdSettings (dict) --

        If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

        LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

        It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

        If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

        For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

        • (string) --

          • (dict) --

            If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models.

            LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

            It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

            If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

            • VocabularyName (string) --

              The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.

              The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

            • VocabularyFilterName (string) --

              The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.

              The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

              Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

            • LanguageModelName (string) --

              The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

              The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

      • Summarization (dict) --

        Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

        • GenerateAbstractiveSummary (boolean) --

          Enables Generative call summarization in your Call Analytics request

          Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

          For more information, see Enabling generative call summarization.

    • ChannelDefinitions (list) --

      Indicates which speaker is on which channel.

      • (dict) --

        Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

        • ChannelId (integer) --

          Specify the audio channel you want to define.

        • ParticipantRole (string) --

          Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

    • Tags (list) --

      The tags, each in the form of a key:value pair, assigned to the specified call analytics job.

      • (dict) --

        Adds metadata, in the form of a key:value pair, to the specified resource.

        For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

        To learn more about tagging, see Tagging resources.

        • Key (string) --

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

        • Value (string) --

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

          Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

{'CategoryProperties': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

To create a new category, see .

See also: AWS API Documentation

Request Syntax

client.update_call_analytics_category(
    CategoryName='string',
    Rules=[
        {
            'NonTalkTimeFilter': {
                'Threshold': 123,
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'Negate': True|False
            },
            'InterruptionFilter': {
                'Threshold': 123,
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'Negate': True|False
            },
            'TranscriptFilter': {
                'TranscriptFilterType': 'EXACT',
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'Negate': True|False,
                'Targets': [
                    'string',
                ]
            },
            'SentimentFilter': {
                'Sentiments': [
                    'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                ],
                'AbsoluteTimeRange': {
                    'StartTime': 123,
                    'EndTime': 123,
                    'First': 123,
                    'Last': 123
                },
                'RelativeTimeRange': {
                    'StartPercentage': 123,
                    'EndPercentage': 123,
                    'First': 123,
                    'Last': 123
                },
                'ParticipantRole': 'AGENT'|'CUSTOMER',
                'Negate': True|False
            }
        },
    ],
    InputType='REAL_TIME'|'POST_CALL'
)

type CategoryName:

string

param CategoryName:

[REQUIRED]

The name of the Call Analytics category you want to update. Category names are case sensitive.

type Rules:

list

param Rules:

[REQUIRED]

The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.

• (dict) --

  A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

  • NonTalkTimeFilter (dict) --

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

    • Threshold (integer) --

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

    • AbsoluteTimeRange (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • Negate (boolean) --

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

  • InterruptionFilter (dict) --

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

    • Threshold (integer) --

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

    • ParticipantRole (string) --

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

    • AbsoluteTimeRange (dict) --

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

      • StartTime (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • Negate (boolean) --

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

  • TranscriptFilter (dict) --

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

    • TranscriptFilterType (string) -- [REQUIRED]

      Flag the presence or absence of an exact match to the phrases that 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 (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • ParticipantRole (string) --

      Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

    • Targets (list) -- [REQUIRED]

      Specify the phrases that you want to flag.

      • (string) --

  • SentimentFilter (dict) --

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

    • Sentiments (list) -- [REQUIRED]

      Specify the sentiments that you want to flag.

      • (string) --

    • AbsoluteTimeRange (dict) --

      Makes it possible 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 (integer) --

        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 (integer) --

        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 (integer) --

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

      • Last (integer) --

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

    • RelativeTimeRange (dict) --

      Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

      • Last (integer) --

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

    • ParticipantRole (string) --

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

    • Negate (boolean) --

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

type InputType:

string

param InputType:

Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the POST_CALL input type, you must use POST_CALL as the input type when updating this category.

rtype:

dict

returns:

Response Syntax

{
    'CategoryProperties': {
        'CategoryName': 'string',
        'Rules': [
            {
                'NonTalkTimeFilter': {
                    'Threshold': 123,
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'InterruptionFilter': {
                    'Threshold': 123,
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'Negate': True|False
                },
                'TranscriptFilter': {
                    'TranscriptFilterType': 'EXACT',
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False,
                    'Targets': [
                        'string',
                    ]
                },
                'SentimentFilter': {
                    'Sentiments': [
                        'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                    ],
                    'AbsoluteTimeRange': {
                        'StartTime': 123,
                        'EndTime': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'RelativeTimeRange': {
                        'StartPercentage': 123,
                        'EndPercentage': 123,
                        'First': 123,
                        'Last': 123
                    },
                    'ParticipantRole': 'AGENT'|'CUSTOMER',
                    'Negate': True|False
                }
            },
        ],
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'InputType': 'REAL_TIME'|'POST_CALL'
    }
}

Response Structure

• (dict) --

  • CategoryProperties (dict) --

    Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.

    • 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.

      • (dict) --

        A rule is a set of criteria that 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 Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

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

        • NonTalkTimeFilter (dict) --

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

          • Threshold (integer) --

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

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • InterruptionFilter (dict) --

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

          • Threshold (integer) --

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

          • ParticipantRole (string) --

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

          • AbsoluteTimeRange (dict) --

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

            • StartTime (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • Negate (boolean) --

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

        • TranscriptFilter (dict) --

          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 that 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 (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

            Specify the participant that 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 that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

          • Targets (list) --

            Specify the phrases that you want to flag.

            • (string) --

        • SentimentFilter (dict) --

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

          • Sentiments (list) --

            Specify the sentiments that you want to flag.

            • (string) --

          • AbsoluteTimeRange (dict) --

            Makes it possible 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 (integer) --

              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 (integer) --

              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 (integer) --

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

            • Last (integer) --

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

          • RelativeTimeRange (dict) --

            Makes it possible 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 specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last (integer) --

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

          • ParticipantRole (string) --

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

          • Negate (boolean) --

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

    • CreateTime (datetime) --

      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 (datetime) --

      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.

    • Tags (list) --

      The tags, each in the form of a key:value pair, assigned to the specified call analytics category.

      • (dict) --

        Adds metadata, in the form of a key:value pair, to the specified resource.

        For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

        To learn more about tagging, see Tagging resources.

        • Key (string) --

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

        • Value (string) --

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

          Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

    • InputType (string) --

      The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.