RecommendClient class final

Implemented types

Constructors

RecommendClient({required String appId, required String apiKey, ClientOptions options = const ClientOptions()})

Properties

hashCode → int
The hash code for this object.
no setterinherited
options → ClientOptions
A set of custom client options to configure the behavior of the API client.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchRecommendRules({required String indexName, required RecommendModels model, List<RecommendRule>? recommendRule, RequestOptions? requestOptions}) → Future<RecommendUpdatedAtResponse>
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).
customDelete({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>
This method allow you to send requests to the Algolia REST API.
customGet({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>
This method allow you to send requests to the Algolia REST API.
customPost({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
This method allow you to send requests to the Algolia REST API.
customPut({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
This method allow you to send requests to the Algolia REST API.
del({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
deleteRecommendRule({required String indexName, required RecommendModels model, required String objectID, RequestOptions? requestOptions}) → Future<DeletedAtResponse>
Deletes a Recommend rule from a recommendation scenario.
dispose() → void
Dispose of underlying resources.
override
get({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
getRecommendations({required GetRecommendationsParams getRecommendationsParams, RequestOptions? requestOptions}) → Future<GetRecommendationsResponse>
Retrieves recommendations from selected AI models.
getRecommendRule({required String indexName, required RecommendModels model, required String objectID, RequestOptions? requestOptions}) → Future<RecommendRule>
Retrieves a Recommend rule that you previously created in the Algolia dashboard.
getRecommendStatus({required String indexName, required RecommendModels model, required int taskID, RequestOptions? requestOptions}) → Future<GetRecommendTaskResponse>
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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
post({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
put({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
searchRecommendRules({required String indexName, required RecommendModels model, SearchRecommendRulesParams? searchRecommendRulesParams, RequestOptions? requestOptions}) → Future<SearchRecommendRulesResponse>
Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.
setClientApiKey({required String apiKey}) → void
Allows to switch the API key used to authenticate requests.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited