> ## Documentation Index > Fetch the complete documentation index at: https://algolia.com/llms.txt > Use this file to discover all available pages before exploring further. # Browse for records > Retrieves records from an index, up to 1,000 per request. Searching returns *hits* (records augmented with highlighting and ranking details). Browsing returns matching records only. Use browse to export your indices. * The Analytics API doesn't collect data when using `browse`. * Records are ranked by attributes and custom ranking. * There's no ranking for typo tolerance, number of matched words, proximity, or geo distance. Browse requests automatically apply these settings: * `advancedSyntax`: `false` * `attributesToHighlight`: `[]` * `attributesToSnippet`: `[]` * `distinct`: `false` * `enablePersonalization`: `false` * `enableRules`: `false` * `facets`: `[]` * `getRankingInfo`: `false` * `ignorePlurals`: `false` * `optionalFilters`: `[]` * `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they're ignored. **Required ACL:** `browse` ## OpenAPI ````yaml specs/search.yml post /1/indexes/{indexName}/browse openapi: 3.1.0 info: title: Search API summary: >- The Algolia Search API lets you search, configure, and manage your indices and records description: > ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla). For more information, see [Algolia's ecosystem](https://www.algolia.com/doc/libraries). ## Base URLs Base URLs for the Search API: - `https://{APPLICATION_ID}.algolia.net` - `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ## Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` - `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different DNS provider than the primary URLs. Randomize this list to ensure an even load across the three servers. All Algolia API clients implement this retry strategy. ## Authentication Add these headers to authenticate requests: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects. ## Parameters Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests. Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of: - A comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array: `attributesToRetrieve=%5B%22title%22,%22description%22%D` ## Response status and errors The Search API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses return `2xx` statuses. Client errors return `4xx` statuses. Server errors return `5xx` statuses. Error responses have a `message` property with more information. ## Version The current version of the Search API is version 1, indicated by the `/1/` in each endpoint's URL. version: 1.0.0 servers: - url: https://{appId}.algolia.net variables: appId: default: ALGOLIA_APPLICATION_ID - url: https://{appId}-1.algolianet.com variables: appId: default: ALGOLIA_APPLICATION_ID - url: https://{appId}-2.algolianet.com variables: appId: default: ALGOLIA_APPLICATION_ID - url: https://{appId}-3.algolianet.com variables: appId: default: ALGOLIA_APPLICATION_ID - url: https://{appId}-dsn.algolia.net variables: appId: default: ALGOLIA_APPLICATION_ID security: - appId: [] apiKey: [] tags: - name: Advanced description: Query your logs. - name: Api Keys x-displayName: API keys description: > Manage your API keys. API requests must be authenticated with an API key. API keys can have permissions (access control lists, ACL) and restrictions. externalDocs: url: https://www.algolia.com/doc/guides/security/api-keys description: API keys. - name: Clusters description: | Multi-cluster operations. Multi-cluster operations are **deprecated**. If you have issues with your Algolia infrastructure due to large volumes of data, contact the Algolia support team. - name: Dictionaries description: > Manage your dictionaries. Customize language-specific settings, such as stop words, plurals, or word segmentation. Dictionaries are application-wide. externalDocs: url: >- https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp description: Natural languages. - name: Indices description: > Manage your indices and index settings. Indices are copies of your data that are stored on Algolia's servers. They're optimal data structures for fast search and are made up of records and settings. externalDocs: url: >- https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices description: Manage your indices. - name: Records description: > Add, update, and delete records from your indices. Records are individual items in your index. When they match a search query, they're returned as search results, in the order determined by your ranking. Records are schemaless JSON objects. When adding or updating many records, check the [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). externalDocs: url: >- https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data description: Prepare your records. - name: Rules description: > Create, update, delete, and search for rules. Rules are _if-then_ statements that you can use to curate search results. Rules have _conditions_ that can trigger _consequences_. Consequences are changes to the search results, such as changing the order of search results or boosting a facet. This can be useful for tuning specific queries or for merchandising. externalDocs: url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview description: Index Rules. - name: Search description: Search one or more indices for matching records or facet values. - name: Synonyms description: | Create, update, delete, and search for synonyms. Synonyms are terms that the search engine should consider equal. externalDocs: url: >- https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms description: Synonyms. - name: Vaults description: >- Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest. externalDocs: url: https://www.algolia.com/doc/guides/security/algolia-vault description: Algolia Vault. - name: _model_index_settings x-displayName: Index settings description: | . paths: /1/indexes/{indexName}/browse: post: tags: - Search summary: Browse for records description: > Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Browsing returns matching records only. Use browse to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There's no ranking for typo tolerance, number of matched words, proximity, or geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they're ignored. operationId: browse parameters: - $ref: '#/components/parameters/IndexName' requestBody: content: application/json: schema: $ref: '#/components/schemas/browseParams' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/browseResponse' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' x-codeSamples: - lang: csharp label: C# source: >- // Initialize the client var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")); // Call the API var response = await client.BrowseAsync(""); // print the response Console.WriteLine(response); - lang: dart label: Dart source: |- // Initialize the client final client = SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY'); // Call the API final response = await client.browse( indexName: "", ); // print the response print(response); - lang: go label: Go source: >- // Initialize the client client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") if err != nil { // The client can fail to initialize if you pass an invalid parameter. panic(err) } // Call the API response, err := client.Browse(client.NewApiBrowseRequest( "")) if err != nil { // handle the eventual error panic(err) } // print the response print(response) - lang: java label: Java source: >- // Initialize the client SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"); // Call the API BrowseResponse response = client.browse("", Hit.class); // print the response System.out.println(response); - lang: javascript label: JavaScript source: >- // Initialize the client const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); // Call the API const response = await client.browse({ indexName: 'cts_e2e_browse' }); // print the response console.log(response); - lang: kotlin label: Kotlin source: >- // Initialize the client val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") // Call the API var response = client.browse(indexName = "") // print the response println(response) - lang: php label: PHP source: >- // Initialize the client $client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); // Call the API $response = $client->browse( '', ); // print the response var_dump($response); - lang: python label: Python source: >- # Initialize the client # In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods. client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") # Call the API response = client.browse( index_name="", ) # print the response print(response) - lang: ruby label: Ruby source: >- # Initialize the client client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") # Call the API response = client.browse("") # print the response puts(response) - lang: scala label: Scala source: >- // Initialize the client val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") // Call the API val response = Await.result( client.browse( indexName = "" ), Duration(100, "sec") ) // print the response println(response) - lang: swift label: Swift source: >- // Initialize the client let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY") // Call the API let response: BrowseResponse = try await client.browse(indexName: "") // print the response print(response) - lang: cURL label: curl source: |- curl --request POST \ --url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/browse \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \ --data ' { "query": "", "similarQuery": "comedy drama crime Macy Buscemi", "filters": "(category:Book OR category:Ebook) AND _tags:published", "facetFilters": [ [ "category:Book", "category:-Movie" ], "author:John Doe" ], "optionalFilters": [ "category:Book", "author:John Doe" ], "numericFilters": [ [ "inStock = 1", "deliveryDate < 1441755506" ], "price < 1000" ], "tagFilters": [ [ "Book", "Movie" ], "SciFi" ], "sumOrFiltersScores": false, "restrictSearchableAttributes": [ "title", "author" ], "facets": [ "*" ], "facetingAfterDistinct": false, "page": 0, "offset": 42, "length": 0, "aroundLatLng": "40.71,-74.01", "aroundLatLngViaIP": false, "aroundRadius": 1, "aroundPrecision": 10, "minimumAroundRadius": 1, "insideBoundingBox": "lorem", "insidePolygon": [ [ 47.3165, 4.9665, 47.3424, 5.0201, 47.32, 4.9 ], [ 40.9234, 2.1185, 38.643, 1.9916, 39.2587, 2.0104 ] ], "naturalLanguages": [], "ruleContexts": [ "mobile" ], "personalizationImpact": 100, "userToken": "test-user-123", "getRankingInfo": false, "synonyms": true, "clickAnalytics": false, "analytics": true, "analyticsTags": [], "percentileComputation": true, "enableABTest": true, "attributesToRetrieve": [ "author", "title", "content" ], "ranking": [ "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom" ], "relevancyStrictness": 90, "attributesToHighlight": [ "author", "title", "conten", "content" ], "attributesToSnippet": [ "content:80", "description" ], "highlightPreTag": "", "highlightPostTag": "", "snippetEllipsisText": "…", "restrictHighlightAndSnippetArrays": false, "hitsPerPage": 20, "minWordSizefor1Typo": 4, "minWordSizefor2Typos": 8, "typoTolerance": true, "allowTyposOnNumericTokens": true, "disableTypoToleranceOnAttributes": [ "sku" ], "ignorePlurals": [ "ca", "es" ], "removeStopWords": [ "ca", "es" ], "queryLanguages": [ "es" ], "decompoundQuery": true, "enableRules": true, "enablePersonalization": false, "queryType": "prefixLast", "removeWordsIfNoResults": "firstWords", "mode": "keywordSearch", "semanticSearch": { "eventSources": [ "lorem" ] }, "advancedSyntax": false, "optionalWords": "lorem", "disableExactOnAttributes": [ "description" ], "exactOnSingleWordQuery": "attribute", "alternativesAsExact": [ "ignorePlurals", "singleWordSynonym" ], "advancedSyntaxFeatures": [ "exactPhrase", "excludeWords" ], "distinct": 1, "replaceSynonymsInHighlight": false, "minProximity": 1, "responseFields": [ "*" ], "maxValuesPerFacet": 100, "sortFacetValuesBy": "count", "attributeCriteriaComputedByMinProximity": false, "renderingContent": { "facetOrdering": { "facets": { "order": [ "lorem" ] }, "values": { "property1": { "order": [ "lorem" ], "sortRemainingBy": "count", "hide": [ "lorem" ] }, "property2": { "order": [ "lorem" ], "sortRemainingBy": "count", "hide": [ "lorem" ] } } }, "redirect": { "url": "lorem" }, "widgets": { "banners": [ { "image": { "urls": [ { "url": "lorem" } ], "title": "lorem" }, "link": { "url": "lorem" } } ] } }, "enableReRanking": true, "reRankingApplyFilter": [ [] ], "cursor": "jMDY3M2MwM2QwMWUxMmQwYWI0ZTN" } ' components: parameters: IndexName: name: indexName in: path description: Name of the index on which to perform the operation. required: true schema: type: string example: ALGOLIA_INDEX_NAME schemas: browseParams: oneOf: - $ref: '#/components/schemas/browseParamsObject' title: Search parameters as object - $ref: '#/components/schemas/searchParamsString' browseResponse: allOf: - $ref: '#/components/schemas/baseSearchResponse' - $ref: '#/components/schemas/BrowsePagination' - $ref: '#/components/schemas/searchHits' - $ref: '#/components/schemas/cursor' browseParamsObject: type: object properties: advancedSyntax: $ref: '#/components/schemas/advancedSyntax' advancedSyntaxFeatures: $ref: '#/components/schemas/IndexSettings_advancedSyntaxFeatures' allowTyposOnNumericTokens: $ref: '#/components/schemas/allowTyposOnNumericTokens' alternativesAsExact: $ref: '#/components/schemas/IndexSettings_alternativesAsExact' analytics: $ref: '#/components/schemas/analytics' analyticsTags: $ref: '#/components/schemas/analyticsTags' x-categories: - Analytics aroundLatLng: $ref: '#/components/schemas/aroundLatLng' aroundLatLngViaIP: $ref: '#/components/schemas/aroundLatLngViaIP' aroundPrecision: $ref: '#/components/schemas/aroundPrecision' aroundRadius: $ref: '#/components/schemas/aroundRadius' attributeCriteriaComputedByMinProximity: $ref: '#/components/schemas/attributeCriteriaComputedByMinProximity' attributesToHighlight: $ref: '#/components/schemas/attributesToHighlight' attributesToRetrieve: $ref: '#/components/schemas/attributesToRetrieve' attributesToSnippet: $ref: '#/components/schemas/attributesToSnippet' clickAnalytics: $ref: '#/components/schemas/clickAnalytics' cursor: type: string description: > Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute. example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN decompoundQuery: $ref: '#/components/schemas/decompoundQuery' disableExactOnAttributes: $ref: '#/components/schemas/disableExactOnAttributes' disableTypoToleranceOnAttributes: $ref: '#/components/schemas/disableTypoToleranceOnAttributes' distinct: $ref: '#/components/schemas/distinct' enableABTest: $ref: '#/components/schemas/enableABTest' enablePersonalization: $ref: '#/components/schemas/enablePersonalization' enableReRanking: $ref: '#/components/schemas/enableReRanking' enableRules: $ref: '#/components/schemas/enableRules' exactOnSingleWordQuery: $ref: '#/components/schemas/exactOnSingleWordQuery' facetFilters: $ref: '#/components/schemas/facetFilters' facetingAfterDistinct: $ref: '#/components/schemas/facetingAfterDistinct' facets: type: array items: type: string description: > Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). default: [] example: - '*' x-categories: - Faceting filters: $ref: '#/components/schemas/filters' getRankingInfo: $ref: '#/components/schemas/getRankingInfo' highlightPostTag: $ref: '#/components/schemas/highlightPostTag' highlightPreTag: $ref: '#/components/schemas/highlightPreTag' hitsPerPage: $ref: '#/components/schemas/hitsPerPage' ignorePlurals: $ref: '#/components/schemas/ignorePlurals' insideBoundingBox: $ref: '#/components/schemas/insideBoundingBox' insidePolygon: $ref: '#/components/schemas/insidePolygon' length: $ref: '#/components/schemas/length' maxValuesPerFacet: $ref: '#/components/schemas/maxValuesPerFacet' minimumAroundRadius: $ref: '#/components/schemas/minimumAroundRadius' minProximity: $ref: '#/components/schemas/minProximity' minWordSizefor1Typo: $ref: '#/components/schemas/minWordSizefor1Typo' minWordSizefor2Typos: $ref: '#/components/schemas/minWordSizefor2Typos' mode: $ref: '#/components/schemas/mode' naturalLanguages: $ref: '#/components/schemas/naturalLanguages' numericFilters: $ref: '#/components/schemas/numericFilters' offset: type: integer description: Position of the first hit to retrieve. x-categories: - Pagination optionalFilters: $ref: '#/components/schemas/optionalFilters' optionalWords: $ref: '#/components/schemas/optionalWords' page: $ref: '#/components/schemas/page' percentileComputation: $ref: '#/components/schemas/percentileComputation' personalizationImpact: $ref: '#/components/schemas/personalizationImpact' query: $ref: '#/components/schemas/query' queryLanguages: $ref: '#/components/schemas/queryLanguages' queryType: $ref: '#/components/schemas/queryType' ranking: type: array items: type: string description: > Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing). default: - typo - geo - words - filters - proximity - attribute - exact - custom x-categories: - Ranking relevancyStrictness: $ref: '#/components/schemas/relevancyStrictness' removeStopWords: $ref: '#/components/schemas/removeStopWords' removeWordsIfNoResults: $ref: '#/components/schemas/removeWordsIfNoResults' renderingContent: $ref: '#/components/schemas/renderingContent' replaceSynonymsInHighlight: $ref: '#/components/schemas/replaceSynonymsInHighlight' reRankingApplyFilter: oneOf: - $ref: '#/components/schemas/reRankingApplyFilter' - type: 'null' responseFields: $ref: '#/components/schemas/responseFields' restrictHighlightAndSnippetArrays: $ref: '#/components/schemas/restrictHighlightAndSnippetArrays' restrictSearchableAttributes: $ref: '#/components/schemas/restrictSearchableAttributes' ruleContexts: $ref: '#/components/schemas/ruleContexts' semanticSearch: $ref: '#/components/schemas/semanticSearch' similarQuery: $ref: '#/components/schemas/similarQuery' snippetEllipsisText: $ref: '#/components/schemas/snippetEllipsisText' sortFacetValuesBy: $ref: '#/components/schemas/sortFacetValuesBy' sumOrFiltersScores: $ref: '#/components/schemas/sumOrFiltersScores' synonyms: $ref: '#/components/schemas/synonyms' tagFilters: $ref: '#/components/schemas/tagFilters' typoTolerance: $ref: '#/components/schemas/typoTolerance' userToken: $ref: '#/components/schemas/userToken' additionalProperties: false description: >- Each parameter value, including the `query` must not be larger than 512 bytes. title: Search parameters as object searchParamsString: type: object title: Search parameters as query string description: Search parameters as query string. additionalProperties: false x-discriminator-fields: - params properties: params: $ref: '#/components/schemas/paramsAsString' baseSearchResponse: type: object additionalProperties: true properties: _automaticInsights: type: boolean description: Whether automatic events collection is enabled for the application. abTestID: type: integer description: >- A/B test ID. This is only included in the response for indices that are part of an A/B test. abTestVariantID: type: integer minimum: 1 description: >- Variant ID. This is only included in the response for indices that are part of an A/B test. appliedRules: description: Rules applied to the query. title: appliedRules type: array items: type: object aroundLatLng: type: string description: Computed geographical location. example: 40.71,-74.01 pattern: ^(-?\d+(\.\d+)?),\s*(-?\d+(\.\d+)?)$ automaticRadius: type: string description: Distance from a central coordinate provided by `aroundLatLng`. exhaustive: title: exhaustive type: object description: >- Whether certain properties of the search response are calculated exhaustive (exact) or approximated. properties: facetsCount: type: boolean title: facetsCount description: >- Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). facetValues: type: boolean title: facetValues description: The value is `false` if not all facet values are retrieved. nbHits: type: boolean title: nbHits description: >- Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query. rulesMatch: type: boolean title: rulesMatch description: >- Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large. typo: type: boolean title: typo description: >- Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled. exhaustiveFacetsCount: type: boolean description: >- See the `facetsCount` field of the `exhaustive` object in the response. deprecated: true exhaustiveNbHits: type: boolean description: See the `nbHits` field of the `exhaustive` object in the response. deprecated: true exhaustiveTypo: type: boolean description: See the `typo` field of the `exhaustive` object in the response. deprecated: true facets: title: facets type: object additionalProperties: x-additionalPropertiesName: facet type: object additionalProperties: x-additionalPropertiesName: facet count type: integer description: Facet counts. example: category: food: 1 tech: 42 facets_stats: type: object description: Statistics for numerical facets. additionalProperties: title: facetStats type: object properties: avg: type: number format: double description: Average facet value in the results. max: type: number format: double description: Maximum value in the results. min: type: number format: double description: Minimum value in the results. sum: type: number format: double description: Sum of all values in the results. index: type: string example: indexName description: Index name used for the query. indexUsed: type: string description: >- Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query. example: indexNameAlt message: type: string description: Warnings about the query. nbSortedHits: type: integer description: Number of hits selected and sorted by the relevant sort algorithm. example: 20 parsedQuery: type: string description: >- Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched. example: george clo processingTimeMS: $ref: '#/components/schemas/processingTimeMS' processingTimingsMS: type: object description: >- Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues. queryAfterRemoval: type: string description: >- Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set. queryID: type: string description: >- Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics). example: a00dbc80a8d13c4565a442e7e2dca80a redirect: title: redirect type: object description: > [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects), this this parameter is for internal use only. properties: index: type: array items: $ref: '#/components/schemas/RedirectRuleIndexMetadata' renderingContent: $ref: '#/components/schemas/renderingContent' serverTimeMS: type: integer description: Time the server took to process the request, in milliseconds. example: 20 serverUsed: type: string description: Host name of the server that processed the request. example: c2-uk-3.algolia.net userData: $ref: '#/components/schemas/userData' BrowsePagination: type: object additionalProperties: false properties: hitsPerPage: $ref: '#/components/schemas/hitsPerPage' nbHits: $ref: '#/components/schemas/nbHits' nbPages: $ref: '#/components/schemas/nbPages' page: $ref: '#/components/schemas/page' searchHits: type: object additionalProperties: true properties: hits: type: array description: > Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting. items: $ref: '#/components/schemas/hit' extensions: $ref: '#/components/schemas/responseExtensions' params: type: string description: URL-encoded string of all search parameters. example: query=a&hitsPerPage=20 query: $ref: '#/components/schemas/query' required: - hits cursor: type: object additionalProperties: false properties: cursor: type: string description: > Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute. example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN ErrorBase: description: Error. type: object x-keep-model: true additionalProperties: true properties: message: type: string example: Invalid Application-Id or API-Key advancedSyntax: type: boolean description: > Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported. default: false x-categories: - Query strategy IndexSettings_advancedSyntaxFeatures: type: array items: $ref: '#/components/schemas/advancedSyntaxFeatures' description: | Advanced search syntax features you want to support - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case" - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain "search" but not "engine" This setting only has an effect if `advancedSyntax` is true. default: - exactPhrase - excludeWords x-categories: - Query strategy allowTyposOnNumericTokens: type: boolean description: | Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. default: true x-categories: - Typos IndexSettings_alternativesAsExact: type: array items: $ref: '#/components/schemas/alternativesAsExact' description: > Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - "swimsuit" and "swimsuits" are treated the same - "swimsuit" and "swimwear" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as "NY" = "NYC", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as "NY" = "New York", are considered exact matches. default: - ignorePlurals - singleWordSynonym x-categories: - Query strategy analytics: type: boolean description: Whether this search will be included in Analytics. default: true x-categories: - Analytics analyticsTags: type: array items: type: string description: >- Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments). default: [] aroundLatLng: type: string description: > Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. example: 40.71,-74.01 default: '' x-categories: - Geo-Search aroundLatLngViaIP: type: boolean description: Whether to obtain the coordinates from the request's IP address. default: false x-categories: - Geo-Search aroundPrecision: description: > Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal. oneOf: - type: integer default: 10 description: > Distance in meters to group results by similar distances. For example, if you set `aroundPrecision` to 100, records wihin 100 meters to the central coordinate are considered to have the same distance, as are records between 100 and 199 meters. - $ref: '#/components/schemas/aroundPrecisionFromValue' x-categories: - Geo-Search aroundRadius: description: > Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. oneOf: - type: integer minimum: 1 description: Maximum search radius around a central location in meters. - $ref: '#/components/schemas/aroundRadiusAll' x-categories: - Geo-Search attributeCriteriaComputedByMinProximity: type: boolean description: > Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. default: false x-categories: - Advanced attributesToHighlight: type: array items: type: string example: - author - title - conten - content description: > Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js). x-categories: - Highlighting and Snippeting attributesToRetrieve: type: array items: type: string example: - author - title - content description: > Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`. - The `objectID` attribute is always included. default: - '*' x-categories: - Attributes attributesToSnippet: type: array items: type: string example: - content:80 - description description: > Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. default: [] x-categories: - Highlighting and Snippeting clickAnalytics: type: boolean description: > Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started). default: false x-categories: - Analytics decompoundQuery: type: boolean description: > Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). default: true x-categories: - Languages disableExactOnAttributes: type: array items: type: string example: - description description: > Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. default: [] x-categories: - Query strategy disableTypoToleranceOnAttributes: type: array items: type: string example: - sku description: > Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. default: [] x-categories: - Typos distinct: description: > Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. example: 1 oneOf: - type: boolean description: >- Whether deduplication is turned on. If true, only one member of a group is shown in the search results. - type: integer description: > Number of members of a group of records to include in the search results. - Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits). The number of hits won't be correct and faceting won't work as expected. - With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups. For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned. Likewise, the `nbHits` response attribute contains the number of returned groups. minimum: 0 maximum: 4 default: 0 x-categories: - Advanced enableABTest: type: boolean description: Whether to enable A/B testing for this search. default: true x-categories: - Advanced enablePersonalization: type: boolean description: Whether to enable Personalization. default: false x-categories: - Personalization enableReRanking: type: boolean description: > Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. default: true x-categories: - Filtering enableRules: type: boolean description: Whether to enable rules. default: true x-categories: - Rules exactOnSingleWordQuery: type: string enum: - attribute - none - word description: > Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. default: attribute x-categories: - Query strategy facetFilters: description: > Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\-value`. example: - - category:Book - category:-Movie - author:John Doe oneOf: - type: array items: $ref: '#/components/schemas/facetFilters' - type: string x-categories: - Filtering facetingAfterDistinct: type: boolean description: > Whether faceting should be applied after deduplication with `distinct` This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. default: false x-categories: - Faceting filters: type: string description: > Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO `, where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:`, where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering). example: (category:Book OR category:Ebook) AND _tags:published x-categories: - Filtering getRankingInfo: type: boolean description: Whether the search response should include detailed ranking information. default: false x-categories: - Advanced highlightPostTag: type: string description: >- HTML tag to insert after the highlighted parts in all highlighted results and snippets. default: x-categories: - Highlighting and Snippeting highlightPreTag: type: string description: >- HTML tag to insert before the highlighted parts in all highlighted results and snippets. default: x-categories: - Highlighting and Snippeting hitsPerPage: type: integer description: Number of hits per page. default: 20 minimum: 1 maximum: 1000 x-categories: - Pagination ignorePlurals: description: | Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index. example: - ca - es oneOf: - type: array description: | ISO code for languages for which this feature should be active. This overrides languages you set with `queryLanguages`. items: $ref: '#/components/schemas/supportedLanguage' - $ref: '#/components/schemas/booleanString' - type: boolean description: > If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty. If false, singulars, plurals, and other declensions won't be considered equivalent. default: false x-categories: - Languages insideBoundingBox: oneOf: - type: string - type: 'null' - $ref: '#/components/schemas/insideBoundingBoxArray' insidePolygon: type: array items: type: array minItems: 6 maxItems: 20000 items: type: number format: double description: > Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`. example: - - 47.3165 - 4.9665 - 47.3424 - 5.0201 - 47.32 - 4.9 - - 40.9234 - 2.1185 - 38.643 - 1.9916 - 39.2587 - 2.0104 x-categories: - Geo-Search length: type: integer description: Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 x-categories: - Pagination maxValuesPerFacet: type: integer description: Maximum number of facet values to return for each facet. default: 100 maximum: 1000 x-categories: - Faceting minimumAroundRadius: type: integer description: >- Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set. minimum: 1 x-categories: - Geo-Search minProximity: type: integer minimum: 1 maximum: 7 description: > Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. default: 1 x-categories: - Advanced minWordSizefor1Typo: type: integer description: >- Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). default: 4 x-categories: - Typos minWordSizefor2Typos: type: integer description: >- Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). default: 8 x-categories: - Typos mode: type: string enum: - neuralSearch - keywordSearch description: > Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you. default: keywordSearch x-categories: - Query strategy naturalLanguages: type: array items: $ref: '#/components/schemas/supportedLanguage' description: > ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`. default: [] x-categories: - Languages numericFilters: description: > Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. example: - - inStock = 1 - deliveryDate < 1441755506 - price < 1000 oneOf: - type: array items: $ref: '#/components/schemas/numericFilters' - type: string x-categories: - Filtering optionalFilters: description: > Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are applied _after_ the replica's [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort). example: - category:Book - author:John Doe oneOf: - type: array items: $ref: '#/components/schemas/optionalFilters' - type: string x-categories: - Filtering optionalWords: description: > Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is optional, the search engine runs two queries: one for "action video" and one for "action". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). oneOf: - type: string - type: 'null' - $ref: '#/components/schemas/optionalWordsArray' page: type: integer description: Page of search results to retrieve. default: 0 minimum: 0 x-categories: - Pagination percentileComputation: type: boolean description: >- Whether to include this search when calculating processing-time percentiles. default: true x-categories: - Advanced personalizationImpact: type: integer description: > Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact). default: 100 minimum: 0 maximum: 100 x-categories: - Personalization query: type: string description: Search query. default: '' x-categories: - Search queryLanguages: type: array items: $ref: '#/components/schemas/supportedLanguage' example: - es description: > Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations). default: [] x-categories: - Languages queryType: type: string enum: - prefixLast - prefixAll - prefixNone description: > Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching). default: prefixLast x-categories: - Query strategy relevancyStrictness: type: integer example: 90 description: > Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. default: 100 x-categories: - Ranking removeStopWords: description: > Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words. Only use this feature for the languages used in your index. example: - ca - es oneOf: - type: array description: >- ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`. items: $ref: '#/components/schemas/supportedLanguage' - type: boolean default: false description: > If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty. If false, stop words are not removed. x-categories: - Languages removeWordsIfNoResults: type: string enum: - none - lastWords - firstWords - allOptional example: firstWords description: > Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results). default: none x-categories: - Query strategy renderingContent: description: > Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code. type: object additionalProperties: false properties: facetOrdering: $ref: '#/components/schemas/facetOrdering' redirect: $ref: '#/components/schemas/redirectURL' widgets: $ref: '#/components/schemas/widgets' x-categories: - Advanced replaceSynonymsInHighlight: type: boolean description: > Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response. default: false x-categories: - Highlighting and Snippeting reRankingApplyFilter: description: > Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) to records that match these filters. oneOf: - type: array items: $ref: '#/components/schemas/reRankingApplyFilter' - type: string x-categories: - Filtering responseFields: type: array items: type: string description: > Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience. default: - '*' x-categories: - Advanced restrictHighlightAndSnippetArrays: type: boolean description: > Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. default: false x-categories: - Highlighting and Snippeting restrictSearchableAttributes: type: array items: type: string example: - title - author description: | Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. default: [] x-categories: - Filtering ruleContexts: type: array items: type: string description: > Assigns a rule context to the search query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules. default: [] example: - mobile x-categories: - Rules semanticSearch: type: object description: | Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. properties: eventSources: oneOf: - type: array description: | Indices from which to collect click and conversion events. If null, the current index and all its replicas are used. items: type: string - type: 'null' similarQuery: type: string description: > Keywords to be used instead of the search query to conduct a more broader search Using the `similarQuery` parameter changes other settings - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords` Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. default: '' example: comedy drama crime Macy Buscemi x-categories: - Search snippetEllipsisText: type: string description: String used as an ellipsis indicator when a snippet is truncated. default: … x-categories: - Highlighting and Snippeting sortFacetValuesBy: type: string description: > Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js). default: count x-categories: - Faceting sumOrFiltersScores: type: boolean description: > Whether to sum all filter scores If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). default: false x-categories: - Filtering synonyms: type: boolean description: Whether to take into account an index's synonyms for this search. default: true x-categories: - Advanced tagFilters: description: > Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. example: - - Book - Movie - SciFi oneOf: - type: array items: $ref: '#/components/schemas/tagFilters' - type: string x-categories: - Filtering typoTolerance: description: > Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) are also active. oneOf: - type: boolean default: true description: >- Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches. - $ref: '#/components/schemas/typoToleranceEnum' x-categories: - Typos userToken: type: string description: > Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). example: test-user-123 x-categories: - Personalization paramsAsString: description: Search parameters as a URL-encoded query string. example: hitsPerPage=2&getRankingInfo=1 type: string default: '' processingTimeMS: type: integer description: Time the server took to process the request, in milliseconds. example: 20 RedirectRuleIndexMetadata: type: object properties: data: title: redirectRuleIndexData type: object description: Redirect rule data. required: - ruleObjectID properties: ruleObjectID: type: string dest: type: string description: Destination index for the redirect rule. reason: type: string description: Reason for the redirect rule. source: type: string description: Source index for the redirect rule. succeed: type: boolean description: Redirect rule status. required: - data - succeed - reason - dest - source userData: example: settingID: f2a7b51e3503acc6a39b3784ffb84300 pluginVersion: 1.6.0 description: | An object with custom data. You can store up to 32kB as custom data. default: {} x-categories: - Advanced nbHits: type: integer description: Number of results (hits). example: 20 nbPages: type: integer description: Number of pages of results. example: 1 hit: type: object description: > Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking. x-is-generic: true x-is-hit-object: true additionalProperties: true required: - objectID properties: objectID: $ref: '#/components/schemas/objectID' _distinctSeqID: $ref: '#/components/schemas/distinctSeqID' _highlightResult: $ref: '#/components/schemas/highlightResultMap' _rankingInfo: $ref: '#/components/schemas/rankingInfo' _snippetResult: $ref: '#/components/schemas/snippetResultMap' responseExtensions: type: object description: > AI-generated metadata returned alongside search results. Present when Algolia AI features such as [Query Categorization](https://www.algolia.com/doc/guides/algolia-ai/query-categorization/) are enabled. properties: queryCategorization: $ref: '#/components/schemas/queryCategorization' advancedSyntaxFeatures: type: string enum: - exactPhrase - excludeWords x-categories: - Query strategy alternativesAsExact: type: string enum: - ignorePlurals - singleWordSynonym - multiWordsSynonym - ignoreConjugations x-categories: - Query strategy aroundPrecisionFromValue: title: range objects type: array items: title: range type: object description: >- Range object with lower and upper values in meters to define custom ranges. properties: from: type: integer description: >- Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal. example: 20 value: type: integer description: >- Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal. aroundRadiusAll: title: all type: string description: >- Return all records with a valid `_geoloc` attribute. Don't filter by distance. enum: - all supportedLanguage: type: string description: ISO code for a supported language. enum: - af - ar - az - bg - bn - ca - cs - cy - da - de - el - en - eo - es - et - eu - fa - fi - fo - fr - ga - gl - he - hi - hu - hy - id - is - it - ja - ka - kk - ko - ku - ky - lt - lv - mi - mn - mr - ms - mt - nb - nl - 'no' - ns - pl - ps - pt - pt-br - qu - ro - ru - sk - sq - sv - sw - ta - te - th - tl - tn - tr - tt - uk - ur - uz - zh booleanString: type: string enum: - 'true' - 'false' insideBoundingBoxArray: type: array items: type: array minItems: 4 maxItems: 4 items: type: number format: double description: > Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). example: - - 47.3165 - 4.9665 - 47.3424 - 5.0201 - - 40.9234 - 2.1185 - 38.643 - 1.9916 x-categories: - Geo-Search optionalWordsArray: type: array items: type: string example: - blue - iphone case description: >- List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). default: [] x-categories: - Query strategy facetOrdering: description: Order of facet names and facet values in your UI. type: object additionalProperties: false properties: facets: $ref: '#/components/schemas/facets' values: $ref: '#/components/schemas/values' redirectURL: description: The redirect rule container. type: object additionalProperties: false properties: url: type: string widgets: description: Widgets returned from any rules that are applied to the current search. type: object additionalProperties: false properties: banners: $ref: '#/components/schemas/banners' typoToleranceEnum: type: string title: typo tolerance description: | - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. enum: - min - strict - 'true' - 'false' objectID: type: string description: Unique record identifier. example: test-record-123 distinctSeqID: type: integer highlightResultMap: title: highlightResultMap type: object description: Surround words that match the query with HTML tags for highlighting. x-is-free-form: false additionalProperties: $ref: '#/components/schemas/highlightResult' x-additionalPropertiesName: attribute rankingInfo: type: object description: Object with detailed information about the record's ranking. additionalProperties: false properties: firstMatchedWord: type: integer minimum: 0 description: >- Position of the first matched word in the best matching attribute of the record. geoDistance: type: integer minimum: 0 description: >- Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters). nbExactWords: type: integer minimum: 0 description: Number of exactly matched words. nbTypos: type: integer minimum: 0 description: Number of typos encountered when matching the record. userScore: type: integer description: >- Overall ranking of the record, expressed as a single integer. This attribute is internal. filters: type: integer minimum: 0 description: Whether a filter matched the query. geoPrecision: type: integer minimum: 1 description: Precision used when computing the geo distance, in meters. matchedGeoLocation: $ref: '#/components/schemas/matchedGeoLocation' personalization: $ref: '#/components/schemas/personalization' promoted: type: boolean description: Whether the record was promoted by a rule. promotedByReRanking: type: boolean description: Whether the record is re-ranked. proximityDistance: type: integer minimum: 0 description: >- Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0. words: type: integer minimum: 1 description: Number of matched words. required: - nbTypos - firstMatchedWord - geoDistance - nbExactWords - userScore snippetResultMap: title: snippetResultMap type: object description: Snippets that show the context around a matching search query. x-is-free-form: false additionalProperties: $ref: '#/components/schemas/snippetResult' x-additionalPropertiesName: attribute queryCategorization: type: object description: > Query Categorization prediction returned by the AI model. This field is empty when the model cannot categorize the query. See [Query Categorization](https://www.algolia.com/doc/guides/algolia-ai/query-categorization/). properties: autofiltering: $ref: '#/components/schemas/autoFilteringResult' categories: type: array description: List of category predictions with confidence levels. items: $ref: '#/components/schemas/categoryPrediction' count: type: integer description: >- Number of times this normalized query was observed during the training window. normalizedQuery: type: string description: Processed and normalized version of the original search query. type: $ref: '#/components/schemas/queryCategorization_type' facets: description: Order of facet names. type: object additionalProperties: false properties: order: $ref: '#/components/schemas/order' values: description: Order of facet values. One object for each facet. type: object additionalProperties: $ref: '#/components/schemas/value' x-additionalPropertiesName: facet banners: description: Banners defined in the Merchandising Studio for a given search. type: array items: $ref: '#/components/schemas/banner' highlightResult: oneOf: - $ref: '#/components/schemas/highlightResultOption' - $ref: '#/components/schemas/highlightResultMap' - $ref: '#/components/schemas/highlightResultArray' matchedGeoLocation: type: object properties: distance: type: integer description: >- Distance between the matched location and the search location (in meters). lat: type: number format: double description: Latitude of the matched location. lng: type: number format: double description: Longitude of the matched location. personalization: type: object properties: filtersScore: type: integer description: The score of the filters. rankingScore: type: integer description: The score of the ranking. score: type: integer description: The score of the event. snippetResult: oneOf: - $ref: '#/components/schemas/snippetResultOption' - $ref: '#/components/schemas/snippetResultMap' - $ref: '#/components/schemas/snippetResultArray' autoFilteringResult: type: object description: Result of automatic filtering applied by Query Categorization. properties: enabled: type: boolean description: Whether automatic filtering was applied to this query. facetFilters: type: array description: Facet filters automatically applied to the query. items: $ref: '#/components/schemas/autoFilteringFilterEntry' maxDepth: type: integer description: Maximum category hierarchy depth used for filtering. optionalFilters: type: array description: Optional filters automatically applied to boost relevant categories. items: $ref: '#/components/schemas/autoFilteringFilterEntry' categoryPrediction: type: object properties: bin: $ref: '#/components/schemas/categoryPrediction_bin' hierarchyPath: type: array description: Ordered list of category levels from root to the predicted category. items: $ref: '#/components/schemas/hierarchyPathEntry' queryCategorization_type: type: string enum: - narrow - broad - ambiguous - none description: Classification of the query scope. order: description: > Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list. type: array items: type: string value: type: object additionalProperties: false properties: hide: $ref: '#/components/schemas/hide' order: $ref: '#/components/schemas/order' sortRemainingBy: $ref: '#/components/schemas/sortRemainingBy' banner: description: Banner with image and link to redirect users. type: object additionalProperties: false properties: image: $ref: '#/components/schemas/bannerImage' link: $ref: '#/components/schemas/bannerLink' highlightResultOption: title: highlightResultOption type: object description: Surround words that match the query with HTML tags for highlighting. additionalProperties: false properties: matchedWords: type: array description: List of matched words from the search query. example: - action items: type: string matchLevel: $ref: '#/components/schemas/matchLevel' value: $ref: '#/components/schemas/highlightedValue' fullyHighlighted: type: boolean description: Whether the entire attribute value is highlighted. required: - value - matchLevel - matchedWords x-discriminator-fields: - matchLevel - matchedWords highlightResultArray: title: highlightResultArray type: array description: Surround words that match the query with HTML tags for highlighting. items: $ref: '#/components/schemas/highlightResult' snippetResultOption: title: snippetResultOption type: object description: Snippets that show the context around a matching search query. additionalProperties: false properties: matchLevel: $ref: '#/components/schemas/matchLevel' value: $ref: '#/components/schemas/highlightedValue' required: - value - matchLevel x-discriminator-fields: - matchLevel snippetResultArray: title: snippetResultArray type: array description: Snippets that show the context around a matching search query. items: $ref: '#/components/schemas/snippetResult' autoFilteringFilterEntry: oneOf: - type: string - type: array items: type: string categoryPrediction_bin: type: string enum: - certain - very high - high - low - very low description: Confidence level of the category prediction. hierarchyPathEntry: type: object properties: depth: type: integer description: Depth level in the category hierarchy, starting at 0. facetName: type: string description: >- Facet attribute name at this hierarchy level, for example, `categories.lvl0`. facetValue: type: string description: Facet value at this level of the category hierarchy. hide: description: Hide facet values. type: array items: type: string sortRemainingBy: description: > Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. type: string enum: - count - alpha - hidden bannerImage: description: Image to show inside a banner. type: object additionalProperties: false properties: title: type: string urls: type: array items: $ref: '#/components/schemas/bannerImageUrl' bannerLink: description: Link for a banner defined in the Merchandising Studio. type: object additionalProperties: false properties: url: type: string matchLevel: type: string description: Whether the whole query string matches or only a part. enum: - none - partial - full highlightedValue: type: string description: Highlighted attribute value, including HTML tags. example: George Clooney bannerImageUrl: description: URL for an image to show inside a banner. type: object additionalProperties: false properties: url: type: string responses: BadRequest: description: Bad request or request arguments. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' FeatureNotEnabled: description: This feature is not enabled on your Algolia account. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' MethodNotAllowed: description: Method not allowed with this API key. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' IndexNotFound: description: Index not found. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' securitySchemes: appId: type: apiKey in: header name: x-algolia-application-id description: Your Algolia application ID. apiKey: type: apiKey in: header name: x-algolia-api-key description: > Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference. ````