> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # algolia > Algolia Search **Server path:** `/algolia` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------- | ------------------------------------------------ | | [`algolia_add_api_key`](#algolia_add_api_key) | Create an API key | | [`algolia_add_or_update_object`](#algolia_add_or_update_object) | Add or replace a record | | [`algolia_append_source`](#algolia_append_source) | Add a source | | [`algolia_batch`](#algolia_batch) | Batch indexing operations on one index | | [`algolia_batch_dictionary_entries`](#algolia_batch_dictionary_entries) | Add or delete dictionary entries | | [`algolia_browse`](#algolia_browse) | Browse for records | | [`algolia_clear_objects`](#algolia_clear_objects) | Delete all records from an index | | [`algolia_clear_rules`](#algolia_clear_rules) | Delete all rules | | [`algolia_clear_synonyms`](#algolia_clear_synonyms) | Delete all synonyms | | [`algolia_delete_api_key`](#algolia_delete_api_key) | Delete an API key | | [`algolia_delete_by`](#algolia_delete_by) | Delete records matching a filter | | [`algolia_delete_index`](#algolia_delete_index) | Delete an index | | [`algolia_delete_object`](#algolia_delete_object) | Delete a record | | [`algolia_delete_rule`](#algolia_delete_rule) | Delete a rule | | [`algolia_delete_source`](#algolia_delete_source) | Delete a source | | [`algolia_delete_synonym`](#algolia_delete_synonym) | Delete a synonym | | [`algolia_get_api_key`](#algolia_get_api_key) | Retrieve API key permissions | | [`algolia_get_app_task`](#algolia_get_app_task) | Check application task status | | [`algolia_get_dictionary_languages`](#algolia_get_dictionary_languages) | List available languages | | [`algolia_get_dictionary_settings`](#algolia_get_dictionary_settings) | Retrieve dictionary settings | | [`algolia_get_logs`](#algolia_get_logs) | Retrieve log entries | | [`algolia_get_object`](#algolia_get_object) | Retrieve a record | | [`algolia_get_objects`](#algolia_get_objects) | Retrieve records | | [`algolia_get_rule`](#algolia_get_rule) | Retrieve a rule | | [`algolia_get_settings`](#algolia_get_settings) | Retrieve index settings | | [`algolia_get_sources`](#algolia_get_sources) | List allowed sources | | [`algolia_get_synonym`](#algolia_get_synonym) | Retrieve a synonym | | [`algolia_get_task`](#algolia_get_task) | Check task status | | [`algolia_list_api_keys`](#algolia_list_api_keys) | List API keys | | [`algolia_list_indices`](#algolia_list_indices) | List indices | | [`algolia_multiple_batch`](#algolia_multiple_batch) | Batch indexing operations on multiple indices | | [`algolia_operation_index`](#algolia_operation_index) | Copy or move an index | | [`algolia_partial_update_object`](#algolia_partial_update_object) | Add or update attributes | | [`algolia_replace_sources`](#algolia_replace_sources) | Replace allowed sources | | [`algolia_restore_api_key`](#algolia_restore_api_key) | Restore an API key | | [`algolia_save_object`](#algolia_save_object) | Add a new record (with auto-generated object ID) | | [`algolia_save_rule`](#algolia_save_rule) | Create or replace a rule | | [`algolia_save_rules`](#algolia_save_rules) | Create or update rules | | [`algolia_save_synonym`](#algolia_save_synonym) | Create or replace a synonym | | [`algolia_save_synonyms`](#algolia_save_synonyms) | Create or replace synonyms | | [`algolia_search`](#algolia_search) | Search multiple indices | | [`algolia_search_dictionary_entries`](#algolia_search_dictionary_entries) | Search dictionary entries | | [`algolia_search_for_facet_values`](#algolia_search_for_facet_values) | Search for facet values | | [`algolia_search_rules`](#algolia_search_rules) | Search for rules | | [`algolia_search_single_index`](#algolia_search_single_index) | Search an index | | [`algolia_search_synonyms`](#algolia_search_synonyms) | Search for synonyms | | [`algolia_set_dictionary_settings`](#algolia_set_dictionary_settings) | Update dictionary settings | | [`algolia_set_settings`](#algolia_set_settings) | Update index settings | | [`algolia_update_api_key`](#algolia_update_api_key) | Update an API key | *** ## algolia\_add\_api\_key Create an API key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `acl` | string\[] | Yes | — | Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). | | `description` | string | No | — | Description of an API key to help you identify this API key. | | `indexes` | string\[] | No | — | Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with "dev\_" - `*_dev` matches all indices ending with "\_dev" - `*_products_*` matches all indices containing "*products*". | | `maxHitsPerQuery` | integer | No | — | Maximum number of results this API key can retrieve in one query. By default, there's no limit. | | `maxQueriesPerIPPerHour` | integer | No | — | Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit. | | `queryParameters` | string | No | — | Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range. | | `referers` | string\[] | No | — | Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with "[https://algolia.com/](https://algolia.com/)" - `*.algolia.com` allows all referrers ending with ".algolia.com" - `*algolia.com*` allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions). | | `validity` | integer | No | — | Duration (in seconds) after which the API key expires. By default, API keys don't expire. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "acl": { "type": "array", "items": { "type": "string", "enum": [ "addObject", "analytics", "browse", "deleteObject", "deleteIndex", "editSettings", "inference", "listIndexes", "logs", "personalization", "recommendation", "search", "seeUnretrievableAttributes", "settings", "usage", "nluWriteProject", "nluReadProject", "nluWriteEntity", "nluReadEntity", "nluWriteIntent", "nluReadIntent", "nluPrediction", "nluReadAnswers" ] }, "description": "Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)." }, "description": { "type": "string", "description": "Description of an API key to help you identify this API key." }, "indexes": { "type": "array", "items": { "type": "string" }, "description": "Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\"." }, "maxHitsPerQuery": { "type": "integer", "description": "Maximum number of results this API key can retrieve in one query. By default, there's no limit." }, "maxQueriesPerIPPerHour": { "type": "integer", "description": "Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit." }, "queryParameters": { "type": "string", "description": "Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range." }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions)." }, "validity": { "type": "integer", "description": "Duration (in seconds) after which the API key expires. By default, API keys don't expire." } }, "required": [ "PCID", "acl" ] } ``` *** ## algolia\_add\_or\_update\_object Add or replace a record **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `body` | object | Yes | — | The record. A schemaless object with attributes that are useful in the context of search and discovery. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "body": { "type": "object", "description": "The record. A schemaless object with attributes that are useful in the context of search and discovery." } }, "required": [ "PCID", "indexName", "objectID", "body" ] } ``` *** ## algolia\_append\_source Add a source **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------- | | `description` | string | No | — | Source description. | | `source` | string | Yes | — | IP address range of the source. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Source description." }, "source": { "type": "string", "description": "IP address range of the source." } }, "required": [ "PCID", "source" ] } ``` *** ## algolia\_batch Batch indexing operations on one index **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addObject", "updateObject", "partialUpdateObject", "partialUpdateObjectNoCreate", "deleteObject", "delete", "clear" ], "description": "Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index operation\"." }, "body": { "type": "object", "description": "Operation arguments (varies with specified `action`)." } }, "required": [ "action", "body" ] }, "description": "The requests value" } }, "required": [ "PCID", "indexName", "requests" ] } ``` *** ## algolia\_batch\_dictionary\_entries Add or delete dictionary entries **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------- | | `dictionaryName` | string | Yes | — | Dictionary type in which to search. | | `clearExistingDictionaryEntries` | boolean | No | — | Whether to replace all custom entries in the dictionary with the ones sent with this request. | | `requests` | object\[] | Yes | — | List of additions and deletions to your dictionaries. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryName": { "type": "string", "description": "Dictionary type in which to search.", "enum": [ "plurals", "stopwords", "compounds" ] }, "clearExistingDictionaryEntries": { "type": "boolean", "description": "Whether to replace all custom entries in the dictionary with the ones sent with this request." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addEntry", "deleteEntry" ], "description": "Actions to perform." }, "body": { "type": "object", "description": "Dictionary entry." } }, "required": [ "action", "body" ] }, "description": "List of additions and deletions to your dictionaries." } }, "required": [ "PCID", "dictionaryName", "requests" ] } ``` *** ## algolia\_browse Browse for records **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "description": "Request body" } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_objects Delete all records from an index **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_rules Delete all rules **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_synonyms Delete all synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_api\_key Delete an API key **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_delete\_by Delete records matching a filter **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `aroundLatLng` | string | No | — | 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`. | | `aroundRadius` | object | No | — | 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. | | `facetFilters` | object | No | — | 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`. | | `filters` | string | No | — | Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: 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). | | `insideBoundingBox` | object | No | — | Inside Bounding Box | | `insidePolygon` | any\[]\[] | No | — | 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`. | | `numericFilters` | object | No | — | 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:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. | | `tagFilters` | object | No | — | Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "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`." }, "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." }, "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`." }, "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)." }, "insideBoundingBox": { "description": "Inside Bounding Box" }, "insidePolygon": { "type": "array", "items": { "type": "array" }, "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`." }, "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`." }, "tagFilters": { "description": "Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_index Delete an index **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_object Delete a record **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_delete\_rule Delete a rule **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_delete\_source Delete a source **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------- | | `source` | string | Yes | — | IP address range of the source. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "source": { "type": "string", "description": "IP address range of the source." } }, "required": [ "PCID", "source" ] } ``` *** ## algolia\_delete\_synonym Delete a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_api\_key Retrieve API key permissions **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_get\_app\_task Check application task status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------- | | `taskID` | integer | Yes | — | Unique task identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "taskID": { "type": "integer", "description": "Unique task identifier." } }, "required": [ "PCID", "taskID" ] } ``` *** ## algolia\_get\_dictionary\_languages List available languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_dictionary\_settings Retrieve dictionary settings ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_logs Retrieve log entries **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `offset` | integer | No | — | First log entry to retrieve. The most recent entries are listed first. | | `length` | integer | No | — | Maximum number of entries to retrieve. | | `indexName` | string | No | — | Index for which to retrieve log entries. By default, log entries are retrieved for all indices. | | `type` | string | No | — | Type of log entries to retrieve. By default, all log entries are retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "First log entry to retrieve. The most recent entries are listed first." }, "length": { "type": "integer", "description": "Maximum number of entries to retrieve." }, "indexName": { "type": "string", "description": "Index for which to retrieve log entries. By default, log entries are retrieved for all indices." }, "type": { "type": "string", "description": "Type of log entries to retrieve. By default, all log entries are retrieved.", "enum": [ "all", "query", "build", "error" ] } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_object Retrieve a record **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `attributesToRetrieve` | string\[] | No | — | Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "description": "Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_objects Retrieve records **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------ | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "description": "Attributes to retrieve. If not specified, all retrievable attributes are returned." }, "objectID": { "type": "string", "description": "Object ID for the record to retrieve." }, "indexName": { "type": "string", "description": "Index from which to retrieve the records." } }, "required": [ "objectID", "indexName" ] }, "description": "The requests value" } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_get\_rule Retrieve a rule **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_settings Retrieve index settings **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `getVersion` | integer | No | — | When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "getVersion": { "type": "integer", "description": "When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_get\_sources List allowed sources ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_synonym Retrieve a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_task Check task status **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `taskID` | integer | Yes | — | Unique task identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "taskID": { "type": "integer", "description": "Unique task identifier." } }, "required": [ "PCID", "indexName", "taskID" ] } ``` *** ## algolia\_list\_api\_keys List API keys ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_list\_indices List indices **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `page` | integer | No | — | Requested page of the API response. If `null`, the API response is not paginated. | | `hitsPerPage` | integer | No | — | Number of hits per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Requested page of the API response. If `null`, the API response is not paginated." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." } }, "required": [ "PCID" ] } ``` *** ## algolia\_multiple\_batch Batch indexing operations on multiple indices **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------ | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addObject", "updateObject", "partialUpdateObject", "partialUpdateObjectNoCreate", "deleteObject", "delete", "clear" ], "description": "Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index operation\"." }, "body": { "type": "object", "description": "Operation arguments (varies with specified `action`)." }, "indexName": { "type": "string", "description": "Index name (case-sensitive)." } }, "required": [ "action", "indexName" ] }, "description": "The requests value" } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_operation\_index Copy or move an index **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `destination` | string | Yes | — | Index name (case-sensitive). | | `operation` | string | Yes | — | Operation to perform on the index. | | `scope` | string\[] | No | — | **Only for copying.** If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "destination": { "type": "string", "description": "Index name (case-sensitive)." }, "operation": { "type": "string", "description": "Operation to perform on the index.", "enum": [ "move", "copy" ] }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "settings", "synonyms", "rules" ] }, "description": "**Only for copying.** If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules." } }, "required": [ "PCID", "indexName", "destination", "operation" ] } ``` *** ## algolia\_partial\_update\_object Add or update attributes **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `createIfNotExists` | boolean | No | — | Whether to create a new record if it doesn't exist. | | `body` | object | Yes | — | Attributes with their values. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "createIfNotExists": { "type": "boolean", "description": "Whether to create a new record if it doesn't exist." }, "body": { "type": "object", "description": "Attributes with their values." } }, "required": [ "PCID", "indexName", "objectID", "body" ] } ``` *** ## algolia\_replace\_sources Replace allowed sources **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------- | | `body` | object\[] | Yes | — | Allowed sources. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "IP address range of the source." }, "description": { "type": "string", "description": "Source description." } }, "required": [ "source" ] }, "description": "Allowed sources." } }, "required": [ "PCID", "body" ] } ``` *** ## algolia\_restore\_api\_key Restore an API key **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_save\_object Add a new record (with auto-generated object ID) **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | Yes | — | The record. A schemaless object with attributes that are useful in the context of search and discovery. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "type": "object", "description": "The record. A schemaless object with attributes that are useful in the context of search and discovery." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_save\_rule Create or replace a rule **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `condition` | object | No | — | The condition value | | `conditions` | object\[] | No | — | Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions). | | `consequence` | object | Yes | — | Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences). | | `description` | string | No | — | Description of the rule's purpose to help you distinguish between different rules. | | `enabled` | boolean | No | — | Whether the rule is active. | | `scope` | string | No | — | The scope value | | `tags` | string\[] | No | — | The tags value | | `validity` | object\[] | No | — | Time periods when the rule is active. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "condition": { "type": "object", "description": "The condition value", "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\"." }, "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" ] }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "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." }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can 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. You can't combine multiple filters with `OR` and you can't use numeric filters." } } }, "conditions": { "type": "array", "items": { "type": "object", "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\"." }, "anchoring": { "type": "string", "enum": [ "is", "startsWith", "endsWith", "contains" ], "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`." }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "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." }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can 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. You can't combine multiple filters with `OR` and you can't use numeric filters." } } }, "description": "Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions)." }, "consequence": { "type": "object", "description": "Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).", "properties": { "params": { "description": "The params value" }, "promote": { "type": "array", "description": "Records you want to pin to a specific position in the search results. You can promote up to 300 records, either individually, or as groups of up to 100 records each." }, "filterPromotes": { "type": "boolean", "description": "Determines whether promoted records must also match active filters for the consequence to apply. This ensures user-applied filters take priority and irrelevant matches aren't shown. For example, if you promote a record with `color: red` but the user filters for `color: blue`, the \"red\" record won't be shown. > In the Algolia dashboard, when you use the **Pin an item** consequence, `filterPromotes` appears as the checkbox: **Pinned items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters)." }, "hide": { "type": "array", "items": { "type": "object" }, "description": "Records you want to hide from the search results." }, "redirect": { "type": "object", "description": "Redirect to a virtual replica index. This consequence is only valid for rules with `scope: redirect`." }, "userData": { "type": "object", "description": "A JSON object with custom data that will be appended to the `userData` array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON." } } }, "description": { "type": "string", "description": "Description of the rule's purpose to help you distinguish between different rules." }, "enabled": { "type": "boolean", "description": "Whether the rule is active." }, "scope": { "type": "string", "description": "The scope value" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The tags value" }, "validity": { "type": "array", "items": { "type": "object", "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." } } }, "description": "Time periods when the rule is active." } }, "required": [ "PCID", "indexName", "objectID", "consequence" ] } ``` *** ## algolia\_save\_rules Create or update rules **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------ | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `clearExistingRules` | boolean | No | — | Whether existing rules should be deleted before adding this batch. | | `body` | object\[] | Yes | — | Rules to add or replace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "clearExistingRules": { "type": "boolean", "description": "Whether existing rules should be deleted before adding this batch." }, "body": { "type": "array", "items": { "type": "object", "properties": { "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "conditions": { "type": "array", "items": { "type": "object", "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\". " }, "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`. " }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "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. " }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can 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. You can't combine multiple filters with `OR` and you can't use numeric filters. " } } }, "description": "Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions)." }, "consequence": { "type": "object", "description": "Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences)." }, "description": { "type": "string", "description": "Description of the rule's purpose to help you distinguish between different rules." }, "enabled": { "type": "boolean", "description": "Whether the rule is active." }, "validity": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "integer", "description": "Timestamp when the rule should start to be active, measured in seconds since the Unix epoch." }, "until": { "type": "integer", "description": "Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch." } } }, "description": "Time periods when the rule is active." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The tags value" }, "scope": { "type": "string", "description": "The scope value" }, "condition": { "type": "object", "description": "The condition value" } }, "required": [ "objectID", "consequence" ] }, "description": "Rules to add or replace." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_save\_synonym Create or replace a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `corrections` | string\[] | No | — | Words to be matched in records. | | `input` | string | No | — | Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms)). | | `placeholder` | string | No | — | [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records. | | `replacements` | string\[] | No | — | Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders). | | `synonyms` | string\[] | No | — | Words or phrases considered equivalent. | | `type` | string | Yes | — | Synonym type. | | `word` | string | No | — | Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections)). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "corrections": { "type": "array", "items": { "type": "string" }, "description": "Words to be matched in records." }, "input": { "type": "string", "description": "Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms))." }, "placeholder": { "type": "string", "description": "[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records." }, "replacements": { "type": "array", "items": { "type": "string" }, "description": "Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders)." }, "synonyms": { "type": "array", "items": { "type": "string" }, "description": "Words or phrases considered equivalent." }, "type": { "type": "string", "description": "Synonym type.", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ] }, "word": { "type": "string", "description": "Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections))." } }, "required": [ "PCID", "indexName", "objectID", "type" ] } ``` *** ## algolia\_save\_synonyms Create or replace synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `replaceExistingSynonyms` | boolean | No | — | Whether to replace all synonyms in the index with the ones sent with this request. | | `body` | object\[] | Yes | — | Matching synonyms. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "replaceExistingSynonyms": { "type": "boolean", "description": "Whether to replace all synonyms in the index with the ones sent with this request." }, "body": { "type": "array", "items": { "type": "object", "properties": { "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "type": { "type": "string", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ], "description": "Synonym type." }, "synonyms": { "type": "array", "items": { "type": "string" }, "description": "Words or phrases considered equivalent." }, "input": { "type": "string", "description": "Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms))." }, "word": { "type": "string", "description": "Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections))." }, "corrections": { "type": "array", "items": { "type": "string" }, "description": "Words to be matched in records." }, "placeholder": { "type": "string", "description": "[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records." }, "replacements": { "type": "array", "items": { "type": "string" }, "description": "Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders)." } }, "required": [ "objectID", "type" ] }, "description": "Matching synonyms." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_search Search multiple indices **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `requests` | any\[] | Yes | — | The requests value | | `strategy` | string | No | — | Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "description": "The requests value" }, "strategy": { "type": "string", "description": "Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.", "enum": [ "none", "stopIfEnoughMatches" ] } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_search\_dictionary\_entries Search dictionary entries **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ----------------------------------- | | `dictionaryName` | string | Yes | — | Dictionary type in which to search. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `language` | string | No | — | ISO code for a supported language. | | `page` | integer | No | — | Page of search results to retrieve. | | `query` | string | Yes | — | Search query. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryName": { "type": "string", "description": "Dictionary type in which to search.", "enum": [ "plurals", "stopwords", "compounds" ] }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "language": { "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" ] }, "page": { "type": "integer", "description": "Page of search results to retrieve." }, "query": { "type": "string", "description": "Search query." } }, "required": [ "PCID", "dictionaryName", "query" ] } ``` *** ## algolia\_search\_for\_facet\_values Search for facet values **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `facetName` | string | Yes | — | Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. | | `facetQuery` | string | No | — | Text to search inside the facet's values. | | `maxFacetHits` | integer | No | — | 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). | | `params` | string | No | — | Search parameters as a URL-encoded query string. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "facetName": { "type": "string", "description": "Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier." }, "facetQuery": { "type": "string", "description": "Text to search inside the facet's values." }, "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)." }, "params": { "type": "string", "description": "Search parameters as a URL-encoded query string." } }, "required": [ "PCID", "indexName", "facetName" ] } ``` *** ## algolia\_search\_rules Search for rules **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | | `anchoring` | string | No | — | 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`. | | | `context` | string | No | — | Only return rules that match the context (exact match). | | | `enabled` | boolean | null | No | — | If `true`, return only enabled rules. If `false`, return only inactive rules. By default, *all* rules are returned. | | `hitsPerPage` | integer | No | — | 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. | | | `page` | integer | No | — | 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. | | | `query` | string | No | — | Search query for rules. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "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", "description": "Only return rules that match the context (exact match)." }, "enabled": { "type": [ "boolean", "null" ], "description": "If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned." }, "hitsPerPage": { "type": "integer", "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." }, "page": { "type": "integer", "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." }, "query": { "type": "string", "description": "Search query for rules." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_search\_single\_index Search an index **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "description": "Request body" } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_search\_synonyms Search for synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `page` | integer | No | — | Page of search results to retrieve. | | `query` | string | No | — | Search query. | | `type` | string | No | — | Synonym type. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "page": { "type": "integer", "description": "Page of search results to retrieve." }, "query": { "type": "string", "description": "Search query." }, "type": { "type": "string", "description": "Synonym type.", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ] } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_set\_dictionary\_settings Update dictionary settings **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `disableStandardEntries` | object | Yes | — | Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "disableStandardEntries": { "type": "object", "description": "Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.", "properties": { "plurals": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." }, "stopwords": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." }, "compounds": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." } } } }, "required": [ "PCID", "disableStandardEntries" ] } ``` *** ## algolia\_set\_settings Update index settings **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `advancedSyntax` | boolean | No | — | Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported. | | `advancedSyntaxFeatures` | string\[] | No | — | 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. | | `allowCompressionOfIntegerArray` | boolean | No | — | Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. | | `allowTyposOnNumericTokens` | boolean | No | — | 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. | | `alternativesAsExact` | string\[] | No | — | 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. | | `attributeCriteriaComputedByMinProximity` | boolean | No | — | 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. | | `attributeForDistinct` | string | No | — | Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting *after* deduplication, which will result in accurate facet counts. | | `attributesForFaceting` | string\[] | No | — | Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly("ATTRIBUTE")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable("ATTRIBUTE")`. Allows searching for facet values. - `afterDistinct("ATTRIBUTE")`. Evaluates the facet count *after* deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. | | `attributesToHighlight` | string\[] | No | — | 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). | | `attributesToRetrieve` | string\[] | No | — | 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. | | `attributesToSnippet` | string\[] | No | — | 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. | | `attributesToTransliterate` | string\[] | No | — | Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. | | `camelCaseAttributes` | string\[] | No | — | Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. | | `customNormalization` | object | No | — | Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization). | | `customRanking` | string\[] | No | — | Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision) of your first attributes, or the other attributes will never be applied. | | `decompoundedAttributes` | object | No | — | Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). | | `decompoundQuery` | boolean | No | — | Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). | | `disableExactOnAttributes` | string\[] | No | — | 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. | | `disablePrefixOnAttributes` | string\[] | No | — | Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. | | `disableTypoToleranceOnAttributes` | string\[] | No | — | 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. | | `disableTypoToleranceOnWords` | string\[] | No | — | Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words. | | `distinct` | object | No | — | Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. | | `enablePersonalization` | boolean | No | — | Whether to enable Personalization. | | `enableReRanking` | boolean | No | — | 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. | | `enableRules` | boolean | No | — | Whether to enable rules. | | `exactOnSingleWordQuery` | string | No | — | 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. | | `highlightPostTag` | string | No | — | HTML tag to insert after the highlighted parts in all highlighted results and snippets. | | `highlightPreTag` | string | No | — | HTML tag to insert before the highlighted parts in all highlighted results and snippets. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `ignorePlurals` | object | No | — | Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index. | | `indexLanguages` | string\[] | No | — | Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing 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). | | `keepDiacriticsOnCharacters` | string | No | — | Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. | | `maxFacetHits` | integer | No | — | 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). | | `maxValuesPerFacet` | integer | No | — | Maximum number of facet values to return for each facet. | | `minProximity` | integer | No | — | 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. | | `minWordSizefor1Typo` | integer | No | — | Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). | | `minWordSizefor2Typos` | integer | No | — | Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). | | `mode` | string | No | — | Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you. | | `numericAttributesForFiltering` | string\[] | No | — | Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly("ATTRIBUTE")`. Support only filtering based on equality comparisons `=` and `!=`. | | `optionalWords` | object | No | — | Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is optional, the search engine runs two queries: one for "action video" and one for "action". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). | | `paginationLimitedTo` | integer | No | — | Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. | | `queryLanguages` | string\[] | No | — | 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). | | `queryType` | string | No | — | 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). | | `ranking` | string\[] | No | — | Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing). | | `relevancyStrictness` | integer | No | — | Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. | | `removeStopWords` | object | No | — | 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. | | `removeWordsIfNoResults` | string | No | — | 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). | | `renderingContent` | object | No | — | 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. | | `replaceSynonymsInHighlight` | boolean | No | — | 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. | | `replicas` | string\[] | No | — | Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual("REPLICA")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort). | | `reRankingApplyFilter` | object | No | — | Re Ranking Apply Filter | | `responseFields` | string\[] | No | — | 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. | | `restrictHighlightAndSnippetArrays` | boolean | No | — | Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. | | `searchableAttributes` | string\[] | No | — | Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `"title,alternate_title"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered("ATTRIBUTE")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end. | | `semanticSearch` | object | No | — | Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. | | `separatorsToIndex` | string | No | — | Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as \$€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words. | | `snippetEllipsisText` | string | No | — | String used as an ellipsis indicator when a snippet is truncated. | | `sortFacetValuesBy` | string | No | — | 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). | | `typoTolerance` | object | No | — | 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. | | `unretrievableAttributes` | string\[] | No | — | Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive. | | `userData` | object | No | — | An object with custom data. You can store up to 32kB as custom data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "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." }, "advancedSyntaxFeatures": { "type": "array", "items": { "type": "string", "enum": [ "exactPhrase", "excludeWords" ] }, "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." }, "allowCompressionOfIntegerArray": { "type": "boolean", "description": "Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered." }, "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." }, "alternativesAsExact": { "type": "array", "items": { "type": "string", "enum": [ "ignorePlurals", "singleWordSynonym", "multiWordsSynonym", "ignoreConjugations" ] }, "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." }, "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." }, "attributeForDistinct": { "type": "string", "description": "Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts." }, "attributesForFaceting": { "type": "array", "items": { "type": "string" }, "description": "Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`." }, "attributesToHighlight": { "type": "array", "items": { "type": "string" }, "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)." }, "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "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." }, "attributesToSnippet": { "type": "array", "items": { "type": "string" }, "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." }, "attributesToTransliterate": { "type": "array", "items": { "type": "string" }, "description": "Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive." }, "camelCaseAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive." }, "customNormalization": { "type": "object", "description": "Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization)." }, "customRanking": { "type": "array", "items": { "type": "string" }, "description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision) of your first attributes, or the other attributes will never be applied." }, "decompoundedAttributes": { "type": "object", "description": "Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308)." }, "decompoundQuery": { "type": "boolean", "description": "Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308)." }, "disableExactOnAttributes": { "type": "array", "items": { "type": "string" }, "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." }, "disablePrefixOnAttributes": { "type": "array", "items": { "type": "string" }, "description": "Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive." }, "disableTypoToleranceOnAttributes": { "type": "array", "items": { "type": "string" }, "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." }, "disableTypoToleranceOnWords": { "type": "array", "items": { "type": "string" }, "description": "Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words." }, "distinct": { "description": "Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set." }, "enablePersonalization": { "type": "boolean", "description": "Whether to enable 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." }, "enableRules": { "type": "boolean", "description": "Whether to enable rules." }, "exactOnSingleWordQuery": { "type": "string", "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.", "enum": [ "attribute", "none", "word" ] }, "highlightPostTag": { "type": "string", "description": "HTML tag to insert after the highlighted parts in all highlighted results and snippets." }, "highlightPreTag": { "type": "string", "description": "HTML tag to insert before the highlighted parts in all highlighted results and snippets." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "ignorePlurals": { "description": "Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index." }, "indexLanguages": { "type": "array", "items": { "type": "string", "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" ] }, "description": "Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing 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)." }, "keepDiacriticsOnCharacters": { "type": "string", "description": "Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics." }, "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)." }, "maxValuesPerFacet": { "type": "integer", "description": "Maximum number of facet values to return for each facet." }, "minProximity": { "type": "integer", "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." }, "minWordSizefor1Typo": { "type": "integer", "description": "Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos)." }, "minWordSizefor2Typos": { "type": "integer", "description": "Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos)." }, "mode": { "type": "string", "description": "Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.", "enum": [ "neuralSearch", "keywordSearch" ] }, "numericAttributesForFiltering": { "type": "array", "items": { "type": "string" }, "description": "Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`." }, "optionalWords": { "description": "Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is optional, the search engine runs two queries: one for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words)." }, "paginationLimitedTo": { "type": "integer", "description": "Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed." }, "queryLanguages": { "type": "array", "items": { "type": "string", "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" ] }, "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)." }, "queryType": { "type": "string", "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).", "enum": [ "prefixLast", "prefixAll", "prefixNone" ] }, "ranking": { "type": "array", "items": { "type": "string" }, "description": "Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing)." }, "relevancyStrictness": { "type": "integer", "description": "Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results." }, "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." }, "removeWordsIfNoResults": { "type": "string", "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).", "enum": [ "none", "lastWords", "firstWords", "allOptional" ] }, "renderingContent": { "type": "object", "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.", "properties": { "facetOrdering": { "type": "object", "description": "Order of facet names and facet values in your UI." }, "redirect": { "type": "object", "description": "The redirect rule container." }, "widgets": { "type": "object", "description": "Widgets returned from any rules that are applied to the current search." } } }, "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." }, "replicas": { "type": "array", "items": { "type": "string" }, "description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort)." }, "reRankingApplyFilter": { "description": "Re Ranking Apply Filter" }, "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." }, "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." }, "searchableAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end." }, "semanticSearch": { "type": "object", "description": "Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.", "properties": { "eventSources": { "type": "array", "items": { "type": "string" }, "description": "Indices from which to collect click and conversion events. If null, the current index and all its replicas are used." } } }, "separatorsToIndex": { "type": "string", "description": "Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words." }, "snippetEllipsisText": { "type": "string", "description": "String used as an ellipsis indicator when a snippet is truncated." }, "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)." }, "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." }, "unretrievableAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive." }, "userData": { "description": "An object with custom data. You can store up to 32kB as custom data." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_update\_api\_key Update an API key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `key` | string | Yes | — | API key. | | `acl` | string\[] | Yes | — | Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). | | `description` | string | No | — | Description of an API key to help you identify this API key. | | `indexes` | string\[] | No | — | Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with "dev\_" - `*_dev` matches all indices ending with "\_dev" - `*_products_*` matches all indices containing "*products*". | | `maxHitsPerQuery` | integer | No | — | Maximum number of results this API key can retrieve in one query. By default, there's no limit. | | `maxQueriesPerIPPerHour` | integer | No | — | Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit. | | `queryParameters` | string | No | — | Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range. | | `referers` | string\[] | No | — | Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with "[https://algolia.com/](https://algolia.com/)" - `*.algolia.com` allows all referrers ending with ".algolia.com" - `*algolia.com*` allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions). | | `validity` | integer | No | — | Duration (in seconds) after which the API key expires. By default, API keys don't expire. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." }, "acl": { "type": "array", "items": { "type": "string", "enum": [ "addObject", "analytics", "browse", "deleteObject", "deleteIndex", "editSettings", "inference", "listIndexes", "logs", "personalization", "recommendation", "search", "seeUnretrievableAttributes", "settings", "usage", "nluWriteProject", "nluReadProject", "nluWriteEntity", "nluReadEntity", "nluWriteIntent", "nluReadIntent", "nluPrediction", "nluReadAnswers" ] }, "description": "Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)." }, "description": { "type": "string", "description": "Description of an API key to help you identify this API key." }, "indexes": { "type": "array", "items": { "type": "string" }, "description": "Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\"." }, "maxHitsPerQuery": { "type": "integer", "description": "Maximum number of results this API key can retrieve in one query. By default, there's no limit." }, "maxQueriesPerIPPerHour": { "type": "integer", "description": "Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit." }, "queryParameters": { "type": "string", "description": "Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range." }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions)." }, "validity": { "type": "integer", "description": "Duration (in seconds) after which the API key expires. By default, API keys don't expire." } }, "required": [ "PCID", "key", "acl" ] } ```