TextSearchOptions Class
Options for a text search.
Note: This class is marked as 'experimental' and may change in the future.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Constructor
TextSearchOptions(*, filter: TextSearchFilter = None, include_total_count: bool = False, top: Annotated[int, Gt(gt=0)] = 5, skip: Annotated[int, Ge(ge=0)] = 0)Keyword-Only Parameters
| Name | Description |
|---|---|
|
filter
Required
|
|
|
include_total_count
Required
|
|
|
top
|
Default value: 5
|
|
skip
Required
|
|
Attributes
filter
filter: TextSearchFilteris_experimental
is_experimental = Trueskip
skip: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]stage_status
stage_status = 'experimental'top
top: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]