Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same objectID already exists. You may also specify true for clearExistingRules, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a source item instead of a query. The main differences are the following: - Conditions pattern and anchoring are unavailable. - Condition filters triggers if the source item matches the specified filters. - Condition filters accepts numeric filters. - Consequence params only covers filtering parameters. - Consequence automaticFacetFilters doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).
Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same objectID already exists. You may also specify true for clearExistingRules, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a source item instead of a query. The main differences are the following: - Conditions pattern and anchoring are unavailable. - Condition filters triggers if the source item matches the specified filters. - Condition filters accepts numeric filters. - Consequence params only covers filtering parameters. - Consequence automaticFacetFilters doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).
Required API Key ACLs:
- editSettings
Value parameters
- indexName
-
Name of the index on which to perform the operation.
- model
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- body
-
Parameters to send with the custom request.
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- body
-
Parameters to send with the custom request.
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
Deletes a Recommend rule from a recommendation scenario.
Deletes a Recommend rule from a recommendation scenario.
Required API Key ACLs:
- editSettings
Value parameters
- indexName
-
Name of the index on which to perform the operation.
- model
- objectID
-
Unique record identifier.
Attributes
Retrieves a Recommend rule that you previously created in the Algolia dashboard.
Retrieves a Recommend rule that you previously created in the Algolia dashboard.
Required API Key ACLs:
- settings
Value parameters
- indexName
-
Name of the index on which to perform the operation.
- model
- objectID
-
Unique record identifier.
Attributes
Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
Required API Key ACLs:
- editSettings
Value parameters
- indexName
-
Name of the index on which to perform the operation.
- model
- taskID
-
Unique task identifier.
Attributes
Retrieves recommendations from selected AI models.
Retrieves recommendations from selected AI models.
Required API Key ACLs:
- search
Attributes
Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.
Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.
Required API Key ACLs:
- settings
Value parameters
- indexName
-
Name of the index on which to perform the operation.
- model