Class QnAKendraConfiguration

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.QnAKendraConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QnAKendraConfiguration.Builder,QnAKendraConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class QnAKendraConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QnAKendraConfiguration.Builder,QnAKendraConfiguration>

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.

See Also:

  • Method Details

    • kendraIndex

      public final String kendraIndex()

      The ARN of the Amazon Kendra index to use.

      Returns:
      The ARN of the Amazon Kendra index to use.

    • queryFilterStringEnabled

      public final Boolean queryFilterStringEnabled()

      Specifies whether to enable an Amazon Kendra filter string or not.

      Returns:
      Specifies whether to enable an Amazon Kendra filter string or not.

    • queryFilterString

      public final String queryFilterString()

      Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.

      Returns:
      Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.

    • exactResponse

      public final Boolean exactResponse()

      Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.

      Returns:
      Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.

    • toBuilder

      public QnAKendraConfiguration.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<QnAKendraConfiguration.Builder,QnAKendraConfiguration>
      Returns:
      a builder for type T

    • builder

      public static QnAKendraConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.