ChimeSDKVoice / Client / get_speaker_search_task

get_speaker_search_task#

ChimeSDKVoice.Client.get_speaker_search_task(**kwargs)#

See also: AWS API Documentation

Request Syntax

response = client.get_speaker_search_task(
    VoiceConnectorId='string',
    SpeakerSearchTaskId='string'
)
Parameters:

  • VoiceConnectorId (string) – [REQUIRED]

  • SpeakerSearchTaskId (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'SpeakerSearchDetails': {
            'Results': [
                {
                    'ConfidenceScore': ...,
                    'VoiceProfileId': 'string'
                },
            ],
            'VoiceprintGenerationStatus': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • SpeakerSearchTask (dict) –

      • SpeakerSearchTaskId (string) –

      • SpeakerSearchTaskStatus (string) –

      • CallDetails (dict) –

        • VoiceConnectorId (string) –

        • TransactionId (string) –

        • IsCaller (boolean) –

      • SpeakerSearchDetails (dict) –

        • Results (list) –

          • (dict) –

            • ConfidenceScore (float) –

            • VoiceProfileId (string) –

        • VoiceprintGenerationStatus (string) –

      • CreatedTimestamp (datetime) –

      • UpdatedTimestamp (datetime) –

      • StartedTimestamp (datetime) –

      • StatusMessage (string) –

Exceptions

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.NotFoundException

  • ChimeSDKVoice.Client.exceptions.ConflictException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.AccessDeniedException

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException