Package software.amazon.awssdk.services.lexruntime.model

Interface PostTextRequest.Builder

    • Method Detail

      • botName

        PostTextRequest.Builder botName​(String botName)

        The name of the Amazon Lex bot.

        Parameters:
        botName - The name of the Amazon Lex bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • botAlias

        PostTextRequest.Builder botAlias​(String botAlias)

        The alias of the Amazon Lex bot.

        Parameters:
        botAlias - The alias of the Amazon Lex bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userId

        PostTextRequest.Builder userId​(String 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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionAttributes

        PostTextRequest.Builder sessionAttributes​(Map<String,​String> sessionAttributes)

        Application-specific information passed between Amazon Lex and a client application.

        For more information, see Setting Session Attributes.

        Parameters:
        sessionAttributes - Application-specific information passed between Amazon Lex and a client application.

        For more information, see Setting Session Attributes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestAttributes

        PostTextRequest.Builder requestAttributes​(Map<String,​String> requestAttributes)

        Request-specific information passed between Amazon Lex and a client application.

        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.

        Parameters:
        requestAttributes - Request-specific information passed between Amazon Lex and a client application.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputText

        PostTextRequest.Builder inputText​(String inputText)

        The text that the user entered (Amazon Lex interprets this text).

        Parameters:
        inputText - The text that the user entered (Amazon Lex interprets this text).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activeContexts

        PostTextRequest.Builder activeContexts​(Collection<ActiveContext> 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.

      • activeContexts

        PostTextRequest.Builder activeContexts​(ActiveContext... 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.

      • activeContexts

        PostTextRequest.Builder activeContexts​(Consumer<ActiveContext.Builder>... 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.

        This is a convenience method that creates an instance of the ActiveContext.Builder avoiding the need to create one manually via ActiveContext.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #activeContexts(List).

        Parameters:
        activeContexts - a consumer that will call methods on ActiveContext.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #activeContexts(java.util.Collection)