@algolia/n8n-nodes-algolia 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -42,11 +42,14 @@ This node supports the following operations:
|
|
|
42
42
|
|
|
43
43
|
<!-- THE FOLLOWING SECTION IS GENERATED BY CI. ANY CHANGES WILL BE OVERRIDDEN -->
|
|
44
44
|
<!-- OPERATIONS START -->
|
|
45
|
+
|
|
45
46
|
### Advanced
|
|
47
|
+
|
|
46
48
|
- **Retrieve log entries** - The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
47
49
|
- **Check application task status** - Checks the status of a given application task.
|
|
48
50
|
|
|
49
51
|
### Api Keys
|
|
52
|
+
|
|
50
53
|
- **List API keys** - Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
|
51
54
|
- **Create an API key** - Creates a new API key with specific permissions and restrictions.
|
|
52
55
|
- **Retrieve API key permissions** - Gets the permissions and restrictions of an API key.
|
|
@@ -55,6 +58,7 @@ This node supports the following operations:
|
|
|
55
58
|
- **Restore an API key** - Restores a deleted API key.
|
|
56
59
|
|
|
57
60
|
### Clusters
|
|
61
|
+
|
|
58
62
|
- **Assign or move a user ID** - Assigns or moves a user ID to a cluster.
|
|
59
63
|
- **List user IDs** - Lists the userIDs assigned to a multi-cluster application.
|
|
60
64
|
- **Assign multiple userIDs** - Assigns multiple user IDs to a cluster.
|
|
@@ -66,6 +70,7 @@ This node supports the following operations:
|
|
|
66
70
|
- **Get migration and user mapping status** - To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
|
|
67
71
|
|
|
68
72
|
### Dictionaries
|
|
73
|
+
|
|
69
74
|
- **Add or delete dictionary entries** - Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
|
70
75
|
- **Search dictionary entries** - Searches for standard and custom dictionary entries.
|
|
71
76
|
- **Retrieve dictionary settings** - Retrieves the languages for which standard dictionary entries are turned off.
|
|
@@ -73,6 +78,7 @@ This node supports the following operations:
|
|
|
73
78
|
- **List available languages** - Lists supported languages with their supported dictionary types and number of custom entries.
|
|
74
79
|
|
|
75
80
|
### Indices
|
|
81
|
+
|
|
76
82
|
- **Delete an index** - Deletes an index and all its settings.
|
|
77
83
|
- **Retrieve index settings** - Retrieves an object with non-null index settings.
|
|
78
84
|
- **Update index settings** - Update the specified index settings.
|
|
@@ -81,6 +87,7 @@ This node supports the following operations:
|
|
|
81
87
|
- **List indices** - Lists all indices in the current Algolia application.
|
|
82
88
|
|
|
83
89
|
### Records
|
|
90
|
+
|
|
84
91
|
- **Add a new record (with auto-generated object ID)** - Adds a record to an index or replaces it.
|
|
85
92
|
- **Retrieve a record** - Retrieves one record by its object ID.
|
|
86
93
|
- **Add or replace a record** - If a record with the specified object ID exists, the existing record is replaced.
|
|
@@ -93,6 +100,7 @@ This node supports the following operations:
|
|
|
93
100
|
- **Retrieve records** - Retrieves one or more records, potentially from different indices.
|
|
94
101
|
|
|
95
102
|
### Rules
|
|
103
|
+
|
|
96
104
|
- **Retrieve a rule** - Retrieves a rule by its ID.
|
|
97
105
|
- **Create or replace a rule** - If a rule with the specified object ID doesn't exist, it's created.
|
|
98
106
|
- **Delete a rule** - Deletes a rule by its ID.
|
|
@@ -101,12 +109,14 @@ This node supports the following operations:
|
|
|
101
109
|
- **Search for rules** - Searches for rules in your index.
|
|
102
110
|
|
|
103
111
|
### Search
|
|
112
|
+
|
|
104
113
|
- **Search an index** - Searches a single index and returns matching search results as hits.
|
|
105
114
|
- **Search multiple indices** - Sends multiple search requests to one or more indices.
|
|
106
115
|
- **Search for facet values** - Searches for values of a specified facet attribute.
|
|
107
116
|
- **Browse for records** - Retrieves records from an index, up to 1,000 per request.
|
|
108
117
|
|
|
109
118
|
### Synonyms
|
|
119
|
+
|
|
110
120
|
- **Retrieve a synonym** - Retrieves a synonym by its ID.
|
|
111
121
|
- **Create or replace a synonym** - If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
|
|
112
122
|
- **Delete a synonym** - Deletes a synonym by its ID.
|
|
@@ -115,11 +125,12 @@ This node supports the following operations:
|
|
|
115
125
|
- **Search for synonyms** - Searches for synonyms in your index.
|
|
116
126
|
|
|
117
127
|
### Vaults
|
|
128
|
+
|
|
118
129
|
- **List allowed sources** - Retrieves all allowed IP addresses with access to your application.
|
|
119
130
|
- **Replace allowed sources** - Replaces the list of allowed sources.
|
|
120
131
|
- **Add a source** - Adds a source to the list of allowed sources.
|
|
121
|
-
- **Delete a source** - Deletes a source from the list of allowed sources.
|
|
122
|
-
|
|
132
|
+
- **Delete a source** - Deletes a source from the list of allowed sources.
|
|
133
|
+
<!-- OPERATIONS END -->
|
|
123
134
|
|
|
124
135
|
## Usage examples
|
|
125
136
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class e{constructor(){this.name="algoliaApi",this.displayName="Algolia API",this.documentationUrl="https://www.algolia.com",this.icon="file:../algolia.svg",this.properties=[{displayName:"Application ID",name:"appId",type:"string",required:!0,default:""},{displayName:"Admin API Key",name:"adminApiKey",type:"string",typeOptions:{password:!0},required:!0,default:""}],this.authenticate={type:"generic",properties:{headers:{"X-Algolia-Application-Id":"={{ $credentials.appId }}","X-Algolia-API-Key":"={{ $credentials.adminApiKey }}"}}}}}exports.AlgoliaApi=e;
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class e{constructor(){this.name="algoliaApi",this.displayName="Algolia API",this.documentationUrl="https://www.algolia.com",this.icon="file:../algolia.svg",this.properties=[{displayName:"Application ID",name:"appId",type:"string",required:!0,default:""},{displayName:"Admin API Key",name:"adminApiKey",type:"string",typeOptions:{password:!0},required:!0,default:""}],this.authenticate={type:"generic",properties:{headers:{"X-Algolia-Application-Id":"={{ $credentials.appId }}","X-Algolia-API-Key":"={{ $credentials.adminApiKey }}"}}},this.test={request:{baseURL:"={{ `https://${$credentials.appId}.algolia.net` }}",url:"/1/keys"}}}}exports.AlgoliaApi=e;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.9.0",i={name:l,version:p},u=[{displayName:"Resource",name:"resource",type:"options",default:"",description:"Select the resource to work with",options:[{name:"Advanced",value:"Advanced",description:"Query your logs"},{name:"Api Keys",value:"Api Keys",description:"Manage your API keys"},{name:"Clusters",value:"Clusters",description:"Multi-cluster operations"},{name:"Dictionaries",value:"Dictionaries",description:"Manage your dictionaries"},{name:"Indices",value:"Indices",description:"Manage your indices and index settings"},{name:"Records",value:"Records",description:"Add, update, and delete records from your indices"},{name:"Rules",value:"Rules",description:"Create, update, delete, and search for rules"},{name:"Search",value:"Search",description:"Search one or more indices for matching records or facet values"},{name:"Synonyms",value:"Synonyms",description:"Create, update, delete, and search for synonyms"},{name:"Vaults",value:"Vaults",description:"Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest"}]},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Search an index",value:"searchSingleIndex",action:"Search an index",description:"Searches a single index and returns matching search results as hits.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/query"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["hits","params","query"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}},{name:"Search multiple indices",value:"search",action:"Search multiple indices",description:"Sends multiple search requests to one or more indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/queries"}}},{name:"Search for facet values",value:"searchForFacetValues",action:"Search for facet values",description:"Searches for values of a specified facet attribute.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/facets/{{ $parameter.facetName_string }}/query"}}},{name:"Browse for records",value:"browse",action:"Browse for records",description:"Retrieves records from an index, up to 1,000 per request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/browse"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["hits","params","query"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}}],displayOptions:{show:{resource:["Search"]}}},{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex","browse"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Delete an index",value:"deleteIndex",action:"Delete an index",description:"Deletes an index and all its settings.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve index settings",value:"getSettings",action:"Retrieve index settings",description:"Retrieves an object with non-null index settings.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"]}},{name:"Update index settings",value:"setSettings",action:"Update index settings",description:"Update the specified index settings.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"}}},{name:"Check task status",value:"getTask",action:"Check task status",description:"Checks the status of a given task.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/task/{{ $parameter.taskID_number }}"}}},{name:"Copy or move an index",value:"operationIndex",action:"Copy or move an index",description:"Copies or moves (renames) an index within the same Algolia application.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/operation"}}},{name:"List indices",value:"listIndices",action:"List indices",description:"Lists all indices in the current Algolia application.",routing:{request:{method:"GET",url:"=/1/indexes"}}}],displayOptions:{show:{resource:["Indices"]}}},{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a synonym",value:"getSynonym",action:"Retrieve a synonym",description:"Retrieves a synonym by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a synonym",value:"saveSynonym",action:"Create or replace a synonym",description:"If a synonym with the specified object ID doesn't exist, Algolia adds a new one.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Delete a synonym",value:"deleteSynonym",action:"Delete a synonym",description:"Deletes a synonym by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace synonyms",value:"saveSynonyms",action:"Create or replace synonyms",description:"If a synonym with the `objectID` doesn't exist, Algolia adds a new one.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/batch"}}},{name:"Delete all synonyms",value:"clearSynonyms",action:"Delete all synonyms",description:"Deletes all synonyms from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/clear"}}},{name:"Search for synonyms",value:"searchSynonyms",action:"Search for synonyms",description:"Searches for synonyms in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/search"}}}],displayOptions:{show:{resource:["Synonyms"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List API keys",value:"listApiKeys",action:"List API keys",description:"Lists all API keys associated with your Algolia application, including their permissions and restrictions.",routing:{request:{method:"GET",url:"=/1/keys"}}},{name:"Create an API key",value:"addApiKey",action:"Create an API key",description:"Creates a new API key with specific permissions and restrictions.",routing:{request:{method:"POST",url:"=/1/keys"}}},{name:"Retrieve API key permissions",value:"getApiKey",action:"Retrieve API key permissions",description:"Gets the permissions and restrictions of an API key.",routing:{request:{method:"GET",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Update an API key",value:"updateApiKey",action:"Update an API key",description:"Replaces the permissions of an existing API key.",routing:{request:{method:"PUT",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Delete an API key",value:"deleteApiKey",action:"Delete an API key",description:"Deletes the API key.",routing:{request:{method:"DELETE",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Restore an API key",value:"restoreApiKey",action:"Restore an API key",description:"Restores a deleted API key.",routing:{request:{method:"POST",url:"=/1/keys/{{ $parameter.key_string }}/restore"}}}],displayOptions:{show:{resource:["Api Keys"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",name:"searchParams",displayName:"Search Params",default:"",options:[{name:"Search parameters as query string",value:"search_parameters_as_query_string"},{name:"Search parameters as object",value:"search_parameters_as_object"}],routing:{send:{type:"body",property:void 0,value:"={{ undefined }}"}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",displayOptions:{show:{searchParams:["search_parameters_as_query_string"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"multiOptions",name:"search_parameters_as_object",displayName:"Search Parameters As Object",description:"Each parameter value, including the `query` must not be larger than 512 bytes.",default:[],options:[{name:"Query",value:"query_string"},{name:"Similar Query",value:"similarquery_string"},{name:"Filters",value:"filters_string"},{name:"Facet Filters",value:"facetfilters"},{name:"Optional Filters",value:"optionalfilters"},{name:"Numeric Filters",value:"numericfilters"},{name:"Tag Filters",value:"tagfilters"},{name:"Sum Or Filters Scores",value:"sumorfiltersscores_boolean"},{name:"Restrict Searchable Attributes",value:"restrictsearchableattributes_json"},{name:"Facets",value:"facets_json"},{name:"Faceting After Distinct",value:"facetingafterdistinct_boolean"},{name:"Page",value:"page_number"},{name:"Offset",value:"offset_number"},{name:"Length",value:"length_number"},{name:"Around Lat Lng",value:"aroundlatlng_string"},{name:"Around Lat Lng Via IP",value:"aroundlatlngviaip_boolean"},{name:"Around Radius",value:"aroundradius"},{name:"Around Precision",value:"aroundprecision"},{name:"Minimum Around Radius",value:"minimumaroundradius_number"},{name:"Inside Bounding Box",value:"insideboundingbox"},{name:"Inside Polygon",value:"insidepolygon_json"},{name:"Natural Languages",value:"naturallanguages_json"},{name:"Rule Contexts",value:"rulecontexts_json"},{name:"Personalization Impact",value:"personalizationimpact_number"},{name:"User Token",value:"usertoken_string"},{name:"Get Ranking Info",value:"getrankinginfo_boolean"},{name:"Synonyms",value:"synonyms_boolean"},{name:"Click Analytics",value:"clickanalytics_boolean"},{name:"Analytics",value:"analytics_boolean"},{name:"Analytics Tags",value:"analyticstags_json"},{name:"Percentile Computation",value:"percentilecomputation_boolean"},{name:"Enable ABTest",value:"enableabtest_boolean"},{name:"Attributes To Retrieve",value:"attributestoretrieve_json"},{name:"Ranking",value:"ranking_json"},{name:"Relevancy Strictness",value:"relevancystrictness_number"},{name:"Attributes To Highlight",value:"attributestohighlight_json"},{name:"Attributes To Snippet",value:"attributestosnippet_json"},{name:"Highlight Pre Tag",value:"highlightpretag_string"},{name:"Highlight Post Tag",value:"highlightposttag_string"},{name:"Snippet Ellipsis Text",value:"snippetellipsistext_string"},{name:"Restrict Highlight And Snippet Arrays",value:"restricthighlightandsnippetarrays_boolean"},{name:"Hits Per Page",value:"hitsperpage_number"},{name:"Min Word Sizefor1Typo",value:"minwordsizefor1typo_number"},{name:"Min Word Sizefor2Typos",value:"minwordsizefor2typos_number"},{name:"Typo Tolerance",value:"typotolerance"},{name:"Allow Typos On Numeric Tokens",value:"allowtyposonnumerictokens_boolean"},{name:"Disable Typo Tolerance On Attributes",value:"disabletypotoleranceonattributes_json"},{name:"Ignore Plurals",value:"ignoreplurals"},{name:"Remove Stop Words",value:"removestopwords"},{name:"Query Languages",value:"querylanguages_json"},{name:"Decompound Query",value:"decompoundquery_boolean"},{name:"Enable Rules",value:"enablerules_boolean"},{name:"Enable Personalization",value:"enablepersonalization_boolean"},{name:"Query Type",value:"querytype_options"},{name:"Remove Words If No Results",value:"removewordsifnoresults_options"},{name:"Mode",value:"mode_options"},{name:"Semantic Search",value:"semantic_search_object"},{name:"Advanced Syntax",value:"advancedsyntax_boolean"},{name:"Optional Words",value:"optionalwords"},{name:"Disable Exact On Attributes",value:"disableexactonattributes_json"},{name:"Exact On Single Word Query",value:"exactonsinglewordquery_options"},{name:"Alternatives As Exact",value:"alternativesasexact_json"},{name:"Advanced Syntax Features",value:"advancedsyntaxfeatures_json"},{name:"Distinct",value:"distinct"},{name:"Replace Synonyms In Highlight",value:"replacesynonymsinhighlight_boolean"},{name:"Min Proximity",value:"minproximity_number"},{name:"Response Fields",value:"responsefields_json"},{name:"Max Values Per Facet",value:"maxvaluesperfacet_number"},{name:"Sort Facet Values By",value:"sortfacetvaluesby_string"},{name:"Attribute Criteria Computed By Min Proximity",value:"attributecriteriacomputedbyminproximity_boolean"},{name:"Rendering Content",value:"rendering_content_object"},{name:"Enable Re Ranking",value:"enablereranking_boolean"},{name:"Re Ranking Apply Filter",value:"rerankingapplyfilter"}],displayOptions:{show:{searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_parameters_as_object:["query_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"similarQuery"}},displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{search_parameters_as_object:["similarquery_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",routing:{send:{type:"body",value:"={{ $value }}",property:"filters"}},displayName:"Filters",name:"filters_string",displayOptions:{show:{search_parameters_as_object:["filters_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"facetFilters",displayName:"Facet Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"facetFilters",value:'={{ typeof $parameter.facetFilters_json !== "undefined" ? JSON.parse($parameter.facetFilters_json) : typeof $parameter.facetFilters_string !== "undefined" ? $parameter.facetFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{facetFilters:["array"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string",displayOptions:{show:{facetFilters:["string"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"optionalFilters",displayName:"Optional Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"optionalFilters",value:'={{ typeof $parameter.optionalFilters_json !== "undefined" ? JSON.parse($parameter.optionalFilters_json) : typeof $parameter.optionalFilters_string !== "undefined" ? $parameter.optionalFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{optionalFilters:["array"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Optional Filters (String)",name:"optionalFilters_string",displayOptions:{show:{optionalFilters:["string"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"numericFilters",displayName:"Numeric Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"numericFilters",value:'={{ typeof $parameter.numericFilters_json !== "undefined" ? JSON.parse($parameter.numericFilters_json) : typeof $parameter.numericFilters_string !== "undefined" ? $parameter.numericFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{numericFilters:["array"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string",displayOptions:{show:{numericFilters:["string"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"tagFilters",displayName:"Tag Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"tagFilters",value:'={{ typeof $parameter.tagFilters_json !== "undefined" ? JSON.parse($parameter.tagFilters_json) : typeof $parameter.tagFilters_string !== "undefined" ? $parameter.tagFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{tagFilters:["array"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string",displayOptions:{show:{tagFilters:["string"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.11.0",i={name:l,version:p},u=[{displayName:"Resource",name:"resource",type:"options",default:"",description:"Select the resource to work with",options:[{name:"Advanced",value:"Advanced",description:"Query your logs"},{name:"Api Keys",value:"Api Keys",description:"Manage your API keys"},{name:"Clusters",value:"Clusters",description:"Multi-cluster operations"},{name:"Dictionaries",value:"Dictionaries",description:"Manage your dictionaries"},{name:"Indices",value:"Indices",description:"Manage your indices and index settings"},{name:"Records",value:"Records",description:"Add, update, and delete records from your indices"},{name:"Rules",value:"Rules",description:"Create, update, delete, and search for rules"},{name:"Search",value:"Search",description:"Search one or more indices for matching records or facet values"},{name:"Synonyms",value:"Synonyms",description:"Create, update, delete, and search for synonyms"},{name:"Vaults",value:"Vaults",description:"Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest"}]},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Search an index",value:"searchSingleIndex",action:"Search an index",description:"Searches a single index and returns matching search results as hits.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/query"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["hits","params","query"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}},{name:"Search multiple indices",value:"search",action:"Search multiple indices",description:"Sends multiple search requests to one or more indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/queries"}}},{name:"Search for facet values",value:"searchForFacetValues",action:"Search for facet values",description:"Searches for values of a specified facet attribute.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/facets/{{ $parameter.facetName_string }}/query"}}},{name:"Browse for records",value:"browse",action:"Browse for records",description:"Retrieves records from an index, up to 1,000 per request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/browse"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["hits","params","query"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}}],displayOptions:{show:{resource:["Search"]}}},{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex","browse"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Delete an index",value:"deleteIndex",action:"Delete an index",description:"Deletes an index and all its settings.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve index settings",value:"getSettings",action:"Retrieve index settings",description:"Retrieves an object with non-null index settings.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"},output:{postReceive:[async function(a){return this.getNodeParameter("simplify",0)?a.map(s=>{const t=s.json||{},r=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{t[e]!==void 0&&r.set(e,t[e])}),{json:Object.fromEntries(r)}}):a}]}},inputSchema:{simplifiedOutput:["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"]}},{name:"Update index settings",value:"setSettings",action:"Update index settings",description:"Update the specified index settings.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"}}},{name:"Check task status",value:"getTask",action:"Check task status",description:"Checks the status of a given task.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/task/{{ $parameter.taskID_number }}"}}},{name:"Copy or move an index",value:"operationIndex",action:"Copy or move an index",description:"Copies or moves (renames) an index within the same Algolia application.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/operation"}}},{name:"List indices",value:"listIndices",action:"List indices",description:"Lists all indices in the current Algolia application.",routing:{request:{method:"GET",url:"=/1/indexes"}}}],displayOptions:{show:{resource:["Indices"]}}},{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a synonym",value:"getSynonym",action:"Retrieve a synonym",description:"Retrieves a synonym by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a synonym",value:"saveSynonym",action:"Create or replace a synonym",description:"If a synonym with the specified object ID doesn't exist, Algolia adds a new one.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Delete a synonym",value:"deleteSynonym",action:"Delete a synonym",description:"Deletes a synonym by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace synonyms",value:"saveSynonyms",action:"Create or replace synonyms",description:"If a synonym with the `objectID` doesn't exist, Algolia adds a new one.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/batch"}}},{name:"Delete all synonyms",value:"clearSynonyms",action:"Delete all synonyms",description:"Deletes all synonyms from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/clear"}}},{name:"Search for synonyms",value:"searchSynonyms",action:"Search for synonyms",description:"Searches for synonyms in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/search"}}}],displayOptions:{show:{resource:["Synonyms"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List API keys",value:"listApiKeys",action:"List API keys",description:"Lists all API keys associated with your Algolia application, including their permissions and restrictions.",routing:{request:{method:"GET",url:"=/1/keys"}}},{name:"Create an API key",value:"addApiKey",action:"Create an API key",description:"Creates a new API key with specific permissions and restrictions.",routing:{request:{method:"POST",url:"=/1/keys"}}},{name:"Retrieve API key permissions",value:"getApiKey",action:"Retrieve API key permissions",description:"Gets the permissions and restrictions of an API key.",routing:{request:{method:"GET",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Update an API key",value:"updateApiKey",action:"Update an API key",description:"Replaces the permissions of an existing API key.",routing:{request:{method:"PUT",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Delete an API key",value:"deleteApiKey",action:"Delete an API key",description:"Deletes the API key.",routing:{request:{method:"DELETE",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Restore an API key",value:"restoreApiKey",action:"Restore an API key",description:"Restores a deleted API key.",routing:{request:{method:"POST",url:"=/1/keys/{{ $parameter.key_string }}/restore"}}}],displayOptions:{show:{resource:["Api Keys"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",name:"searchParams",displayName:"Search Params",default:"",options:[{name:"Search parameters as query string",value:"search_parameters_as_query_string"},{name:"Search parameters as object",value:"search_parameters_as_object"}],routing:{send:{type:"body",property:void 0,value:"={{ undefined }}"}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",displayOptions:{show:{searchParams:["search_parameters_as_query_string"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"multiOptions",name:"search_parameters_as_object",displayName:"Search Parameters As Object",description:"Each parameter value, including the `query` must not be larger than 512 bytes.",default:[],options:[{name:"Query",value:"query_string"},{name:"Similar Query",value:"similarquery_string"},{name:"Filters",value:"filters_string"},{name:"Facet Filters",value:"facetfilters"},{name:"Optional Filters",value:"optionalfilters"},{name:"Numeric Filters",value:"numericfilters"},{name:"Tag Filters",value:"tagfilters"},{name:"Sum Or Filters Scores",value:"sumorfiltersscores_boolean"},{name:"Restrict Searchable Attributes",value:"restrictsearchableattributes_json"},{name:"Facets",value:"facets_json"},{name:"Faceting After Distinct",value:"facetingafterdistinct_boolean"},{name:"Page",value:"page_number"},{name:"Offset",value:"offset_number"},{name:"Length",value:"length_number"},{name:"Around Lat Lng",value:"aroundlatlng_string"},{name:"Around Lat Lng Via IP",value:"aroundlatlngviaip_boolean"},{name:"Around Radius",value:"aroundradius"},{name:"Around Precision",value:"aroundprecision"},{name:"Minimum Around Radius",value:"minimumaroundradius_number"},{name:"Inside Bounding Box",value:"insideboundingbox"},{name:"Inside Polygon",value:"insidepolygon_json"},{name:"Natural Languages",value:"naturallanguages_json"},{name:"Rule Contexts",value:"rulecontexts_json"},{name:"Personalization Impact",value:"personalizationimpact_number"},{name:"User Token",value:"usertoken_string"},{name:"Get Ranking Info",value:"getrankinginfo_boolean"},{name:"Synonyms",value:"synonyms_boolean"},{name:"Click Analytics",value:"clickanalytics_boolean"},{name:"Analytics",value:"analytics_boolean"},{name:"Analytics Tags",value:"analyticstags_json"},{name:"Percentile Computation",value:"percentilecomputation_boolean"},{name:"Enable ABTest",value:"enableabtest_boolean"},{name:"Attributes To Retrieve",value:"attributestoretrieve_json"},{name:"Ranking",value:"ranking_json"},{name:"Relevancy Strictness",value:"relevancystrictness_number"},{name:"Attributes To Highlight",value:"attributestohighlight_json"},{name:"Attributes To Snippet",value:"attributestosnippet_json"},{name:"Highlight Pre Tag",value:"highlightpretag_string"},{name:"Highlight Post Tag",value:"highlightposttag_string"},{name:"Snippet Ellipsis Text",value:"snippetellipsistext_string"},{name:"Restrict Highlight And Snippet Arrays",value:"restricthighlightandsnippetarrays_boolean"},{name:"Hits Per Page",value:"hitsperpage_number"},{name:"Min Word Sizefor1Typo",value:"minwordsizefor1typo_number"},{name:"Min Word Sizefor2Typos",value:"minwordsizefor2typos_number"},{name:"Typo Tolerance",value:"typotolerance"},{name:"Allow Typos On Numeric Tokens",value:"allowtyposonnumerictokens_boolean"},{name:"Disable Typo Tolerance On Attributes",value:"disabletypotoleranceonattributes_json"},{name:"Ignore Plurals",value:"ignoreplurals"},{name:"Remove Stop Words",value:"removestopwords"},{name:"Query Languages",value:"querylanguages_json"},{name:"Decompound Query",value:"decompoundquery_boolean"},{name:"Enable Rules",value:"enablerules_boolean"},{name:"Enable Personalization",value:"enablepersonalization_boolean"},{name:"Query Type",value:"querytype_options"},{name:"Remove Words If No Results",value:"removewordsifnoresults_options"},{name:"Mode",value:"mode_options"},{name:"Semantic Search",value:"semantic_search_object"},{name:"Advanced Syntax",value:"advancedsyntax_boolean"},{name:"Optional Words",value:"optionalwords"},{name:"Disable Exact On Attributes",value:"disableexactonattributes_json"},{name:"Exact On Single Word Query",value:"exactonsinglewordquery_options"},{name:"Alternatives As Exact",value:"alternativesasexact_json"},{name:"Advanced Syntax Features",value:"advancedsyntaxfeatures_json"},{name:"Distinct",value:"distinct"},{name:"Replace Synonyms In Highlight",value:"replacesynonymsinhighlight_boolean"},{name:"Min Proximity",value:"minproximity_number"},{name:"Response Fields",value:"responsefields_json"},{name:"Max Values Per Facet",value:"maxvaluesperfacet_number"},{name:"Sort Facet Values By",value:"sortfacetvaluesby_string"},{name:"Attribute Criteria Computed By Min Proximity",value:"attributecriteriacomputedbyminproximity_boolean"},{name:"Rendering Content",value:"rendering_content_object"},{name:"Enable Re Ranking",value:"enablereranking_boolean"},{name:"Re Ranking Apply Filter",value:"rerankingapplyfilter"}],displayOptions:{show:{searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_parameters_as_object:["query_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"similarQuery"}},displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{search_parameters_as_object:["similarquery_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",routing:{send:{type:"body",value:"={{ $value }}",property:"filters"}},displayName:"Filters",name:"filters_string",displayOptions:{show:{search_parameters_as_object:["filters_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"facetFilters",displayName:"Facet Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"facetFilters",value:'={{ typeof $parameter.facetFilters_json !== "undefined" ? JSON.parse($parameter.facetFilters_json) : typeof $parameter.facetFilters_string !== "undefined" ? $parameter.facetFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{facetFilters:["array"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string",displayOptions:{show:{facetFilters:["string"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"optionalFilters",displayName:"Optional Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"optionalFilters",value:'={{ typeof $parameter.optionalFilters_json !== "undefined" ? JSON.parse($parameter.optionalFilters_json) : typeof $parameter.optionalFilters_string !== "undefined" ? $parameter.optionalFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{optionalFilters:["array"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Optional Filters (String)",name:"optionalFilters_string",displayOptions:{show:{optionalFilters:["string"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"numericFilters",displayName:"Numeric Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"numericFilters",value:'={{ typeof $parameter.numericFilters_json !== "undefined" ? JSON.parse($parameter.numericFilters_json) : typeof $parameter.numericFilters_string !== "undefined" ? $parameter.numericFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{numericFilters:["array"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string",displayOptions:{show:{numericFilters:["string"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"tagFilters",displayName:"Tag Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"tagFilters",value:'={{ typeof $parameter.tagFilters_json !== "undefined" ? JSON.parse($parameter.tagFilters_json) : typeof $parameter.tagFilters_string !== "undefined" ? $parameter.tagFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{tagFilters:["array"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string",displayOptions:{show:{tagFilters:["string"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
2
2
|
If true, all filter scores are summed.
|
|
3
3
|
Otherwise, the maximum filter score is kept.
|
|
4
4
|
For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
|