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

Class KnowledgeBaseRetrievalResult

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult

All Implemented Interfaces:

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

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

Details about a result from querying the knowledge base.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseRetrievalResult.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseRetrievalResult.Builder	builder()
RetrievalResultContent	content()	Contains a chunk of text from a data source in the knowledge base.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetrievalResultLocation	location()	Contains information about the location of the data source.
Double	score()	The level of relevance of the result to the query.
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseRetrievalResult.Builder>	serializableBuilderClass()
KnowledgeBaseRetrievalResult.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

content

public final RetrievalResultContent content()

Contains a chunk of text from a data source in the knowledge base.

Returns:

Contains a chunk of text from a data source in the knowledge base.

location

public final RetrievalResultLocation location()

Contains information about the location of the data source.

Returns:

Contains information about the location of the data source.

score

public final Double score()

The level of relevance of the result to the query.

Returns:

The level of relevance of the result to the query.

toBuilder

public KnowledgeBaseRetrievalResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseRetrievalResult.Builder,KnowledgeBaseRetrievalResult>

builder

public static KnowledgeBaseRetrievalResult.Builder builder()

serializableBuilderClass

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