| Name | Type | Description |
|---|---|---|
query* | str | Full-text query string. |
k | int | Default: 4Number of |
filter | Optional[FilterExpression] | Default: NoneOptional RedisVL |
text_fields | Optional[Union[str, Dict[str, float]]] | Default: None |
text_scorer | str | Default: 'BM25STD' |
stopwords | Optional[Union[str, Set[str]]] | Default: 'english' |
return_metadata | bool | Default: True |
Return docs matching the query by full-text relevance only.
Text field to search in, or a mapping of field
names to weights (e.g. {"title": 5.0, "text": 1.0}).
Defaults to the configured content_field.
Full-text scoring algorithm (default 'BM25STD').
Stopwords to strip from the query text client-side.
Language string, set of words, or None to disable.
Whether to return metadata with the documents.