Current section
Files
Jump to
Current section
Files
src/aws_lex_runtime.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc Amazon Lex provides both build and runtime endpoints.
%%
%% Each endpoint provides a set of operations (API). Your conversational bot
%% uses the runtime API to understand user utterances (user input text or
%% voice). For example, suppose a user says "I want pizza", your
%% bot sends this input to Amazon Lex using the runtime API. Amazon Lex
%% recognizes that the user request is for the OrderPizza intent (one of the
%% intents defined in the bot). Then Amazon Lex engages in user conversation
%% on behalf of the bot to elicit required information (slot values, such as
%% pizza size and crust type), and then performs fulfillment activity (that
%% you configured when you created the bot). You use the build-time API to
%% create and manage your Amazon Lex bot. For a list of build-time
%% operations, see the build-time API, .
-module(aws_lex_runtime).
-export([delete_session/5,
delete_session/6,
get_session/4,
get_session/6,
get_session/7,
post_content/5,
post_content/6,
post_text/5,
post_text/6,
put_session/5,
put_session/6]).
-include_lib("hackney/include/hackney_lib.hrl").
%%====================================================================
%% API
%%====================================================================
%% @doc Removes session information for a specified bot, alias, and user ID.
delete_session(Client, BotAlias, BotName, UserId, Input) ->
delete_session(Client, BotAlias, BotName, UserId, Input, []).
delete_session(Client, BotAlias, BotName, UserId, Input0, Options0) ->
Method = delete,
Path = ["/bot/", aws_util:encode_uri(BotName), "/alias/", aws_util:encode_uri(BotAlias), "/user/", aws_util:encode_uri(UserId), "/session"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Returns session information for a specified bot, alias, and user ID.
get_session(Client, BotAlias, BotName, UserId)
when is_map(Client) ->
get_session(Client, BotAlias, BotName, UserId, #{}, #{}).
get_session(Client, BotAlias, BotName, UserId, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_session(Client, BotAlias, BotName, UserId, QueryMap, HeadersMap, []).
get_session(Client, BotAlias, BotName, UserId, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/bot/", aws_util:encode_uri(BotName), "/alias/", aws_util:encode_uri(BotAlias), "/user/", aws_util:encode_uri(UserId), "/session/"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"checkpointLabelFilter">>, maps:get(<<"checkpointLabelFilter">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Sends user input (text or speech) to Amazon Lex.
%%
%% Clients use this API to send text and audio requests to Amazon Lex at
%% runtime. Amazon Lex interprets the user input using the machine learning
%% model that it built for the bot.
%%
%% The `PostContent' operation supports audio input at 8kHz and 16kHz.
%% You can use 8kHz audio to achieve higher speech recognition accuracy in
%% telephone audio applications.
%%
%% In response, Amazon Lex returns the next message to convey to the user.
%% Consider the following example messages:
%%
%% <ul> <li> For a user input "I would like a pizza," Amazon Lex
%% might return a response with a message eliciting slot data (for example,
%% `PizzaSize'): "What size pizza would you like?".
%%
%% </li> <li> After the user provides all of the pizza order information,
%% Amazon Lex might return a response with a message to get user
%% confirmation: "Order the pizza?".
%%
%% </li> <li> After the user replies "Yes" to the confirmation
%% prompt, Amazon Lex might return a conclusion statement: "Thank you,
%% your cheese pizza has been ordered.".
%%
%% </li> </ul> Not all Amazon Lex messages require a response from the user.
%% For example, conclusion statements do not require a response. Some
%% messages require only a yes or no response. In addition to the
%% `message', Amazon Lex provides additional context about the message in
%% the response that you can use to enhance client behavior, such as
%% displaying the appropriate client user interface. Consider the following
%% examples:
%%
%% <ul> <li> If the message is to elicit slot data, Amazon Lex returns the
%% following context information:
%%
%% <ul> <li> `x-amz-lex-dialog-state' header set to `ElicitSlot'
%%
%% </li> <li> `x-amz-lex-intent-name' header set to the intent name in
%% the current context
%%
%% </li> <li> `x-amz-lex-slot-to-elicit' header set to the slot name for
%% which the `message' is eliciting information
%%
%% </li> <li> `x-amz-lex-slots' header set to a map of slots configured
%% for the intent with their current values
%%
%% </li> </ul> </li> <li> If the message is a confirmation prompt, the
%% `x-amz-lex-dialog-state' header is set to `Confirmation' and the
%% `x-amz-lex-slot-to-elicit' header is omitted.
%%
%% </li> <li> If the message is a clarification prompt configured for the
%% intent, indicating that the user intent is not understood, the
%% `x-amz-dialog-state' header is set to `ElicitIntent' and the
%% `x-amz-slot-to-elicit' header is omitted.
%%
%% </li> </ul> In addition, Amazon Lex also returns your application-specific
%% `sessionAttributes'. For more information, see Managing Conversation
%% Context: https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html.
post_content(Client, BotAlias, BotName, UserId, Input) ->
post_content(Client, BotAlias, BotName, UserId, Input, []).
post_content(Client, BotAlias, BotName, UserId, Input0, Options0) ->
Method = post,
Path = ["/bot/", aws_util:encode_uri(BotName), "/alias/", aws_util:encode_uri(BotAlias), "/user/", aws_util:encode_uri(UserId), "/content"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
HeadersMapping = [
{<<"Accept">>, <<"accept">>},
{<<"x-amz-lex-active-contexts">>, <<"activeContexts">>},
{<<"Content-Type">>, <<"contentType">>},
{<<"x-amz-lex-request-attributes">>, <<"requestAttributes">>},
{<<"x-amz-lex-session-attributes">>, <<"sessionAttributes">>}
],
{Headers, Input1} = aws_request:build_headers(HeadersMapping, Input0),
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
case request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode) of
{ok, Body0, {_, ResponseHeaders, _} = Response} ->
ResponseHeadersParams =
[
{<<"x-amz-lex-active-contexts">>, <<"activeContexts">>},
{<<"x-amz-lex-alternative-intents">>, <<"alternativeIntents">>},
{<<"x-amz-lex-bot-version">>, <<"botVersion">>},
{<<"Content-Type">>, <<"contentType">>},
{<<"x-amz-lex-dialog-state">>, <<"dialogState">>},
{<<"x-amz-lex-encoded-input-transcript">>, <<"encodedInputTranscript">>},
{<<"x-amz-lex-encoded-message">>, <<"encodedMessage">>},
{<<"x-amz-lex-input-transcript">>, <<"inputTranscript">>},
{<<"x-amz-lex-intent-name">>, <<"intentName">>},
{<<"x-amz-lex-message">>, <<"message">>},
{<<"x-amz-lex-message-format">>, <<"messageFormat">>},
{<<"x-amz-lex-nlu-intent-confidence">>, <<"nluIntentConfidence">>},
{<<"x-amz-lex-sentiment">>, <<"sentimentResponse">>},
{<<"x-amz-lex-session-attributes">>, <<"sessionAttributes">>},
{<<"x-amz-lex-session-id">>, <<"sessionId">>},
{<<"x-amz-lex-slot-to-elicit">>, <<"slotToElicit">>},
{<<"x-amz-lex-slots">>, <<"slots">>}
],
FoldFun = fun({Name_, Key_}, Acc_) ->
case lists:keyfind(Name_, 1, ResponseHeaders) of
false -> Acc_;
{_, Value_} -> Acc_#{Key_ => Value_}
end
end,
Body = lists:foldl(FoldFun, Body0, ResponseHeadersParams),
{ok, Body, Response};
Result ->
Result
end.
%% @doc Sends user input to Amazon Lex.
%%
%% Client applications can use this API to send requests to Amazon Lex at
%% runtime. Amazon Lex then interprets the user input using the machine
%% learning model it built for the bot.
%%
%% In response, Amazon Lex returns the next `message' to convey to the
%% user an optional `responseCard' to display. Consider the following
%% example messages:
%%
%% <ul> <li> For a user input "I would like a pizza", Amazon Lex
%% might return a response with a message eliciting slot data (for example,
%% PizzaSize): "What size pizza would you like?"
%%
%% </li> <li> After the user provides all of the pizza order information,
%% Amazon Lex might return a response with a message to obtain user
%% confirmation "Proceed with the pizza order?".
%%
%% </li> <li> After the user replies to a confirmation prompt with a
%% "yes", Amazon Lex might return a conclusion statement:
%% "Thank you, your cheese pizza has been ordered.".
%%
%% </li> </ul> Not all Amazon Lex messages require a user response. For
%% example, a conclusion statement does not require a response. Some messages
%% require only a "yes" or "no" user response. In
%% addition to the `message', Amazon Lex provides additional context
%% about the message in the response that you might use to enhance client
%% behavior, for example, to display the appropriate client user interface.
%% These are the `slotToElicit', `dialogState', `intentName', and
%% `slots' fields in the response. Consider the following examples:
%%
%% <ul> <li> If the message is to elicit slot data, Amazon Lex returns the
%% following context information:
%%
%% <ul> <li> `dialogState' set to ElicitSlot
%%
%% </li> <li> `intentName' set to the intent name in the current context
%%
%% </li> <li> `slotToElicit' set to the slot name for which the
%% `message' is eliciting information
%%
%% </li> <li> `slots' set to a map of slots, configured for the intent,
%% with currently known values
%%
%% </li> </ul> </li> <li> If the message is a confirmation prompt, the
%% `dialogState' is set to ConfirmIntent and `SlotToElicit' is set to
%% null.
%%
%% </li> <li> If the message is a clarification prompt (configured for the
%% intent) that indicates that user intent is not understood, the
%% `dialogState' is set to ElicitIntent and `slotToElicit' is set to
%% null.
%%
%% </li> </ul> In addition, Amazon Lex also returns your application-specific
%% `sessionAttributes'. For more information, see Managing Conversation
%% Context: https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html.
post_text(Client, BotAlias, BotName, UserId, Input) ->
post_text(Client, BotAlias, BotName, UserId, Input, []).
post_text(Client, BotAlias, BotName, UserId, Input0, Options0) ->
Method = post,
Path = ["/bot/", aws_util:encode_uri(BotName), "/alias/", aws_util:encode_uri(BotAlias), "/user/", aws_util:encode_uri(UserId), "/text"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Creates a new session or modifies an existing session with an Amazon
%% Lex bot.
%%
%% Use this operation to enable your application to set the state of the bot.
%%
%% For more information, see Managing Sessions:
%% https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html.
put_session(Client, BotAlias, BotName, UserId, Input) ->
put_session(Client, BotAlias, BotName, UserId, Input, []).
put_session(Client, BotAlias, BotName, UserId, Input0, Options0) ->
Method = post,
Path = ["/bot/", aws_util:encode_uri(BotName), "/alias/", aws_util:encode_uri(BotAlias), "/user/", aws_util:encode_uri(UserId), "/session"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
HeadersMapping = [
{<<"Accept">>, <<"accept">>}
],
{Headers, Input1} = aws_request:build_headers(HeadersMapping, Input0),
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
case request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode) of
{ok, Body0, {_, ResponseHeaders, _} = Response} ->
ResponseHeadersParams =
[
{<<"x-amz-lex-active-contexts">>, <<"activeContexts">>},
{<<"Content-Type">>, <<"contentType">>},
{<<"x-amz-lex-dialog-state">>, <<"dialogState">>},
{<<"x-amz-lex-encoded-message">>, <<"encodedMessage">>},
{<<"x-amz-lex-intent-name">>, <<"intentName">>},
{<<"x-amz-lex-message">>, <<"message">>},
{<<"x-amz-lex-message-format">>, <<"messageFormat">>},
{<<"x-amz-lex-session-attributes">>, <<"sessionAttributes">>},
{<<"x-amz-lex-session-id">>, <<"sessionId">>},
{<<"x-amz-lex-slot-to-elicit">>, <<"slotToElicit">>},
{<<"x-amz-lex-slots">>, <<"slots">>}
],
FoldFun = fun({Name_, Key_}, Acc_) ->
case lists:keyfind(Name_, 1, ResponseHeaders) of
false -> Acc_;
{_, Value_} -> Acc_#{Key_ => Value_}
end
end,
Body = lists:foldl(FoldFun, Body0, ResponseHeadersParams),
{ok, Body, Response};
Result ->
Result
end.
%%====================================================================
%% Internal functions
%%====================================================================
-spec request(aws_client:aws_client(), atom(), iolist(), list(),
list(), map() | undefined, list(), pos_integer() | undefined) ->
{ok, {integer(), list()}} |
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map(),
Error :: map().
request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
RequestFun = fun() -> do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) end,
aws_request:request(RequestFun, Options).
do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
Client1 = Client#{service => <<"lex">>},
Host = build_host(<<"runtime.lex">>, Client1),
URL0 = build_url(Host, Path, Client1),
URL = aws_request:add_query(URL0, Query),
AdditionalHeaders1 = [ {<<"Host">>, Host}
, {<<"Content-Type">>, <<"application/x-amz-json-1.1">>}
],
Payload =
case proplists:get_value(send_body_as_binary, Options) of
true ->
maps:get(<<"Body">>, Input, <<"">>);
false ->
encode_payload(Input)
end,
AdditionalHeaders = case proplists:get_value(append_sha256_content_hash, Options, false) of
true ->
add_checksum_hash_header(AdditionalHeaders1, Payload);
false ->
AdditionalHeaders1
end,
Headers1 = aws_request:add_headers(AdditionalHeaders, Headers0),
MethodBin = aws_request:method_to_binary(Method),
SignedHeaders = aws_request:sign_request(Client1, MethodBin, URL, Headers1, Payload),
Response = hackney:request(Method, URL, SignedHeaders, Payload, Options),
DecodeBody = not proplists:get_value(receive_body_as_binary, Options),
handle_response(Response, SuccessStatusCode, DecodeBody).
add_checksum_hash_header(Headers, Body) ->
[ {<<"X-Amz-CheckSum-SHA256">>, base64:encode(crypto:hash(sha256, Body))}
| Headers
].
handle_response({ok, StatusCode, ResponseHeaders}, SuccessStatusCode, _DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
{ok, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders}, _, _DecodeBody) ->
{error, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders, Client}, SuccessStatusCode, DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
case hackney:body(Client) of
{ok, <<>>} when StatusCode =:= 200;
StatusCode =:= SuccessStatusCode ->
{ok, #{}, {StatusCode, ResponseHeaders, Client}};
{ok, Body} ->
Result = case DecodeBody of
true ->
try
jsx:decode(Body)
catch
Error:Reason:Stack ->
erlang:raise(error, {body_decode_failed, Error, Reason, StatusCode, Body}, Stack)
end;
false -> #{<<"Body">> => Body}
end,
{ok, Result, {StatusCode, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, _ResponseHeaders, _Client}, _, _DecodeBody)
when StatusCode =:= 503 ->
%% Retriable error if retries are enabled
{error, service_unavailable};
handle_response({ok, StatusCode, ResponseHeaders, Client}, _, _DecodeBody) ->
{ok, Body} = hackney:body(Client),
try
DecodedError = jsx:decode(Body),
{error, DecodedError, {StatusCode, ResponseHeaders, Client}}
catch
Error:Reason:Stack ->
erlang:raise(error, {body_decode_failed, Error, Reason, StatusCode, Body}, Stack)
end;
handle_response({error, Reason}, _, _DecodeBody) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Path0, Client) ->
Proto = aws_client:proto(Client),
Path = erlang:iolist_to_binary(Path0),
Port = aws_client:port(Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, Path], <<"">>).
-spec encode_payload(undefined | map()) -> binary().
encode_payload(undefined) ->
<<>>;
encode_payload(Input) ->
jsx:encode(Input).