Skip to content

ExtractedInformation

Source code in docs_src/capo_connect_contact_lens/types/extracted_information.py
class ExtractedInformation(TypedDict, closed=True):
    extraction_definition_id: NotRequired[
        "capo_connect_contact_lens.types.extraction_definition_id.ExtractionDefinitionId"
    ]
    """<p>The identifier of the extraction definition that produced this result.</p>"""
    extraction_definition_name: NotRequired[
        "capo_connect_contact_lens.types.extraction_definition_name.ExtractionDefinitionName"
    ]
    """<p>The name of the extraction definition that produced this result.</p>"""
    extraction_definition_display_label: NotRequired[
        "capo_connect_contact_lens.types.extraction_definition_display_label.ExtractionDefinitionDisplayLabel"
    ]
    """<p>The display label of the extraction definition that produced this result.</p>"""
    extracted_values: NotRequired[
        "capo_connect_contact_lens.types.extracted_information_values.ExtractedInformationValues"
    ]
    """<p>The list of values extracted from the conversation for this extraction definition. This field is empty when a <code>FailureCode</code> is present.</p>"""
    failure_code: NotRequired[
        "capo_connect_contact_lens.types.extracted_information_failure_code.ExtractedInformationFailureCode"
    ]
    """<p>If the information failed to be extracted, one of the following failure codes occurs:</p> <ul> <li> <p> <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service quota.</p> </li> <li> <p> <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: Information extraction requires a conversation with at least one turn from each participant.</p> </li> <li> <p> <code>FAILED_SAFETY_GUIDELINES</code>: The extracted information cannot be provided because it failed to meet system safety guidelines.</p> </li> <li> <p> <code>INTERNAL_ERROR</code>: Internal system error.</p> </li> <li> <p> <code>MAX_PACKAGE_FEATURE_ONLY</code>: Information extraction is only available in Amazon Connect Customer instances.</p> </li> </ul>"""

extracted_values instance-attribute

extracted_values: NotRequired[ExtractedInformationValues]

The list of values extracted from the conversation for this extraction definition. This field is empty when a FailureCode is present.

extraction_definition_display_label instance-attribute

extraction_definition_display_label: NotRequired[ExtractionDefinitionDisplayLabel]

The display label of the extraction definition that produced this result.

extraction_definition_id instance-attribute

extraction_definition_id: NotRequired[ExtractionDefinitionId]

The identifier of the extraction definition that produced this result.

extraction_definition_name instance-attribute

extraction_definition_name: NotRequired[ExtractionDefinitionName]

The name of the extraction definition that produced this result.

failure_code instance-attribute

failure_code: NotRequired[ExtractedInformationFailureCode]

If the information failed to be extracted, one of the following failure codes occurs:

  • QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

  • INSUFFICIENT_CONVERSATION_CONTENT: Information extraction requires a conversation with at least one turn from each participant.

  • FAILED_SAFETY_GUIDELINES: The extracted information cannot be provided because it failed to meet system safety guidelines.

  • INTERNAL_ERROR: Internal system error.

  • MAX_PACKAGE_FEATURE_ONLY: Information extraction is only available in Amazon Connect Customer instances.