Interface KnowledgeBaseLookupOutput.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseLookupOutput

@Mutable
@NotThreadSafe
public static interface KnowledgeBaseLookupOutput.Builder
extends SdkPojo, CopyableBuilder<KnowledgeBaseLookupOutput.Builder,KnowledgeBaseLookupOutput>

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseLookupOutput.Builder	metadata(Consumer<Metadata.Builder> metadata)	Contains information about the knowledge base output.
KnowledgeBaseLookupOutput.Builder	metadata(Metadata metadata)	Contains information about the knowledge base output.
KnowledgeBaseLookupOutput.Builder	retrievedReferences(Collection<RetrievedReference> retrievedReferences)	Contains metadata about the sources cited for the generated response.
KnowledgeBaseLookupOutput.Builder	retrievedReferences(Consumer<RetrievedReference.Builder>... retrievedReferences)	Contains metadata about the sources cited for the generated response.
KnowledgeBaseLookupOutput.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 Details

metadata

KnowledgeBaseLookupOutput.Builder metadata(Metadata metadata)

Contains information about the knowledge base output.

Parameters:

metadata - Contains information about the knowledge base output.

Returns:

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

metadata

default KnowledgeBaseLookupOutput.Builder metadata(Consumer<Metadata.Builder> metadata)

Contains information about the knowledge base output.

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

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

Parameters:

metadata - a consumer that will call methods on Metadata.Builder

Returns:

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

See Also:

• metadata(Metadata)

retrievedReferences

KnowledgeBaseLookupOutput.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

KnowledgeBaseLookupOutput.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

KnowledgeBaseLookupOutput.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<RetrievedReference>).

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<RetrievedReference>)