Package com.microsoft.semantickernel.data.vectorstorage.options

Class VectorSearchOptions.Builder

java.lang.Object

com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder

All Implemented Interfaces:

SemanticKernelBuilder<VectorSearchOptions>

Enclosing class:

VectorSearchOptions

public static class VectorSearchOptions.Builder
extends Object
implements SemanticKernelBuilder<VectorSearchOptions>

A builder for the VectorSearchOptions class.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VectorSearchOptions	build()	Builds a new instance of the VectorSearchOptions class.
VectorSearchOptions.Builder	withIncludeTotalCount(boolean includeTotalCount)	Sets a value indicating whether to include the total count of the results.
VectorSearchOptions.Builder	withIncludeVectors(boolean includeVectors)	Sets a value indicating whether to include vectors in the results.
VectorSearchOptions.Builder	withSkip(int skip)	Sets the offset of the results to return.
VectorSearchOptions.Builder	withTop(int top)	Sets the limit of the number of results to return.
VectorSearchOptions.Builder	withVectorFieldName(String vectorFieldName)	Sets the name of the vector field.
VectorSearchOptions.Builder	withVectorSearchFilter(VectorSearchFilter vectorSearchFilter)	Sets the vector search filter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withVectorSearchFilter

public VectorSearchOptions.Builder withVectorSearchFilter(VectorSearchFilter vectorSearchFilter)

Sets the vector search filter.

Parameters:

vectorSearchFilter - the vector search filter

Returns:

this builder

withVectorFieldName

public VectorSearchOptions.Builder withVectorFieldName(String vectorFieldName)

Sets the name of the vector field.

Parameters:

vectorFieldName - the name of the vector field

Returns:

this builder

withTop

public VectorSearchOptions.Builder withTop(int top)

Sets the limit of the number of results to return.

Parameters:

top - the limit of the number of results to return

Returns:

this builder

withSkip

public VectorSearchOptions.Builder withSkip(int skip)

Sets the offset of the results to return.

Parameters:

skip - the offset of the results to return

Returns:

this builder

withIncludeVectors

public VectorSearchOptions.Builder withIncludeVectors(boolean includeVectors)

Sets a value indicating whether to include vectors in the results.

Parameters:

includeVectors - a value indicating whether to include vectors in the results

Returns:

this builder

withIncludeTotalCount

public VectorSearchOptions.Builder withIncludeTotalCount(boolean includeTotalCount)

Sets a value indicating whether to include the total count of the results.

Parameters:

includeTotalCount - a value indicating whether to include the total count of the results

Returns:

this builder

build

public VectorSearchOptions build()

Builds a new instance of the VectorSearchOptions class.

Specified by:

build in interface SemanticKernelBuilder<VectorSearchOptions>

Returns:

a new instance of the VectorSearchOptions class