GetRecordOptions 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

public class GetRecordOptions

Options for getting a record.

Constructor Summary

Constructor Description
GetRecordOptions(boolean includeVectors)

Creates a new instance of the GetRecordOptions class.
GetRecordOptions(boolean includeVectors, boolean wildcardKeyMatching)

Creates a new instance of the GetRecordOptions class.

Method Summary

Modifier and Type Method and Description
static Builder builder()

Creates a new builder.
boolean isIncludeVectors()

Gets whether to include vectors.
boolean isWildcardKeyMatching()

Gets 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

GetRecordOptions

public GetRecordOptions(boolean includeVectors)

Creates a new instance of the GetRecordOptions class.

Parameters:

includeVectors - A value indicating whether to include vectors in a response.

GetRecordOptions

public GetRecordOptions(boolean includeVectors, boolean wildcardKeyMatching)

Creates a new instance of the GetRecordOptions class.

Parameters:

includeVectors - A value indicating whether to include vectors in a response.
wildcardKeyMatching - A value indicating whether to use wildcard key matching.

Method Details

builder

public static GetRecordOptions.Builder builder()

Creates a new builder.

Returns:

the builder

isIncludeVectors

public boolean isIncludeVectors()

Gets whether to include vectors.

Returns:

whether to include vectors

isWildcardKeyMatching

public boolean isWildcardKeyMatching()

Gets whether to use wildcard key matching.

Returns:

true if wildcard key matching is used; otherwise, false.

Applies to