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

Class RetrievalResultContent

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrievalResultContent

All Implemented Interfaces:

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

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

Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.

This data type is used in the following API operations:

• Retrieve response – in the content field

• RetrieveAndGenerate response – in the content field

• InvokeAgent response – in the content field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalResultContent.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievalResultContent.Builder	builder()
String	byteContent()	A data URI with base64-encoded content from the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRow()	For responses, this returns true if the service returned a value for the Row property.
List<RetrievalResultContentColumn>	row()	Specifies information about the rows with the cells to return in retrieval.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrievalResultContent.Builder>	serializableBuilderClass()
String	text()	The cited text from the data source.
RetrievalResultContent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrievalResultContentType	type()	The type of content in the retrieval result.
String	typeAsString()	The type of content in the retrieval result.

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

byteContent

public final String byteContent()

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

Returns:

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

hasRow

public final boolean hasRow()

For responses, this returns true if the service returned a value for the Row property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

row

public final List<RetrievalResultContentColumn> row()

Specifies information about the rows with the cells to return in retrieval.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRow() method.

Returns:

Specifies information about the rows with the cells to return in retrieval.

text

public final String text()

The cited text from the data source.

Returns:

The cited text from the data source.

type

public final RetrievalResultContentType type()

The type of content in the retrieval result.

If the service returns an enum value that is not available in the current SDK version, type will return RetrievalResultContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of content in the retrieval result.

See Also:

RetrievalResultContentType

typeAsString

public final String typeAsString()

The type of content in the retrieval result.

If the service returns an enum value that is not available in the current SDK version, type will return RetrievalResultContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of content in the retrieval result.

See Also:

RetrievalResultContentType

toBuilder

public RetrievalResultContent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrievalResultContent.Builder,RetrievalResultContent>

builder

public static RetrievalResultContent.Builder builder()

serializableBuilderClass

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