Interface SearchCriteria.Builder

All Superinterfaces:

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

Enclosing class:

SearchCriteria

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

Method Summary

Modifier and Type	Method	Description
SearchCriteria.Builder	memoryStrategyId(String memoryStrategyId)	The memory strategy identifier to filter memory records by.
SearchCriteria.Builder	metadataFilters(Collection<MemoryMetadataFilterExpression> metadataFilters)	Filters to apply to metadata associated with a memory.
SearchCriteria.Builder	metadataFilters(Consumer<MemoryMetadataFilterExpression.Builder>... metadataFilters)	Filters to apply to metadata associated with a memory.
SearchCriteria.Builder	metadataFilters(MemoryMetadataFilterExpression... metadataFilters)	Filters to apply to metadata associated with a memory.
SearchCriteria.Builder	searchQuery(String searchQuery)	The search query to use for finding relevant memory records.
SearchCriteria.Builder	topK(Integer topK)	The maximum number of top-scoring memory records to return.

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

searchQuery

SearchCriteria.Builder searchQuery(String searchQuery)

The search query to use for finding relevant memory records.

Parameters:

searchQuery - The search query to use for finding relevant memory records.

Returns:

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

memoryStrategyId

SearchCriteria.Builder memoryStrategyId(String memoryStrategyId)

The memory strategy identifier to filter memory records by.

Parameters:

memoryStrategyId - The memory strategy identifier to filter memory records by.

Returns:

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

topK

SearchCriteria.Builder topK(Integer topK)

The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.

Parameters:

topK - The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.

Returns:

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

metadataFilters

SearchCriteria.Builder metadataFilters(Collection<MemoryMetadataFilterExpression> metadataFilters)

Filters to apply to metadata associated with a memory.

Parameters:

metadataFilters - Filters to apply to metadata associated with a memory.

Returns:

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

metadataFilters

SearchCriteria.Builder metadataFilters(MemoryMetadataFilterExpression... metadataFilters)

Filters to apply to metadata associated with a memory.

Parameters:

metadataFilters - Filters to apply to metadata associated with a memory.

Returns:

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

metadataFilters

SearchCriteria.Builder metadataFilters(Consumer<MemoryMetadataFilterExpression.Builder>... metadataFilters)

Filters to apply to metadata associated with a memory.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataFilters(List<MemoryMetadataFilterExpression>).

Parameters:

metadataFilters - a consumer that will call methods on MemoryMetadataFilterExpression.Builder

Returns:

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

See Also:

• metadataFilters(java.util.Collection<MemoryMetadataFilterExpression>)