ChimeSDKVoice / Client / get_speaker_search_task

get_speaker_search_task#

ChimeSDKVoice.Client.get_speaker_search_task(**kwargs)#

Retrieves the details of the specified speaker search task.

Request Syntax

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

Parameters:

VoiceConnectorId (string) –
[REQUIRED]

The Voice Connector ID.
SpeakerSearchTaskId (string) –
[REQUIRED]

The ID of the speaker search task.

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) –
  
  The details of the speaker search task.
  - SpeakerSearchTaskId (string) –
    
    The speaker search task ID.
  - SpeakerSearchTaskStatus (string) –
    
    The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.
  - CallDetails (dict) –
    
    The call details of a speaker search 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.
  - SpeakerSearchDetails (dict) –
    
    The details of a speaker search task.
    - Results (list) –
      
      The result value in the speaker search details.
      - (dict) –
        
        The result of a speaker search analysis.
        
        ConfidenceScore (float) –
        
        The confidence score in the speaker search analysis.
        
        VoiceProfileId (string) –
        
        The voice profile ID.
    - VoiceprintGenerationStatus (string) –
      
      The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..
  - CreatedTimestamp (datetime) –
    
    The time at which a speaker search task was created.
  - UpdatedTimestamp (datetime) –
    
    The time at which a speaker search task was updated.
  - StartedTimestamp (datetime) –
    
    The time at which the speaker search task began.
  - StatusMessage (string) –
    
    A detailed message about the status of a speaker search.

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