Struct rusoto_lex_runtime::PostContentRequest
source · [−]pub struct PostContentRequest {
pub accept: Option<String>,
pub active_contexts: Option<String>,
pub bot_alias: String,
pub bot_name: String,
pub content_type: String,
pub input_stream: Bytes,
pub request_attributes: Option<String>,
pub session_attributes: Option<String>,
pub user_id: String,
}
Fields
accept: Option<String>
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)
-
active_contexts: Option<String>
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.
bot_alias: String
Alias of the Amazon Lex bot.
bot_name: String
Name of the Amazon Lex bot.
content_type: String
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
-
input_stream: Bytes
User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
request_attributes: Option<String>
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.
session_attributes: Option<String>
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.
user_id: String
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.
Trait Implementations
sourceimpl Clone for PostContentRequest
impl Clone for PostContentRequest
sourcefn clone(&self) -> PostContentRequest
fn clone(&self) -> PostContentRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PostContentRequest
impl Debug for PostContentRequest
sourceimpl Default for PostContentRequest
impl Default for PostContentRequest
sourcefn default() -> PostContentRequest
fn default() -> PostContentRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<PostContentRequest> for PostContentRequest
impl PartialEq<PostContentRequest> for PostContentRequest
sourcefn eq(&self, other: &PostContentRequest) -> bool
fn eq(&self, other: &PostContentRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PostContentRequest) -> bool
fn ne(&self, other: &PostContentRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for PostContentRequest
impl Serialize for PostContentRequest
impl StructuralPartialEq for PostContentRequest
Auto Trait Implementations
impl RefUnwindSafe for PostContentRequest
impl Send for PostContentRequest
impl Sync for PostContentRequest
impl Unpin for PostContentRequest
impl UnwindSafe for PostContentRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more