search method

Future<SearchResponses> search({
  1. required SearchMethodParams searchMethodParams,
  2. RequestOptions? requestOptions,
})

Runs multiple search queries against one or more indices in a single API request. Use cases include: - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters. If you know the expected result type, use the searchForHits or searchForFacets helper to simplify the response format.

Required API Key ACLs:

  • search

Parameters:

  • searchMethodParams Multi-query search request body. Results are returned in the same order as the requests.
  • requestOptions additional request configuration.

Implementation

Future<SearchResponses> search({
  required SearchMethodParams searchMethodParams,
  RequestOptions? requestOptions,
}) async {
  final request = ApiRequest(
    method: RequestMethod.post,
    path: r'/1/indexes/*/queries',
    isRead: true,
    body: searchMethodParams.toJson(),
  );
  final response = await _retryStrategy.execute(
    request: request,
    options: requestOptions,
  );
  return deserialize<SearchResponses, SearchResponses>(
    response,
    'SearchResponses',
    growable: true,
  );
}