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

Class GetChatControlsConfigurationResponse

    • Method Detail

      • blockedPhrases

        public final BlockedPhrasesConfiguration blockedPhrases()

        The phrases blocked from chat by your chat control configuration.

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

      • nextToken

        public final String nextToken()

        If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.

        Returns:
        If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.

      • responseScope

        public final ResponseScope responseScope()

        The response scope configured for a Amazon Q 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 a Amazon Q 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 a Amazon Q 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 a Amazon Q 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

      • hasTopicConfigurations

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

      • topicConfigurations

        public final List<TopicConfiguration> topicConfigurations()

        The topic specific controls configured for a Amazon Q application.

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

        Returns:
        The topic specific controls configured for a Amazon Q application.

      • 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