Interface PostContentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PostContentRequest.Builder,
,PostContentRequest> LexRuntimeRequest.Builder
,SdkBuilder<PostContentRequest.Builder,
,PostContentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PostContentRequest
-
Method Summary
Modifier and TypeMethodDescriptionYou pass this value as theAccept
HTTP header.activeContexts
(String activeContexts) A list of contexts active for the request.Alias of the Amazon Lex bot.Name of the Amazon Lex bot.contentType
(String contentType) You pass this value as theContent-Type
HTTP header.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestAttributes
(String requestAttributes) You pass this value as thex-amz-lex-request-attributes
HTTP header.sessionAttributes
(String sessionAttributes) You pass this value as thex-amz-lex-session-attributes
HTTP header.The ID of the client application user.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lexruntime.model.LexRuntimeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
botName
Name of the Amazon Lex bot.
- Parameters:
botName
- Name of the Amazon Lex bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
botAlias
Alias of the Amazon Lex bot.
- Parameters:
botAlias
- Alias of the Amazon Lex bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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 theuserID
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
andrequestAttributes
headers is limited to 12 KB.For more information, see Setting Session Attributes.
- Parameters:
sessionAttributes
- You pass this value as thex-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
andrequestAttributes
headers is limited to 12 KB.For more information, see Setting Session Attributes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
andsessionAttributes
headers is limited to 12 KB.The namespace
x-amz-lex:
is reserved for special attributes. Don't create any request attributes with the prefixx-amz-lex:
.For more information, see Setting Request Attributes.
- Parameters:
requestAttributes
- You pass this value as thex-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
andsessionAttributes
headers is limited to 12 KB.The namespace
x-amz-lex:
is reserved for special attributes. Don't create any request attributes with the prefixx-amz-lex:
.For more information, see Setting Request Attributes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
- Parameters:
contentType
- You pass this value as theContent-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
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theAccept
header). For example, if you specifyaudio/mpeg
as the value, Amazon Lex returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/pcm
in 16-bit, little endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
text/plain; charset=utf-8
-
audio/* (defaults to mpeg)
-
- Parameters:
accept
- You pass this value as theAccept
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 theAccept
header). For example, if you specifyaudio/mpeg
as the value, Amazon Lex returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/pcm
in 16-bit, little endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
text/plain; charset=utf-8
-
audio/* (defaults to mpeg)
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
activeContexts
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
- Parameters:
activeContexts
- A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
PostContentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PostContentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-