Skip to content

Commit

Permalink
Fix some mistakes in federated multi search docs (#3074)
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasKalbertodt authored Jan 14, 2025
1 parent 6288c48 commit 3d9732c
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions reference/api/multi_search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ When both `facetsByIndex` and `mergeFacets` are present and not null, facet info
{
"hits": [ ],
"facetFederation": {
"facetDistribution": {
"ATTRIBUTE": {
"VALUE": <Integer>,
"VALUE": <Integer>
Expand Down Expand Up @@ -207,19 +207,14 @@ Federated search requests return a single object and the following fields:

| Name | Type | Description |
| :----------------------- | :--------------- | :------------------------------------------------------------------------------- |
| **`indexUid`** | String | [`uid`](/learn/getting_started/indexes#index-uid) of the requested index |
| **`hits`** | Array of objects | Results of the query |
| **`offset`** | Number | Number of documents skipped |
| **`limit`** | Number | Number of documents to take |
| **`estimatedTotalHits`** | Number | Estimated total number of matches |
| **`totalHits`** | Number | Exhaustive total number of matches |
| **`totalPages`** | Number | Exhaustive total number of search result pages |
| **`hitsPerPage`** | Number | Number of results on each page |
| **`page`** | Number | Current search results page |
| **`facetDistribution`** | Object | **[Distribution of the given facets](/reference/api/search#facetdistribution)** |
| **`facetStats`** | Object | [The numeric `min` and `max` values per facet](/reference/api/search#facetstats) |
| **`processingTimeMs`** | Number | Processing time of the query |
| **`query`** | String | Query originating the response |
| **`facetsByIndex`** | Object | [Data for facets present in the search results](#facetsbyindex) |
| **`facetDistribution`** | Object | [Distribution of the given facets](#mergefacets) |
| **`facetStats`** | Object | [The numeric `min` and `max` values per facet](#mergefacets) |

Each result in the `hits` array contains an additional `_federation` field with the following fields:

Expand Down

0 comments on commit 3d9732c

Please sign in to comment.