openapi: 3.0.2 info: title: Composition API summary: >- The Algolia Composition API lets you run composed search requests on your Compositions description: > ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. For more information, see [Algolia's ecosystem](https://www.algolia.com/doc/libraries). ## Base URLs Base URLs for the Composition 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 in the request body for POST and PUT requests. ## Response status and errors The Composition 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 Composition 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: Advanced endpoints to manage tasks. - name: Composition Rules description: Manage your compositions rules. - name: Compositions description: Manage your compositions and composition settings. - name: Search description: Search one or more indices for matching records or facet values. paths: /{path}: get: operationId: customGet summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - composition post: operationId: customPost requestBody: description: Parameters to send with the custom request. content: application/json: schema: type: object summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - composition put: operationId: customPut requestBody: description: Parameters to send with the custom request. content: application/json: schema: type: object summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - composition delete: operationId: customDelete summary: Send requests to the Algolia REST API description: This method lets you send requests to the Algolia REST API. parameters: - $ref: '#/components/parameters/PathInPath' - $ref: '#/components/parameters/Parameters' responses: '200': description: OK content: application/json: schema: type: object '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' tags: - composition /1/compositions/{compositionID}/run: post: tags: - composition operationId: search x-use-read-transporter: true x-cacheable: true x-acl: - search summary: Run a Composition description: Runs a query on a single composition and returns matching results. parameters: - $ref: '#/components/parameters/compositionID' requestBody: required: true content: application/json: schema: title: requestBody type: object additionalProperties: false properties: params: $ref: '#/components/schemas/params' feedsOrder: $ref: '#/components/schemas/feedsOrder' externalProvider: $ref: '#/components/schemas/externalProvider' feeds: $ref: '#/components/schemas/feeds' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/searchResponse' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /1/compositions/{compositionID}/facets/{facetName}/query: post: tags: - composition operationId: searchForFacetValues x-use-read-transporter: true x-cacheable: true x-acl: - search summary: Search for facet values description: > Searches for values of a specified facet attribute on the composition's main source's index. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**. parameters: - $ref: '#/components/parameters/compositionID' - name: facetName description: > Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. in: path required: true schema: type: string requestBody: content: application/json: schema: title: searchForFacetValuesRequest type: object additionalProperties: false properties: params: title: searchForFacetValuesParams type: object properties: query: $ref: '#/components/schemas/query' maxFacetHits: $ref: '#/components/schemas/maxFacetHits' searchQuery: $ref: '#/components/schemas/params' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/searchForFacetValuesResponse' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /1/compositions: get: tags: - composition operationId: listCompositions x-acl: - editSettings - settings summary: List compositions description: | Lists all compositions in the current Algolia application. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/HitsPerPage' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/listCompositionsResponse' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/CompositionNotFound' /1/compositions/{compositionID}: get: tags: - composition operationId: getComposition x-acl: - editSettings - settings summary: Retrieve a composition description: | Retrieve a single composition in the current Algolia application. parameters: - $ref: '#/components/parameters/compositionID' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/composition' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/CompositionNotFound' put: tags: - composition operationId: putComposition x-acl: - editSettings summary: Update and insert (upsert) a composition description: | Update and insert a composition in the current Algolia application. parameters: - $ref: '#/components/parameters/compositionID' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/composition' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: taskIDResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '422': $ref: '#/components/responses/UnprocessableEntity' delete: tags: - composition operationId: deleteComposition x-acl: - editSettings summary: Delete a composition description: | Delete a composition from the current Algolia application. parameters: - $ref: '#/components/parameters/compositionID' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: taskIDResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' /1/compositions/*/batch: post: tags: - composition operationId: multipleBatch description: | Adds, updates, or deletes compositions with a single API request. x-acl: - editSettings summary: Batch action to multiple compositions requestBody: required: true content: application/json: schema: title: batchParams description: Batch parameters. type: object additionalProperties: false properties: requests: type: array items: title: multipleBatchRequest type: object additionalProperties: false properties: action: $ref: '#/components/schemas/action' body: $ref: '#/components/schemas/batchCompositionAction' required: - action - body required: - requests responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: multipleBatchResponse type: object additionalProperties: false properties: taskID: type: object description: Task IDs. One for each index. additionalProperties: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /1/compositions/{compositionID}/sortingStrategy: post: tags: - composition operationId: updateSortingStrategyComposition x-acl: - editSettings summary: >- Set or update the "sortingStrategy" configuration for an existing composition description: > Updates the "sortingStrategy" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. This endpoint only validates that the sorting indices exist. At runtime, the API ignores a sorting index that is unrelated to the targeted indices. The response reports it in the `errors` field. The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion. parameters: - $ref: '#/components/parameters/compositionID' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/sortingStrategy' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: taskIDResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/CompositionNotFound' /1/compositions/{compositionID}/rules/{objectID}: get: tags: - composition operationId: getRule x-acl: - editSettings - settings summary: Retrieve a rule description: > Retrieves a rule by its ID. To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules). parameters: - $ref: '#/components/parameters/compositionID' - $ref: '#/components/parameters/ObjectIDRule' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/compositionRule' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' put: tags: - composition operationId: putCompositionRule x-acl: - editSettings summary: Add or update a composition rule description: | If a composition rule with the provided ID already exists, it's replaced. Otherwise, a new one is added. parameters: - $ref: '#/components/parameters/compositionID' - $ref: '#/components/parameters/ObjectIDRule' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/compositionRule' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: taskIDResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/CompositionNotFound' '422': $ref: '#/components/responses/UnprocessableEntity' delete: tags: - composition operationId: deleteCompositionRule x-acl: - editSettings summary: Delete a Composition Rule description: | Delete a Composition Rule from the specified Composition ID. parameters: - $ref: '#/components/parameters/compositionID' - $ref: '#/components/parameters/ObjectIDRule' responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: taskIDResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/CompositionNotFound' /1/compositions/{compositionID}/rules/batch: post: tags: - composition operationId: saveRules x-acl: - editSettings summary: Create or update or delete composition rules description: | Create or update or delete multiple composition rules. x-codegen-request-body-name: rules parameters: - $ref: '#/components/parameters/compositionID' requestBody: required: true content: application/json: schema: title: compositionRulesBatchParams description: Composition rules batch parameters. type: object additionalProperties: false properties: requests: type: array items: title: rulesMultipleBatchRequest type: object additionalProperties: false properties: action: $ref: '#/components/schemas/action' body: $ref: '#/components/schemas/rulesBatchCompositionAction' required: - action - body responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: rulesMultipleBatchResponse type: object additionalProperties: false properties: taskID: $ref: '#/components/schemas/taskID' required: - taskID '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /1/compositions/{compositionID}/rules/search: post: tags: - composition operationId: searchCompositionRules x-acl: - settings summary: Search for composition rules description: Searches for composition rules in your index. parameters: - $ref: '#/components/parameters/compositionID' requestBody: content: application/json: schema: title: searchCompositionRulesParams type: object description: Composition Rules search parameters. additionalProperties: false properties: query: $ref: '#/components/schemas/parameters_query' anchoring: $ref: '#/components/schemas/anchoring' context: type: string description: >- Only return composition rules that match the context (exact match). example: mobile page: $ref: '#/components/schemas/parameters_page' hitsPerPage: $ref: '#/components/schemas/parameters_hitsPerPage' enabled: oneOf: - type: boolean description: | If `true`, return only enabled composition rules. If `false`, return only inactive composition rules. By default, _all_ composition rules are returned. - type: 'null' default: null responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: title: searchCompositionRulesResponse type: object additionalProperties: false required: - hits - nbHits - page - nbPages properties: hits: type: array description: Composition rules that matched the search criteria. items: $ref: '#/components/schemas/compositionRule' nbHits: type: integer description: >- Number of composition rules that matched the search criteria. page: type: integer description: Current page. nbPages: type: integer description: Number of pages. '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /1/compositions/{compositionID}/task/{taskID}: get: tags: - composition operationId: getTask x-acl: - editSettings - settings - addObject - deleteObject - deleteIndex description: | Checks the status of a given task. summary: Check task status parameters: - $ref: '#/components/parameters/compositionID' - name: taskID in: path description: Unique task identifier. required: true schema: type: integer format: int64 example: 1506303845001 responses: '200': description: OK headers: Correlation-ID: $ref: '#/components/headers/Correlation-ID' content: application/json: schema: $ref: '#/components/schemas/GetTaskResponse' '400': $ref: '#/components/responses/BadRequest' '402': $ref: '#/components/responses/FeatureNotEnabled' '403': $ref: '#/components/responses/MethodNotAllowed' '404': $ref: '#/components/responses/IndexNotFound' /setClientApiKey: get: x-helper: true x-asynchronous-helper: false x-acl: [] tags: - composition operationId: setClientApiKey summary: Switch the API key used to authenticate requests description: | Switch the API key used to authenticate requests. parameters: - in: query name: apiKey description: API key to use for subsequent requests. required: true schema: type: string responses: '204': description: No content. /waitForCompositionTask: get: x-helper: true tags: - composition operationId: waitForCompositionTask x-acl: - editSettings - settings - addObject - deleteObject - deleteIndex summary: Wait for operation to complete description: > Wait for a task to complete to ensure synchronized composition updates. All Algolia write operations are asynchronous. When you make a request for a write operation, for example, to upsert or delete a composition, Algolia creates a task on a queue and returns a taskID. The task itself runs separately, depending on the server load. parameters: - in: query name: compositionID description: The ID of the composition on which the operation was performed. required: true schema: type: string - in: query name: taskID description: The taskID returned by the operation. required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetTaskResponse' '400': $ref: '#/components/responses/CompositionNotFound' components: 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. parameters: PathInPath: name: path in: path description: Path of the endpoint, for example `1/newFeature`. required: true schema: type: string example: /keys Parameters: name: parameters in: query description: Query parameters to apply to the current query. schema: type: object additionalProperties: true compositionID: in: path name: compositionID description: Unique Composition ObjectID. required: true schema: $ref: '#/components/schemas/compositionObjectID' Page: in: query name: page description: | Requested page of the API response. If `null`, the API response is not paginated. required: false schema: oneOf: - type: integer minimum: 0 - type: 'null' default: null HitsPerPage: in: query name: hitsPerPage description: Number of hits per page. required: false schema: type: integer default: 100 ObjectIDRule: in: path name: objectID description: Unique identifier of a rule object. required: true schema: $ref: '#/components/schemas/ruleID' schemas: ErrorBase: description: Error. type: object x-keep-model: true additionalProperties: true properties: message: type: string example: Invalid Application-Id or API-Key compositionObjectID: type: string example: my_composition_object_id description: Composition unique identifier. 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 aroundRadiusAll: title: all type: string description: >- Return all records with a valid `_geoloc` attribute. Don't filter by distance. enum: - all 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 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. 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 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 enableABTest: type: boolean description: | Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored. 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 composition rules. default: true x-categories: - Composition Rules 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 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 `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting). default: [] example: - category - disjunctive(brand) - price examples: - - category - disjunctive(brand) - price - - '*' - - '*' - disjunctive(brand) 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 run response should include detailed ranking information. default: false x-categories: - Advanced hitsPerPage: type: integer description: Number of hits per page. default: 20 minimum: 1 maximum: 1000 x-categories: - Pagination externalInjectedItem: type: object description: | Contains a list of objects to inject from an external source. properties: items: type: array items: title: externalInjection type: object additionalProperties: false properties: objectID: type: string description: >- An objectID injected from an external source and also present in the targeted index. metadata: type: object additionalProperties: true description: > User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime. example: my-field: my-value required: - objectID example: objectID: my-object-1 metadata': my-field: my-value required: - items injectedItems: type: object additionalProperties: $ref: '#/components/schemas/externalInjectedItem' description: > An object containing keys corresponding to the `key`s from an injection's `injectedItems` and values containing a list of hits to inject. default: {} x-categories: - Retail Media Network example: my-group-key: items: - objectID: my-object-1 metadata: my-field: my-value - objectID: my-object-2 metadata: my-field: my-value-2 my-other-group-key: items: - objectID: my-other-object-1 - objectID: my-other-object-2 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 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 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 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 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 page: type: integer description: Page of search results to retrieve. default: 0 minimum: 0 x-categories: - Pagination 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 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/#standard-and-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. default: 100 x-categories: - Ranking ruleContexts: type: array items: type: string description: > Assigns a rule context to the run query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#assign-context) are strings that you can use to trigger matching rules. default: [] example: - mobile x-categories: - Composition Rules sortBy: type: string description: > Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the "sortingStrategy" mapping. For example, "Price (asc)", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in "sortingStrategy", and the query is executed using that index instead of main's. In addition to "sortingStrategy", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on "sortBy", see Composition Rules. If no value is provided or an invalid value, no sorting strategy is applied. For `multifeed` compositions, every feed inherits the root "sortBy" unless the feed sets its own "sortBy" in `feeds..params`. An empty string disables sorting for that feed. The response reports an invalid value in the `errors` field. This includes a value whose index is unrelated to the feed's indices. Composition Rules still match on the root "sortBy". default: '' example: Price (asc) 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 params: title: Run composition parameters as object type: object additionalProperties: false properties: analytics: $ref: '#/components/schemas/analytics' analyticsTags: $ref: '#/components/schemas/analyticsTags' aroundLatLng: $ref: '#/components/schemas/aroundLatLng' aroundLatLngViaIP: $ref: '#/components/schemas/aroundLatLngViaIP' aroundRadius: $ref: '#/components/schemas/aroundRadius' aroundPrecision: $ref: '#/components/schemas/aroundPrecision' clickAnalytics: $ref: '#/components/schemas/clickAnalytics' enableABTest: $ref: '#/components/schemas/enableABTest' enablePersonalization: $ref: '#/components/schemas/enablePersonalization' enableReRanking: $ref: '#/components/schemas/enableReRanking' enableRules: $ref: '#/components/schemas/enableRules' facetFilters: $ref: '#/components/schemas/facetFilters' facets: $ref: '#/components/schemas/facets' filters: $ref: '#/components/schemas/filters' getRankingInfo: $ref: '#/components/schemas/getRankingInfo' hitsPerPage: $ref: '#/components/schemas/hitsPerPage' injectedItems: $ref: '#/components/schemas/injectedItems' insideBoundingBox: $ref: '#/components/schemas/insideBoundingBox' insidePolygon: $ref: '#/components/schemas/insidePolygon' minimumAroundRadius: $ref: '#/components/schemas/minimumAroundRadius' naturalLanguages: $ref: '#/components/schemas/naturalLanguages' numericFilters: $ref: '#/components/schemas/numericFilters' optionalFilters: $ref: '#/components/schemas/optionalFilters' page: $ref: '#/components/schemas/page' query: $ref: '#/components/schemas/query' queryLanguages: $ref: '#/components/schemas/queryLanguages' relevancyStrictness: $ref: '#/components/schemas/relevancyStrictness' ruleContexts: $ref: '#/components/schemas/ruleContexts' sortBy: $ref: '#/components/schemas/sortBy' userToken: $ref: '#/components/schemas/userToken' feedsOrder: type: array description: > A list of Feed IDs that specifies the order in which to order the results in the response. The IDs should be a subset of those in the `feeds` object of the targeted `multifeed` Composition / Composition Rule, and only those specified will be processed. The value overrides the value in the defined behavior, and when unspecified, the value defined in the behavior is used. When neither value is present, all feeds are processed. items: type: string default: null example: - feed-1 - feed-3 externalProvider: title: Run composition external provider parameters as object type: object additionalProperties: false properties: configurationParams: type: object additionalProperties: true description: >- Values for non-prefixed configuration placeholders, overriding the composition source's `configurationParams` and the configuration's `defaults`. example: customer_id: customer123 feedParams: title: Run composition feed parameters as object description: >- Parameters for a single feed. These match the root `params` minus `injectedItems`, `getRankingInfo`, and `enableABTest`. type: object additionalProperties: false properties: analytics: $ref: '#/components/schemas/analytics' analyticsTags: $ref: '#/components/schemas/analyticsTags' aroundLatLng: $ref: '#/components/schemas/aroundLatLng' aroundLatLngViaIP: $ref: '#/components/schemas/aroundLatLngViaIP' aroundRadius: $ref: '#/components/schemas/aroundRadius' aroundPrecision: $ref: '#/components/schemas/aroundPrecision' clickAnalytics: $ref: '#/components/schemas/clickAnalytics' enablePersonalization: $ref: '#/components/schemas/enablePersonalization' enableReRanking: $ref: '#/components/schemas/enableReRanking' enableRules: $ref: '#/components/schemas/enableRules' facetFilters: $ref: '#/components/schemas/facetFilters' facets: $ref: '#/components/schemas/facets' filters: $ref: '#/components/schemas/filters' hitsPerPage: $ref: '#/components/schemas/hitsPerPage' insideBoundingBox: $ref: '#/components/schemas/insideBoundingBox' insidePolygon: $ref: '#/components/schemas/insidePolygon' minimumAroundRadius: $ref: '#/components/schemas/minimumAroundRadius' naturalLanguages: $ref: '#/components/schemas/naturalLanguages' numericFilters: $ref: '#/components/schemas/numericFilters' optionalFilters: $ref: '#/components/schemas/optionalFilters' page: $ref: '#/components/schemas/page' query: $ref: '#/components/schemas/query' queryLanguages: $ref: '#/components/schemas/queryLanguages' relevancyStrictness: $ref: '#/components/schemas/relevancyStrictness' ruleContexts: $ref: '#/components/schemas/ruleContexts' sortBy: $ref: '#/components/schemas/sortBy' userToken: $ref: '#/components/schemas/userToken' feeds: title: Run composition feeds as object type: object description: > Per-feed parameters for `multifeed` compositions. Each key is a feed ID. Feed `params` take precedence over the root `params`. A feed inherits every root key it doesn't set. A feed value replaces the root value instead of combining with it. This applies to every key, including `filters`, `facetFilters`, `optionalFilters`, and `analyticsTags`. For example, `filters` must repeat the common values. An empty value such as `filters: ""` discards the root value. The API validates feed `params` like the root `params`. An unsupported parameter returns a 400 error. A feed ID may not exist in the composition (for example, because a rule removed it). The response reports it in the `errors` field but request still succeeds. Rules match once per request, against the root `params` only. additionalProperties: title: feedRequest type: object additionalProperties: false properties: params: $ref: '#/components/schemas/feedParams' example: organic: params: filters: category:shoes hitsPerPage: 20 banner: params: hitsPerPage: 2 sortBy: '' compositionRunAppliedRules: type: object properties: objectID: type: string description: The objectID of the applied composition rule on this query. example: objectID: cr-1765458959657 required: - objectID compositionRunSearchResponse: type: object additionalProperties: true properties: objectID: type: string description: The objectID of the composition which generated this result set. appliedRules: type: array items: $ref: '#/components/schemas/compositionRunAppliedRules' example: objectID: comp1765458818347 appliedRules: - objectID: cr-1765458959657 required: - objectID compositionsSearchResponse: type: object description: >- Information about the compositions processed by the run request. Only present when `getRankingInfo` is `true`. additionalProperties: true properties: run: type: array items: $ref: '#/components/schemas/compositionRunSearchResponse' required: - run compositionBaseSearchResponse: type: object properties: compositions: $ref: '#/components/schemas/compositionsSearchResponse' processingTimeMS: type: integer description: Time the server took to process the request, in milliseconds. example: 20 RedirectRuleIndexMetadata: type: object properties: source: type: string description: Source index for the redirect rule. dest: type: string description: Destination index for the redirect rule. reason: type: string description: Reason for the redirect rule. succeed: type: boolean description: Redirect rule status. data: title: redirectRuleIndexData type: object description: Redirect rule data. required: - ruleObjectID properties: ruleObjectID: type: string required: - data - succeed - reason - dest - source 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 IndexSettings_facets: description: Order of facet names. type: object additionalProperties: false properties: order: $ref: '#/components/schemas/order' 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 hide: description: Hide facet values. type: array items: type: string value: type: object additionalProperties: false properties: order: $ref: '#/components/schemas/order' sortRemainingBy: $ref: '#/components/schemas/sortRemainingBy' hide: $ref: '#/components/schemas/hide' values: description: Order of facet values. One object for each facet. type: object additionalProperties: x-additionalPropertiesName: facet $ref: '#/components/schemas/value' facetOrdering: description: Order of facet names and facet values in your UI. type: object additionalProperties: false properties: facets: $ref: '#/components/schemas/IndexSettings_facets' values: $ref: '#/components/schemas/values' redirectURL: description: The redirect rule container. type: object additionalProperties: false properties: url: type: string bannerImageUrl: description: URL for an image to show inside a banner. type: object additionalProperties: false properties: url: type: string bannerImage: description: Image to show inside a banner. type: object additionalProperties: false properties: urls: type: array items: $ref: '#/components/schemas/bannerImageUrl' title: type: string bannerLink: description: Link for a banner defined in the Merchandising Studio. type: object additionalProperties: false properties: url: type: string 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' banners: description: Banners defined in the Merchandising Studio for a given search. type: array items: $ref: '#/components/schemas/banner' resultCard: description: Agent Studio Result Card to display for a given search. type: object additionalProperties: false properties: enabled: type: boolean description: Whether to show the Result Card for the current search. widgets: description: Widgets returned from any rules that are applied to the current search. type: object additionalProperties: false properties: banners: $ref: '#/components/schemas/banners' resultCard: $ref: '#/components/schemas/resultCard' 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 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 baseSearchResponse: type: object additionalProperties: true properties: 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. 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. appliedRules: description: Rules applied to the query. title: appliedRules type: array items: type: object 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: min: type: number format: double description: Minimum value in the results. max: type: number format: double description: Maximum value in the results. avg: type: number format: double description: Average facet 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. 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' 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 _automaticInsights: type: boolean description: Whether automatic events collection is enabled for the application. objectID: type: string description: Unique record identifier. example: test-record-123 highlightedValue: type: string description: Highlighted attribute value, including HTML tags. example: George Clooney matchLevel: type: string description: Whether the whole query string matches or only a part. enum: - none - partial - full highlightResultOption: title: highlightResultOption type: object description: Surround words that match the query with HTML tags for highlighting. additionalProperties: false properties: value: $ref: '#/components/schemas/highlightedValue' matchLevel: $ref: '#/components/schemas/matchLevel' matchedWords: type: array description: List of matched words from the search query. example: - action items: type: string fullyHighlighted: type: boolean description: Whether the entire attribute value is highlighted. required: - value - matchLevel - matchedWords x-discriminator-fields: - matchLevel - matchedWords highlightResultMap: title: highlightResultMap type: object description: Surround words that match the query with HTML tags for highlighting. x-is-free-form: false additionalProperties: x-additionalPropertiesName: attribute $ref: '#/components/schemas/highlightResult' highlightResult: oneOf: - $ref: '#/components/schemas/highlightResultOption' - $ref: '#/components/schemas/highlightResultMap' - $ref: '#/components/schemas/highlightResultArray' 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: value: $ref: '#/components/schemas/highlightedValue' matchLevel: $ref: '#/components/schemas/matchLevel' required: - value - matchLevel x-discriminator-fields: - matchLevel snippetResultMap: title: snippetResultMap type: object description: Snippets that show the context around a matching search query. x-is-free-form: false additionalProperties: x-additionalPropertiesName: attribute $ref: '#/components/schemas/snippetResult' snippetResult: oneOf: - $ref: '#/components/schemas/snippetResultOption' - $ref: '#/components/schemas/snippetResultMap' - $ref: '#/components/schemas/snippetResultArray' snippetResultArray: title: snippetResultArray type: array description: Snippets that show the context around a matching search query. items: $ref: '#/components/schemas/snippetResult' matchedGeoLocation: type: object properties: lat: type: number format: double description: Latitude of the matched location. lng: type: number format: double description: Longitude of the matched location. distance: type: integer description: >- Distance between the matched location and the search location (in meters). 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. rankingInfo: type: object description: Object with detailed information about the record's ranking. additionalProperties: false properties: filters: type: integer minimum: 0 description: Whether a filter matched the query. 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). 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' 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. promoted: type: boolean description: Whether the record was promoted by a rule. proximityDistance: type: integer minimum: 0 description: >- Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0. userScore: type: integer description: >- Overall ranking of the record, expressed as a single integer. This attribute is internal. words: type: integer minimum: 1 description: Number of matched words. promotedByReRanking: type: boolean description: Whether the record is re-ranked. required: - nbTypos - firstMatchedWord - geoDistance - nbExactWords - userScore compositionRankingInfo: type: object additionalProperties: false properties: composed: title: composedRankingInfo type: object additionalProperties: title: compositionIdRankingInfo x-additionalPropertiesName: composition-id type: object properties: index: type: string example: products injectedItemKey: type: string example: sponsored-products required: - index - injectedItemKey example: my-composition-to-sponsor-products: index: products injectedItemKey: sponsored-products Hit_rankingInfo: allOf: - $ref: '#/components/schemas/rankingInfo' - $ref: '#/components/schemas/compositionRankingInfo' distinctSeqID: type: integer hitMetadata: type: object description: >- An object that contains the extra key-value pairs provided in the injectedItem definition. Only present on hits inserted by an injectedItem that defines metadata, either in its `metadata` field or sent by an external source. additionalProperties: true properties: _injectedItemKey: type: string description: >- The key of the injectedItem that inserted this metadata. Only present when the injectedItem's `metadata.hits.addItemKey` is `true`. 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 additionalProperties: true required: - objectID properties: objectID: $ref: '#/components/schemas/objectID' _highlightResult: $ref: '#/components/schemas/highlightResultMap' _snippetResult: $ref: '#/components/schemas/snippetResultMap' _rankingInfo: $ref: '#/components/schemas/Hit_rankingInfo' _distinctSeqID: $ref: '#/components/schemas/distinctSeqID' _extra: $ref: '#/components/schemas/hitMetadata' 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' SingleResultSet_hitsPerPage: type: integer description: Number of hits returned per page. example: 20 nbHits: type: integer description: Number of results (hits). example: 20 nbPages: type: integer description: Number of pages of results. example: 1 SingleResultSet_page: type: integer description: The current page of the results. example: 0 SingleResultSet_params: type: string description: URL-encoded string of all search parameters. example: query=a&hitsPerPage=20 SingleResultSet_query: type: string description: The search query string. example: shoes SearchFields: type: object additionalProperties: false properties: hits: $ref: '#/components/schemas/hits' hitsPerPage: $ref: '#/components/schemas/SingleResultSet_hitsPerPage' nbHits: $ref: '#/components/schemas/nbHits' nbPages: $ref: '#/components/schemas/nbPages' page: $ref: '#/components/schemas/SingleResultSet_page' params: $ref: '#/components/schemas/SingleResultSet_params' query: $ref: '#/components/schemas/SingleResultSet_query' feedID: type: string description: The ID of the feed. example: products-feed resultsInjectedItemAppliedRulesInfoResponse: type: object properties: objectID: type: string description: The objectID of the applied index level rule on this injected group. example: objectID: qr-1765458959657 required: - objectID resultsInjectedItemInfoResponse: type: object additionalProperties: true properties: key: type: string description: The key of the injected group. example: men-sponsored-group appliedRules: type: array items: $ref: '#/components/schemas/resultsInjectedItemAppliedRulesInfoResponse' required: - key resultsCompositionInfoResponse: type: object x-additionalPropertiesName: composition-id properties: injectedItems: type: array items: $ref: '#/components/schemas/resultsInjectedItemInfoResponse' required: - injectedItems resultsCompositionsResponse: type: object properties: feedID: $ref: '#/components/schemas/feedID' compositions: additionalProperties: $ref: '#/components/schemas/resultsCompositionInfoResponse' required: - compositions searchResultsItem: allOf: - $ref: '#/components/schemas/baseSearchResponse' - $ref: '#/components/schemas/SearchFields' - $ref: '#/components/schemas/resultsCompositionsResponse' processingError: type: object additionalProperties: false properties: message: type: string description: Description of the non-critical error. required: - message searchResults: type: object additionalProperties: false properties: results: type: array description: Search results. items: $ref: '#/components/schemas/searchResultsItem' errors: type: array description: >- Non-critical errors encountered while processing the request that may have affected the returned results (for example, an external provider failure that fell back to another result set). items: $ref: '#/components/schemas/processingError' required: - results searchResponse: additionalProperties: true allOf: - $ref: '#/components/schemas/compositionBaseSearchResponse' - $ref: '#/components/schemas/searchResults' maxFacetHits: type: integer description: >- Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). maximum: 100 default: 10 x-categories: - Advanced searchForFacetValuesResults: type: object additionalProperties: false required: - facetHits - exhaustiveFacetsCount - indexName x-discriminator-fields: - facetHits properties: indexName: type: string facetHits: type: array description: Matching facet values. items: title: facetHits type: object additionalProperties: false required: - value - highlighted - count properties: value: description: Facet value. example: Mobile phone type: string highlighted: $ref: '#/components/schemas/highlightedValue' count: description: >- Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). type: integer exhaustiveFacetsCount: type: boolean description: > Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). processingTimeMS: $ref: '#/components/schemas/processingTimeMS' searchForFacetValuesResponse: type: object additionalProperties: false properties: results: type: array description: Search for facet values results. items: $ref: '#/components/schemas/searchForFacetValuesResults' baseSearchSource: type: object additionalProperties: false properties: index: type: string description: Algolia index used to retrieve records. example: Products required: - index 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 advancedSyntaxFeatures: type: string enum: - exactPhrase - excludeWords 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 alternativesAsExact: type: string enum: - ignorePlurals - singleWordSynonym - multiWordsSynonym - ignoreConjugations x-categories: - Query strategy 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 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. Prefer `attributeCriteriaComputedBy`, which expresses the same two behaviors and adds the `sum` strategy. If you set both, `attributeCriteriaComputedBy` takes precedence. 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 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/#deduplicate-results-with-distinct). 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 SearchParams_enableABTest: type: boolean description: Whether to enable A/B testing for this search. default: true x-categories: - Advanced IndexSettings_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 SearchParams_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 booleanString: type: string enum: - 'true' - 'false' 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 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/#configure-word-size-threshold-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/#configure-word-size-threshold-for-typos). default: 8 x-categories: - Typos 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/#create-a-list-of-optional-words). default: [] x-categories: - Query strategy 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/#create-a-list-of-optional-words). oneOf: - type: string - type: 'null' - $ref: '#/components/schemas/optionalWordsArray' 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 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 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 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 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 SearchParams_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/#assign-context) are strings that you can use to trigger matching rules. default: [] example: - mobile x-categories: - Rules snippetEllipsisText: type: string description: String used as an ellipsis indicator when a snippet is truncated. default: … x-categories: - Highlighting and Snippeting synonyms: type: boolean description: Whether to take into account an index's synonyms for this search. default: true x-categories: - Advanced 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' 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 baseInjectionQueryParameters: title: >- Composition common query parameters between main and injected items as object type: object additionalProperties: false properties: advancedSyntax: $ref: '#/components/schemas/advancedSyntax' advancedSyntaxFeatures: $ref: '#/components/schemas/IndexSettings_advancedSyntaxFeatures' allowTyposOnNumericTokens: $ref: '#/components/schemas/allowTyposOnNumericTokens' alternativesAsExact: $ref: '#/components/schemas/IndexSettings_alternativesAsExact' 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' disableExactOnAttributes: $ref: '#/components/schemas/disableExactOnAttributes' disableTypoToleranceOnAttributes: $ref: '#/components/schemas/disableTypoToleranceOnAttributes' distinct: $ref: '#/components/schemas/distinct' enableABTest: $ref: '#/components/schemas/SearchParams_enableABTest' enablePersonalization: $ref: '#/components/schemas/enablePersonalization' enableReRanking: $ref: '#/components/schemas/enableReRanking' enableRules: $ref: '#/components/schemas/IndexSettings_enableRules' exactOnSingleWordQuery: $ref: '#/components/schemas/exactOnSingleWordQuery' facetFilters: $ref: '#/components/schemas/facetFilters' filters: $ref: '#/components/schemas/filters' getRankingInfo: $ref: '#/components/schemas/SearchParams_getRankingInfo' highlightPostTag: $ref: '#/components/schemas/highlightPostTag' highlightPreTag: $ref: '#/components/schemas/highlightPreTag' ignorePlurals: $ref: '#/components/schemas/ignorePlurals' minProximity: $ref: '#/components/schemas/minProximity' minWordSizefor1Typo: $ref: '#/components/schemas/minWordSizefor1Typo' minWordSizefor2Typos: $ref: '#/components/schemas/minWordSizefor2Typos' naturalLanguages: $ref: '#/components/schemas/naturalLanguages' numericFilters: $ref: '#/components/schemas/numericFilters' optionalFilters: $ref: '#/components/schemas/optionalFilters' optionalWords: $ref: '#/components/schemas/optionalWords' percentileComputation: $ref: '#/components/schemas/percentileComputation' personalizationImpact: $ref: '#/components/schemas/personalizationImpact' queryLanguages: $ref: '#/components/schemas/queryLanguages' queryType: $ref: '#/components/schemas/queryType' removeStopWords: $ref: '#/components/schemas/removeStopWords' removeWordsIfNoResults: $ref: '#/components/schemas/removeWordsIfNoResults' replaceSynonymsInHighlight: $ref: '#/components/schemas/replaceSynonymsInHighlight' responseFields: $ref: '#/components/schemas/responseFields' restrictHighlightAndSnippetArrays: $ref: '#/components/schemas/restrictHighlightAndSnippetArrays' restrictSearchableAttributes: $ref: '#/components/schemas/restrictSearchableAttributes' ruleContexts: $ref: '#/components/schemas/SearchParams_ruleContexts' snippetEllipsisText: $ref: '#/components/schemas/snippetEllipsisText' synonyms: $ref: '#/components/schemas/synonyms' typoTolerance: $ref: '#/components/schemas/typoTolerance' 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 maxValuesPerFacet: type: integer description: Maximum number of facet values to return for each facet. default: 100 maximum: 1000 x-categories: - Faceting 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/#accumulate-scores-with-sumorfiltersscores). default: false x-categories: - Filtering mainInjectionQueryParameters: title: Composition Main Injection Query parameters as object type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseInjectionQueryParameters' - type: object additionalProperties: false properties: facetingAfterDistinct: $ref: '#/components/schemas/facetingAfterDistinct' facets: $ref: '#/components/schemas/facets' hitsPerPage: $ref: '#/components/schemas/hitsPerPage' maxValuesPerFacet: $ref: '#/components/schemas/maxValuesPerFacet' renderingContent: $ref: '#/components/schemas/renderingContent' sortFacetValuesBy: $ref: '#/components/schemas/sortFacetValuesBy' sumOrFiltersScores: $ref: '#/components/schemas/sumOrFiltersScores' injectionMainSearch: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseSearchSource' - type: object additionalProperties: false properties: params: $ref: '#/components/schemas/mainInjectionQueryParameters' injectionMainSearchSource: description: >- Organic result set will originate from a search request performed on the specified index. x-discriminator-fields: - search type: object additionalProperties: false properties: search: $ref: '#/components/schemas/injectionMainSearch' required: - search model: type: string enum: - trending-items description: Recommendation model to use for retrieving recommendations. example: trending-items baseRecommendSource: type: object additionalProperties: false properties: indexName: type: string description: Index to retrieve recommendations from. example: Products model: $ref: '#/components/schemas/model' threshold: type: integer minimum: 0 maximum: 100 description: Minimum score a recommendation must have to be included. required: - indexName - model - threshold injectionMainRecommend: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseRecommendSource' - type: object additionalProperties: false properties: queryParameters: $ref: '#/components/schemas/mainInjectionQueryParameters' fallbackParameters: $ref: '#/components/schemas/mainInjectionQueryParameters' injectionMainRecommendSource: description: Organic result set will originate from a recommend request. x-discriminator-fields: - recommend type: object additionalProperties: false properties: recommend: $ref: '#/components/schemas/injectionMainRecommend' required: - recommend externalProviderOrdering: type: string description: > Ordering to apply on the items retrieved from the external provider. 'algoliaDefined' uses the relevance ranking from the Algolia retrieval step. 'providerDefined' uses the ordering returned by the external provider. enum: - algoliaDefined - providerDefined default: providerDefined baseExternalProviderSource: type: object additionalProperties: false properties: index: type: string description: Algolia index used to fetch the records. example: Products configurationID: type: string description: Identifier of the external provider configuration. example: my-rmn-connection configurationParams: type: object additionalProperties: true description: >- Default values for the configuration placeholders that are not reserved Composition placeholders. example: campaign_id: winter-sale customer_id: user123 ordering: $ref: '#/components/schemas/externalProviderOrdering' required: - index - configurationID injectionMainExternalProvider: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseExternalProviderSource' - type: object additionalProperties: false properties: params: $ref: '#/components/schemas/mainInjectionQueryParameters' injectionMainExternalProviderSource: description: >- Organic result set will originate from a request to an external provider configuration. x-discriminator-fields: - externalProvider type: object additionalProperties: false properties: externalProvider: $ref: '#/components/schemas/injectionMainExternalProvider' required: - externalProvider injectionMainSource: description: Source to be used to retrieve organic result set. oneOf: - $ref: '#/components/schemas/injectionMainSearchSource' - $ref: '#/components/schemas/injectionMainRecommendSource' - $ref: '#/components/schemas/injectionMainExternalProviderSource' injectionMain: type: object additionalProperties: false description: Main defines the organic result set of the injection. properties: source: $ref: '#/components/schemas/injectionMainSource' injectedItemSearch: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseSearchSource' - type: object additionalProperties: false properties: params: $ref: '#/components/schemas/baseInjectionQueryParameters' injectedItemSearchSource: description: >- Injected items will originate from a search request performed on the specified index. x-discriminator-fields: - search type: object additionalProperties: false properties: search: $ref: '#/components/schemas/injectedItemSearch' required: - search externalOrdering: description: >- Ordering to apply on the injected items coming from the external source. 'algoliaDefined' means the items will be ordered as they are in the index (natural relevance) in the smart group. 'userDefined' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group. enum: - algoliaDefined - default - userDefined default: algoliaDefined baseExternalSource: type: object additionalProperties: false properties: index: type: string description: Algolia index used to retrieve records. example: Products ordering: $ref: '#/components/schemas/externalOrdering' required: - index injectedItemExternal: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseExternalSource' - type: object additionalProperties: false properties: params: $ref: '#/components/schemas/baseInjectionQueryParameters' injectedItemExternalSource: description: >- Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload. x-discriminator-fields: - external type: object additionalProperties: false properties: external: $ref: '#/components/schemas/injectedItemExternal' required: - external injectedItemRecommend: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseRecommendSource' - type: object additionalProperties: false properties: queryParameters: $ref: '#/components/schemas/baseInjectionQueryParameters' fallbackParameters: $ref: '#/components/schemas/baseInjectionQueryParameters' injectedItemRecommendSource: description: >- Injected items will originate from a recommendation request performed on the specified index. x-discriminator-fields: - recommend type: object additionalProperties: false properties: recommend: $ref: '#/components/schemas/injectedItemRecommend' required: - recommend injectedItemExternalProvider: type: object additionalProperties: false allOf: - $ref: '#/components/schemas/baseExternalProviderSource' - type: object additionalProperties: false properties: params: $ref: '#/components/schemas/baseInjectionQueryParameters' injectedItemExternalProviderSource: description: >- Injected items will originate from a request to an external provider configuration. x-discriminator-fields: - externalProvider type: object additionalProperties: false properties: externalProvider: $ref: '#/components/schemas/injectedItemExternalProvider' required: - externalProvider injectedItemSource: oneOf: - $ref: '#/components/schemas/injectedItemSearchSource' - $ref: '#/components/schemas/injectedItemExternalSource' - $ref: '#/components/schemas/injectedItemRecommendSource' - $ref: '#/components/schemas/injectedItemExternalProviderSource' injectionInjectedItem: type: object additionalProperties: false properties: key: type: string description: injected Item unique identifier. source: description: Source to be used to inject items into result set. $ref: '#/components/schemas/injectedItemSource' position: type: integer minimum: 0 maximum: 99 length: type: integer minimum: 0 maximum: 50 metadata: title: injectedItemMetadata type: object description: Used to add metadata to the results of the injectedItem. properties: hits: title: injectedItemHitsMetadata type: object description: >- Adds the provided metadata to each injected hit via an `_extra` attribute. properties: addItemKey: type: boolean description: >- When true, each affected hit's `_extra` object includes an `_injectedItemKey` field identifying the injectedItem that inserted it. Defaults to false, meaning hits don't include `_injectedItemKey`. To identify injected hits without this flag, define your own key-value pairs in `extra`. extra: type: object additionalProperties: true description: >- The user-defined key-value pairs that will be placed in the `_extra` field of each affected hit. required: - key - source - position - length dedupPositioning: type: string enum: - highest - highestInjected description: > Deduplication positioning configures how a duplicate result should be resolved between an injected item and main search results. Current configuration supports: - 'highest': always select the item in the highest position, and remove duplicates that appear lower in the results. - 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher. If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main). example: highest default: highestInjected injection: title: injection type: object additionalProperties: false properties: main: $ref: '#/components/schemas/injectionMain' injectedItems: type: array description: list of injected items of the current Composition. minItems: 0 maxItems: 3 items: $ref: '#/components/schemas/injectionInjectedItem' deduplication: title: deduplication type: object additionalProperties: false description: >- Deduplication configures the methods used to resolve duplicate items between main search results and injected group results. properties: positioning: $ref: '#/components/schemas/dedupPositioning' required: - positioning required: - main compositionInjectionBehavior: type: object additionalProperties: false description: An object containing an `injection` behavior. properties: injection: $ref: '#/components/schemas/injection' required: - injection feedInjection: type: object description: Feed formatted as an injection. additionalProperties: false properties: injection: $ref: '#/components/schemas/injection' required: - injection Behaviour_feedID: type: object oneOf: - $ref: '#/components/schemas/feedInjection' multifeed: title: multifeed type: object additionalProperties: false properties: feeds: type: object description: >- A key-value store of Feed ID to Feed. Currently, the only supported Feed type is an Injection. additionalProperties: $ref: '#/components/schemas/Behaviour_feedID' feedsOrder: type: array description: >- A list of Feed IDs that specifies the order in which to order the results in the response. The IDs should be a subset of those in the Feeds object, and only those specified will be processed. When this field is not set, all Feeds are processed and returned with a default ordering. items: type: string required: - feeds example: feeds: products-feed: injection: main: source: search: index: products injectedItems: - key: sponsored position: 0 length: 4 source: search: index: products params: filters: sponsored:true articles-feed: injection: main: source: search: index: articles feedsOrder: - products-feed - articles-feed compositionMultifeedBehavior: type: object additionalProperties: false description: An object containing a `multifeed` behavior. properties: multifeed: $ref: '#/components/schemas/multifeed' required: - multifeed compositionBehavior: type: object additionalProperties: false description: >- An object containing either an `injection` or `multifeed` behavior schema, but not both. oneOf: - $ref: '#/components/schemas/compositionInjectionBehavior' - $ref: '#/components/schemas/compositionMultifeedBehavior' sortingStrategy: type: object description: > A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. When the composition is run, the API ignores a sorting index that is unrelated to the targeted indices. The response reports it in the `errors` field. Each key is the label your frontend sends at runtime (for example, "Price (asc)"), and each value is the name of the index that should be queried when that label is selected. When a request includes a "sortBy" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to. Up to 20 sorting strategies can be defined. additionalProperties: type: string example: Price (asc): products-low-to-high Price (desc): products-high-to-low composition: type: object additionalProperties: false properties: objectID: $ref: '#/components/schemas/compositionObjectID' name: type: string description: Composition name. example: my lovely crafted composition description: type: string description: Composition description. example: my lovely crafted composition that is used for X purpose behavior: $ref: '#/components/schemas/compositionBehavior' sortingStrategy: $ref: '#/components/schemas/sortingStrategy' required: - objectID - behavior - name listCompositionsResponse: type: object additionalProperties: false properties: items: type: array description: All compositions in your Algolia application. items: $ref: '#/components/schemas/composition' nbPages: type: integer description: Number of pages. example: 100 page: type: integer description: Current page. example: 0 hitsPerPage: type: integer description: Number of items per page. example: 20 nbHits: type: integer description: Number of items. example: 200 required: - hitsPerPage - items - nbHits - nbPages - page taskID: type: integer format: int64 example: 1514562690001 description: > Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID. action: type: string enum: - upsert - delete description: Type of Composition Batch operation. deleteCompositionAction: type: object description: Operation arguments when deleting. additionalProperties: false properties: objectID: $ref: '#/components/schemas/compositionObjectID' required: - objectID batchCompositionAction: oneOf: - title: Upsert (update and insert) $ref: '#/components/schemas/composition' - title: Delete $ref: '#/components/schemas/deleteCompositionAction' ruleID: title: objectID type: string description: Unique identifier of a rule object. compositionRuleObjectID: type: string example: my_composition_rule_object_id description: Composition rule unique identifier. anchoring: type: string description: | Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. enum: - is - startsWith - endsWith - contains context: type: string pattern: '[A-Za-z0-9_-]+' description: > An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters. example: mobile condition: type: object additionalProperties: false properties: pattern: type: string description: > Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as "comedy". example: '{facet:genre}' anchoring: $ref: '#/components/schemas/anchoring' context: $ref: '#/components/schemas/context' filters: type: string description: > Filters that trigger the rule. You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. example: genre:comedy sortBy: type: string description: > Sort criteria that trigger the rule. You can trigger composition rules based on the selected sorting strategy set by the parameter `sortBy`. The rule will trigger if the value passed to `sortBy` matches the one defined in the condition. example: price-low-to-high timeRange: type: object additionalProperties: false properties: from: type: integer format: int64 description: >- Timestamp when the rule should start to be active, measured in seconds since the Unix epoch. until: type: integer format: int64 description: >- Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch. compositionRule: type: object additionalProperties: false properties: objectID: $ref: '#/components/schemas/compositionRuleObjectID' conditions: type: array minItems: 0 maxItems: 25 description: Conditions that trigger a composition rule. items: $ref: '#/components/schemas/condition' consequence: title: compositionRuleConsequence type: object description: Effect of the rule. additionalProperties: false properties: behavior: $ref: '#/components/schemas/compositionBehavior' required: - behavior description: type: string description: >- Description of the rule's purpose to help you distinguish between different rules. example: Display a promotional banner enabled: type: boolean default: true description: Whether the rule is active. validity: type: array description: Time periods when the rule is active. items: $ref: '#/components/schemas/timeRange' tags: type: array description: A list of tags. items: type: string example: - conditional required: - objectID - consequence deleteCompositionRuleAction: type: object description: Operation arguments when deleting. additionalProperties: false properties: objectID: $ref: '#/components/schemas/compositionRuleObjectID' required: - objectID rulesBatchCompositionAction: oneOf: - title: Upsert (update and insert) $ref: '#/components/schemas/compositionRule' - title: Delete $ref: '#/components/schemas/deleteCompositionRuleAction' parameters_query: type: string description: Search query for rules. default: '' parameters_page: type: integer minimum: 0 description: > Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. parameters_hitsPerPage: type: integer default: 20 minimum: 1 maximum: 1000 description: > Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. taskStatus: type: string enum: - published - notPublished description: >- Task status, `published` if the task is completed, `notPublished` otherwise. GetTaskResponse: title: getTaskResponse type: object additionalProperties: false properties: status: $ref: '#/components/schemas/taskStatus' required: - status 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' CompositionNotFound: description: Composition not found. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' UnprocessableEntity: description: Unprocessable Entity. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' headers: Correlation-ID: description: > Identifies the request in Algolia's logs, where it's the `cid` property of a log entry. Include it when you contact the Algolia support team about a specific request. Retried requests can share an identifier, so don't use it as a unique key. example: MyAppl-1tMcE-a7BqLm2Pd0Z schema: type: string x-tagGroups: - name: Composition tags: - Search - Compositions - Composition Rules - Advanced