Get Session

lexruntimev2_get_session

R Documentation

Returns session information for a specified bot, alias, and user

Description

Returns session information for a specified bot, alias, and user.

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

Usage

lexruntimev2_get_session(botId, botAliasId, localeId, sessionId)

Arguments

botId

[required] The identifier of the bot that contains the session data.

botAliasId

[required] The alias identifier in use for the bot that contains the session data.

localeId

[required] The locale where the session is in use.

sessionId

[required] The identifier of the session to return.

Value

A list with the following syntax:

list(
  sessionId = "string",
  messages = list(
    list(
      content = "string",
      contentType = "CustomPayload"|"ImageResponseCard"|"PlainText"|"SSML",
      imageResponseCard = list(
        title = "string",
        subtitle = "string",
        imageUrl = "string",
        buttons = list(
          list(
            text = "string",
            value = "string"
          )
        )
      )
    )
  ),
  interpretations = list(
    list(
      nluConfidence = list(
        score = 123.0
      ),
      sentimentResponse = list(
        sentiment = "MIXED"|"NEGATIVE"|"NEUTRAL"|"POSITIVE",
        sentimentScore = list(
          positive = 123.0,
          negative = 123.0,
          neutral = 123.0,
          mixed = 123.0
        )
      ),
      intent = list(
        name = "string",
        slots = list(
          list(
            value = list(
              originalValue = "string",
              interpretedValue = "string",
              resolvedValues = list(
                "string"
              )
            ),
            shape = "Scalar"|"List"|"Composite",
            values = list(
              list()
            ),
            subSlots = list()
          )
        ),
        state = "Failed"|"Fulfilled"|"InProgress"|"ReadyForFulfillment"|"Waiting"|"FulfillmentInProgress",
        confirmationState = "Confirmed"|"Denied"|"None"
      ),
      interpretationSource = "Bedrock"|"Lex"
    )
  ),
  sessionState = list(
    dialogAction = list(
      type = "Close"|"ConfirmIntent"|"Delegate"|"ElicitIntent"|"ElicitSlot"|"None",
      slotToElicit = "string",
      slotElicitationStyle = "Default"|"SpellByLetter"|"SpellByWord",
      subSlotToElicit = list(
        name = "string",
        subSlotToElicit = list()
      )
    ),
    intent = list(
      name = "string",
      slots = list(
        list(
          value = list(
            originalValue = "string",
            interpretedValue = "string",
            resolvedValues = list(
              "string"
            )
          ),
          shape = "Scalar"|"List"|"Composite",
          values = list(
            list()
          ),
          subSlots = list()
        )
      ),
      state = "Failed"|"Fulfilled"|"InProgress"|"ReadyForFulfillment"|"Waiting"|"FulfillmentInProgress",
      confirmationState = "Confirmed"|"Denied"|"None"
    ),
    activeContexts = list(
      list(
        name = "string",
        timeToLive = list(
          timeToLiveInSeconds = 123,
          turnsToLive = 123
        ),
        contextAttributes = list(
          "string"
        )
      )
    ),
    sessionAttributes = list(
      "string"
    ),
    originatingRequestId = "string",
    runtimeHints = list(
      slotHints = list(
        list(
          list(
            runtimeHintValues = list(
              list(
                phrase = "string"
              )
            ),
            subSlotHints = list()
          )
        )
      )
    )
  )
)

Request syntax

svc$get_session(
  botId = "string",
  botAliasId = "string",
  localeId = "string",
  sessionId = "string"
)