SearchRequest.md

SearchRequest

Request object for search operation. Either table (regular search) or chat (conversational search) must be provided.

Properties

Name	Type	Description	Notes
table	str	The table to perform the search on	[optional]
chat	Chat		[optional]
query	SearchQuery		[optional]
join	List[Join]	Join clause to combine search data from multiple tables	[optional]
highlight	Highlight		[optional]
limit	int	Maximum number of results to return	[optional]
knn	Knn	K-nearest neighbor search settings. Pass a single `knn` object or an array of objects for multi-vector search.	[optional]
hybrid	Hybrid		[optional]
facet_filter_mode	FacetFilterMode		[optional]
aggs	Dict[str, Aggregation]	Defines aggregation settings for grouping results	[optional]
expressions	Dict[str, str]	Expressions to calculate additional values for the result. Simpler alternative to `script_fields`; expression names must be lowercase.	[optional]
script_fields	Dict[str, ScriptField]	Named expressions computed at search time. Each value defines an inline script whose result is stored under the field name. For more information see Expressions	[optional]
max_matches	int	Maximum number of matches allowed in the result	[optional]
offset	int	Starting point for pagination of the result	[optional]
options	object	Additional search options	[optional]
profile	bool	Enable or disable profiling of the search request	[optional]
sort	object		[optional]
source	object		[optional]
track_scores	bool	Enable or disable result weight calculation used for sorting	[optional]

Example

from manticoresearch.models.search_request import SearchRequest

# TODO update the JSON string below
json = "{}"
# create an instance of SearchRequest from a JSON string
search_request_instance = SearchRequest.from_json(json)
# print the JSON string representation of the object
print(SearchRequest.to_json())

# convert the object into a dict
search_request_dict = search_request_instance.to_dict()
# create an instance of SearchRequest from a dict
search_request_from_dict = SearchRequest.from_dict(search_request_dict)

[Back to Model list] [Back to API list] [Back to README]