Package software.amazon.awssdk.services.bedrockagent.model

Class KnowledgeBaseDocument

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.KnowledgeBaseDocument

All Implemented Interfaces:

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

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

Contains information about a document to ingest into a knowledge base and metadata to associate with it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseDocument.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseDocument.Builder	builder()
DocumentContent	content()	Contains the content of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DocumentMetadata	metadata()	Contains the metadata to associate with the document.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseDocument.Builder>	serializableBuilderClass()
KnowledgeBaseDocument.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

metadata

public final DocumentMetadata metadata()

Contains the metadata to associate with the document.

Returns:

Contains the metadata to associate with the document.

content

public final DocumentContent content()

Contains the content of the document.

Returns:

Contains the content of the document.

toBuilder

public KnowledgeBaseDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseDocument.Builder,KnowledgeBaseDocument>

builder

public static KnowledgeBaseDocument.Builder builder()

serializableBuilderClass

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