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

Class RetrieveAndGenerateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>

@Generated("software.amazon.awssdk:codegen")
public final class RetrieveAndGenerateResponse
extends BedrockAgentRuntimeResponse
implements ToCopyableBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrieveAndGenerateResponse.Builder

Method Summary

Modifier and Type	Method	Description
static RetrieveAndGenerateResponse.Builder	builder()
List<Citation>	citations()	A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCitations()	For responses, this returns true if the service returned a value for the Citations property.
int	hashCode()
RetrieveAndGenerateOutput	output()	Contains the response generated from querying the knowledge base.
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieveAndGenerateResponse.Builder>	serializableBuilderClass()
String	sessionId()	The unique identifier of the session.
RetrieveAndGenerateResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasCitations

public final boolean hasCitations()

For responses, this returns true if the service returned a value for the Citations 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.

citations

public final List<Citation> citations()

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

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 hasCitations() method.

Returns:

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

output

public final RetrieveAndGenerateOutput output()

Contains the response generated from querying the knowledge base.

Returns:

Contains the response generated from querying the knowledge base.

sessionId

public final String sessionId()

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

Returns:

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

toBuilder

public RetrieveAndGenerateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static RetrieveAndGenerateResponse.Builder builder()

serializableBuilderClass

public static Class<? extends RetrieveAndGenerateResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo