TextSearchOptions Class

Package:
com.microsoft.semantickernel.data.textsearch
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • java.lang.Object
    • com.microsoft.semantickernel.data.textsearch.TextSearchOptions

public class TextSearchOptions

Represents the options for a text search.

Field Summary

Modifier and Type Field and Description
static final int DEFAULT_TOP

The default number of search results to return.

Method Summary

Modifier and Type Method and Description
static Builder builder()

Creates a new instance of the Builder class.
static TextSearchOptions createDefault()

Creates a new instance of the TextSearchOptions class with default values.
TextSearchFilter getFilter()

Gets the search filter.
int getSkip()

Gets the offset of the results to return.
int getTop()

Gets the limit of the number of results to return.
boolean isIncludeTotalCount()

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

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

Field Details

DEFAULT_TOP

public static final int DEFAULT_TOP

The default number of search results to return.

Method Details

builder

public static TextSearchOptions.Builder builder()

Creates a new instance of the Builder class.

Returns:

The builder.

createDefault

public static TextSearchOptions createDefault()

Creates a new instance of the TextSearchOptions class with default values.

Returns:

A new instance of the TextSearchOptions class with default values.

getFilter

public TextSearchFilter getFilter()

Gets the search filter.

Returns:

The search filter.

getSkip

public int getSkip()

Gets the offset of the results to return.

Returns:

The offset of the results to return.

getTop

public int getTop()

Gets the limit of the number of results to return.

Returns:

The limit of the number of results to return.

isIncludeTotalCount

public boolean isIncludeTotalCount()

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

Returns:

A value indicating whether to include the total count of search results.

Applies to