| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Transcribe.CreateCallAnalyticsCategory
Description
Creates a new Call Analytics category.
All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.
When creating a new category, you can use the InputType parameter to
label the category as a batch category (POST_CALL) or a streaming
category (REAL_TIME). Batch categories can only be applied to batch
transcriptions and streaming categories can only be applied to streaming
transcriptions. If you do not include InputType, your category is
created as a batch category by default.
Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .
To update an existing category, see .
To learn more about Call Analytics categories, see Creating categories for batch transcriptions and Creating categories for streaming transcriptions.
Synopsis
- data CreateCallAnalyticsCategory = CreateCallAnalyticsCategory' {}
- newCreateCallAnalyticsCategory :: Text -> NonEmpty Rule -> CreateCallAnalyticsCategory
- createCallAnalyticsCategory_inputType :: Lens' CreateCallAnalyticsCategory (Maybe InputType)
- createCallAnalyticsCategory_categoryName :: Lens' CreateCallAnalyticsCategory Text
- createCallAnalyticsCategory_rules :: Lens' CreateCallAnalyticsCategory (NonEmpty Rule)
- data CreateCallAnalyticsCategoryResponse = CreateCallAnalyticsCategoryResponse' {}
- newCreateCallAnalyticsCategoryResponse :: Int -> CreateCallAnalyticsCategoryResponse
- createCallAnalyticsCategoryResponse_categoryProperties :: Lens' CreateCallAnalyticsCategoryResponse (Maybe CategoryProperties)
- createCallAnalyticsCategoryResponse_httpStatus :: Lens' CreateCallAnalyticsCategoryResponse Int
Creating a Request
data CreateCallAnalyticsCategory Source #
See: newCreateCallAnalyticsCategory smart constructor.
Constructors
| CreateCallAnalyticsCategory' | |
Fields
| |
Instances
newCreateCallAnalyticsCategory Source #
Arguments
| :: Text | |
| -> NonEmpty Rule | |
| -> CreateCallAnalyticsCategory |
Create a value of CreateCallAnalyticsCategory 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:
CreateCallAnalyticsCategory, createCallAnalyticsCategory_inputType - Choose whether you want to create a streaming or a batch category for
your Call Analytics transcription.
Specifying POST_CALL assigns your category to batch transcriptions;
categories with this input type cannot be applied to streaming
(real-time) transcriptions.
Specifying REAL_TIME assigns your category to streaming
transcriptions; categories with this input type cannot be applied to
batch (post-call) transcriptions.
If you do not include InputType, your category is created as a batch
category by default.
CreateCallAnalyticsCategory, createCallAnalyticsCategory_categoryName - A unique name, chosen by you, for your Call Analytics category. It's
helpful to use a detailed naming system that will make sense to you in
the future. For example, it's better to use
sentiment-positive-last30seconds for a category over a generic name
like test-category.
Category names are case sensitive.
CreateCallAnalyticsCategory, createCallAnalyticsCategory_rules - Rules define a Call Analytics category. When creating a new category,
you must create between 1 and 20 rules for that category. For each rule,
you specify a filter you want applied to the attributes of a call. For
example, you can choose a sentiment filter that detects if a customer's
sentiment was positive during the last 30 seconds of the call.
Request Lenses
createCallAnalyticsCategory_inputType :: Lens' CreateCallAnalyticsCategory (Maybe InputType) Source #
Choose whether you want to create a streaming or a batch category for your Call Analytics transcription.
Specifying POST_CALL assigns your category to batch transcriptions;
categories with this input type cannot be applied to streaming
(real-time) transcriptions.
Specifying REAL_TIME assigns your category to streaming
transcriptions; categories with this input type cannot be applied to
batch (post-call) transcriptions.
If you do not include InputType, your category is created as a batch
category by default.
createCallAnalyticsCategory_categoryName :: Lens' CreateCallAnalyticsCategory Text Source #
A unique name, chosen by you, for your Call Analytics category. It's
helpful to use a detailed naming system that will make sense to you in
the future. For example, it's better to use
sentiment-positive-last30seconds for a category over a generic name
like test-category.
Category names are case sensitive.
createCallAnalyticsCategory_rules :: Lens' CreateCallAnalyticsCategory (NonEmpty Rule) Source #
Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.
Destructuring the Response
data CreateCallAnalyticsCategoryResponse Source #
See: newCreateCallAnalyticsCategoryResponse smart constructor.
Constructors
| CreateCallAnalyticsCategoryResponse' | |
Fields
| |
Instances
newCreateCallAnalyticsCategoryResponse Source #
Arguments
| :: Int | |
| -> CreateCallAnalyticsCategoryResponse |
Create a value of CreateCallAnalyticsCategoryResponse 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:categoryProperties:CreateCallAnalyticsCategoryResponse', createCallAnalyticsCategoryResponse_categoryProperties - Provides you with the properties of your new category, including its
associated rules.
$sel:httpStatus:CreateCallAnalyticsCategoryResponse', createCallAnalyticsCategoryResponse_httpStatus - The response's http status code.
Response Lenses
createCallAnalyticsCategoryResponse_categoryProperties :: Lens' CreateCallAnalyticsCategoryResponse (Maybe CategoryProperties) Source #
Provides you with the properties of your new category, including its associated rules.
createCallAnalyticsCategoryResponse_httpStatus :: Lens' CreateCallAnalyticsCategoryResponse Int Source #
The response's http status code.