ChimeSDKVoice / Client / start_voice_tone_analysis_task

start_voice_tone_analysis_task#

ChimeSDKVoice.Client.start_voice_tone_analysis_task(**kwargs)#

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Warning

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

See also: AWS API Documentation

Request Syntax

response = client.start_voice_tone_analysis_task(
    VoiceConnectorId='string',
    TransactionId='string',
    LanguageCode='en-US',
    ClientRequestToken='string'
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Voice Connector ID.

  • TransactionId (string) –

    [REQUIRED]

    The transaction ID.

  • LanguageCode (string) –

    [REQUIRED]

    The language code.

  • ClientRequestToken (string) – The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • VoiceToneAnalysisTask (dict) –

      The details of the voice tone analysis task.

      • VoiceToneAnalysisTaskId (string) –

        The ID of the voice tone analysis task.

      • VoiceToneAnalysisTaskStatus (string) –

        The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

      • CallDetails (dict) –

        The call details of a voice tone analysis task.

        • VoiceConnectorId (string) –

          The Voice Connector ID.

        • TransactionId (string) –

          The transaction ID of a Voice Connector call.

        • IsCaller (boolean) –

          Identifies a person as the caller or the callee.

      • CreatedTimestamp (datetime) –

        The time at which a voice tone analysis task was created.

      • UpdatedTimestamp (datetime) –

        The time at which a voice tone analysis task was updated.

      • StartedTimestamp (datetime) –

        The time at which a voice tone analysis task started.

      • StatusMessage (string) –

        The status of a voice tone analysis task.

Exceptions