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

Interface Citation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Citation.Builder,Citation>, SdkBuilder<Citation.Builder,Citation>, SdkPojo

Enclosing class:

Citation

public static interface Citation.Builder
extends SdkPojo, CopyableBuilder<Citation.Builder,Citation>

Method Summary

Modifier and Type	Method	Description
default Citation.Builder	generatedResponsePart(Consumer<GeneratedResponsePart.Builder> generatedResponsePart)	Contains the generated response and metadata
Citation.Builder	generatedResponsePart(GeneratedResponsePart generatedResponsePart)	Contains the generated response and metadata
Citation.Builder	retrievedReferences(Collection<RetrievedReference> retrievedReferences)	Contains metadata about the sources cited for the generated response.
Citation.Builder	retrievedReferences(Consumer<RetrievedReference.Builder>... retrievedReferences)	Contains metadata about the sources cited for the generated response.
Citation.Builder	retrievedReferences(RetrievedReference... retrievedReferences)	Contains metadata about the sources cited for the generated response.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

generatedResponsePart

Citation.Builder generatedResponsePart(GeneratedResponsePart generatedResponsePart)

Contains the generated response and metadata

Parameters:

generatedResponsePart - Contains the generated response and metadata

Returns:

Returns a reference to this object so that method calls can be chained together.

generatedResponsePart

default Citation.Builder generatedResponsePart(Consumer<GeneratedResponsePart.Builder> generatedResponsePart)

Contains the generated response and metadata

This is a convenience method that creates an instance of the GeneratedResponsePart.Builder avoiding the need to create one manually via GeneratedResponsePart.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to generatedResponsePart(GeneratedResponsePart).

Parameters:

generatedResponsePart - a consumer that will call methods on GeneratedResponsePart.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

generatedResponsePart(GeneratedResponsePart)

retrievedReferences

Citation.Builder retrievedReferences(Collection<RetrievedReference> retrievedReferences)

Contains metadata about the sources cited for the generated response.

Parameters:

retrievedReferences - Contains metadata about the sources cited for the generated response.

Returns:

Returns a reference to this object so that method calls can be chained together.

retrievedReferences

Citation.Builder retrievedReferences(RetrievedReference... retrievedReferences)

Contains metadata about the sources cited for the generated response.

Parameters:

retrievedReferences - Contains metadata about the sources cited for the generated response.

Returns:

Returns a reference to this object so that method calls can be chained together.

retrievedReferences

Citation.Builder retrievedReferences(Consumer<RetrievedReference.Builder>... retrievedReferences)

Contains metadata about the sources cited for the generated response.

This is a convenience method that creates an instance of the RetrievedReference.Builder avoiding the need to create one manually via RetrievedReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #retrievedReferences(List).

Parameters:

retrievedReferences - a consumer that will call methods on RetrievedReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#retrievedReferences(java.util.Collection)