putSession method

Future<PutSessionResponse> putSession({ required String botAlias, required String botName, required String userId, String? accept, List<ActiveContext>? activeContexts, DialogAction? dialogAction, List<IntentSummary>? recentIntentSummaryView, Map<String, String>? sessionAttributes, })

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.

May throw NotFoundException. May throw BadRequestException. May throw LimitExceededException. May throw InternalFailureException. May throw ConflictException. May throw NotAcceptableException. May throw DependencyFailedException. May throw BadGatewayException.

Parameter botAlias : The alias in use for the bot that contains the session data.

Parameter botName : The name of the bot that contains the session data.

Parameter userId : The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Parameter accept : The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• 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 in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.
• The following are the accepted values:
  • audio/mpeg
  • audio/ogg
  • audio/pcm
  • audio/* (defaults to mpeg)
  • text/plain; charset=utf-8

Parameter 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.

Parameter dialogAction : Sets the next action that the bot should take to fulfill the conversation.

Parameter recentIntentSummaryView : A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName
• slot names
• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Parameter sessionAttributes : Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Implementation

Future<PutSessionResponse> putSession({
  required String botAlias,
  required String botName,
  required String userId,
  String? accept,
  List<ActiveContext>? activeContexts,
  DialogAction? dialogAction,
  List<IntentSummary>? recentIntentSummaryView,
  Map<String, String>? sessionAttributes,
}) async {
  ArgumentError.checkNotNull(botAlias, 'botAlias');
  ArgumentError.checkNotNull(botName, 'botName');
  ArgumentError.checkNotNull(userId, 'userId');
  _s.validateStringLength(
    'userId',
    userId,
    2,
    100,
    isRequired: true,
  );
  final headers = <String, String>{
    if (accept != null) 'Accept': accept.toString(),
  };
  final $payload = <String, dynamic>{
    if (activeContexts != null) 'activeContexts': activeContexts,
    if (dialogAction != null) 'dialogAction': dialogAction,
    if (recentIntentSummaryView != null)
      'recentIntentSummaryView': recentIntentSummaryView,
    if (sessionAttributes != null) 'sessionAttributes': sessionAttributes,
  };
  final response = await _protocol.sendRaw(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/bot/${Uri.encodeComponent(botName)}/alias/${Uri.encodeComponent(botAlias)}/user/${Uri.encodeComponent(userId)}/session',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return PutSessionResponse(
    audioStream: await response.stream.toBytes(),
    activeContexts: _s.extractHeaderJsonValue(
        response.headers, 'x-amz-lex-active-contexts'),
    contentType:
        _s.extractHeaderStringValue(response.headers, 'Content-Type'),
    dialogState: _s
        .extractHeaderStringValue(response.headers, 'x-amz-lex-dialog-state')
        ?.toDialogState(),
    intentName: _s.extractHeaderStringValue(
        response.headers, 'x-amz-lex-intent-name'),
    message:
        _s.extractHeaderStringValue(response.headers, 'x-amz-lex-message'),
    messageFormat: _s
        .extractHeaderStringValue(
            response.headers, 'x-amz-lex-message-format')
        ?.toMessageFormatType(),
    sessionAttributes: _s.extractHeaderJsonValue(
        response.headers, 'x-amz-lex-session-attributes'),
    sessionId:
        _s.extractHeaderStringValue(response.headers, 'x-amz-lex-session-id'),
    slotToElicit: _s.extractHeaderStringValue(
        response.headers, 'x-amz-lex-slot-to-elicit'),
    slots: _s.extractHeaderJsonValue(response.headers, 'x-amz-lex-slots'),
  );
}