Package software.amazon.awssdk.services.qbusiness.model

Class UpdateChatControlsConfigurationRequest

    • Method Detail

      • applicationId

        public final String applicationId()

        The identifier of the application for which the chat controls are configured.

        Returns:
        The identifier of the application for which the chat controls are configured.

      • clientToken

        public final String clientToken()

        A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

        Returns:
        A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

      • responseScope

        public final ResponseScope responseScope()

        The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

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

        Returns:
        The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
        See Also:
        ResponseScope

      • responseScopeAsString

        public final String responseScopeAsString()

        The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

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

        Returns:
        The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
        See Also:
        ResponseScope

      • blockedPhrasesConfigurationUpdate

        public final BlockedPhrasesConfigurationUpdate blockedPhrasesConfigurationUpdate()

        The phrases blocked from chat by your chat control configuration.

        Returns:
        The phrases blocked from chat by your chat control configuration.

      • hasTopicConfigurationsToCreateOrUpdate

        public final boolean hasTopicConfigurationsToCreateOrUpdate()
        For responses, this returns true if the service returned a value for the TopicConfigurationsToCreateOrUpdate 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.

      • topicConfigurationsToCreateOrUpdate

        public final List<TopicConfiguration> topicConfigurationsToCreateOrUpdate()

        The configured topic specific chat controls you want to update.

        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 hasTopicConfigurationsToCreateOrUpdate() method.

        Returns:
        The configured topic specific chat controls you want to update.

      • hasTopicConfigurationsToDelete

        public final boolean hasTopicConfigurationsToDelete()
        For responses, this returns true if the service returned a value for the TopicConfigurationsToDelete 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.

      • topicConfigurationsToDelete

        public final List<TopicConfiguration> topicConfigurationsToDelete()

        The configured topic specific chat controls you want to delete.

        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 hasTopicConfigurationsToDelete() method.

        Returns:
        The configured topic specific chat controls you want to delete.

      • creatorModeConfiguration

        public final CreatorModeConfiguration creatorModeConfiguration()

        The configuration details for CREATOR_MODE.

        Returns:
        The configuration details for CREATOR_MODE.

      • 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