Package software.amazon.awssdk.services.bedrockagentruntime.model

Class KnowledgeBase

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBase

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>

@Generated("software.amazon.awssdk:codegen")
public final class KnowledgeBase
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>

Details of the knowledge base associated withe inline agent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBase.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBase.Builder	builder()
String	description()	The description of the knowledge base associated with the inline agent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier for a knowledge base associated with the inline agent.
KnowledgeBaseRetrievalConfiguration	retrievalConfiguration()	The configurations to apply to the knowledge base during query.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBase.Builder>	serializableBuilderClass()
KnowledgeBase.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

description

public final String description()

The description of the knowledge base associated with the inline agent.

Returns:

The description of the knowledge base associated with the inline agent.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier for a knowledge base associated with the inline agent.

Returns:

The unique identifier for a knowledge base associated with the inline agent.

retrievalConfiguration

public final KnowledgeBaseRetrievalConfiguration retrievalConfiguration()

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

Returns:

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

toBuilder

public KnowledgeBase.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>

builder

public static KnowledgeBase.Builder builder()

serializableBuilderClass

public static Class<? extends KnowledgeBase.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo