Connect / Client / start_contact_conversational_analytics_job

start_contact_conversational_analytics_job

Connect.Client.start_contact_conversational_analytics_job(**kwargs)

Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.

Warning

A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI.

Note

For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.

See also: AWS API Documentation

Request Syntax

response = client.start_contact_conversational_analytics_job(
    InstanceId='string',
    ContactId='string',
    AnalyticsModes=[
        'PostContact'|'RealTime'|'ContactLens'|'AutomatedInteraction',
    ],
    AnalyticsConfiguration={
        'LanguageConfiguration': {
            'LanguageLocale': 'string'
        },
        'RedactionConfiguration': {
            'Behavior': 'Enable'|'Disable',
            'Policy': 'None'|'RedactedOnly'|'RedactedAndOriginal',
            'Entities': [
                'string',
            ],
            'MaskMode': 'PII'|'EntityType'
        },
        'SentimentConfiguration': {
            'Behavior': 'Enable'|'Disable'
        },
        'SummaryConfiguration': {
            'SummaryModes': [
                'PostContact'|'AutomatedInteraction'|'ContactChain',
            ]
        },
        'RulesConfiguration': {
            'Behavior': 'Enable'|'Disable'
        }
    },
    ClientToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact in this instance of Connect Customer.

  • AnalyticsModes (list) –

    [REQUIRED]

    The analytics modes to run for the contact. Valid values: PostContact.

    • (string) –

  • AnalyticsConfiguration (dict) –

    [REQUIRED]

    The configuration for the conversational analytics job.

    • LanguageConfiguration (dict) – [REQUIRED]

      The language configuration for conversational analytics.

      • LanguageLocale (string) –

        The language locale setting for conversational analytics.

    • RedactionConfiguration (dict) – [REQUIRED]

      The redaction configuration for conversational analytics.

      • Behavior (string) – [REQUIRED]

        Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.

      • Policy (string) – [REQUIRED]

        The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.

      • Entities (list) –

        The list of PII entity types to redact from the transcript (for example, NAME, ADDRESS, CREDIT_DEBIT_NUMBER).

        • (string) –

      • MaskMode (string) –

        The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).

    • SentimentConfiguration (dict) – [REQUIRED]

      The sentiment configuration for conversational analytics.

      • Behavior (string) – [REQUIRED]

        Controls whether sentiment analysis is applied to the analytics output. Valid values: Enable | Disable.

    • SummaryConfiguration (dict) – [REQUIRED]

      The summary configuration for conversational analytics.

      • SummaryModes (list) – [REQUIRED]

        The summary modes that determine what type of summarization is generated. Valid values: PostContact | AutomatedInteraction | ContactChain.

        • (string) –

    • RulesConfiguration (dict) – [REQUIRED]

      The rules configuration for conversational analytics.

      • Behavior (string) –

        Controls whether Contact Lens rules are evaluated for the contact. Valid values: Enable | Disable.

  • ClientToken (string) – A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceId': 'string',
    'ContactId': 'string'
}

Response Structure

  • (dict) –

    • InstanceId (string) –

      The identifier of the Connect Customer instance.

    • ContactId (string) –

      The identifier of the contact.

Exceptions

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.IdempotencyException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException