public static interface PostContentRequest.Builder extends LexRuntimeRequest.Builder, SdkPojo, CopyableBuilder<PostContentRequest.Builder,PostContentRequest>
| Modifier and Type | Method and Description |
|---|---|
PostContentRequest.Builder |
accept(String accept)
You pass this value as the
Accept HTTP header. |
PostContentRequest.Builder |
botAlias(String botAlias)
Alias of the Amazon Lex bot.
|
PostContentRequest.Builder |
botName(String botName)
Name of the Amazon Lex bot.
|
PostContentRequest.Builder |
contentType(String contentType)
You pass this value as the
Content-Type HTTP header. |
PostContentRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PostContentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PostContentRequest.Builder |
requestAttributes(String requestAttributes)
You pass this value as the
x-amz-lex-request-attributes HTTP header. |
PostContentRequest.Builder |
sessionAttributes(String sessionAttributes)
You pass this value as the
x-amz-lex-session-attributes HTTP header. |
PostContentRequest.Builder |
userId(String userId)
The ID of the client application user.
|
buildoverrideConfigurationcopyapplyMutation, buildPostContentRequest.Builder botName(String botName)
Name of the Amazon Lex bot.
botName - Name of the Amazon Lex bot.PostContentRequest.Builder botAlias(String botAlias)
Alias of the Amazon Lex bot.
botAlias - Alias of the Amazon Lex bot.PostContentRequest.Builder userId(String userId)
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
The userID field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
userId - The ID of the client application user. Amazon Lex uses this to identify a user's conversation with
your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
The userID field must not contain any personally identifiable information of the user,
for example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
PostContentRequest.Builder sessionAttributes(String sessionAttributes)
You pass this value as the x-amz-lex-session-attributes HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes and requestAttributes headers is limited to 12 KB.
For more information, see Setting Session Attributes.
sessionAttributes - You pass this value as the x-amz-lex-session-attributes HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be
a JSON serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes and requestAttributes headers is limited to 12 KB.
For more information, see Setting Session Attributes.
PostContentRequest.Builder requestAttributes(String requestAttributes)
You pass this value as the x-amz-lex-request-attributes HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes and sessionAttributes headers is limited to 12 KB.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes
with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
requestAttributes - You pass this value as the x-amz-lex-request-attributes HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a
JSON serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes and sessionAttributes headers is limited to 12 KB.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request
attributes with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
PostContentRequest.Builder contentType(String contentType)
You pass this value as the Content-Type HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
contentType - You pass this value as the Content-Type HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
PostContentRequest.Builder accept(String accept)
You pass this value as the Accept HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept
HTTP header value in the request.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses
Amazon Polly to generate the speech (using the configuration you specified in the Accept
header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the
MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
accept - You pass this value as the Accept HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the
Accept HTTP header value in the request.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex
uses Amazon Polly to generate the speech (using the configuration you specified in the
Accept header). For example, if you specify audio/mpeg as the value, Amazon
Lex returns speech in the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
PostContentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.PostContentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.