TextSearchOptions (Semantic Kernel API 1.4.2 API)

java.lang.Object
- com.microsoft.semantickernel.data.textsearch.TextSearchOptions

public class TextSearchOptions
extends Object

Represents the options for a text search.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TextSearchOptions.Builder
The builder for the TextSearchOptions class.

Field Summary

Fields
Modifier and Type Field Description

static int DEFAULT_TOP
The default number of search results to return.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TextSearchOptions.Builder`	`builder()`	Creates a new instance of the `TextSearchOptions.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 class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_TOP
```
public static final int DEFAULT_TOP
```
    The default number of search results to return.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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.
  - 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.
  - getTop
```
public int getTop()
```
    Gets the limit of the number of results to return.
    
    Returns:
    
    The limit of the number of results to return.
  - getSkip
```
public int getSkip()
```
    Gets the offset of the results to return.
    
    Returns:
    
    The offset of the results to return.
  - getFilter
```
public TextSearchFilter getFilter()
```
    Gets the search filter.
    
    Returns:
    
    The search filter.
  - builder
```
public static TextSearchOptions.Builder builder()
```
    Creates a new instance of the TextSearchOptions.Builder class.
    
    Returns:
    
    The builder.