GetRecordOptions.Builder Class

Package:
com.microsoft.semantickernel.data.vectorstorage.options
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • java.lang.Object
    • com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions.Builder

Implements

SemanticKernelBuilder<GetRecordOptions>

public static class GetRecordOptions.Builder
implements SemanticKernelBuilder<GetRecordOptions>

A builder for GetRecordOptions.

Constructor Summary

Constructor Description
Builder()

Method Summary

Modifier and Type Method and Description
GetRecordOptions build()

Builds the options.
Builder includeVectors(boolean includeVectors)

Sets whether to include vectors.
Builder setWildcardKeyMatching(boolean wildcardKeyMatching)

Sets whether to use wildcard key matching.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Builder

public Builder()

Method Details

build

public GetRecordOptions build()

Builds the options.

Returns:

GetRecordOptions

includeVectors

public GetRecordOptions.Builder includeVectors(boolean includeVectors)

Sets whether to include vectors.

Parameters:

includeVectors - whether to include vectors

Returns:

GetRecordOptions.Builder

setWildcardKeyMatching

public GetRecordOptions.Builder setWildcardKeyMatching(boolean wildcardKeyMatching)

Sets whether to use wildcard key matching. Default is false. Wildcard key matching allows for matching multiple ids, for instance using "LIKE 'a%'" on a SQL query.

NOTE: Currently this is only supported by the SQL connectors.

Parameters:

wildcardKeyMatching - whether to use wildcard key matching

Returns:

GetRecordOptions.Builder

Applies to