Provides a list of analysis segments for a real-time chat analysis session¶

Description¶

Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.

This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs.

Usage¶

connect_list_realtime_contact_analysis_segments_v2(InstanceId,
  ContactId, MaxResults, NextToken, OutputType, SegmentTypes)

Arguments¶

InstanceId

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

[required] The identifier of the contact in this instance of Connect Customer.
MaxResults

The maximum number of results to return per page.
NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
OutputType

[required] The Contact Lens output type to be returned.
SegmentTypes

[required] Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.

Value¶

A list with the following syntax:

list(
  Channel = "VOICE"|"CHAT",
  Status = "IN_PROGRESS"|"FAILED"|"COMPLETED",
  Segments = list(
    list(
      Transcript = list(
        Id = "string",
        ParticipantId = "string",
        ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
        DisplayName = "string",
        Content = "string",
        ContentType = "string",
        Time = list(
          AbsoluteTime = as.POSIXct(
            "2015-01-01"
          )
        ),
        Redaction = list(
          CharacterOffsets = list(
            list(
              BeginOffsetChar = 123,
              EndOffsetChar = 123
            )
          )
        ),
        Sentiment = "POSITIVE"|"NEGATIVE"|"NEUTRAL"
      ),
      Categories = list(
        MatchedDetails = list(
          list(
            PointsOfInterest = list(
              list(
                TranscriptItems = list(
                  list(
                    Id = "string",
                    CharacterOffsets = list(
                      BeginOffsetChar = 123,
                      EndOffsetChar = 123
                    )
                  )
                )
              )
            )
          )
        )
      ),
      Issues = list(
        IssuesDetected = list(
          list(
            TranscriptItems = list(
              list(
                Content = "string",
                Id = "string",
                CharacterOffsets = list(
                  BeginOffsetChar = 123,
                  EndOffsetChar = 123
                )
              )
            )
          )
        )
      ),
      Event = list(
        Id = "string",
        ParticipantId = "string",
        ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
        DisplayName = "string",
        EventType = "string",
        Time = list(
          AbsoluteTime = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      Attachments = list(
        Id = "string",
        ParticipantId = "string",
        ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
        DisplayName = "string",
        Attachments = list(
          list(
            AttachmentName = "string",
            ContentType = "string",
            AttachmentId = "string",
            Status = "APPROVED"|"REJECTED"|"IN_PROGRESS"
          )
        ),
        Time = list(
          AbsoluteTime = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      PostContactSummary = list(
        Content = "string",
        Status = "FAILED"|"COMPLETED",
        FailureCode = "QUOTA_EXCEEDED"|"INSUFFICIENT_CONVERSATION_CONTENT"|"FAILED_SAFETY_GUIDELINES"|"INVALID_ANALYSIS_CONFIGURATION"|"INTERNAL_ERROR"
      ),
      ExtractedInformation = list(
        ExtractionDefinitionId = "string",
        ExtractionDefinitionName = "string",
        ExtractionDefinitionDisplayLabel = "string",
        ExtractedValues = list(
          list(
            Content = "string",
            PointsOfInterest = list(
              list(
                Id = "string",
                CharacterOffsets = list(
                  BeginOffsetChar = 123,
                  EndOffsetChar = 123
                )
              )
            )
          )
        ),
        FailureCode = "QUOTA_EXCEEDED"|"INSUFFICIENT_CONVERSATION_CONTENT"|"FAILED_SAFETY_GUIDELINES"|"INTERNAL_ERROR"|"MAX_PACKAGE_FEATURE_ONLY"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_realtime_contact_analysis_segments_v2(
  InstanceId = "string",
  ContactId = "string",
  MaxResults = 123,
  NextToken = "string",
  OutputType = "Raw"|"Redacted",
  SegmentTypes = list(
    "Transcript"|"Categories"|"Issues"|"Event"|"Attachments"|"PostContactSummary"|"ExtractedInformation"
  )
)