Package software.amazon.awssdk.services.lexmodelsv2.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QnAKendraConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static QnAKendraConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kendraIndex()	The ARN of the Amazon Kendra index to use.
String	queryFilterString()	Contains the Amazon Kendra filter string to use if enabled.
Boolean	queryFilterStringEnabled()	Specifies whether to enable an Amazon Kendra filter string or not.
List<SdkField<?>>	sdkFields()
static Class<? extends QnAKendraConfiguration.Builder>	serializableBuilderClass()
QnAKendraConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<QnAKendraConfiguration.Builder,QnAKendraConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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