AWS API Changes

2023/05/30 - Amazon Chime SDK Voice - 1 updated api methods

Changes Added optional CallLeg field to StartSpeakerSearchTask API request

StartSpeakerSearchTask (updated)

Link ¶
Changes (request)

{'CallLeg': 'Caller | Callee'}

Starts a speaker search task.

Warning

Before starting any speaker search 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

client.start_speaker_search_task(
    VoiceConnectorId='string',
    TransactionId='string',
    VoiceProfileDomainId='string',
    ClientRequestToken='string',
    CallLeg='Caller'|'Callee'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Voice Connector ID.

type TransactionId

string

param TransactionId

[REQUIRED]

The transaction ID of the call being analyzed.

type VoiceProfileDomainId

string

param VoiceProfileDomainId

[REQUIRED]

The ID of the voice profile domain that will store the voice profile.

type ClientRequestToken

string

param ClientRequestToken

The unique identifier for the client request. Use a different token for different speaker search tasks.

type CallLeg

string

param CallLeg

Specifies which call leg to stream for speaker search.

rtype

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.