@algolia/n8n-nodes-algolia 0.11.0 → 0.12.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/dist/nodes/Algolia/Algolia.node.js +121 -136
- package/package.json +4 -5
|
@@ -1,38 +1,28 @@
|
|
|
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
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.12.0",o={name:l,version:p},d=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["browse"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Browse Params",name:"browseParams_options",default:"search_parameters_as_query_string_object",options:[{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"},{name:"Browse Params Object",value:"browse_params_object"}],required:!1},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string",displayOptions:{show:{browseParams_options:["search_parameters_as_query_string_object"]}}},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{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",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{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",displayName:"Filters",name:"filters_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{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).
|
|
5
|
-
`,
|
|
5
|
+
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Restrict Searchable Attributes",name:"restrictSearchableAttributes_json",default:"[]",description:`Restricts a search to a subset of your searchable attributes.
|
|
6
6
|
Attribute names are case-sensitive.
|
|
7
|
-
`,required:!1,
|
|
7
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Facets",name:"facets_json",default:"[]",description:`Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
8
8
|
To retrieve all facets, use the wildcard character \`*\`.
|
|
9
9
|
For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
|
|
10
|
-
`,required:!1,
|
|
11
|
-
|
|
12
|
-
For example, if you set \`aroundPrecision\` to 100, records wihin 100 meters to the central coordinate are considered to have the same distance,
|
|
13
|
-
as are records between 100 and 199 meters.
|
|
14
|
-
`,displayName:"Around Precision (Integer)",name:"aroundPrecision_number",displayOptions:{show:{aroundPrecision:["integer"],search_parameters_as_object:["aroundprecision"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Around Precision (Range Objects)",name:"aroundPrecision_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{aroundPrecision:["range_objects"],search_parameters_as_object:["aroundprecision"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:"",description:"Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",typeOptions:{minValue:1},routing:{send:{type:"body",value:"={{ $value }}",property:"minimumAroundRadius"}},displayName:"Minimum Around Radius",name:"minimumAroundRadius_number",displayOptions:{show:{search_parameters_as_object:["minimumaroundradius_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Inside bounding box array",value:"inside_bounding_box_array"}],routing:{send:{type:"body",property:"insideBoundingBox",value:'={{ typeof $parameter.insideBoundingBox_string !== "undefined" ? $parameter.insideBoundingBox_string : typeof $parameter.insideBoundingBox_null !== "undefined" ? JSON.parse($parameter.insideBoundingBox_null) : typeof $parameter.insideBoundingBox_json !== "undefined" ? JSON.parse($parameter.insideBoundingBox_json) : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["insideboundingbox"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Inside Bounding Box (String)",name:"insideBoundingBox_string",displayOptions:{show:{insideBoundingBox:["string"],search_parameters_as_object:["insideboundingbox"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Inside Bounding Box (Null)",name:"insideBoundingBox_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{insideBoundingBox:["null"]}},displayOptions:{show:{insideBoundingBox:["null"],search_parameters_as_object:["insideboundingbox"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Inside Bounding Box (Inside Bounding Box Array)",name:"insideBoundingBox_json",default:"[]",description:`Coordinates for a rectangular area in which to search.
|
|
15
|
-
|
|
16
|
-
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
17
|
-
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
18
|
-
Provide multiple bounding boxes as nested arrays.
|
|
19
|
-
For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
20
|
-
`,required:!1,displayOptions:{show:{insideBoundingBox:["inside_bounding_box_array"],search_parameters_as_object:["insideboundingbox"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
10
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether faceting should be applied after deduplication with `distinct`\nThis leads to accurate facet counts when using faceting in combination with `distinct`.\nIt's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,\nas `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.\n",displayName:"Faceting After Distinct",name:"facetingAfterDistinct_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",displayName:"Offset",name:"offset_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},displayName:"Length",name:"length_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether to obtain the coordinates from the request's IP address.",displayName:"Around Lat Lng Via IP",name:"aroundLatLngViaIP_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"aroundPrecision",displayName:"Around Precision",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:"",description:"Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",typeOptions:{minValue:1},displayName:"Minimum Around Radius",name:"minimumAroundRadius_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
21
11
|
|
|
22
12
|
Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
|
|
23
13
|
Provide multiple polygons as nested arrays.
|
|
24
14
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
25
15
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
26
|
-
`,required:!1,
|
|
16
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Natural Languages",name:"naturalLanguages_json",default:"[]",description:"ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)\n- Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.\n- Sets `removeWordsIfNoResults` to `allOptional`.\n- Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.\n",required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Rule Contexts",name:"ruleContexts_json",default:"[]",description:`Assigns a rule context to the search query
|
|
27
17
|
[Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
|
|
28
|
-
`,required:!1,
|
|
18
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
29
19
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
30
20
|
For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
31
|
-
`,typeOptions:{minValue:0,maxValue:100},
|
|
21
|
+
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
32
22
|
|
|
33
23
|
This helps with analytics and click and conversion events.
|
|
34
24
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
35
|
-
`,
|
|
25
|
+
`,displayName:"User Token",name:"userToken_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",displayName:"Get Ranking Info",name:"getRankingInfo_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",displayName:"Synonyms",name:"synonyms_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether to include a `queryID` attribute in the response\nThe query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).\n",displayName:"Click Analytics",name:"clickAnalytics_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",displayName:"Analytics",name:"analytics_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Analytics Tags",name:"analyticsTags_json",default:"[]",description:"Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).",required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",displayName:"Percentile Computation",name:"percentileComputation_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",displayName:"Enable ABTest",name:"enableABTest_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:'Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`.\n- The `objectID` attribute is always included.\n',required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
36
26
|
|
|
37
27
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
38
28
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -49,29 +39,29 @@ you put the sorting attribute at the top of the list.
|
|
|
49
39
|
Before you modify the default setting,
|
|
50
40
|
you should test your changes in the dashboard,
|
|
51
41
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
52
|
-
`,required:!1,
|
|
42
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
53
43
|
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).
|
|
54
44
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
55
|
-
`,
|
|
45
|
+
`,displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Attributes To Highlight",name:"attributesToHighlight_json",default:"[]",description:"Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).\n",required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
56
46
|
Attribute names are case-sensitive
|
|
57
47
|
Snippets provide additional context to matched words.
|
|
58
48
|
If you enable snippets, they include 10 words, including the matched word.
|
|
59
49
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
60
50
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
61
51
|
where \`NUMBER\` is the number of words to be extracted.
|
|
62
|
-
`,required:!1,
|
|
52
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
63
53
|
By default, all items are highlighted and snippeted.
|
|
64
|
-
`,
|
|
54
|
+
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:4,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).",displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:8,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).",displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"typoTolerance",displayName:"Typo Tolerance",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
65
55
|
Turn off this setting to reduce the number of irrelevant matches
|
|
66
56
|
when searching in large sets of similar numbers.
|
|
67
|
-
`,
|
|
57
|
+
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Disable Typo Tolerance On Attributes",name:"disableTypoToleranceOnAttributes_json",default:"[]",description:`Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).
|
|
68
58
|
Attribute names are case-sensitive
|
|
69
59
|
Returning only exact matches can help when
|
|
70
60
|
- [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).
|
|
71
61
|
- Reducing the number of matches when you have too many.
|
|
72
62
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
73
63
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
74
|
-
`,required:!1,
|
|
64
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
75
65
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
76
66
|
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.
|
|
77
67
|
To support this, you must place the CJK language **first**
|
|
@@ -80,7 +70,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
80
70
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
81
71
|
This can lead to unexpected search results.
|
|
82
72
|
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).
|
|
83
|
-
`,required:!1,
|
|
73
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether to split compound words in the query into their building blocks\nFor 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).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
84
74
|
|
|
85
75
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
86
76
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -88,7 +78,7 @@ Avoid \`prefixAll\`, which treats all query words as prefixes.
|
|
|
88
78
|
This might lead to counterintuitive results and makes your search slower.
|
|
89
79
|
|
|
90
80
|
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).
|
|
91
|
-
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],
|
|
81
|
+
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],displayName:"Query Type",name:"queryType_options",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"options",placeholder:"firstWords",default:"none",description:`Strategy for removing words from the query when it doesn't return any results.
|
|
92
82
|
This helps to avoid returning empty search results.
|
|
93
83
|
|
|
94
84
|
- \`none\`.
|
|
@@ -106,16 +96,16 @@ This helps to avoid returning empty search results.
|
|
|
106
96
|
Treat all words as optional.
|
|
107
97
|
|
|
108
98
|
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).
|
|
109
|
-
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],
|
|
99
|
+
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],displayName:"Remove Words If No Results",name:"removeWordsIfNoResults_options",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"options",default:"keywordSearch",description:`Search mode the index will use to query for results.
|
|
110
100
|
|
|
111
101
|
This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
|
|
112
|
-
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],
|
|
102
|
+
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:"{}",displayName:"Semantic Search",name:"semantic_search_object",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"optionalWords",displayName:"Optional Words",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Disable Exact On Attributes",name:"disableExactOnAttributes_json",default:"[]",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).
|
|
113
103
|
Attribute names are case-sensitive
|
|
114
104
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
115
105
|
such as product descriptions.
|
|
116
106
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
117
107
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
118
|
-
`,required:!1,
|
|
108
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"options",default:"attribute",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.
|
|
119
109
|
|
|
120
110
|
- \`attribute\`.
|
|
121
111
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -129,7 +119,7 @@ This reduces the impact of individual attributes with a lot of content on rankin
|
|
|
129
119
|
The query word must have at least 3 characters and must not be a stop word.
|
|
130
120
|
Only exact matches will be highlighted,
|
|
131
121
|
partial and prefix matches won't.
|
|
132
|
-
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],
|
|
122
|
+
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],displayName:"Exact On Single Word Query",name:"exactOnSingleWordQuery_options",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Alternatives As Exact",name:"alternativesAsExact_json",default:"[]",description:`Determine which plurals and synonyms should be considered an exact matches
|
|
133
123
|
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.
|
|
134
124
|
For example
|
|
135
125
|
- "swimsuit" and "swimsuits" are treated the same
|
|
@@ -140,11 +130,11 @@ For example
|
|
|
140
130
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
141
131
|
- \`multiWordsSynonym\`.
|
|
142
132
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
143
|
-
`,required:!1,
|
|
133
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json",default:"[]",description:'Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain "search" but not "engine"\nThis setting only has an effect if `advancedSyntax` is true.\n',required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"distinct",displayName:"Distinct",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:'Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either "home" or "house" are included in the search results,\nand either "home" or "house" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of "house" are replaced by "home" in the highlighted response.\n',displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
144
134
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
145
135
|
by equally scoring matches that are farther apart
|
|
146
136
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
147
|
-
`,typeOptions:{minValue:1,maxValue:7},
|
|
137
|
+
`,typeOptions:{minValue:1,maxValue:7},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",displayName:"Response Fields",name:"responseFields_json",default:"[]",description:"Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",required:!1,displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
148
138
|
- \`count\`.
|
|
149
139
|
Facet values are retrieved by decreasing count.
|
|
150
140
|
The count is the number of matching records containing this facet value
|
|
@@ -152,47 +142,41 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
152
142
|
Retrieve facet values alphabetically
|
|
153
143
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
154
144
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
155
|
-
`,
|
|
145
|
+
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!1,description:"Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",description:`Extra data that can be used in the search UI.
|
|
156
146
|
|
|
157
147
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
158
148
|
without changing your frontend code.
|
|
159
|
-
`,required:!1,default:"{}",
|
|
149
|
+
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
160
150
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
161
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"enableReRanking"}},displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{search_parameters_as_object:["enablereranking_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"},{name:"Null",value:"null"}],routing:{send:{type:"body",property:"reRankingApplyFilter",value:'={{ typeof $parameter.reRankingApplyFilter_json !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_json) : typeof $parameter.reRankingApplyFilter_string !== "undefined" ? $parameter.reRankingApplyFilter_string : typeof $parameter.reRankingApplyFilter_null !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_null) : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["rerankingapplyfilter"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Array)",name:"reRankingApplyFilter_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{reRankingApplyFilter:["array"],search_parameters_as_object:["rerankingapplyfilter"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",displayOptions:{show:{reRankingApplyFilter:["string"],search_parameters_as_object:["rerankingapplyfilter"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Null)",name:"reRankingApplyFilter_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{reRankingApplyFilter:["null"]}},displayOptions:{show:{reRankingApplyFilter:["null"],search_parameters_as_object:["rerankingapplyfilter"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Search Method Params",name:"search_method_params_object",type:"multiOptions",description:void 0,required:!0,default:[],options:[{name:"Requests",value:"requests_json"},{name:"Strategy",value:"strategy_options"}],displayOptions:{show:{resource:["Search"],operation:["search"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{search_method_params_object:["requests_json"],resource:["Search"],operation:["search"]}}},{type:"options",default:"",description:"Strategy for multiple search queries:\n\n- `none`. Run all queries.\n- `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.\n",options:[{name:"none",value:"none"},{name:"stopIfEnoughMatches",value:"stopIfEnoughMatches"}],routing:{send:{type:"body",value:"={{ $value }}",property:"strategy"}},displayName:"Strategy",name:"strategy_options",displayOptions:{show:{search_method_params_object:["strategy_options"],resource:["Search"],operation:["search"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}},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:"string",default:"",displayName:"Facet Name",name:"facetName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}},{displayName:"Search For Facet Values Request",name:"search_for_facet_values_request_object",type:"multiOptions",description:void 0,required:!1,default:[],options:[{name:"Params",value:"params_string"},{name:"Facet Query",value:"facetQuery_string"},{name:"Max Facet Hits",value:"maxFacetHits_number"}],displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}},{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:{search_for_facet_values_request_object:["params_string"],resource:["Search"],operation:["searchForFacetValues"]}}},{type:"string",placeholder:"george",default:"",description:"Text to search inside the facet's values.",routing:{send:{type:"body",value:"={{ $value }}",property:"facetQuery"}},displayName:"Facet Query",name:"facetQuery_string",displayOptions:{show:{search_for_facet_values_request_object:["facetQuery_string"],resource:["Search"],operation:["searchForFacetValues"]}}},{type:"number",default:10,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).",typeOptions:{maxValue:100},routing:{send:{type:"body",value:"={{ $value }}",property:"maxFacetHits"}},displayName:"Max Facet Hits",name:"maxFacetHits_number",displayOptions:{show:{search_for_facet_values_request_object:["maxFacetHits_number"],resource:["Search"],operation:["searchForFacetValues"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["browse"]}},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:"browseParams",displayName:"Browse Params",default:"",options:[{name:"Search parameters as query string",value:"search_parameters_as_query_string"},{name:"Browse params object",value:"browse_params_object"}],routing:{send:{type:"body",property:void 0,value:"={{ undefined }}"}},displayOptions:{show:{resource:["Search"],operation:["browse"]}}},{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:{browseParams:["search_parameters_as_query_string"],resource:["Search"],operation:["browse"]}}},{type:"multiOptions",name:"browse_params_object",displayName:"Browse Params Object",description:void 0,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"},{name:"Cursor",value:"cursor_string"}],displayOptions:{show:{browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{browse_params_object:["query_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["similarquery_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["filters_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["facetfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{facetFilters:["array"],browse_params_object:["facetfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string",displayOptions:{show:{facetFilters:["string"],browse_params_object:["facetfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["optionalfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{optionalFilters:["array"],browse_params_object:["optionalfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Optional Filters (String)",name:"optionalFilters_string",displayOptions:{show:{optionalFilters:["string"],browse_params_object:["optionalfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["numericfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{numericFilters:["array"],browse_params_object:["numericfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string",displayOptions:{show:{numericFilters:["string"],browse_params_object:["numericfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["tagfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{tagFilters:["array"],browse_params_object:["tagfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string",displayOptions:{show:{tagFilters:["string"],browse_params_object:["tagfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
151
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",displayOptions:{show:{browseParams_options:["browse_params_object"]}}},{type:"string",placeholder:"jMDY3M2MwM2QwMWUxMmQwYWI0ZTN",default:"",description:`Cursor to get the next page of the response.
|
|
152
|
+
|
|
153
|
+
The parameter must match the value returned in the response of a previous request.
|
|
154
|
+
The last page of the response does not return a \`cursor\` attribute.
|
|
155
|
+
`,displayName:"Cursor",name:"cursor_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}}],routing:{request:{body:{params:"={{ $value.params_string }}",query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}",cursor:"={{ $value.cursor_string }}"}}},displayOptions:{show:{resource:["Search"],operation:["browse"]}}}],u=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Search"],operation:["search"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",default:"",description:"Strategy for multiple search queries:\n\n- `none`. Run all queries.\n- `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.\n",options:[{name:"none",value:"none"},{name:"stopIfEnoughMatches",value:"stopIfEnoughMatches"}],displayName:"Strategy",name:"strategy_options"}],routing:{request:{body:{strategy:"={{ $value.strategy_options }}"}}},displayOptions:{show:{resource:["Search"],operation:["search"]}}}],c=[{type:"string",default:"",displayName:"Facet Name",name:"facetName_string",required:!0,description:"Facet attribute in which to search for values.\n\nThis attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.\n",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string"},{type:"string",placeholder:"george",default:"",description:"Text to search inside the facet's values.",displayName:"Facet Query",name:"facetQuery_string"},{type:"number",default:10,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).",typeOptions:{maxValue:100},displayName:"Max Facet Hits",name:"maxFacetHits_number"}],routing:{request:{body:{params:"={{ $value.params_string }}",facetQuery:"={{ $value.facetQuery_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}}],m=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Search Params",name:"searchParams_options",default:"search_parameters_as_query_string_object",options:[{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"},{name:"Search Parameters As Object",value:"search_parameters_as_object"}],required:!1},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string",displayOptions:{show:{searchParams_options:["search_parameters_as_query_string_object"]}}},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{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",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{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",displayName:"Filters",name:"filters_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
162
156
|
If true, all filter scores are summed.
|
|
163
157
|
Otherwise, the maximum filter score is kept.
|
|
164
158
|
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).
|
|
165
|
-
`,
|
|
159
|
+
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Restrict Searchable Attributes",name:"restrictSearchableAttributes_json",default:"[]",description:`Restricts a search to a subset of your searchable attributes.
|
|
166
160
|
Attribute names are case-sensitive.
|
|
167
|
-
`,required:!1,
|
|
161
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Facets",name:"facets_json",default:"[]",description:`Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
168
162
|
To retrieve all facets, use the wildcard character \`*\`.
|
|
169
163
|
For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
|
|
170
|
-
`,required:!1,
|
|
171
|
-
|
|
172
|
-
For example, if you set \`aroundPrecision\` to 100, records wihin 100 meters to the central coordinate are considered to have the same distance,
|
|
173
|
-
as are records between 100 and 199 meters.
|
|
174
|
-
`,displayName:"Around Precision (Integer)",name:"aroundPrecision_number",displayOptions:{show:{aroundPrecision:["integer"],browse_params_object:["aroundprecision"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Around Precision (Range Objects)",name:"aroundPrecision_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{aroundPrecision:["range_objects"],browse_params_object:["aroundprecision"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:"",description:"Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",typeOptions:{minValue:1},routing:{send:{type:"body",value:"={{ $value }}",property:"minimumAroundRadius"}},displayName:"Minimum Around Radius",name:"minimumAroundRadius_number",displayOptions:{show:{browse_params_object:["minimumaroundradius_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Inside bounding box array",value:"inside_bounding_box_array"}],routing:{send:{type:"body",property:"insideBoundingBox",value:'={{ typeof $parameter.insideBoundingBox_string !== "undefined" ? $parameter.insideBoundingBox_string : typeof $parameter.insideBoundingBox_null !== "undefined" ? JSON.parse($parameter.insideBoundingBox_null) : typeof $parameter.insideBoundingBox_json !== "undefined" ? JSON.parse($parameter.insideBoundingBox_json) : undefined }}'}},displayOptions:{show:{browse_params_object:["insideboundingbox"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Inside Bounding Box (String)",name:"insideBoundingBox_string",displayOptions:{show:{insideBoundingBox:["string"],browse_params_object:["insideboundingbox"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Inside Bounding Box (Null)",name:"insideBoundingBox_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{insideBoundingBox:["null"]}},displayOptions:{show:{insideBoundingBox:["null"],browse_params_object:["insideboundingbox"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Inside Bounding Box (Inside Bounding Box Array)",name:"insideBoundingBox_json",default:"[]",description:`Coordinates for a rectangular area in which to search.
|
|
175
|
-
|
|
176
|
-
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
177
|
-
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
178
|
-
Provide multiple bounding boxes as nested arrays.
|
|
179
|
-
For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
180
|
-
`,required:!1,displayOptions:{show:{insideBoundingBox:["inside_bounding_box_array"],browse_params_object:["insideboundingbox"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
164
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether faceting should be applied after deduplication with `distinct`\nThis leads to accurate facet counts when using faceting in combination with `distinct`.\nIt's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,\nas `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.\n",displayName:"Faceting After Distinct",name:"facetingAfterDistinct_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",displayName:"Offset",name:"offset_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},displayName:"Length",name:"length_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to obtain the coordinates from the request's IP address.",displayName:"Around Lat Lng Via IP",name:"aroundLatLngViaIP_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"aroundPrecision",displayName:"Around Precision",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",typeOptions:{minValue:1},displayName:"Minimum Around Radius",name:"minimumAroundRadius_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
181
165
|
|
|
182
166
|
Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
|
|
183
167
|
Provide multiple polygons as nested arrays.
|
|
184
168
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
185
169
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
186
|
-
`,required:!1,
|
|
170
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Natural Languages",name:"naturalLanguages_json",default:"[]",description:"ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)\n- Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.\n- Sets `removeWordsIfNoResults` to `allOptional`.\n- Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.\n",required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Rule Contexts",name:"ruleContexts_json",default:"[]",description:`Assigns a rule context to the search query
|
|
187
171
|
[Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
|
|
188
|
-
`,required:!1,
|
|
172
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
189
173
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
190
174
|
For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
191
|
-
`,typeOptions:{minValue:0,maxValue:100},
|
|
175
|
+
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
192
176
|
|
|
193
177
|
This helps with analytics and click and conversion events.
|
|
194
178
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
195
|
-
`,
|
|
179
|
+
`,displayName:"User Token",name:"userToken_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",displayName:"Get Ranking Info",name:"getRankingInfo_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",displayName:"Synonyms",name:"synonyms_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to include a `queryID` attribute in the response\nThe query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).\n",displayName:"Click Analytics",name:"clickAnalytics_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",displayName:"Analytics",name:"analytics_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Analytics Tags",name:"analyticsTags_json",default:"[]",description:"Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).",required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",displayName:"Percentile Computation",name:"percentileComputation_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",displayName:"Enable ABTest",name:"enableABTest_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:'Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`.\n- The `objectID` attribute is always included.\n',required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
196
180
|
|
|
197
181
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
198
182
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -209,29 +193,29 @@ you put the sorting attribute at the top of the list.
|
|
|
209
193
|
Before you modify the default setting,
|
|
210
194
|
you should test your changes in the dashboard,
|
|
211
195
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
212
|
-
`,required:!1,
|
|
196
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
213
197
|
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).
|
|
214
198
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
215
|
-
`,
|
|
199
|
+
`,displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Highlight",name:"attributesToHighlight_json",default:"[]",description:"Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).\n",required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
216
200
|
Attribute names are case-sensitive
|
|
217
201
|
Snippets provide additional context to matched words.
|
|
218
202
|
If you enable snippets, they include 10 words, including the matched word.
|
|
219
203
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
220
204
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
221
205
|
where \`NUMBER\` is the number of words to be extracted.
|
|
222
|
-
`,required:!1,
|
|
206
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
223
207
|
By default, all items are highlighted and snippeted.
|
|
224
|
-
`,
|
|
208
|
+
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:4,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).",displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:8,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).",displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"typoTolerance",displayName:"Typo Tolerance",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
225
209
|
Turn off this setting to reduce the number of irrelevant matches
|
|
226
210
|
when searching in large sets of similar numbers.
|
|
227
|
-
`,
|
|
211
|
+
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Disable Typo Tolerance On Attributes",name:"disableTypoToleranceOnAttributes_json",default:"[]",description:`Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).
|
|
228
212
|
Attribute names are case-sensitive
|
|
229
213
|
Returning only exact matches can help when
|
|
230
214
|
- [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).
|
|
231
215
|
- Reducing the number of matches when you have too many.
|
|
232
216
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
233
217
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
234
|
-
`,required:!1,
|
|
218
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
235
219
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
236
220
|
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.
|
|
237
221
|
To support this, you must place the CJK language **first**
|
|
@@ -240,7 +224,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
240
224
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
241
225
|
This can lead to unexpected search results.
|
|
242
226
|
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).
|
|
243
|
-
`,required:!1,
|
|
227
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to split compound words in the query into their building blocks\nFor 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).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
244
228
|
|
|
245
229
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
246
230
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -248,7 +232,7 @@ Avoid \`prefixAll\`, which treats all query words as prefixes.
|
|
|
248
232
|
This might lead to counterintuitive results and makes your search slower.
|
|
249
233
|
|
|
250
234
|
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).
|
|
251
|
-
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],
|
|
235
|
+
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],displayName:"Query Type",name:"queryType_options",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"options",placeholder:"firstWords",default:"none",description:`Strategy for removing words from the query when it doesn't return any results.
|
|
252
236
|
This helps to avoid returning empty search results.
|
|
253
237
|
|
|
254
238
|
- \`none\`.
|
|
@@ -266,16 +250,16 @@ This helps to avoid returning empty search results.
|
|
|
266
250
|
Treat all words as optional.
|
|
267
251
|
|
|
268
252
|
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).
|
|
269
|
-
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],
|
|
253
|
+
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],displayName:"Remove Words If No Results",name:"removeWordsIfNoResults_options",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"options",default:"keywordSearch",description:`Search mode the index will use to query for results.
|
|
270
254
|
|
|
271
255
|
This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
|
|
272
|
-
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],
|
|
256
|
+
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:"{}",displayName:"Semantic Search",name:"semantic_search_object",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalWords",displayName:"Optional Words",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Disable Exact On Attributes",name:"disableExactOnAttributes_json",default:"[]",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).
|
|
273
257
|
Attribute names are case-sensitive
|
|
274
258
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
275
259
|
such as product descriptions.
|
|
276
260
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
277
261
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
278
|
-
`,required:!1,
|
|
262
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"options",default:"attribute",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.
|
|
279
263
|
|
|
280
264
|
- \`attribute\`.
|
|
281
265
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -289,7 +273,7 @@ This reduces the impact of individual attributes with a lot of content on rankin
|
|
|
289
273
|
The query word must have at least 3 characters and must not be a stop word.
|
|
290
274
|
Only exact matches will be highlighted,
|
|
291
275
|
partial and prefix matches won't.
|
|
292
|
-
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],
|
|
276
|
+
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],displayName:"Exact On Single Word Query",name:"exactOnSingleWordQuery_options",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Alternatives As Exact",name:"alternativesAsExact_json",default:"[]",description:`Determine which plurals and synonyms should be considered an exact matches
|
|
293
277
|
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.
|
|
294
278
|
For example
|
|
295
279
|
- "swimsuit" and "swimsuits" are treated the same
|
|
@@ -300,11 +284,11 @@ For example
|
|
|
300
284
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
301
285
|
- \`multiWordsSynonym\`.
|
|
302
286
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
303
|
-
`,required:!1,
|
|
287
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json",default:"[]",description:'Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain "search" but not "engine"\nThis setting only has an effect if `advancedSyntax` is true.\n',required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"distinct",displayName:"Distinct",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:'Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either "home" or "house" are included in the search results,\nand either "home" or "house" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of "house" are replaced by "home" in the highlighted response.\n',displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
304
288
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
305
289
|
by equally scoring matches that are farther apart
|
|
306
290
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
307
|
-
`,typeOptions:{minValue:1,maxValue:7},
|
|
291
|
+
`,typeOptions:{minValue:1,maxValue:7},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Response Fields",name:"responseFields_json",default:"[]",description:"Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
308
292
|
- \`count\`.
|
|
309
293
|
Facet values are retrieved by decreasing count.
|
|
310
294
|
The count is the number of matching records containing this facet value
|
|
@@ -312,29 +296,31 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
312
296
|
Retrieve facet values alphabetically
|
|
313
297
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
314
298
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
315
|
-
`,
|
|
299
|
+
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",description:`Extra data that can be used in the search UI.
|
|
316
300
|
|
|
317
301
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
318
302
|
without changing your frontend code.
|
|
319
|
-
`,required:!1,default:"{}",
|
|
303
|
+
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
320
304
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
321
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"enableReRanking"}},displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{browse_params_object:["enablereranking_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"},{name:"Null",value:"null"}],routing:{send:{type:"body",property:"reRankingApplyFilter",value:'={{ typeof $parameter.reRankingApplyFilter_json !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_json) : typeof $parameter.reRankingApplyFilter_string !== "undefined" ? $parameter.reRankingApplyFilter_string : typeof $parameter.reRankingApplyFilter_null !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_null) : undefined }}'}},displayOptions:{show:{browse_params_object:["rerankingapplyfilter"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Array)",name:"reRankingApplyFilter_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{reRankingApplyFilter:["array"],browse_params_object:["rerankingapplyfilter"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",displayOptions:{show:{reRankingApplyFilter:["string"],browse_params_object:["rerankingapplyfilter"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Null)",name:"reRankingApplyFilter_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{reRankingApplyFilter:["null"]}},displayOptions:{show:{reRankingApplyFilter:["null"],browse_params_object:["rerankingapplyfilter"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",placeholder:"jMDY3M2MwM2QwMWUxMmQwYWI0ZTN",default:"",description:`Cursor to get the next page of the response.
|
|
322
|
-
|
|
323
|
-
The parameter must match the value returned in the response of a previous request.
|
|
324
|
-
The last page of the response does not return a \`cursor\` attribute.
|
|
325
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"cursor"}},displayName:"Cursor",name:"cursor_string",displayOptions:{show:{browse_params_object:["cursor_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},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",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},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",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["getObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["getObject"]}}},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:void 0,required:!1,routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["deleteObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["deleteObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}},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 }}"}}]}}}}},{displayName:"Delete By Params",name:"delete_by_params_object",type:"multiOptions",description:void 0,required:!1,default:[],options:[{name:"Facet Filters",value:"facetFilters"},{name:"Filters",value:"filters_string"},{name:"Numeric Filters",value:"numericFilters"},{name:"Tag Filters",value:"tagFilters"},{name:"Around Lat Lng",value:"aroundLatLng_string"},{name:"Around Radius",value:"aroundRadius"},{name:"Inside Bounding Box",value:"insideBoundingBox"},{name:"Inside Polygon",value:"insidePolygon_json"}],displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}}},{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:{delete_by_params_object:["facetFilters"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{delete_by_params_object:["facetFilters"],facetFilters:["array"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string",displayOptions:{show:{delete_by_params_object:["facetFilters"],facetFilters:["string"],resource:["Records"],operation:["deleteBy"]}}},{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:{delete_by_params_object:["filters_string"],resource:["Records"],operation:["deleteBy"]}}},{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:{delete_by_params_object:["numericFilters"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{delete_by_params_object:["numericFilters"],numericFilters:["array"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string",displayOptions:{show:{delete_by_params_object:["numericFilters"],numericFilters:["string"],resource:["Records"],operation:["deleteBy"]}}},{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:{delete_by_params_object:["tagFilters"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{delete_by_params_object:["tagFilters"],tagFilters:["array"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string",displayOptions:{show:{delete_by_params_object:["tagFilters"],tagFilters:["string"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"aroundLatLng"}},displayName:"Around Lat Lng",name:"aroundLatLng_string",displayOptions:{show:{delete_by_params_object:["aroundLatLng_string"],resource:["Records"],operation:["deleteBy"]}}},{type:"options",name:"aroundRadius",displayName:"Around Radius",default:"",options:[{name:"Integer",value:"integer"},{name:"All",value:"all"}],routing:{send:{type:"body",property:"aroundRadius",value:'={{ typeof $parameter.aroundRadius_number !== "undefined" ? $parameter.aroundRadius_number : typeof $parameter.aroundRadius_options !== "undefined" ? $parameter.aroundRadius_options : undefined }}'}},displayOptions:{show:{delete_by_params_object:["aroundRadius"],resource:["Records"],operation:["deleteBy"]}}},{type:"number",default:"",description:"Maximum search radius around a central location in meters.",typeOptions:{minValue:1},displayName:"Around Radius (Integer)",name:"aroundRadius_number",displayOptions:{show:{delete_by_params_object:["aroundRadius"],aroundRadius:["integer"],resource:["Records"],operation:["deleteBy"]}}},{type:"options",default:"",description:"Return all records with a valid `_geoloc` attribute. Don't filter by distance.",options:[{name:"all",value:"all"}],displayName:"Around Radius (All)",name:"aroundRadius_options",displayOptions:{show:{delete_by_params_object:["aroundRadius"],aroundRadius:["all"],resource:["Records"],operation:["deleteBy"]}}},{type:"options",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Inside bounding box array",value:"inside_bounding_box_array"}],routing:{send:{type:"body",property:"insideBoundingBox",value:'={{ typeof $parameter.insideBoundingBox_string !== "undefined" ? $parameter.insideBoundingBox_string : typeof $parameter.insideBoundingBox_null !== "undefined" ? JSON.parse($parameter.insideBoundingBox_null) : typeof $parameter.insideBoundingBox_json !== "undefined" ? JSON.parse($parameter.insideBoundingBox_json) : undefined }}'}},displayOptions:{show:{delete_by_params_object:["insideBoundingBox"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",default:"",displayName:"Inside Bounding Box (String)",name:"insideBoundingBox_string",displayOptions:{show:{delete_by_params_object:["insideBoundingBox"],insideBoundingBox:["string"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Inside Bounding Box (Null)",name:"insideBoundingBox_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{insideBoundingBox:["null"]}},displayOptions:{show:{delete_by_params_object:["insideBoundingBox"],insideBoundingBox:["null"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Inside Bounding Box (Inside Bounding Box Array)",name:"insideBoundingBox_json",default:"[]",description:`Coordinates for a rectangular area in which to search.
|
|
326
|
-
|
|
327
|
-
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
328
|
-
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
329
|
-
Provide multiple bounding boxes as nested arrays.
|
|
330
|
-
For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
331
|
-
`,required:!1,displayOptions:{show:{delete_by_params_object:["insideBoundingBox"],insideBoundingBox:["inside_bounding_box_array"],resource:["Records"],operation:["deleteBy"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
305
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}}],routing:{request:{body:{params:"={{ $value.params_string }}",query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}}],h=[{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(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits","params","query"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},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(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits","params","query"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}}],displayOptions:{show:{resource:["Search"]}}}],y=[...h,{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"]}}},...d,...u,...c,...m],g=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}}],f=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["batch"]}},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:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["batch"]}}}],b=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["clearObjects"]}},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 }}"}}]}}}}}],w=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",name:"facetFilters",displayName:"Facet Filters",default:""},{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",displayName:"Filters",name:"filters_string"},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:""},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:""},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string"},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:""},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:""},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
332
306
|
|
|
333
307
|
Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
|
|
334
308
|
Provide multiple polygons as nested arrays.
|
|
335
309
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
336
310
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
337
|
-
`,required:!1,routing:{
|
|
311
|
+
`,required:!1}],routing:{request:{body:{facetFilters:"={{ JSON.parse($value.facetFilters) }}",filters:"={{ $value.filters_string }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}}}],_=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["deleteObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["deleteObject"]}}}],v=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["getObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["getObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:`Attributes to include with the records in the response.
|
|
312
|
+
This is useful to reduce the size of the API response.
|
|
313
|
+
By default, all retrievable attributes are returned.
|
|
314
|
+
|
|
315
|
+
\`objectID\` is always retrieved.
|
|
316
|
+
|
|
317
|
+
Attributes included in \`unretrievableAttributes\`
|
|
318
|
+
won't be retrieved unless the request is authenticated with the admin API key.
|
|
319
|
+
`,required:!1}],routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}}],N=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}}],x=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}}],O=[{type:"json",description:"Attributes to update.",required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}},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:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!0,displayName:"Create If Not Exists",name:"createIfNotExists_boolean",description:"Whether to create a new record if it doesn't exist."}],routing:{request:{qs:{createIfNotExists:"={{ $value.createIfNotExists_boolean }}"}}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}}],P=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},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 }}"}}]}}}}}],A=[{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"]}}}],T=[...A,...g,...f,...b,...w,..._,...v,...N,...x,...O,...P],q=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},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 }}"}}]}}}}}],S=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}},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 }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:1,displayName:"Get Version",name:"getVersion_number",description:"When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility."}],routing:{request:{qs:{getVersion:"={{ $value.getVersion_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}}],I=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},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:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}}],j=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}],$=[{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},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",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
320
|
+
|
|
321
|
+
If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.
|
|
322
|
+
If you omit the \`scope\` parameter, everything is copied: records, settings, synonyms, and rules.
|
|
323
|
+
`,required:!1}],routing:{request:{body:{scope:"={{ JSON.parse($value.scope_json) }}"}}},displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}}],R=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Attributes For Faceting",name:"attributesForFaceting_json",default:"[]",description:`Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting).
|
|
338
324
|
|
|
339
325
|
Facets are attributes that let you categorize search results.
|
|
340
326
|
They can be used for filtering search results.
|
|
@@ -353,7 +339,7 @@ Attribute names are case-sensitive.
|
|
|
353
339
|
Evaluates the facet count _after_ deduplication with \`distinct\`.
|
|
354
340
|
This ensures accurate facet counts.
|
|
355
341
|
You can apply this modifier to searchable facets: \`afterDistinct(searchable(ATTRIBUTE))\`.
|
|
356
|
-
`,required:!1
|
|
342
|
+
`,required:!1},{type:"json",displayName:"Replicas",name:"replicas_json",default:"[]",description:`Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas).
|
|
357
343
|
|
|
358
344
|
Replicas are copies of a primary index with the same records but different settings, synonyms, or rules.
|
|
359
345
|
If you want to offer a different ranking or sorting of your search results, you'll use replica indices.
|
|
@@ -366,36 +352,36 @@ If you omit a replica from this list, the replica turns into a regular, standalo
|
|
|
366
352
|
- \`virtual("REPLICA")\`.
|
|
367
353
|
Create a virtual replica,
|
|
368
354
|
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).
|
|
369
|
-
`,required:!1
|
|
355
|
+
`,required:!1},{type:"number",placeholder:"100",default:1e3,description:`Maximum number of search results that can be obtained through pagination.
|
|
370
356
|
|
|
371
357
|
Higher pagination limits might slow down your search.
|
|
372
358
|
For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
|
|
373
|
-
`,typeOptions:{maxValue:2e4},
|
|
359
|
+
`,typeOptions:{maxValue:2e4},displayName:"Pagination Limited To",name:"paginationLimitedTo_number"},{type:"json",displayName:"Unretrievable Attributes",name:"unretrievableAttributes_json",default:"[]",description:`Attributes that can't be retrieved at query time.
|
|
374
360
|
|
|
375
361
|
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),
|
|
376
362
|
but don't want to include it in the search results.
|
|
377
363
|
Attribute names are case-sensitive.
|
|
378
|
-
`,required:!1
|
|
364
|
+
`,required:!1},{type:"json",displayName:"Disable Typo Tolerance On Words",name:"disableTypoToleranceOnWords_json",default:"[]",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).
|
|
379
365
|
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.
|
|
380
|
-
`,required:!1
|
|
366
|
+
`,required:!1},{type:"json",displayName:"Attributes To Transliterate",name:"attributesToTransliterate_json",default:"[]",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).
|
|
381
367
|
|
|
382
368
|
Transliteration supports searching in any of the Japanese writing systems.
|
|
383
369
|
To support transliteration, you must set the indexing language to Japanese.
|
|
384
370
|
Attribute names are case-sensitive.
|
|
385
|
-
`,required:!1
|
|
371
|
+
`,required:!1},{type:"json",displayName:"Camel Case Attributes",name:"camelCaseAttributes_json",default:"[]",description:`Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
386
372
|
Attribute names are case-sensitive.
|
|
387
|
-
`,required:!1
|
|
373
|
+
`,required:!1},{type:"json",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).\nAttribute names are case-sensitive.\n\nCompound words are formed by combining two or more individual words,\nand are particularly prevalent in Germanic languages—for example, \"firefighter\".\nWith decompounding, the individual components are indexed separately.\n\nYou can specify different lists for different languages.\nDecompounding is supported for these languages:\nDutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",required:!1,default:"{}",displayName:"Decompounded Attributes",name:"decompounded_attributes_object"},{type:"json",displayName:"Index Languages",name:"indexLanguages_json",default:"[]",description:`Languages for language-specific processing steps, such as word detection and dictionary settings.
|
|
388
374
|
|
|
389
375
|
**You should always specify an indexing language.**
|
|
390
376
|
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),
|
|
391
377
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
392
378
|
This can lead to unexpected search results.
|
|
393
379
|
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).
|
|
394
|
-
`,required:!1
|
|
380
|
+
`,required:!1},{type:"json",displayName:"Disable Prefix On Attributes",name:"disablePrefixOnAttributes_json",default:"[]",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).
|
|
395
381
|
Attribute names are case-sensitive.
|
|
396
|
-
`,required:!1
|
|
382
|
+
`,required:!1},{type:"boolean",default:!1,description:`Whether arrays with exclusively non-negative integers should be compressed for better performance.
|
|
397
383
|
If true, the compressed arrays may be reordered.
|
|
398
|
-
`,
|
|
384
|
+
`,displayName:"Allow Compression Of Integer Array",name:"allowCompressionOfIntegerArray_boolean"},{type:"json",displayName:"Numeric Attributes For Filtering",name:"numericAttributesForFiltering_json",default:"[]",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).
|
|
399
385
|
Attribute names are case-sensitive.
|
|
400
386
|
|
|
401
387
|
By default, all numeric attributes are available as numerical filters.
|
|
@@ -407,7 +393,7 @@ To turn off filtering for all numeric attributes, specify an attribute that does
|
|
|
407
393
|
|
|
408
394
|
- \`equalOnly("ATTRIBUTE")\`.
|
|
409
395
|
Support only filtering based on equality comparisons \`=\` and \`!=\`.
|
|
410
|
-
`,required:!1
|
|
396
|
+
`,required:!1},{type:"string",placeholder:"+#",default:"",description:'Control which non-alphanumeric characters are indexed.\n\nBy 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 (`(`,`)`).\nTo include such characters, define them with `separatorsToIndex`.\n\nSeparators are all non-letter characters except spaces and currency characters, such as $€£¥.\n\nWith `separatorsToIndex`, Algolia treats separator characters as separate words.\nFor example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.\n',displayName:"Separators To Index",name:"separatorsToIndex_string"},{type:"json",displayName:"Searchable Attributes",name:"searchableAttributes_json",default:"[]",description:`Attributes used for searching. Attribute names are case-sensitive.
|
|
411
397
|
|
|
412
398
|
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.
|
|
413
399
|
With a non-empty list, Algolia only returns results with matches in the selected attributes.
|
|
@@ -423,9 +409,9 @@ For more information, see [Searchable attributes](https://www.algolia.com/doc/gu
|
|
|
423
409
|
Ignore the position of a match within the attribute.
|
|
424
410
|
|
|
425
411
|
Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
|
|
426
|
-
`,required:!1
|
|
412
|
+
`,required:!1},{type:"json",description:`Characters and their normalized replacements.
|
|
427
413
|
This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization).
|
|
428
|
-
`,required:!1,default:"{}",
|
|
414
|
+
`,required:!1,default:"{}",displayName:"Custom Normalization",name:"custom_normalization_object"},{type:"string",placeholder:"url",default:"",description:`Attribute that should be used to establish groups of results.
|
|
429
415
|
Attribute names are case-sensitive.
|
|
430
416
|
|
|
431
417
|
All records with the same value for this attribute are considered a group.
|
|
@@ -434,12 +420,12 @@ how many items per group are included in the search results.
|
|
|
434
420
|
|
|
435
421
|
If you want to use the same attribute also for faceting, use the \`afterDistinct\` modifier of the \`attributesForFaceting\` setting.
|
|
436
422
|
This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
|
437
|
-
`,
|
|
423
|
+
`,displayName:"Attribute For Distinct",name:"attributeForDistinct_string"},{type:"number",default:10,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).",typeOptions:{maxValue:100},displayName:"Max Facet Hits",name:"maxFacetHits_number"},{type:"string",placeholder:"øé",default:"",description:`Characters for which diacritics should be preserved.
|
|
438
424
|
|
|
439
425
|
By default, Algolia removes diacritics from letters.
|
|
440
426
|
For example, \`é\` becomes \`e\`. If this causes issues in your search,
|
|
441
427
|
you can specify characters that should keep their diacritics.
|
|
442
|
-
`,
|
|
428
|
+
`,displayName:"Keep Diacritics On Characters",name:"keepDiacriticsOnCharacters_string"},{type:"json",displayName:"Custom Ranking",name:"customRanking_json",default:"[]",description:`Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking).
|
|
443
429
|
Attribute names are case-sensitive.
|
|
444
430
|
|
|
445
431
|
The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.
|
|
@@ -458,7 +444,7 @@ Boolean attributes are sorted based on their alphabetical order.
|
|
|
458
444
|
If you use two or more custom ranking attributes,
|
|
459
445
|
[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,
|
|
460
446
|
or the other attributes will never be applied.
|
|
461
|
-
`,required:!1
|
|
447
|
+
`,required:!1},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:'Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`.\n- The `objectID` attribute is always included.\n',required:!1},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
462
448
|
|
|
463
449
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
464
450
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -475,29 +461,29 @@ you put the sorting attribute at the top of the list.
|
|
|
475
461
|
Before you modify the default setting,
|
|
476
462
|
you should test your changes in the dashboard,
|
|
477
463
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
478
|
-
`,required:!1
|
|
464
|
+
`,required:!1},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
479
465
|
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).
|
|
480
466
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
481
|
-
`,
|
|
467
|
+
`,displayName:"Relevancy Strictness",name:"relevancyStrictness_number"},{type:"json",displayName:"Attributes To Highlight",name:"attributesToHighlight_json",default:"[]",description:"Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).\n",required:!1},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
482
468
|
Attribute names are case-sensitive
|
|
483
469
|
Snippets provide additional context to matched words.
|
|
484
470
|
If you enable snippets, they include 10 words, including the matched word.
|
|
485
471
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
486
472
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
487
473
|
where \`NUMBER\` is the number of words to be extracted.
|
|
488
|
-
`,required:!1
|
|
474
|
+
`,required:!1},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Pre Tag",name:"highlightPreTag_string"},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Post Tag",name:"highlightPostTag_string"},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string"},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
489
475
|
By default, all items are highlighted and snippeted.
|
|
490
|
-
`,
|
|
476
|
+
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"number",default:4,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).",displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number"},{type:"number",default:8,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).",displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number"},{type:"json",name:"typoTolerance",displayName:"Typo Tolerance",default:""},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
491
477
|
Turn off this setting to reduce the number of irrelevant matches
|
|
492
478
|
when searching in large sets of similar numbers.
|
|
493
|
-
`,
|
|
479
|
+
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean"},{type:"json",displayName:"Disable Typo Tolerance On Attributes",name:"disableTypoToleranceOnAttributes_json",default:"[]",description:`Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).
|
|
494
480
|
Attribute names are case-sensitive
|
|
495
481
|
Returning only exact matches can help when
|
|
496
482
|
- [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).
|
|
497
483
|
- Reducing the number of matches when you have too many.
|
|
498
484
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
499
485
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
500
|
-
`,required:!1
|
|
486
|
+
`,required:!1},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:""},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:""},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
501
487
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
502
488
|
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.
|
|
503
489
|
To support this, you must place the CJK language **first**
|
|
@@ -506,7 +492,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
506
492
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
507
493
|
This can lead to unexpected search results.
|
|
508
494
|
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).
|
|
509
|
-
`,required:!1
|
|
495
|
+
`,required:!1},{type:"boolean",default:!0,description:"Whether to split compound words in the query into their building blocks\nFor 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).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",displayName:"Decompound Query",name:"decompoundQuery_boolean"},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean"},{type:"boolean",default:!1,description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean"},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
510
496
|
|
|
511
497
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
512
498
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -514,7 +500,7 @@ Avoid \`prefixAll\`, which treats all query words as prefixes.
|
|
|
514
500
|
This might lead to counterintuitive results and makes your search slower.
|
|
515
501
|
|
|
516
502
|
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).
|
|
517
|
-
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],
|
|
503
|
+
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],displayName:"Query Type",name:"queryType_options"},{type:"options",placeholder:"firstWords",default:"none",description:`Strategy for removing words from the query when it doesn't return any results.
|
|
518
504
|
This helps to avoid returning empty search results.
|
|
519
505
|
|
|
520
506
|
- \`none\`.
|
|
@@ -532,16 +518,16 @@ This helps to avoid returning empty search results.
|
|
|
532
518
|
Treat all words as optional.
|
|
533
519
|
|
|
534
520
|
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).
|
|
535
|
-
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],
|
|
521
|
+
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],displayName:"Remove Words If No Results",name:"removeWordsIfNoResults_options"},{type:"options",default:"keywordSearch",description:`Search mode the index will use to query for results.
|
|
536
522
|
|
|
537
523
|
This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
|
|
538
|
-
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],
|
|
524
|
+
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options"},{type:"json",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:"{}",displayName:"Semantic Search",name:"semantic_search_object"},{type:"boolean",default:!1,description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",displayName:"Advanced Syntax",name:"advancedSyntax_boolean"},{type:"json",name:"optionalWords",displayName:"Optional Words",default:""},{type:"json",displayName:"Disable Exact On Attributes",name:"disableExactOnAttributes_json",default:"[]",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).
|
|
539
525
|
Attribute names are case-sensitive
|
|
540
526
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
541
527
|
such as product descriptions.
|
|
542
528
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
543
529
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
544
|
-
`,required:!1
|
|
530
|
+
`,required:!1},{type:"options",default:"attribute",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.
|
|
545
531
|
|
|
546
532
|
- \`attribute\`.
|
|
547
533
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -555,7 +541,7 @@ This reduces the impact of individual attributes with a lot of content on rankin
|
|
|
555
541
|
The query word must have at least 3 characters and must not be a stop word.
|
|
556
542
|
Only exact matches will be highlighted,
|
|
557
543
|
partial and prefix matches won't.
|
|
558
|
-
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],
|
|
544
|
+
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],displayName:"Exact On Single Word Query",name:"exactOnSingleWordQuery_options"},{type:"json",displayName:"Alternatives As Exact",name:"alternativesAsExact_json",default:"[]",description:`Determine which plurals and synonyms should be considered an exact matches
|
|
559
545
|
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.
|
|
560
546
|
For example
|
|
561
547
|
- "swimsuit" and "swimsuits" are treated the same
|
|
@@ -566,11 +552,11 @@ For example
|
|
|
566
552
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
567
553
|
- \`multiWordsSynonym\`.
|
|
568
554
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
569
|
-
`,required:!1
|
|
555
|
+
`,required:!1},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json",default:"[]",description:'Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain "search" but not "engine"\nThis setting only has an effect if `advancedSyntax` is true.\n',required:!1},{type:"json",name:"distinct",displayName:"Distinct",default:""},{type:"boolean",default:!1,description:'Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either "home" or "house" are included in the search results,\nand either "home" or "house" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of "house" are replaced by "home" in the highlighted response.\n',displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean"},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
570
556
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
571
557
|
by equally scoring matches that are farther apart
|
|
572
558
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
573
|
-
`,typeOptions:{minValue:1,maxValue:7},
|
|
559
|
+
`,typeOptions:{minValue:1,maxValue:7},displayName:"Min Proximity",name:"minProximity_number"},{type:"json",displayName:"Response Fields",name:"responseFields_json",default:"[]",description:"Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",required:!1},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number"},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
574
560
|
- \`count\`.
|
|
575
561
|
Facet values are retrieved by decreasing count.
|
|
576
562
|
The count is the number of matching records containing this facet value
|
|
@@ -578,29 +564,29 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
578
564
|
Retrieve facet values alphabetically
|
|
579
565
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
580
566
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
581
|
-
`,
|
|
567
|
+
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string"},{type:"boolean",default:!1,description:"Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean"},{type:"json",description:`Extra data that can be used in the search UI.
|
|
582
568
|
|
|
583
569
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
584
570
|
without changing your frontend code.
|
|
585
|
-
`,required:!1,default:"{}",
|
|
571
|
+
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object"},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
586
572
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
587
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"enableReRanking"}},displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{index_settings:["enablereranking_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"},{name:"Null",value:"null"}],routing:{send:{type:"body",property:"reRankingApplyFilter",value:'={{ typeof $parameter.reRankingApplyFilter_json !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_json) : typeof $parameter.reRankingApplyFilter_string !== "undefined" ? $parameter.reRankingApplyFilter_string : typeof $parameter.reRankingApplyFilter_null !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_null) : undefined }}'}},displayOptions:{show:{index_settings:["rerankingapplyfilter"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Array)",name:"reRankingApplyFilter_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{reRankingApplyFilter:["array"],index_settings:["rerankingapplyfilter"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",displayOptions:{show:{reRankingApplyFilter:["string"],index_settings:["rerankingapplyfilter"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Null)",name:"reRankingApplyFilter_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{reRankingApplyFilter:["null"]}},displayOptions:{show:{reRankingApplyFilter:["null"],index_settings:["rerankingapplyfilter"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}},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:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}},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:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Synonym Hit",name:"synonym_hit_object",type:"multiOptions",description:"Synonym object.",required:!0,default:[],options:[{name:"Object ID",value:"objectID_string"},{name:"Type",value:"type_options"},{name:"Synonyms",value:"synonyms_json"},{name:"Input",value:"input_string"},{name:"Word",value:"word_string"},{name:"Corrections",value:"corrections_json"},{name:"Placeholder",value:"placeholder_string"},{name:"Replacements",value:"replacements_json"}],displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"synonymID",default:"",description:"Unique identifier of a synonym object.",routing:{send:{type:"body",value:"={{ $value }}",property:"objectID"}},displayName:"Object ID",name:"objectID_string",displayOptions:{show:{synonym_hit_object:["objectID_string"],resource:["Synonyms"],operation:["saveSynonym"]}},required:!0},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],routing:{send:{type:"body",value:"={{ $value }}",property:"type"}},displayName:"Type",name:"type_options",displayOptions:{show:{synonym_hit_object:["type_options"],resource:["Synonyms"],operation:["saveSynonym"]}},required:!0},{type:"json",displayName:"Synonyms",name:"synonyms_json",default:"[]",description:"Words or phrases considered equivalent.",required:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"synonyms"}},displayOptions:{show:{synonym_hit_object:["synonyms_json"],resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"car",default:"",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)).",routing:{send:{type:"body",value:"={{ $value }}",property:"input"}},displayName:"Input",name:"input_string",displayOptions:{show:{synonym_hit_object:["input_string"],resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"car",default:"",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)).",routing:{send:{type:"body",value:"={{ $value }}",property:"word"}},displayName:"Word",name:"word_string",displayOptions:{show:{synonym_hit_object:["word_string"],resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"json",displayName:"Corrections",name:"corrections_json",default:"[]",description:"Words to be matched in records.",required:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"corrections"}},displayOptions:{show:{synonym_hit_object:["corrections_json"],resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"<Street>",default:"",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.
|
|
588
|
-
`,
|
|
573
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean"},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:""}],routing:{request:{body:{attributesForFaceting:"={{ JSON.parse($value.attributesForFaceting_json) }}",replicas:"={{ JSON.parse($value.replicas_json) }}",paginationLimitedTo:"={{ $value.paginationLimitedTo_number }}",unretrievableAttributes:"={{ JSON.parse($value.unretrievableAttributes_json) }}",disableTypoToleranceOnWords:"={{ JSON.parse($value.disableTypoToleranceOnWords_json) }}",attributesToTransliterate:"={{ JSON.parse($value.attributesToTransliterate_json) }}",camelCaseAttributes:"={{ JSON.parse($value.camelCaseAttributes_json) }}",decompoundedAttributes:"={{ JSON.parse($value.decompounded_attributes_object) }}",indexLanguages:"={{ JSON.parse($value.indexLanguages_json) }}",disablePrefixOnAttributes:"={{ JSON.parse($value.disablePrefixOnAttributes_json) }}",allowCompressionOfIntegerArray:"={{ $value.allowCompressionOfIntegerArray_boolean }}",numericAttributesForFiltering:"={{ JSON.parse($value.numericAttributesForFiltering_json) }}",separatorsToIndex:"={{ $value.separatorsToIndex_string }}",searchableAttributes:"={{ JSON.parse($value.searchableAttributes_json) }}",customNormalization:"={{ JSON.parse($value.custom_normalization_object) }}",attributeForDistinct:"={{ $value.attributeForDistinct_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}",keepDiacriticsOnCharacters:"={{ $value.keepDiacriticsOnCharacters_string }}",customRanking:"={{ JSON.parse($value.customRanking_json) }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}}],k=[{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(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},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"]}}}],D=[...k,{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"]}}},...q,...S,...I,...j,...$,...R],F=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}},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 }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}}}],E=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}},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:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}}],W=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}},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:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}}}],L=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}},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:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"synonymID",default:"",description:"Unique identifier of a synonym object.",routing:{send:{type:"body",value:"={{ $value }}",property:"objectID"}},displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],routing:{send:{type:"body",value:"={{ $value }}",property:"type"}},displayName:"Type",name:"type_options",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Synonyms",name:"synonyms_json",default:"[]",description:"Words or phrases considered equivalent.",required:!1},{type:"string",placeholder:"car",default:"",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)).",displayName:"Input",name:"input_string"},{type:"string",placeholder:"car",default:"",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)).",displayName:"Word",name:"word_string"},{type:"json",displayName:"Corrections",name:"corrections_json",default:"[]",description:"Words to be matched in records.",required:!1},{type:"string",placeholder:"<Street>",default:"",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.
|
|
574
|
+
`,displayName:"Placeholder",name:"placeholder_string"},{type:"json",displayName:"Replacements",name:"replacements_json",default:"[]",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:!1}],routing:{request:{body:{synonyms:"={{ JSON.parse($value.synonyms_json) }}",input:"={{ $value.input_string }}",word:"={{ $value.word_string }}",corrections:"={{ JSON.parse($value.corrections_json) }}",placeholder:"={{ $value.placeholder_string }}",replacements:"={{ JSON.parse($value.replacements_json) }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}}],C=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Matching synonyms.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}},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 }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Replace Existing Synonyms",name:"replaceExistingSynonyms_boolean",description:"Whether to replace all synonyms in the index with the ones sent with this request."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",replaceExistingSynonyms:"={{ $value.replaceExistingSynonyms_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}}],B=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["searchSynonyms"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string"},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],displayName:"Type",name:"type_options"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{query:"={{ $value.query_string }}",type:"={{ $value.type_options }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["searchSynonyms"]}}}],z=[{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"]}}}],U=[...z,...F,...E,...W,...L,...C,...B],M=[{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
589
575
|
The required ACL is listed in each endpoint's reference.
|
|
590
576
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
591
|
-
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{
|
|
577
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_".\n- `*_dev` matches all indices ending with "_dev".\n- `*_products_*` matches all indices containing "_products_".\n',required:!1},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
592
578
|
By default, there's no limit.
|
|
593
|
-
`,
|
|
579
|
+
`,displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number"},{type:"number",default:"",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.
|
|
594
580
|
|
|
595
581
|
If this limit is reached, the API returns an error with status code \`429\`.
|
|
596
582
|
By default, there's no limit.
|
|
597
|
-
`,
|
|
583
|
+
`,displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number"},{type:"string",placeholder:"typoTolerance=strict&restrictSources=192.168.1.0/24",default:"",description:`Query parameters to add when making API requests with this API key.
|
|
598
584
|
|
|
599
585
|
To restrict this API key to specific IP addresses, add the \`restrictSources\` parameter.
|
|
600
586
|
You can only add a single source, but you can provide a range of IP addresses.
|
|
601
587
|
|
|
602
588
|
Creating an API key fails if the request is made from an IP address outside the restricted range.
|
|
603
|
-
`,
|
|
589
|
+
`,displayName:"Query Parameters",name:"queryParameters_string"},{type:"json",displayName:"Referers",name:"referers_json",default:"[]",description:`Allowed HTTP referrers for this API key.
|
|
604
590
|
|
|
605
591
|
By default, all referrers are allowed.
|
|
606
592
|
You can use leading and trailing wildcard characters (\`*\`):
|
|
@@ -611,24 +597,24 @@ You can use leading and trailing wildcard characters (\`*\`):
|
|
|
611
597
|
|
|
612
598
|
Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
|
|
613
599
|
For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
|
|
614
|
-
`,required:!1
|
|
600
|
+
`,required:!1},{type:"number",placeholder:"86400",default:"",description:`Duration (in seconds) after which the API key expires.
|
|
615
601
|
By default, API keys don't expire.
|
|
616
|
-
`,routing:{
|
|
602
|
+
`,displayName:"Validity",name:"validity_number"}],routing:{request:{body:{description:"={{ $value.description_string }}",indexes:"={{ JSON.parse($value.indexes_json) }}",maxHitsPerQuery:"={{ $value.maxHitsPerQuery_number }}",maxQueriesPerIPPerHour:"={{ $value.maxQueriesPerIPPerHour_number }}",queryParameters:"={{ $value.queryParameters_string }}",referers:"={{ JSON.parse($value.referers_json) }}",validity:"={{ $value.validity_number }}"}}},displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}}],J=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["deleteApiKey"]}}}],V=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["getApiKey"]}}}],H=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["restoreApiKey"]}}}],G=[{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
617
603
|
The required ACL is listed in each endpoint's reference.
|
|
618
604
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
619
|
-
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{
|
|
605
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_".\n- `*_dev` matches all indices ending with "_dev".\n- `*_products_*` matches all indices containing "_products_".\n',required:!1},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
620
606
|
By default, there's no limit.
|
|
621
|
-
`,
|
|
607
|
+
`,displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number"},{type:"number",default:"",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.
|
|
622
608
|
|
|
623
609
|
If this limit is reached, the API returns an error with status code \`429\`.
|
|
624
610
|
By default, there's no limit.
|
|
625
|
-
`,
|
|
611
|
+
`,displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number"},{type:"string",placeholder:"typoTolerance=strict&restrictSources=192.168.1.0/24",default:"",description:`Query parameters to add when making API requests with this API key.
|
|
626
612
|
|
|
627
613
|
To restrict this API key to specific IP addresses, add the \`restrictSources\` parameter.
|
|
628
614
|
You can only add a single source, but you can provide a range of IP addresses.
|
|
629
615
|
|
|
630
616
|
Creating an API key fails if the request is made from an IP address outside the restricted range.
|
|
631
|
-
`,
|
|
617
|
+
`,displayName:"Query Parameters",name:"queryParameters_string"},{type:"json",displayName:"Referers",name:"referers_json",default:"[]",description:`Allowed HTTP referrers for this API key.
|
|
632
618
|
|
|
633
619
|
By default, all referrers are allowed.
|
|
634
620
|
You can use leading and trailing wildcard characters (\`*\`):
|
|
@@ -639,19 +625,18 @@ You can use leading and trailing wildcard characters (\`*\`):
|
|
|
639
625
|
|
|
640
626
|
Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
|
|
641
627
|
For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
|
|
642
|
-
`,required:!1
|
|
628
|
+
`,required:!1},{type:"number",placeholder:"86400",default:"",description:`Duration (in seconds) after which the API key expires.
|
|
643
629
|
By default, API keys don't expire.
|
|
644
|
-
`,routing:{
|
|
645
|
-
|
|
646
|
-
Some consequences require specific conditions or don't require any condition.
|
|
647
|
-
For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
|
|
648
|
-
`,required:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"conditions"}},displayOptions:{show:{rule_object:["conditions_json"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",description:`Effect of the rule.
|
|
630
|
+
`,displayName:"Validity",name:"validity_number"}],routing:{request:{body:{description:"={{ $value.description_string }}",indexes:"={{ JSON.parse($value.indexes_json) }}",maxHitsPerQuery:"={{ $value.maxHitsPerQuery_number }}",maxQueriesPerIPPerHour:"={{ $value.maxQueriesPerIPPerHour_number }}",queryParameters:"={{ $value.queryParameters_string }}",referers:"={{ JSON.parse($value.referers_json) }}",validity:"={{ $value.validity_number }}"}}},displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}}],Q=[{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"]}}}],K=[...Q,...M,...J,...V,...H,...G],Y=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["clearRules"]}},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 }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["clearRules"]}}}],X=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}},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:"string",default:"",description:"Unique identifier of a rule object.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}}],Z=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["getRule"]}},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:"string",default:"",description:"Unique identifier of a rule object.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["getRule"]}}}],ee=[{type:"json",description:`Effect of the rule.
|
|
649
631
|
|
|
650
632
|
For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
|
|
651
|
-
`,required:!0,default:"{}",routing:{send:{type:"body",property:"consequence",value:"={{ JSON.parse($value) }}"}},displayName:"Consequence",name:"consequence_object",displayOptions:{show:{rule_object:["consequence_object"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",displayOptions:{show:{rule_object:["description_string"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether the rule is active.",routing:{send:{type:"body",value:"={{ $value }}",property:"enabled"}},displayName:"Enabled",name:"enabled_boolean",displayOptions:{show:{rule_object:["enabled_boolean"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"validity"}},displayOptions:{show:{rule_object:["validity_json"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}},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:"string",default:"",description:"Unique identifier of a rule object.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},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:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"boolean",default:!1,routing:{request:{qs:{clearExistingRules:"={{ $value }}"}}},displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!1,routing:{request:{body:"={{ JSON.parse($value) }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["clearRules"]}},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:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Rules"],operation:["clearRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},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 }}"}}]}}}}},{displayName:"Search Rules Params",name:"search_rules_params_object",type:"multiOptions",description:"Rules search parameters.",required:!1,default:[],options:[{name:"Query",value:"query_string"},{name:"Anchoring",value:"anchoring_options"},{name:"Context",value:"context_string"},{name:"Page",value:"page_number"},{name:"Hits Per Page",value:"hitsPerPage_number"},{name:"Enabled",value:"enabled"}],displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}},{type:"string",default:"",description:"Search query for rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_rules_params_object:["query_string"],resource:["Rules"],operation:["searchRules"]}}},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],routing:{send:{type:"body",value:"={{ $value }}",property:"anchoring"}},displayName:"Anchoring",name:"anchoring_options",displayOptions:{show:{search_rules_params_object:["anchoring_options"],resource:["Rules"],operation:["searchRules"]}}},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",routing:{send:{type:"body",value:"={{ $value }}",property:"context"}},displayName:"Context",name:"context_string",displayOptions:{show:{search_rules_params_object:["context_string"],resource:["Rules"],operation:["searchRules"]}}},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia 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)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `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.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},routing:{send:{type:"body",value:"={{ $value }}",property:"page"}},displayName:"Page",name:"page_number",displayOptions:{show:{search_rules_params_object:["page_number"],resource:["Rules"],operation:["searchRules"]}}},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia 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)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `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.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"hitsPerPage"}},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{search_rules_params_object:["hitsPerPage_number"],resource:["Rules"],operation:["searchRules"]}}},{type:"options",name:"enabled",displayName:"Enabled",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Null",value:"null"}],routing:{send:{type:"body",property:"enabled",value:'={{ typeof $parameter.enabled_boolean !== "undefined" ? $parameter.enabled_boolean : typeof $parameter.enabled_null !== "undefined" ? JSON.parse($parameter.enabled_null) : undefined }}'}},displayOptions:{show:{search_rules_params_object:["enabled"],resource:["Rules"],operation:["searchRules"]}}},{type:"boolean",default:!1,description:"If `true`, return only enabled rules.\nIf `false`, return only inactive rules.\nBy default, _all_ rules are returned.\n",displayName:"Enabled (Boolean)",name:"enabled_boolean",displayOptions:{show:{search_rules_params_object:["enabled"],enabled:["boolean"],resource:["Rules"],operation:["searchRules"]}}},{type:"json",displayName:"Enabled (Null)",name:"enabled_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{enabled:["null"]}},displayOptions:{show:{search_rules_params_object:["enabled"],enabled:["null"],resource:["Rules"],operation:["searchRules"]}}},{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Batch Dictionary Entries Params",name:"batch_dictionary_entries_params_object",type:"multiOptions",description:"Request body for updating dictionary entries.",required:!0,default:[],options:[{name:"Clear Existing Dictionary Entries",value:"clearExistingDictionaryEntries_boolean"},{name:"Requests",value:"requests_json"}],displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",routing:{send:{type:"body",value:"={{ $value }}",property:"clearExistingDictionaryEntries"}},displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean",displayOptions:{show:{batch_dictionary_entries_params_object:["clearExistingDictionaryEntries_boolean"],resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{batch_dictionary_entries_params_object:["requests_json"],resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Search Dictionary Entries Params",name:"search_dictionary_entries_params_object",type:"multiOptions",description:"Search parameter.",required:!0,default:[],options:[{name:"Query",value:"query_string"},{name:"Page",value:"page_number"},{name:"Hits Per Page",value:"hitsPerPage_number"},{name:"Language",value:"language_options"}],displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_dictionary_entries_params_object:["query_string"],resource:["Dictionaries"],operation:["searchDictionaryEntries"]}},required:!0},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},routing:{send:{type:"body",value:"={{ $value }}",property:"page"}},displayName:"Page",name:"page_number",displayOptions:{show:{search_dictionary_entries_params_object:["page_number"],resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"hitsPerPage"}},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{search_dictionary_entries_params_object:["hitsPerPage_number"],resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],routing:{send:{type:"body",value:"={{ $value }}",property:"language"}},displayName:"Language",name:"language_options",displayOptions:{show:{search_dictionary_entries_params_object:["language_options"],resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Dictionary Settings Params",name:"dictionary_settings_params_object",type:"multiOptions",description:`Turn on or off the built-in Algolia stop words for a specific language.
|
|
652
|
-
`,required:!0,default:[],options:[{name:"Standard Entries",value:"standard_entries_object"}],displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",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.
|
|
653
|
-
`,required:!0,default:"{}",routing:{send:{type:"body",property:"disableStandardEntries",value:"={{ JSON.parse($value) }}"}},displayName:"Standard Entries",name:"standard_entries_object",displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{displayName:"Assign User Id Params",name:"assign_user_id_params_object",type:"multiOptions",description:"Assign userID parameters.",required:!0,default:[],options:[{name:"Cluster",value:"cluster_string"}],displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",displayOptions:{show:{assign_user_id_params_object:["cluster_string"],resource:["Clusters"],operation:["assignUserId"]}},required:!0},{type:"options",name:"page",displayName:"Page",default:"",options:[{name:"Integer",value:"integer"},{name:"Null",value:"null"}],routing:{request:{qs:{page:'={{ (() => { const value = typeof $parameter.page_number !== "undefined" ? $parameter.page_number : typeof $parameter.page_null !== "undefined" ? JSON.parse($parameter.page_null) : undefined; if (value !== undefined && value !== null) { return value; } return undefined; })() }}'}}},displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}},{type:"number",default:"",typeOptions:{minValue:0},displayName:"Page (Integer)",name:"page_number",displayOptions:{show:{page:["integer"],resource:["Clusters"],operation:["listUserIds"]}}},{type:"json",displayName:"Page (Null)",name:"page_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{page:["null"]}},displayOptions:{show:{page:["null"],resource:["Clusters"],operation:["listUserIds"]}}},{type:"number",default:100,routing:{request:{qs:{hitsPerPage:"={{ $value }}"}}},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{displayName:"Batch Assign User Ids Params",name:"batch_assign_user_ids_params_object",type:"multiOptions",description:"Assign userID parameters.",required:!0,default:[],options:[{name:"Cluster",value:"cluster_string"},{name:"Users",value:"users_json"}],displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",displayOptions:{show:{batch_assign_user_ids_params_object:["cluster_string"],resource:["Clusters"],operation:["batchAssignUserIds"]}},required:!0},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"users"}},displayOptions:{show:{batch_assign_user_ids_params_object:["users_json"],resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["removeUserId"]}}},{displayName:"Search User Ids Params",name:"search_user_ids_params_object",type:"multiOptions",description:"OK",required:!0,default:[],options:[{name:"Query",value:"query_string"},{name:"Cluster Name",value:"clusterName_string"},{name:"Page",value:"page_number"},{name:"Hits Per Page",value:"hitsPerPage_number"}],displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}},{type:"string",default:"",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_user_ids_params_object:["query_string"],resource:["Clusters"],operation:["searchUserIds"]}},required:!0},{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"clusterName"}},displayName:"Cluster Name",name:"clusterName_string",displayOptions:{show:{search_user_ids_params_object:["clusterName_string"],resource:["Clusters"],operation:["searchUserIds"]}}},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},routing:{send:{type:"body",value:"={{ $value }}",property:"page"}},displayName:"Page",name:"page_number",displayOptions:{show:{search_user_ids_params_object:["page_number"],resource:["Clusters"],operation:["searchUserIds"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"hitsPerPage"}},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{search_user_ids_params_object:["hitsPerPage_number"],resource:["Clusters"],operation:["searchUserIds"]}}},{type:"boolean",default:!1,routing:{request:{qs:{getClusters:"={{ $value }}"}}},displayName:"Get Clusters",name:"getClusters_boolean",displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}},{type:"json",displayName:"Sources",name:"sources_json",default:"[]",description:"Sources.",required:!1,routing:{request:{body:"={{ JSON.parse($value) }}"}},displayOptions:{show:{resource:["Vaults"],operation:["replaceSources"]}}},{displayName:"Source",name:"source_object",type:"multiOptions",description:"Source.",required:!0,default:[],options:[{name:"Source",value:"source_string"},{name:"Description",value:"description_string"}],displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}},{type:"string",placeholder:"10.0.0.1/32",default:"",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",displayOptions:{show:{source_object:["source_string"],resource:["Vaults"],operation:["appendSource"]}},required:!0},{type:"string",placeholder:"Server subnet",default:"",description:"Source description.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",displayOptions:{show:{source_object:["description_string"],resource:["Vaults"],operation:["appendSource"]}}},{type:"string",placeholder:"10.0.0.1/32",default:"",displayName:"Source",name:"source_string",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}},{type:"number",default:"",routing:{request:{qs:{offset:"={{ $value }}"}}},displayName:"Offset",name:"offset_number",displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}},{type:"number",default:10,typeOptions:{maxValue:1e3},routing:{request:{qs:{length:"={{ $value }}"}}},displayName:"Length",name:"length_number",displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}},{type:"options",name:"indexName",displayName:"Index Name",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"}],routing:{request:{qs:{indexName:'={{ (() => { const value = typeof $parameter.indexName_string !== "undefined" ? $parameter.indexName_string : typeof $parameter.indexName_null !== "undefined" ? JSON.parse($parameter.indexName_null) : undefined; if (value !== undefined && value !== null) { return value; } return undefined; })() }}'}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}},{type:"options",default:"",displayName:"Index Name (String)",name:"indexName_string",displayOptions:{show:{indexName:["string"],resource:["Advanced"],operation:["getLogs"]}},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:"json",displayName:"Index Name (Null)",name:"indexName_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{indexName:["null"]}},displayOptions:{show:{indexName:["null"],resource:["Advanced"],operation:["getLogs"]}}},{type:"options",default:"all",options:[{name:"all",value:"all"},{name:"query",value:"query"},{name:"build",value:"build"},{name:"error",value:"error"}],routing:{request:{qs:{type:"={{ $value }}"}}},displayName:"Type",name:"type_options",displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}},{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},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:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},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 }}"}}]}}}}},{displayName:"Operation Index Params",name:"operation_index_params_object",type:"multiOptions",description:void 0,required:!0,default:[],options:[{name:"Operation",value:"operation_options"},{name:"Destination",value:"destination_string"},{name:"Scope",value:"scope_json"}],displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",displayOptions:{show:{operation_index_params_object:["operation_options"],resource:["Indices"],operation:["operationIndex"]}},required:!0},{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",displayOptions:{show:{operation_index_params_object:["destination_string"],resource:["Indices"],operation:["operationIndex"]}},required:!0},{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
633
|
+
`,required:!0,default:"{}",routing:{send:{type:"body",property:"consequence",value:"={{ JSON.parse($value) }}"}},displayName:"Consequence",name:"consequence_object",displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}},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:"string",default:"",description:"Unique identifier of a rule object.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",description:"Unique identifier of a rule object.",routing:{send:{type:"body",value:"={{ $value }}",property:"objectID"}},displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Conditions",name:"conditions_json",default:"[]",description:`Conditions that trigger a rule.
|
|
654
634
|
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
`,required:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"scope"}},displayOptions:{show:{operation_index_params_object:["scope_json"],resource:["Indices"],operation:["operationIndex"]}}},{type:"options",name:"page",displayName:"Page",default:"",options:[{name:"Integer",value:"integer"},{name:"Null",value:"null"}],routing:{request:{qs:{page:'={{ (() => { const value = typeof $parameter.page_number !== "undefined" ? $parameter.page_number : typeof $parameter.page_null !== "undefined" ? JSON.parse($parameter.page_null) : undefined; if (value !== undefined && value !== null) { return value; } return undefined; })() }}'}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}},{type:"number",default:"",typeOptions:{minValue:0},displayName:"Page (Integer)",name:"page_number",displayOptions:{show:{page:["integer"],resource:["Indices"],operation:["listIndices"]}}},{type:"json",displayName:"Page (Null)",name:"page_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{page:["null"]}},displayOptions:{show:{page:["null"],resource:["Indices"],operation:["listIndices"]}}},{type:"number",default:100,routing:{request:{qs:{hitsPerPage:"={{ $value }}"}}},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}];class d{constructor(){this.description={name:"algolia",displayName:"Algolia",description:"Use Algolia in your n8n workflows",subtitle:'={{ $parameter.operation.replace(/([a-z])([A-Z])/g, "$1 $2").toTitleCase() }}',icon:"file:../../algolia.svg",defaults:{name:"Algolia"},credentials:[{name:"algoliaApi",required:!0}],requestDefaults:{baseURL:"=https://{{ $credentials.appId }}.algolia.net",headers:{"User-Agent":`${i.name} (${i.version})`}},version:1,inputs:[o.NodeConnectionTypes.Main],outputs:[o.NodeConnectionTypes.Main],properties:u,group:[]}}}exports.Algolia=d;
|
|
635
|
+
Some consequences require specific conditions or don't require any condition.
|
|
636
|
+
For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
|
|
637
|
+
`,required:!1},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",displayName:"Description",name:"description_string"},{type:"boolean",default:!0,description:"Whether the rule is active.",displayName:"Enabled",name:"enabled_boolean"},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1}],routing:{request:{body:{conditions:"={{ JSON.parse($value.conditions_json) }}",description:"={{ $value.description_string }}",enabled:"={{ $value.enabled_boolean }}",validity:"={{ JSON.parse($value.validity_json) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}}],te=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},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 }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",description:"Whether existing rules should be deleted before adding this batch."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",clearExistingRules:"={{ $value.clearExistingRules_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}}],ae=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},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 }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query for rules.",displayName:"Query",name:"query_string"},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],displayName:"Anchoring",name:"anchoring_options"},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",displayName:"Context",name:"context_string"},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia 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)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `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.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia 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)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `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.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"json",name:"enabled",displayName:"Enabled",default:""}],routing:{request:{body:{query:"={{ $value.query_string }}",anchoring:"={{ $value.anchoring_options }}",context:"={{ $value.context_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",enabled:"={{ JSON.parse($value.enabled) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}}],se=[{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"]}}}],re=[...se,...Y,...X,...Z,...ee,...te,...ae],ne=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean"}],routing:{request:{body:{clearExistingDictionaryEntries:"={{ $value.clearExistingDictionaryEntries_boolean }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}}],ie=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],displayName:"Language",name:"language_options"}],routing:{request:{body:{page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",language:"={{ $value.language_options }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}}],oe=[{type:"json",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.
|
|
638
|
+
`,required:!0,default:"{}",routing:{send:{type:"body",property:"disableStandardEntries",value:"={{ JSON.parse($value) }}"}},displayName:"Disable Standard Entries",name:"disable_standard_entries_object",displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}}],le=[{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"]}}}],pe=[...le,...ne,...ie,...oe],de=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}}],ue=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"users"}},displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}}],ce=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}}],me=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Get Clusters",name:"getClusters_boolean",description:"Whether to include the cluster's pending mapping state in the response."}],routing:{request:{qs:{getClusters:"={{ $value.getClusters_boolean }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}}],he=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}}],ye=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["removeUserId"]}}}],ge=[{type:"string",default:"",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",displayName:"Cluster Name",name:"clusterName_string"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{clusterName:"={{ $value.clusterName_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}}],fe=[{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"]}}}],be=[...fe,...de,...ue,...ce,...me,...he,...ye,...ge],we=[{type:"string",placeholder:"10.0.0.1/32",default:"",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Server subnet",default:"",description:"Source description.",displayName:"Description",name:"description_string"}],routing:{request:{body:{description:"={{ $value.description_string }}"}}},displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}}],_e=[{type:"string",placeholder:"10.0.0.1/32",default:"",displayName:"Source",name:"source_string",required:!0,description:"IP address range of the source.",displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}}],ve=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Sources.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Vaults"],operation:["replaceSources"]}}}],Ne=[{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"]}}}],xe=[...Ne,...we,..._e,...ve],Oe=[{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}}],Pe=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:"",displayName:"Offset",name:"offset_number",description:"First log entry to retrieve. The most recent entries are listed first."},{type:"number",default:10,typeOptions:{maxValue:1e3},displayName:"Length",name:"length_number",description:"Maximum number of entries to retrieve."},{type:"json",name:"indexName",displayName:"Index Name",default:"",description:`Index for which to retrieve log entries.
|
|
639
|
+
By default, log entries are retrieved for all indices.
|
|
640
|
+
`},{type:"options",default:"all",options:[{name:"all",value:"all"},{name:"query",value:"query"},{name:"build",value:"build"},{name:"error",value:"error"}],displayName:"Type",name:"type_options",description:`Type of log entries to retrieve.
|
|
641
|
+
By default, all log entries are retrieved.
|
|
642
|
+
`}],routing:{request:{qs:{offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",indexName:"={{ JSON.parse($value.indexName) }}",type:"={{ $value.type_options }}"}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}}],Ae=[{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"]}}}],Te=[...Ae,...Oe,...Pe],qe=[{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"}]}],Se=[...qe,...y,...T,...D,...U,...K,...re,...pe,...be,...xe,...Te];class Ie{constructor(){this.description={name:"algolia",displayName:"Algolia",description:"Use Algolia in your n8n workflows",subtitle:'={{ $parameter.operation.replace(/([a-z])([A-Z])/g, "$1 $2").toTitleCase() }}',icon:"file:../../algolia.svg",defaults:{name:"Algolia"},credentials:[{name:"algoliaApi",required:!0}],requestDefaults:{baseURL:"=https://{{ $credentials.appId }}.algolia.net",headers:{"User-Agent":`${o.name} (${o.version})`}},version:1,inputs:[i.NodeConnectionTypes.Main],outputs:[i.NodeConnectionTypes.Main],properties:Se,group:[]}}}exports.Algolia=Ie;
|