| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ConnectContactLens
Description
Derived from API version 2020-08-21 of the AWS service descriptions, licensed under Apache 2.0.
Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts.
Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using Contact Lens in the Amazon Connect Administrator Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListRealtimeContactAnalysisSegments = ListRealtimeContactAnalysisSegments' (Maybe Text) (Maybe Natural) Text Text
- newListRealtimeContactAnalysisSegments :: Text -> Text -> ListRealtimeContactAnalysisSegments
- data ListRealtimeContactAnalysisSegmentsResponse = ListRealtimeContactAnalysisSegmentsResponse' (Maybe Text) Int [RealtimeContactAnalysisSegment]
- newListRealtimeContactAnalysisSegmentsResponse :: Int -> ListRealtimeContactAnalysisSegmentsResponse
- newtype SentimentValue where
- SentimentValue' { }
- pattern SentimentValue_NEGATIVE :: SentimentValue
- pattern SentimentValue_NEUTRAL :: SentimentValue
- pattern SentimentValue_POSITIVE :: SentimentValue
- data Categories = Categories' [Text] (HashMap Text CategoryDetails)
- newCategories :: Categories
- data CategoryDetails = CategoryDetails' [PointOfInterest]
- newCategoryDetails :: CategoryDetails
- data CharacterOffsets = CharacterOffsets' Natural Natural
- newCharacterOffsets :: Natural -> Natural -> CharacterOffsets
- data IssueDetected = IssueDetected' CharacterOffsets
- newIssueDetected :: CharacterOffsets -> IssueDetected
- data PointOfInterest = PointOfInterest' Natural Natural
- newPointOfInterest :: Natural -> Natural -> PointOfInterest
- data RealtimeContactAnalysisSegment = RealtimeContactAnalysisSegment' (Maybe Categories) (Maybe Transcript)
- newRealtimeContactAnalysisSegment :: RealtimeContactAnalysisSegment
- data Transcript = Transcript' (Maybe [IssueDetected]) Text Text Text Text Natural Natural SentimentValue
- newTranscript :: Text -> Text -> Text -> Text -> Natural -> Natural -> SentimentValue -> Transcript
Service Configuration
defaultService :: Service Source #
API version 2020-08-21 of the Amazon Connect Contact Lens SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ConnectContactLens.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is not valid.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The throttling limit has been exceeded.
InternalServiceException
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request processing failed due to an error or failure with the service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListRealtimeContactAnalysisSegments
data ListRealtimeContactAnalysisSegments Source #
See: newListRealtimeContactAnalysisSegments smart constructor.
Instances
newListRealtimeContactAnalysisSegments Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListRealtimeContactAnalysisSegments |
Create a value of ListRealtimeContactAnalysisSegments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_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.
$sel:maxResults:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_maxResults - The maximimum number of results to return per page.
$sel:instanceId:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_instanceId - The identifier of the Amazon Connect instance.
$sel:contactId:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_contactId - The identifier of the contact.
data ListRealtimeContactAnalysisSegmentsResponse Source #
See: newListRealtimeContactAnalysisSegmentsResponse smart constructor.
Constructors
| ListRealtimeContactAnalysisSegmentsResponse' (Maybe Text) Int [RealtimeContactAnalysisSegment] |
Instances
newListRealtimeContactAnalysisSegmentsResponse Source #
Arguments
| :: Int |
|
| -> ListRealtimeContactAnalysisSegmentsResponse |
Create a value of ListRealtimeContactAnalysisSegmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegmentsResponse_nextToken - If there are additional results, this is the token for the next set of
results. If response includes nextToken there are two possible
scenarios:
- There are more segments so another call is required to get them.
- There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.
If response does not include nextToken, the analysis is completed
(successfully or failed) and there are no more segments to retrieve.
$sel:httpStatus:ListRealtimeContactAnalysisSegmentsResponse', listRealtimeContactAnalysisSegmentsResponse_httpStatus - The response's http status code.
$sel:segments:ListRealtimeContactAnalysisSegmentsResponse', listRealtimeContactAnalysisSegmentsResponse_segments - An analyzed transcript or category.
Types
SentimentValue
newtype SentimentValue Source #
Constructors
| SentimentValue' | |
Fields | |
Bundled Patterns
| pattern SentimentValue_NEGATIVE :: SentimentValue | |
| pattern SentimentValue_NEUTRAL :: SentimentValue | |
| pattern SentimentValue_POSITIVE :: SentimentValue |
Instances
Categories
data Categories Source #
Provides the category rules that are used to automatically categorize contacts based on uttered keywords and phrases.
See: newCategories smart constructor.
Constructors
| Categories' [Text] (HashMap Text CategoryDetails) |
Instances
newCategories :: Categories Source #
Create a value of Categories with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchedCategories:Categories', categories_matchedCategories - The category rules that have been matched in the analyzed segment.
$sel:matchedDetails:Categories', categories_matchedDetails - The category rule that was matched and when it occurred in the
transcript.
CategoryDetails
data CategoryDetails Source #
Provides information about the category rule that was matched.
See: newCategoryDetails smart constructor.
Constructors
| CategoryDetails' [PointOfInterest] |
Instances
newCategoryDetails :: CategoryDetails Source #
Create a value of CategoryDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pointsOfInterest:CategoryDetails', categoryDetails_pointsOfInterest - The section of audio where the category rule was detected.
CharacterOffsets
data CharacterOffsets Source #
For characters that were detected as issues, where they occur in the transcript.
See: newCharacterOffsets smart constructor.
Constructors
| CharacterOffsets' Natural Natural |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> CharacterOffsets |
Create a value of CharacterOffsets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffsetChar:CharacterOffsets', characterOffsets_beginOffsetChar - The beginning of the issue.
$sel:endOffsetChar:CharacterOffsets', characterOffsets_endOffsetChar - The end of the issue.
IssueDetected
data IssueDetected Source #
Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
See: newIssueDetected smart constructor.
Constructors
| IssueDetected' CharacterOffsets |
Instances
Create a value of IssueDetected with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:characterOffsets:IssueDetected', issueDetected_characterOffsets - The offset for when the issue was detected in the segment.
PointOfInterest
data PointOfInterest Source #
The section of the contact audio where that category rule was detected.
See: newPointOfInterest smart constructor.
Constructors
| PointOfInterest' Natural Natural |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> PointOfInterest |
Create a value of PointOfInterest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffsetMillis:PointOfInterest', pointOfInterest_beginOffsetMillis - The beginning offset in milliseconds where the category rule was
detected.
$sel:endOffsetMillis:PointOfInterest', pointOfInterest_endOffsetMillis - The ending offset in milliseconds where the category rule was detected.
RealtimeContactAnalysisSegment
data RealtimeContactAnalysisSegment Source #
An analyzed segment for a real-time analysis session.
See: newRealtimeContactAnalysisSegment smart constructor.
Constructors
| RealtimeContactAnalysisSegment' (Maybe Categories) (Maybe Transcript) |
Instances
newRealtimeContactAnalysisSegment :: RealtimeContactAnalysisSegment Source #
Create a value of RealtimeContactAnalysisSegment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:categories:RealtimeContactAnalysisSegment', realtimeContactAnalysisSegment_categories - The matched category rules.
$sel:transcript:RealtimeContactAnalysisSegment', realtimeContactAnalysisSegment_transcript - The analyzed transcript.
Transcript
data Transcript Source #
A list of messages in the session.
See: newTranscript smart constructor.
Constructors
| Transcript' (Maybe [IssueDetected]) Text Text Text Text Natural Natural SentimentValue |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Natural | |
| -> Natural | |
| -> SentimentValue | |
| -> Transcript |
Create a value of Transcript with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:issuesDetected:Transcript', transcript_issuesDetected - List of positions where issues were detected on the transcript.
$sel:id:Transcript', transcript_id - The identifier of the transcript.
$sel:participantId:Transcript', transcript_participantId - The identifier of the participant.
$sel:participantRole:Transcript', transcript_participantRole - The role of participant. For example, is it a customer, agent, or
system.
$sel:content:Transcript', transcript_content - The content of the transcript.
$sel:beginOffsetMillis:Transcript', transcript_beginOffsetMillis - The beginning offset in the contact for this transcript.
$sel:endOffsetMillis:Transcript', transcript_endOffsetMillis - The end offset in the contact for this transcript.
$sel:sentiment:Transcript', transcript_sentiment - The sentiment of the detected for this piece of transcript.