SearchRequest

October 23, 2025 ยท View on GitHub

Request object for search operation

Properties

NameTypeDescriptionNotes
tablestrThe table to perform the search on
querySearchQuery[optional]
joinList[Join]Join clause to combine search data from multiple tables[optional]
highlightHighlight[optional]
limitintMaximum number of results to return[optional]
knnKnn[optional]
aggsDict[str, Aggregation]Defines aggregation settings for grouping results[optional]
expressionsDict[str, str]Expressions to calculate additional values for the result[optional]
max_matchesintMaximum number of matches allowed in the result[optional]
offsetintStarting point for pagination of the result[optional]
optionsobjectAdditional search options[optional]
profileboolEnable or disable profiling of the search request[optional]
sortobject[optional]
sourceobject[optional]
track_scoresboolEnable 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]