Class ChatSyncRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.qbusiness.model.QBusinessRequest
software.amazon.awssdk.services.qbusiness.model.ChatSyncRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>
@Generated("software.amazon.awssdk:codegen") public final class ChatSyncRequest extends QBusinessRequest implements ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

      Returns:
      The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

    • userId

      public final String userId()

      The identifier of the user attached to the chat input.

      Returns:
      The identifier of the user attached to the chat input.

    • hasUserGroups

      public final boolean hasUserGroups()
      For responses, this returns true if the service returned a value for the UserGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • userGroups

      public final List<String> userGroups()

      The group names that a user associated with the chat input belongs to.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserGroups() method.

      Returns:
      The group names that a user associated with the chat input belongs to.

    • userMessage

      public final String userMessage()

      A end user message in a conversation.

      Returns:
      A end user message in a conversation.

    • hasAttachments

      public final boolean hasAttachments()
      For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attachments

      public final List<AttachmentInput> attachments()

      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachments() method.

      Returns:
      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

    • actionExecution

      public final ActionExecution actionExecution()

      A request from an end user to perform an Amazon Q Business plugin action.

      Returns:
      A request from an end user to perform an Amazon Q Business plugin action.

    • authChallengeResponse

      public final AuthChallengeResponse authChallengeResponse()

      An authentication verification event response by a third party authentication server to Amazon Q Business.

      Returns:
      An authentication verification event response by a third party authentication server to Amazon Q Business.

    • conversationId

      public final String conversationId()

      The identifier of the Amazon Q Business conversation.

      Returns:
      The identifier of the Amazon Q Business conversation.

    • parentMessageId

      public final String parentMessageId()

      The identifier of the previous system message in a conversation.

      Returns:
      The identifier of the previous system message in a conversation.

    • attributeFilter

      public final AttributeFilter attributeFilter()

      Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

      Returns:
      Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

    • chatMode

      public final ChatMode chatMode()

      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      If the service returns an enum value that is not available in the current SDK version, chatMode will return ChatMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatModeAsString().

      Returns:
      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      See Also:

    • chatModeAsString

      public final String chatModeAsString()

      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      If the service returns an enum value that is not available in the current SDK version, chatMode will return ChatMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatModeAsString().

      Returns:
      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      See Also:

    • chatModeConfiguration

      public final ChatModeConfiguration chatModeConfiguration()

      The chat mode configuration for an Amazon Q Business application.

      Returns:
      The chat mode configuration for an Amazon Q Business application.

    • clientToken

      public final String clientToken()

      A token that you provide to identify a chat request.

      Returns:
      A token that you provide to identify a chat request.

    • toBuilder

      public ChatSyncRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>
      Specified by:
      toBuilder in class QBusinessRequest
      Returns:
      a builder for type T

    • builder

      public static ChatSyncRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ChatSyncRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.