@algolia/n8n-nodes-algolia 0.8.0 → 0.8.1
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 +112 -114
- package/package.json +1 -1
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",u="0.8.0",i={name:l,version:u},c=[{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 n=s.json||{},t=new Map;return["hits","params","query"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):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 n=s.json||{},t=new Map;return["hits","params","query"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):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 n=s.json||{},t=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):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",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",default:"",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 Object",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 Object",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",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",default:"",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",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",default:"",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",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",default:"",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",displayName:"Facet Filters (String)",name:"facetFilters_string",default:"",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",displayName:"Optional Filters (String)",name:"optionalFilters_string",default:"",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",displayName:"Numeric Filters (String)",name:"numericFilters_string",default:"",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",displayName:"Tag Filters (String)",name:"tagFilters_string",default:"",displayOptions:{show:{tagFilters:["string"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",description:`Whether to sum all filter scores
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("n8n-workflow"),u="@algolia/n8n-nodes-algolia",l="0.8.1",i={name:u,version:l},c=[{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 n=s.json||{},t=new Map;return["hits","params","query"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):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 n=s.json||{},t=new Map;return["hits","params","query"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):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 n=s.json||{},t=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{n[e]!==void 0&&t.set(e,n[e])}),{json:Object.fromEntries(t)}}):a}]}},inputSchema:{simplifiedOutput:["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"]}},{name:"Update index settings",value:"setSettings",action:"Update index settings",description:"Update the specified index settings.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"}}},{name:"Check task status",value:"getTask",action:"Check task status",description:"Checks the status of a given task.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/task/{{ $parameter.taskID_number }}"}}},{name:"Copy or move an index",value:"operationIndex",action:"Copy or move an index",description:"Copies or moves (renames) an index within the same Algolia application.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/operation"}}},{name:"List indices",value:"listIndices",action:"List indices",description:"Lists all indices in the current Algolia application.",routing:{request:{method:"GET",url:"=/1/indexes"}}}],displayOptions:{show:{resource:["Indices"]}}},{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a synonym",value:"getSynonym",action:"Retrieve a synonym",description:"Retrieves a synonym by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a synonym",value:"saveSynonym",action:"Create or replace a synonym",description:"If a synonym with the specified object ID doesn't exist, Algolia adds a new one.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Delete a synonym",value:"deleteSynonym",action:"Delete a synonym",description:"Deletes a synonym by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace synonyms",value:"saveSynonyms",action:"Create or replace synonyms",description:"If a synonym with the `objectID` doesn't exist, Algolia adds a new one.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/batch"}}},{name:"Delete all synonyms",value:"clearSynonyms",action:"Delete all synonyms",description:"Deletes all synonyms from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/clear"}}},{name:"Search for synonyms",value:"searchSynonyms",action:"Search for synonyms",description:"Searches for synonyms in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/search"}}}],displayOptions:{show:{resource:["Synonyms"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List API keys",value:"listApiKeys",action:"List API keys",description:"Lists all API keys associated with your Algolia application, including their permissions and restrictions.",routing:{request:{method:"GET",url:"=/1/keys"}}},{name:"Create an API key",value:"addApiKey",action:"Create an API key",description:"Creates a new API key with specific permissions and restrictions.",routing:{request:{method:"POST",url:"=/1/keys"}}},{name:"Retrieve API key permissions",value:"getApiKey",action:"Retrieve API key permissions",description:"Gets the permissions and restrictions of an API key.",routing:{request:{method:"GET",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Update an API key",value:"updateApiKey",action:"Update an API key",description:"Replaces the permissions of an existing API key.",routing:{request:{method:"PUT",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Delete an API key",value:"deleteApiKey",action:"Delete an API key",description:"Deletes the API key.",routing:{request:{method:"DELETE",url:"=/1/keys/{{ $parameter.key_string }}"}}},{name:"Restore an API key",value:"restoreApiKey",action:"Restore an API key",description:"Restores a deleted API key.",routing:{request:{method:"POST",url:"=/1/keys/{{ $parameter.key_string }}/restore"}}}],displayOptions:{show:{resource:["Api Keys"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}},{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",name:"searchParams",displayName:"Search Params",default:"",options:[{name:"Search parameters as query string",value:"search_parameters_as_query_string"},{name:"Search parameters as object",value:"search_parameters_as_object"}],routing:{send:{type:"body",property:void 0,value:"={{ undefined }}"}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",displayOptions:{show:{searchParams:["search_parameters_as_query_string"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"multiOptions",name:"search_parameters_as_object",displayName:"Search Parameters As Object",description:"Each parameter value, including the `query` must not be larger than 512 bytes.",default:[],options:[{name:"Query",value:"query_string"},{name:"Similar Query",value:"similarquery_string"},{name:"Filters",value:"filters_string"},{name:"Facet Filters",value:"facetfilters"},{name:"Optional Filters",value:"optionalfilters"},{name:"Numeric Filters",value:"numericfilters"},{name:"Tag Filters",value:"tagfilters"},{name:"Sum Or Filters Scores",value:"sumorfiltersscores_boolean"},{name:"Restrict Searchable Attributes",value:"restrictsearchableattributes_json"},{name:"Facets",value:"facets_json"},{name:"Faceting After Distinct",value:"facetingafterdistinct_boolean"},{name:"Page",value:"page_number"},{name:"Offset",value:"offset_number"},{name:"Length",value:"length_number"},{name:"Around Lat Lng",value:"aroundlatlng_string"},{name:"Around Lat Lng Via IP",value:"aroundlatlngviaip_boolean"},{name:"Around Radius",value:"aroundradius"},{name:"Around Precision",value:"aroundprecision"},{name:"Minimum Around Radius",value:"minimumaroundradius_number"},{name:"Inside Bounding Box",value:"insideboundingbox"},{name:"Inside Polygon",value:"insidepolygon_json"},{name:"Natural Languages",value:"naturallanguages_json"},{name:"Rule Contexts",value:"rulecontexts_json"},{name:"Personalization Impact",value:"personalizationimpact_number"},{name:"User Token",value:"usertoken_string"},{name:"Get Ranking Info",value:"getrankinginfo_boolean"},{name:"Synonyms",value:"synonyms_boolean"},{name:"Click Analytics",value:"clickanalytics_boolean"},{name:"Analytics",value:"analytics_boolean"},{name:"Analytics Tags",value:"analyticstags_json"},{name:"Percentile Computation",value:"percentilecomputation_boolean"},{name:"Enable ABTest",value:"enableabtest_boolean"},{name:"Attributes To Retrieve",value:"attributestoretrieve_json"},{name:"Ranking",value:"ranking_json"},{name:"Relevancy Strictness",value:"relevancystrictness_number"},{name:"Attributes To Highlight",value:"attributestohighlight_json"},{name:"Attributes To Snippet",value:"attributestosnippet_json"},{name:"Highlight Pre Tag",value:"highlightpretag_string"},{name:"Highlight Post Tag",value:"highlightposttag_string"},{name:"Snippet Ellipsis Text",value:"snippetellipsistext_string"},{name:"Restrict Highlight And Snippet Arrays",value:"restricthighlightandsnippetarrays_boolean"},{name:"Hits Per Page",value:"hitsperpage_number"},{name:"Min Word Sizefor1Typo",value:"minwordsizefor1typo_number"},{name:"Min Word Sizefor2Typos",value:"minwordsizefor2typos_number"},{name:"Typo Tolerance",value:"typotolerance"},{name:"Allow Typos On Numeric Tokens",value:"allowtyposonnumerictokens_boolean"},{name:"Disable Typo Tolerance On Attributes",value:"disabletypotoleranceonattributes_json"},{name:"Ignore Plurals",value:"ignoreplurals"},{name:"Remove Stop Words",value:"removestopwords"},{name:"Query Languages",value:"querylanguages_json"},{name:"Decompound Query",value:"decompoundquery_boolean"},{name:"Enable Rules",value:"enablerules_boolean"},{name:"Enable Personalization",value:"enablepersonalization_boolean"},{name:"Query Type",value:"querytype_options"},{name:"Remove Words If No Results",value:"removewordsifnoresults_options"},{name:"Mode",value:"mode_options"},{name:"Semantic Search",value:"semantic_search_object"},{name:"Advanced Syntax",value:"advancedsyntax_boolean"},{name:"Optional Words",value:"optionalwords"},{name:"Disable Exact On Attributes",value:"disableexactonattributes_json"},{name:"Exact On Single Word Query",value:"exactonsinglewordquery_options"},{name:"Alternatives As Exact",value:"alternativesasexact_json"},{name:"Advanced Syntax Features",value:"advancedsyntaxfeatures_json"},{name:"Distinct",value:"distinct"},{name:"Replace Synonyms In Highlight",value:"replacesynonymsinhighlight_boolean"},{name:"Min Proximity",value:"minproximity_number"},{name:"Response Fields",value:"responsefields_json"},{name:"Max Values Per Facet",value:"maxvaluesperfacet_number"},{name:"Sort Facet Values By",value:"sortfacetvaluesby_string"},{name:"Attribute Criteria Computed By Min Proximity",value:"attributecriteriacomputedbyminproximity_boolean"},{name:"Rendering Content",value:"rendering_content_object"},{name:"Enable Re Ranking",value:"enablereranking_boolean"},{name:"Re Ranking Apply Filter",value:"rerankingapplyfilter"}],displayOptions:{show:{searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_parameters_as_object:["query_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"similarQuery"}},displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{search_parameters_as_object:["similarquery_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",routing:{send:{type:"body",value:"={{ $value }}",property:"filters"}},displayName:"Filters",name:"filters_string",displayOptions:{show:{search_parameters_as_object:["filters_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"facetFilters",displayName:"Facet Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"facetFilters",value:'={{ typeof $parameter.facetFilters_json !== "undefined" ? JSON.parse($parameter.facetFilters_json) : typeof $parameter.facetFilters_string !== "undefined" ? $parameter.facetFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{facetFilters:["array"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string",displayOptions:{show:{facetFilters:["string"],search_parameters_as_object:["facetfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"optionalFilters",displayName:"Optional Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"optionalFilters",value:'={{ typeof $parameter.optionalFilters_json !== "undefined" ? JSON.parse($parameter.optionalFilters_json) : typeof $parameter.optionalFilters_string !== "undefined" ? $parameter.optionalFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{optionalFilters:["array"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Optional Filters (String)",name:"optionalFilters_string",displayOptions:{show:{optionalFilters:["string"],search_parameters_as_object:["optionalfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"numericFilters",displayName:"Numeric Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"numericFilters",value:'={{ typeof $parameter.numericFilters_json !== "undefined" ? JSON.parse($parameter.numericFilters_json) : typeof $parameter.numericFilters_string !== "undefined" ? $parameter.numericFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{numericFilters:["array"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string",displayOptions:{show:{numericFilters:["string"],search_parameters_as_object:["numericfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"tagFilters",displayName:"Tag Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],routing:{send:{type:"body",property:"tagFilters",value:'={{ typeof $parameter.tagFilters_json !== "undefined" ? JSON.parse($parameter.tagFilters_json) : typeof $parameter.tagFilters_string !== "undefined" ? $parameter.tagFilters_string : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json",default:"[]",description:void 0,required:!1,displayOptions:{show:{tagFilters:["array"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string",displayOptions:{show:{tagFilters:["string"],search_parameters_as_object:["tagfilters"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
2
2
|
If true, all filter scores are summed.
|
|
3
3
|
Otherwise, the maximum filter score is kept.
|
|
4
4
|
For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
|
|
5
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sumOrFiltersScores"}},displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",
|
|
5
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sumOrFiltersScores"}},displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{search_parameters_as_object:["sumorfiltersscores_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
7
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictSearchableAttributes"}},displayOptions:{show:{search_parameters_as_object:["restrictsearchableattributes_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
10
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"facets"}},displayOptions:{show:{search_parameters_as_object:["facets_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"facetingAfterDistinct"}},displayName:"Faceting After Distinct",name:"facetingAfterDistinct_boolean",displayOptions:{show:{search_parameters_as_object:["facetingafterdistinct_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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_parameters_as_object:["page_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",routing:{send:{type:"body",value:"={{ $value }}",property:"offset"}},displayName:"Offset",name:"offset_number",displayOptions:{show:{search_parameters_as_object:["offset_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"length"}},displayName:"Length",name:"length_number",displayOptions:{show:{search_parameters_as_object:["length_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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:{search_parameters_as_object:["aroundlatlng_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"Whether to obtain the coordinates from the request's IP address.",routing:{send:{type:"body",value:"={{ $value }}",property:"aroundLatLngViaIP"}},displayName:"Around Lat Lng Via IP",name:"aroundLatLngViaIP_boolean",displayOptions:{show:{search_parameters_as_object:["aroundlatlngviaip_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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:{search_parameters_as_object:["aroundradius"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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:{aroundRadius:["integer"],search_parameters_as_object:["aroundradius"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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:{aroundRadius:["all"],search_parameters_as_object:["aroundradius"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"aroundPrecision",displayName:"Around Precision",default:"",options:[{name:"Integer",value:"integer"},{name:"Range objects",value:"range_objects"}],routing:{send:{type:"body",property:"aroundPrecision",value:'={{ typeof $parameter.aroundPrecision_number !== "undefined" ? $parameter.aroundPrecision_number : typeof $parameter.aroundPrecision_json !== "undefined" ? JSON.parse($parameter.aroundPrecision_json) : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["aroundprecision"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:10,description:`Distance in meters to group results by similar distances.
|
|
11
11
|
|
|
12
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
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:"
|
|
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
15
|
|
|
16
16
|
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
17
17
|
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
@@ -23,16 +23,16 @@ Polygons are defined by 3 to 10,000 points. Each point is represented by its lat
|
|
|
23
23
|
Provide multiple polygons as nested arrays.
|
|
24
24
|
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
25
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
26
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
26
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"insidePolygon"}},displayOptions:{show:{search_parameters_as_object:["insidepolygon_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"naturalLanguages"}},displayOptions:{show:{search_parameters_as_object:["naturallanguages_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Rule Contexts",name:"ruleContexts_json",default:"[]",description:`Assigns a rule context to the search query
|
|
27
27
|
[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,routing:{send:{type:"body",value:"={{
|
|
28
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"ruleContexts"}},displayOptions:{show:{search_parameters_as_object:["rulecontexts_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
29
29
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
30
30
|
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},routing:{send:{type:"body",value:"={{ $value }}",property:"personalizationImpact"}},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{search_parameters_as_object:["personalizationimpact_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"test-user-123",description:`Unique pseudonymous or anonymous user identifier.
|
|
31
|
+
`,typeOptions:{minValue:0,maxValue:100},routing:{send:{type:"body",value:"={{ $value }}",property:"personalizationImpact"}},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{search_parameters_as_object:["personalizationimpact_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
32
32
|
|
|
33
33
|
This helps with analytics and click and conversion events.
|
|
34
34
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
35
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"userToken"}},displayName:"User Token",name:"userToken_string",
|
|
35
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"userToken"}},displayName:"User Token",name:"userToken_string",displayOptions:{show:{search_parameters_as_object:["usertoken_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",routing:{send:{type:"body",value:"={{ $value }}",property:"getRankingInfo"}},displayName:"Get Ranking Info",name:"getRankingInfo_boolean",displayOptions:{show:{search_parameters_as_object:["getrankinginfo_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",routing:{send:{type:"body",value:"={{ $value }}",property:"synonyms"}},displayName:"Synonyms",name:"synonyms_boolean",displayOptions:{show:{search_parameters_as_object:["synonyms_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"clickAnalytics"}},displayName:"Click Analytics",name:"clickAnalytics_boolean",displayOptions:{show:{search_parameters_as_object:["clickanalytics_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",routing:{send:{type:"body",value:"={{ $value }}",property:"analytics"}},displayName:"Analytics",name:"analytics_boolean",displayOptions:{show:{search_parameters_as_object:["analytics_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"analyticsTags"}},displayOptions:{show:{search_parameters_as_object:["analyticstags_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",routing:{send:{type:"body",value:"={{ $value }}",property:"percentileComputation"}},displayName:"Percentile Computation",name:"percentileComputation_boolean",displayOptions:{show:{search_parameters_as_object:["percentilecomputation_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",routing:{send:{type:"body",value:"={{ $value }}",property:"enableABTest"}},displayName:"Enable ABTest",name:"enableABTest_boolean",displayOptions:{show:{search_parameters_as_object:["enableabtest_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToRetrieve"}},displayOptions:{show:{search_parameters_as_object:["attributestoretrieve_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
36
36
|
|
|
37
37
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
38
38
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -49,19 +49,19 @@ you put the sorting attribute at the top of the list.
|
|
|
49
49
|
Before you modify the default setting,
|
|
50
50
|
you should test your changes in the dashboard,
|
|
51
51
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
52
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
52
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"ranking"}},displayOptions:{show:{search_parameters_as_object:["ranking_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
53
53
|
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
54
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
55
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{search_parameters_as_object:["relevancystrictness_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
55
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{search_parameters_as_object:["relevancystrictness_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToHighlight"}},displayOptions:{show:{search_parameters_as_object:["attributestohighlight_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
56
56
|
Attribute names are case-sensitive
|
|
57
57
|
Snippets provide additional context to matched words.
|
|
58
58
|
If you enable snippets, they include 10 words, including the matched word.
|
|
59
59
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
60
60
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
61
61
|
where \`NUMBER\` is the number of words to be extracted.
|
|
62
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
62
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToSnippet"}},displayOptions:{show:{search_parameters_as_object:["attributestosnippet_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPreTag"}},displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{search_parameters_as_object:["highlightpretag_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPostTag"}},displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{search_parameters_as_object:["highlightposttag_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",routing:{send:{type:"body",value:"={{ $value }}",property:"snippetEllipsisText"}},displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{search_parameters_as_object:["snippetellipsistext_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
63
63
|
By default, all items are highlighted and snippeted.
|
|
64
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",
|
|
64
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{search_parameters_as_object:["restricthighlightandsnippetarrays_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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_parameters_as_object:["hitsperpage_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor1Typo"}},displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{search_parameters_as_object:["minwordsizefor1typo_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor2Typos"}},displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{search_parameters_as_object:["minwordsizefor2typos_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"typoTolerance",displayName:"Typo Tolerance",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Typo tolerance",value:"typo_tolerance"}],routing:{send:{type:"body",property:"typoTolerance",value:'={{ typeof $parameter.typoTolerance_boolean !== "undefined" ? $parameter.typoTolerance_boolean : typeof $parameter.typoTolerance_options !== "undefined" ? $parameter.typoTolerance_options : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["typotolerance"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.",displayName:"Typo Tolerance (Boolean)",name:"typoTolerance_boolean",displayOptions:{show:{typoTolerance:["boolean"],search_parameters_as_object:["typotolerance"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",default:"",description:"- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",options:[{name:"min",value:"min"},{name:"strict",value:"strict"},{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Typo Tolerance (Typo Tolerance)",name:"typoTolerance_options",displayOptions:{show:{typoTolerance:["typo_tolerance"],search_parameters_as_object:["typotolerance"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
65
65
|
Turn off this setting to reduce the number of irrelevant matches
|
|
66
66
|
when searching in large sets of similar numbers.
|
|
67
67
|
`,routing:{send:{type:"body",value:"={{ $value }}",property:"allowTyposOnNumericTokens"}},displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{search_parameters_as_object:["allowtyposonnumerictokens_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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).
|
|
@@ -71,7 +71,7 @@ Returning only exact matches can help when
|
|
|
71
71
|
- Reducing the number of matches when you have too many.
|
|
72
72
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
73
73
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
74
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
74
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableTypoToleranceOnAttributes"}},displayOptions:{show:{search_parameters_as_object:["disabletypotoleranceonattributes_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",options:[{name:"Array",value:"array"},{name:"Boolean string",value:"boolean_string"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"ignorePlurals",value:'={{ typeof $parameter.ignorePlurals_json !== "undefined" ? JSON.parse($parameter.ignorePlurals_json) : typeof $parameter.ignorePlurals_options !== "undefined" ? $parameter.ignorePlurals_options : typeof $parameter.ignorePlurals_boolean !== "undefined" ? $parameter.ignorePlurals_boolean : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["ignoreplurals"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Ignore Plurals (Array)",name:"ignorePlurals_json",default:"[]",description:"ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",required:!1,displayOptions:{show:{ignorePlurals:["array"],search_parameters_as_object:["ignoreplurals"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",default:"",options:[{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Ignore Plurals (Boolean String)",name:"ignorePlurals_options",displayOptions:{show:{ignorePlurals:["boolean_string"],search_parameters_as_object:["ignoreplurals"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.\nIf false, singulars, plurals, and other declensions won't be considered equivalent.\n",displayName:"Ignore Plurals (Boolean)",name:"ignorePlurals_boolean",displayOptions:{show:{ignorePlurals:["boolean"],search_parameters_as_object:["ignoreplurals"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"removeStopWords",displayName:"Remove Stop Words",default:"",options:[{name:"Array",value:"array"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"removeStopWords",value:'={{ typeof $parameter.removeStopWords_json !== "undefined" ? JSON.parse($parameter.removeStopWords_json) : typeof $parameter.removeStopWords_boolean !== "undefined" ? $parameter.removeStopWords_boolean : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["removestopwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Remove Stop Words (Array)",name:"removeStopWords_json",default:"[]",description:"ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.",required:!1,displayOptions:{show:{removeStopWords:["array"],search_parameters_as_object:["removestopwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n",displayName:"Remove Stop Words (Boolean)",name:"removeStopWords_boolean",displayOptions:{show:{removeStopWords:["boolean"],search_parameters_as_object:["removestopwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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
75
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
76
76
|
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
77
|
To support this, you must place the CJK language **first**
|
|
@@ -80,7 +80,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
80
80
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
81
81
|
This can lead to unexpected search results.
|
|
82
82
|
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,routing:{send:{type:"body",value:"={{
|
|
83
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"queryLanguages"}},displayOptions:{show:{search_parameters_as_object:["querylanguages_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"decompoundQuery"}},displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{search_parameters_as_object:["decompoundquery_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"enableRules"}},displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{search_parameters_as_object:["enablerules_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",routing:{send:{type:"body",value:"={{ $value }}",property:"enablePersonalization"}},displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{search_parameters_as_object:["enablepersonalization_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
84
84
|
|
|
85
85
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
86
86
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -112,13 +112,13 @@ This setting only applies to indices, for which Algolia enabled NeuralSearch for
|
|
|
112
112
|
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],routing:{send:{type:"body",value:"={{ $value }}",property:"mode"}},displayName:"Mode",name:"mode_options",displayOptions:{show:{search_parameters_as_object:["mode_options"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Semantic Search",name:"semantic_search_object",type:"multiOptions",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:[],options:[{name:"Event Sources",value:"eventSources_semanticSearch"}],routing:{send:{type:"body",property:"semanticSearch",value:'={{ { "eventSources": typeof $parameter.eventSources_json_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_json_semanticSearch) : typeof $parameter.eventSources_null_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_null_semanticSearch) : undefined } }}'}},displayOptions:{show:{search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"eventSources_semanticSearch",displayName:"Event Sources",default:"",options:[{name:"Array",value:"array"},{name:"Null",value:"null"}],displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Event Sources (Array)",name:"eventSources_json_semanticSearch",default:"[]",description:`Indices from which to collect click and conversion events.
|
|
113
113
|
|
|
114
114
|
If null, the current index and all its replicas are used.
|
|
115
|
-
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",
|
|
115
|
+
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],search_parameters_as_object:["semantic_search_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{search_parameters_as_object:["advancedsyntax_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"optionalWords",displayName:"Optional Words",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Optional words array",value:"optional_words_array"}],routing:{send:{type:"body",property:"optionalWords",value:'={{ typeof $parameter.optionalWords_string !== "undefined" ? $parameter.optionalWords_string : typeof $parameter.optionalWords_null !== "undefined" ? JSON.parse($parameter.optionalWords_null) : typeof $parameter.optionalWords_json !== "undefined" ? JSON.parse($parameter.optionalWords_json) : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["optionalwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Optional Words (String)",name:"optionalWords_string",displayOptions:{show:{optionalWords:["string"],search_parameters_as_object:["optionalwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Optional Words (Null)",name:"optionalWords_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{optionalWords:["null"]}},displayOptions:{show:{optionalWords:["null"],search_parameters_as_object:["optionalwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Optional Words (Optional Words Array)",name:"optionalWords_json",default:"[]",description:"List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).",required:!1,displayOptions:{show:{optionalWords:["optional_words_array"],search_parameters_as_object:["optionalwords"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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).
|
|
116
116
|
Attribute names are case-sensitive
|
|
117
117
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
118
118
|
such as product descriptions.
|
|
119
119
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
120
120
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
121
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
121
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableExactOnAttributes"}},displayOptions:{show:{search_parameters_as_object:["disableexactonattributes_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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.
|
|
122
122
|
|
|
123
123
|
- \`attribute\`.
|
|
124
124
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -143,11 +143,11 @@ For example
|
|
|
143
143
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
144
144
|
- \`multiWordsSynonym\`.
|
|
145
145
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
146
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
146
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"alternativesAsExact"}},displayOptions:{show:{search_parameters_as_object:["alternativesasexact_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntaxFeatures"}},displayOptions:{show:{search_parameters_as_object:["advancedsyntaxfeatures_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"options",name:"distinct",displayName:"Distinct",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Integer",value:"integer"}],routing:{send:{type:"body",property:"distinct",value:'={{ typeof $parameter.distinct_boolean !== "undefined" ? $parameter.distinct_boolean : typeof $parameter.distinct_number !== "undefined" ? $parameter.distinct_number : undefined }}'}},displayOptions:{show:{search_parameters_as_object:["distinct"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!1,description:"Whether deduplication is turned on. If true, only one member of a group is shown in the search results.",displayName:"Distinct (Boolean)",name:"distinct_boolean",displayOptions:{show:{distinct:["boolean"],search_parameters_as_object:["distinct"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:"",description:"Number of members of a group of records to include in the search results.\n\n- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",typeOptions:{minValue:0,maxValue:4},displayName:"Distinct (Integer)",name:"distinct_number",displayOptions:{show:{distinct:["integer"],search_parameters_as_object:["distinct"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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',routing:{send:{type:"body",value:"={{ $value }}",property:"replaceSynonymsInHighlight"}},displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{search_parameters_as_object:["replacesynonymsinhighlight_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
147
147
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
148
148
|
by equally scoring matches that are farther apart
|
|
149
149
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
150
|
-
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{search_parameters_as_object:["minproximity_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
150
|
+
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{search_parameters_as_object:["minproximity_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"responseFields"}},displayOptions:{show:{search_parameters_as_object:["responsefields_json"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"maxValuesPerFacet"}},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{search_parameters_as_object:["maxvaluesperfacet_number"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
151
151
|
- \`count\`.
|
|
152
152
|
Facet values are retrieved by decreasing count.
|
|
153
153
|
The count is the number of matching records containing this facet value
|
|
@@ -155,29 +155,29 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
155
155
|
Retrieve facet values alphabetically
|
|
156
156
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
157
157
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
158
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{search_parameters_as_object:["sortfacetvaluesby_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",
|
|
158
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{search_parameters_as_object:["sortfacetvaluesby_string"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{search_parameters_as_object:["attributecriteriacomputedbyminproximity_boolean"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Rendering Content",name:"rendering_content_object",type:"multiOptions",description:`Extra data that can be used in the search UI.
|
|
159
159
|
|
|
160
160
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
161
161
|
without changing your frontend code.
|
|
162
|
-
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect
|
|
162
|
+
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect URL",value:"redirect_url_object_renderingContent"},{name:"Widgets",value:"widgets_object_renderingContent"}],routing:{send:{type:"body",property:"renderingContent",value:'={{ { "facetOrdering": { "facets": { "order": typeof $parameter.order_json_facets_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.order_json_facets_facetOrdering_renderingContent) : undefined }, "values": typeof $parameter.values_object_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.values_object_facetOrdering_renderingContent) : undefined }, "redirect": { "url": typeof $parameter.url_string_redirect_renderingContent !== "undefined" ? $parameter.url_string_redirect_renderingContent : undefined }, "widgets": { "banners": typeof $parameter.banners_json_widgets_renderingContent !== "undefined" ? JSON.parse($parameter.banners_json_widgets_renderingContent) : undefined } } }}'}},displayOptions:{show:{search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Facet Ordering",name:"facet_ordering_object_renderingContent",type:"multiOptions",description:"Order of facet names and facet values in your UI.",required:!1,default:[],options:[{name:"Facets",value:"facets_object_facetOrdering"},{name:"Values",value:"values_object_facetOrdering"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Facets",name:"facets_object_facetOrdering_renderingContent",type:"multiOptions",description:"Order of facet names.",required:!1,default:[],options:[{name:"Order",value:"order_json_facets"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Order",name:"order_json_facets_facetOrdering_renderingContent",default:"[]",description:`Explicit order of facets or facet values.
|
|
163
163
|
|
|
164
164
|
This setting lets you always show specific facets or facet values at the top of the list.
|
|
165
|
-
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{
|
|
165
|
+
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Values",name:"values_object_facetOrdering_renderingContent",description:"Order of facet values. One object for each facet.",required:!1,default:"{}",displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["values_object_facetOrdering"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Redirect URL",name:"redirect_url_object_renderingContent",type:"multiOptions",description:"The redirect rule container.",required:!1,default:[],options:[{name:"Url",value:"url_string_redirect"}],displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"string",default:"",displayName:"Url",name:"url_string_redirect_renderingContent",displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],redirect_url_object_renderingContent:["url_string_redirect"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{displayName:"Widgets",name:"widgets_object_renderingContent",type:"multiOptions",description:"Widgets returned from any rules that are applied to the current search.",required:!1,default:[],options:[{name:"Banners",value:"banners_json_widgets"}],displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"json",displayName:"Banners",name:"banners_json_widgets_renderingContent",default:"[]",description:"Banners defined in the Merchandising Studio for a given search.",required:!1,displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],widgets_object_renderingContent:["banners_json_widgets"],search_parameters_as_object:["rendering_content_object"],searchParams:["search_parameters_as_object"],resource:["Search"],operation:["searchSingleIndex"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
166
166
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
167
|
-
`,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",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",default:"",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:!1,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{search_method_params_object:["requests_json"],resource:["Search"],operation:["search"]}}},{type:"options",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",default:"",displayOptions:{show:{search_method_params_object:["strategy_options"],resource:["Search"],operation:["search"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",displayName:"Facet Name",name:"facetName_string",default:"",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",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",default:"",displayOptions:{show:{search_for_facet_values_request_object:["params_string"],resource:["Search"],operation:["searchForFacetValues"]}}},{type:"string",placeholder:"george",description:"Text to search inside the facet's values.",routing:{send:{type:"body",value:"={{ $value }}",property:"facetQuery"}},displayName:"Facet Query",name:"facetQuery_string",default:"",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",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Search parameters as a URL-encoded query string.",routing:{send:{type:"body",value:"={{ $value }}",property:"params"}},displayName:"Params",name:"params_string",default:"",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 Object",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 Object",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",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",default:"",displayOptions:{show:{browse_params_object:["query_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",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",default:"",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",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",default:"",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",displayName:"Facet Filters (String)",name:"facetFilters_string",default:"",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",displayName:"Optional Filters (String)",name:"optionalFilters_string",default:"",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",displayName:"Numeric Filters (String)",name:"numericFilters_string",default:"",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",displayName:"Tag Filters (String)",name:"tagFilters_string",default:"",displayOptions:{show:{tagFilters:["string"],browse_params_object:["tagfilters"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",description:`Whether to sum all filter scores
|
|
167
|
+
`,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:"={{ $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
|
|
168
168
|
If true, all filter scores are summed.
|
|
169
169
|
Otherwise, the maximum filter score is kept.
|
|
170
170
|
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).
|
|
171
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sumOrFiltersScores"}},displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",
|
|
171
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sumOrFiltersScores"}},displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{browse_params_object:["sumorfiltersscores_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Restrict Searchable Attributes",name:"restrictSearchableAttributes_json",default:"[]",description:`Restricts a search to a subset of your searchable attributes.
|
|
172
172
|
Attribute names are case-sensitive.
|
|
173
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
173
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictSearchableAttributes"}},displayOptions:{show:{browse_params_object:["restrictsearchableattributes_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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
|
|
174
174
|
To retrieve all facets, use the wildcard character \`*\`.
|
|
175
175
|
For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
|
|
176
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
176
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"facets"}},displayOptions:{show:{browse_params_object:["facets_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"facetingAfterDistinct"}},displayName:"Faceting After Distinct",name:"facetingAfterDistinct_boolean",displayOptions:{show:{browse_params_object:["facetingafterdistinct_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["page_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",routing:{send:{type:"body",value:"={{ $value }}",property:"offset"}},displayName:"Offset",name:"offset_number",displayOptions:{show:{browse_params_object:["offset_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"length"}},displayName:"Length",name:"length_number",displayOptions:{show:{browse_params_object:["length_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["aroundlatlng_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"Whether to obtain the coordinates from the request's IP address.",routing:{send:{type:"body",value:"={{ $value }}",property:"aroundLatLngViaIP"}},displayName:"Around Lat Lng Via IP",name:"aroundLatLngViaIP_boolean",displayOptions:{show:{browse_params_object:["aroundlatlngviaip_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["aroundradius"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{aroundRadius:["integer"],browse_params_object:["aroundradius"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{aroundRadius:["all"],browse_params_object:["aroundradius"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"aroundPrecision",displayName:"Around Precision",default:"",options:[{name:"Integer",value:"integer"},{name:"Range objects",value:"range_objects"}],routing:{send:{type:"body",property:"aroundPrecision",value:'={{ typeof $parameter.aroundPrecision_number !== "undefined" ? $parameter.aroundPrecision_number : typeof $parameter.aroundPrecision_json !== "undefined" ? JSON.parse($parameter.aroundPrecision_json) : undefined }}'}},displayOptions:{show:{browse_params_object:["aroundprecision"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:10,description:`Distance in meters to group results by similar distances.
|
|
177
177
|
|
|
178
178
|
For example, if you set \`aroundPrecision\` to 100, records wihin 100 meters to the central coordinate are considered to have the same distance,
|
|
179
179
|
as are records between 100 and 199 meters.
|
|
180
|
-
`,displayName:"Around Precision (Integer)",name:"aroundPrecision_number",displayOptions:{show:{aroundPrecision:["integer"],browse_params_object:["aroundprecision"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"
|
|
180
|
+
`,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.
|
|
181
181
|
|
|
182
182
|
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
183
183
|
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
@@ -189,16 +189,16 @@ Polygons are defined by 3 to 10,000 points. Each point is represented by its lat
|
|
|
189
189
|
Provide multiple polygons as nested arrays.
|
|
190
190
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
191
191
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
192
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
192
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"insidePolygon"}},displayOptions:{show:{browse_params_object:["insidepolygon_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"naturalLanguages"}},displayOptions:{show:{browse_params_object:["naturallanguages_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Rule Contexts",name:"ruleContexts_json",default:"[]",description:`Assigns a rule context to the search query
|
|
193
193
|
[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.
|
|
194
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
194
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"ruleContexts"}},displayOptions:{show:{browse_params_object:["rulecontexts_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
195
195
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
196
196
|
For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
197
|
-
`,typeOptions:{minValue:0,maxValue:100},routing:{send:{type:"body",value:"={{ $value }}",property:"personalizationImpact"}},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{browse_params_object:["personalizationimpact_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",placeholder:"test-user-123",description:`Unique pseudonymous or anonymous user identifier.
|
|
197
|
+
`,typeOptions:{minValue:0,maxValue:100},routing:{send:{type:"body",value:"={{ $value }}",property:"personalizationImpact"}},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{browse_params_object:["personalizationimpact_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
198
198
|
|
|
199
199
|
This helps with analytics and click and conversion events.
|
|
200
200
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
201
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"userToken"}},displayName:"User Token",name:"userToken_string",
|
|
201
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"userToken"}},displayName:"User Token",name:"userToken_string",displayOptions:{show:{browse_params_object:["usertoken_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",routing:{send:{type:"body",value:"={{ $value }}",property:"getRankingInfo"}},displayName:"Get Ranking Info",name:"getRankingInfo_boolean",displayOptions:{show:{browse_params_object:["getrankinginfo_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",routing:{send:{type:"body",value:"={{ $value }}",property:"synonyms"}},displayName:"Synonyms",name:"synonyms_boolean",displayOptions:{show:{browse_params_object:["synonyms_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"clickAnalytics"}},displayName:"Click Analytics",name:"clickAnalytics_boolean",displayOptions:{show:{browse_params_object:["clickanalytics_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",routing:{send:{type:"body",value:"={{ $value }}",property:"analytics"}},displayName:"Analytics",name:"analytics_boolean",displayOptions:{show:{browse_params_object:["analytics_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"analyticsTags"}},displayOptions:{show:{browse_params_object:["analyticstags_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",routing:{send:{type:"body",value:"={{ $value }}",property:"percentileComputation"}},displayName:"Percentile Computation",name:"percentileComputation_boolean",displayOptions:{show:{browse_params_object:["percentilecomputation_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",routing:{send:{type:"body",value:"={{ $value }}",property:"enableABTest"}},displayName:"Enable ABTest",name:"enableABTest_boolean",displayOptions:{show:{browse_params_object:["enableabtest_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToRetrieve"}},displayOptions:{show:{browse_params_object:["attributestoretrieve_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
202
202
|
|
|
203
203
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
204
204
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -215,19 +215,19 @@ you put the sorting attribute at the top of the list.
|
|
|
215
215
|
Before you modify the default setting,
|
|
216
216
|
you should test your changes in the dashboard,
|
|
217
217
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
218
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
218
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"ranking"}},displayOptions:{show:{browse_params_object:["ranking_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
219
219
|
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).
|
|
220
220
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
221
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{browse_params_object:["relevancystrictness_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
221
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{browse_params_object:["relevancystrictness_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToHighlight"}},displayOptions:{show:{browse_params_object:["attributestohighlight_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
222
222
|
Attribute names are case-sensitive
|
|
223
223
|
Snippets provide additional context to matched words.
|
|
224
224
|
If you enable snippets, they include 10 words, including the matched word.
|
|
225
225
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
226
226
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
227
227
|
where \`NUMBER\` is the number of words to be extracted.
|
|
228
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
228
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToSnippet"}},displayOptions:{show:{browse_params_object:["attributestosnippet_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPreTag"}},displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{browse_params_object:["highlightpretag_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPostTag"}},displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{browse_params_object:["highlightposttag_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",routing:{send:{type:"body",value:"={{ $value }}",property:"snippetEllipsisText"}},displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{browse_params_object:["snippetellipsistext_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
229
229
|
By default, all items are highlighted and snippeted.
|
|
230
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",
|
|
230
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{browse_params_object:["restricthighlightandsnippetarrays_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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:{browse_params_object:["hitsperpage_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor1Typo"}},displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{browse_params_object:["minwordsizefor1typo_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor2Typos"}},displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{browse_params_object:["minwordsizefor2typos_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"typoTolerance",displayName:"Typo Tolerance",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Typo tolerance",value:"typo_tolerance"}],routing:{send:{type:"body",property:"typoTolerance",value:'={{ typeof $parameter.typoTolerance_boolean !== "undefined" ? $parameter.typoTolerance_boolean : typeof $parameter.typoTolerance_options !== "undefined" ? $parameter.typoTolerance_options : undefined }}'}},displayOptions:{show:{browse_params_object:["typotolerance"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.",displayName:"Typo Tolerance (Boolean)",name:"typoTolerance_boolean",displayOptions:{show:{typoTolerance:["boolean"],browse_params_object:["typotolerance"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",default:"",description:"- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",options:[{name:"min",value:"min"},{name:"strict",value:"strict"},{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Typo Tolerance (Typo Tolerance)",name:"typoTolerance_options",displayOptions:{show:{typoTolerance:["typo_tolerance"],browse_params_object:["typotolerance"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
231
231
|
Turn off this setting to reduce the number of irrelevant matches
|
|
232
232
|
when searching in large sets of similar numbers.
|
|
233
233
|
`,routing:{send:{type:"body",value:"={{ $value }}",property:"allowTyposOnNumericTokens"}},displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{browse_params_object:["allowtyposonnumerictokens_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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).
|
|
@@ -237,7 +237,7 @@ Returning only exact matches can help when
|
|
|
237
237
|
- Reducing the number of matches when you have too many.
|
|
238
238
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
239
239
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
240
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
240
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableTypoToleranceOnAttributes"}},displayOptions:{show:{browse_params_object:["disabletypotoleranceonattributes_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",options:[{name:"Array",value:"array"},{name:"Boolean string",value:"boolean_string"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"ignorePlurals",value:'={{ typeof $parameter.ignorePlurals_json !== "undefined" ? JSON.parse($parameter.ignorePlurals_json) : typeof $parameter.ignorePlurals_options !== "undefined" ? $parameter.ignorePlurals_options : typeof $parameter.ignorePlurals_boolean !== "undefined" ? $parameter.ignorePlurals_boolean : undefined }}'}},displayOptions:{show:{browse_params_object:["ignoreplurals"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Ignore Plurals (Array)",name:"ignorePlurals_json",default:"[]",description:"ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",required:!1,displayOptions:{show:{ignorePlurals:["array"],browse_params_object:["ignoreplurals"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",default:"",options:[{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Ignore Plurals (Boolean String)",name:"ignorePlurals_options",displayOptions:{show:{ignorePlurals:["boolean_string"],browse_params_object:["ignoreplurals"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.\nIf false, singulars, plurals, and other declensions won't be considered equivalent.\n",displayName:"Ignore Plurals (Boolean)",name:"ignorePlurals_boolean",displayOptions:{show:{ignorePlurals:["boolean"],browse_params_object:["ignoreplurals"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"removeStopWords",displayName:"Remove Stop Words",default:"",options:[{name:"Array",value:"array"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"removeStopWords",value:'={{ typeof $parameter.removeStopWords_json !== "undefined" ? JSON.parse($parameter.removeStopWords_json) : typeof $parameter.removeStopWords_boolean !== "undefined" ? $parameter.removeStopWords_boolean : undefined }}'}},displayOptions:{show:{browse_params_object:["removestopwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Remove Stop Words (Array)",name:"removeStopWords_json",default:"[]",description:"ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.",required:!1,displayOptions:{show:{removeStopWords:["array"],browse_params_object:["removestopwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n",displayName:"Remove Stop Words (Boolean)",name:"removeStopWords_boolean",displayOptions:{show:{removeStopWords:["boolean"],browse_params_object:["removestopwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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
|
|
241
241
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
242
242
|
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.
|
|
243
243
|
To support this, you must place the CJK language **first**
|
|
@@ -246,7 +246,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
246
246
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
247
247
|
This can lead to unexpected search results.
|
|
248
248
|
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).
|
|
249
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
249
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"queryLanguages"}},displayOptions:{show:{browse_params_object:["querylanguages_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"decompoundQuery"}},displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{browse_params_object:["decompoundquery_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"enableRules"}},displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{browse_params_object:["enablerules_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",routing:{send:{type:"body",value:"={{ $value }}",property:"enablePersonalization"}},displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{browse_params_object:["enablepersonalization_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
250
250
|
|
|
251
251
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
252
252
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -278,13 +278,13 @@ This setting only applies to indices, for which Algolia enabled NeuralSearch for
|
|
|
278
278
|
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],routing:{send:{type:"body",value:"={{ $value }}",property:"mode"}},displayName:"Mode",name:"mode_options",displayOptions:{show:{browse_params_object:["mode_options"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Semantic Search",name:"semantic_search_object",type:"multiOptions",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:[],options:[{name:"Event Sources",value:"eventSources_semanticSearch"}],routing:{send:{type:"body",property:"semanticSearch",value:'={{ { "eventSources": typeof $parameter.eventSources_json_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_json_semanticSearch) : typeof $parameter.eventSources_null_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_null_semanticSearch) : undefined } }}'}},displayOptions:{show:{browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"eventSources_semanticSearch",displayName:"Event Sources",default:"",options:[{name:"Array",value:"array"},{name:"Null",value:"null"}],displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Event Sources (Array)",name:"eventSources_json_semanticSearch",default:"[]",description:`Indices from which to collect click and conversion events.
|
|
279
279
|
|
|
280
280
|
If null, the current index and all its replicas are used.
|
|
281
|
-
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",
|
|
281
|
+
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],browse_params_object:["semantic_search_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{browse_params_object:["advancedsyntax_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"optionalWords",displayName:"Optional Words",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Optional words array",value:"optional_words_array"}],routing:{send:{type:"body",property:"optionalWords",value:'={{ typeof $parameter.optionalWords_string !== "undefined" ? $parameter.optionalWords_string : typeof $parameter.optionalWords_null !== "undefined" ? JSON.parse($parameter.optionalWords_null) : typeof $parameter.optionalWords_json !== "undefined" ? JSON.parse($parameter.optionalWords_json) : undefined }}'}},displayOptions:{show:{browse_params_object:["optionalwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Optional Words (String)",name:"optionalWords_string",displayOptions:{show:{optionalWords:["string"],browse_params_object:["optionalwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Optional Words (Null)",name:"optionalWords_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{optionalWords:["null"]}},displayOptions:{show:{optionalWords:["null"],browse_params_object:["optionalwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Optional Words (Optional Words Array)",name:"optionalWords_json",default:"[]",description:"List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).",required:!1,displayOptions:{show:{optionalWords:["optional_words_array"],browse_params_object:["optionalwords"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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).
|
|
282
282
|
Attribute names are case-sensitive
|
|
283
283
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
284
284
|
such as product descriptions.
|
|
285
285
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
286
286
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
287
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
287
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableExactOnAttributes"}},displayOptions:{show:{browse_params_object:["disableexactonattributes_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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.
|
|
288
288
|
|
|
289
289
|
- \`attribute\`.
|
|
290
290
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -309,11 +309,11 @@ For example
|
|
|
309
309
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
310
310
|
- \`multiWordsSynonym\`.
|
|
311
311
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
312
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
312
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"alternativesAsExact"}},displayOptions:{show:{browse_params_object:["alternativesasexact_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntaxFeatures"}},displayOptions:{show:{browse_params_object:["advancedsyntaxfeatures_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",name:"distinct",displayName:"Distinct",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Integer",value:"integer"}],routing:{send:{type:"body",property:"distinct",value:'={{ typeof $parameter.distinct_boolean !== "undefined" ? $parameter.distinct_boolean : typeof $parameter.distinct_number !== "undefined" ? $parameter.distinct_number : undefined }}'}},displayOptions:{show:{browse_params_object:["distinct"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!1,description:"Whether deduplication is turned on. If true, only one member of a group is shown in the search results.",displayName:"Distinct (Boolean)",name:"distinct_boolean",displayOptions:{show:{distinct:["boolean"],browse_params_object:["distinct"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:"",description:"Number of members of a group of records to include in the search results.\n\n- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",typeOptions:{minValue:0,maxValue:4},displayName:"Distinct (Integer)",name:"distinct_number",displayOptions:{show:{distinct:["integer"],browse_params_object:["distinct"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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',routing:{send:{type:"body",value:"={{ $value }}",property:"replaceSynonymsInHighlight"}},displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{browse_params_object:["replacesynonymsinhighlight_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
313
313
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
314
314
|
by equally scoring matches that are farther apart
|
|
315
315
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
316
|
-
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{browse_params_object:["minproximity_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
316
|
+
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{browse_params_object:["minproximity_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"responseFields"}},displayOptions:{show:{browse_params_object:["responsefields_json"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"maxValuesPerFacet"}},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{browse_params_object:["maxvaluesperfacet_number"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
317
317
|
- \`count\`.
|
|
318
318
|
Facet values are retrieved by decreasing count.
|
|
319
319
|
The count is the number of matching records containing this facet value
|
|
@@ -321,20 +321,20 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
321
321
|
Retrieve facet values alphabetically
|
|
322
322
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
323
323
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
324
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{browse_params_object:["sortfacetvaluesby_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",
|
|
324
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{browse_params_object:["sortfacetvaluesby_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{browse_params_object:["attributecriteriacomputedbyminproximity_boolean"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Rendering Content",name:"rendering_content_object",type:"multiOptions",description:`Extra data that can be used in the search UI.
|
|
325
325
|
|
|
326
326
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
327
327
|
without changing your frontend code.
|
|
328
|
-
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect
|
|
328
|
+
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect URL",value:"redirect_url_object_renderingContent"},{name:"Widgets",value:"widgets_object_renderingContent"}],routing:{send:{type:"body",property:"renderingContent",value:'={{ { "facetOrdering": { "facets": { "order": typeof $parameter.order_json_facets_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.order_json_facets_facetOrdering_renderingContent) : undefined }, "values": typeof $parameter.values_object_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.values_object_facetOrdering_renderingContent) : undefined }, "redirect": { "url": typeof $parameter.url_string_redirect_renderingContent !== "undefined" ? $parameter.url_string_redirect_renderingContent : undefined }, "widgets": { "banners": typeof $parameter.banners_json_widgets_renderingContent !== "undefined" ? JSON.parse($parameter.banners_json_widgets_renderingContent) : undefined } } }}'}},displayOptions:{show:{browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Facet Ordering",name:"facet_ordering_object_renderingContent",type:"multiOptions",description:"Order of facet names and facet values in your UI.",required:!1,default:[],options:[{name:"Facets",value:"facets_object_facetOrdering"},{name:"Values",value:"values_object_facetOrdering"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Facets",name:"facets_object_facetOrdering_renderingContent",type:"multiOptions",description:"Order of facet names.",required:!1,default:[],options:[{name:"Order",value:"order_json_facets"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Order",name:"order_json_facets_facetOrdering_renderingContent",default:"[]",description:`Explicit order of facets or facet values.
|
|
329
329
|
|
|
330
330
|
This setting lets you always show specific facets or facet values at the top of the list.
|
|
331
|
-
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{
|
|
331
|
+
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Values",name:"values_object_facetOrdering_renderingContent",description:"Order of facet values. One object for each facet.",required:!1,default:"{}",displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["values_object_facetOrdering"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Redirect URL",name:"redirect_url_object_renderingContent",type:"multiOptions",description:"The redirect rule container.",required:!1,default:[],options:[{name:"Url",value:"url_string_redirect"}],displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"string",default:"",displayName:"Url",name:"url_string_redirect_renderingContent",displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],redirect_url_object_renderingContent:["url_string_redirect"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{displayName:"Widgets",name:"widgets_object_renderingContent",type:"multiOptions",description:"Widgets returned from any rules that are applied to the current search.",required:!1,default:[],options:[{name:"Banners",value:"banners_json_widgets"}],displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"json",displayName:"Banners",name:"banners_json_widgets_renderingContent",default:"[]",description:"Banners defined in the Merchandising Studio for a given search.",required:!1,displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],widgets_object_renderingContent:["banners_json_widgets"],browse_params_object:["rendering_content_object"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
332
332
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
333
|
-
`,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",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",
|
|
333
|
+
`,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.
|
|
334
334
|
|
|
335
335
|
The parameter must match the value returned in the response of a previous request.
|
|
336
336
|
The last page of the response does not return a \`cursor\` attribute.
|
|
337
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"cursor"}},displayName:"Cursor",name:"cursor_string",default:"",displayOptions:{show:{browse_params_object:["cursor_string"],browseParams:["browse_params_object"],resource:["Search"],operation:["browse"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",displayName:"Index Name",name:"indexName_string",default:"",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",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",default:"",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",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",default:"",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",default:"",required:!0,displayOptions:{show:{resource:["Records"],operation:["deleteObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",displayName:"Facet Filters (String)",name:"facetFilters_string",default:"",displayOptions:{show:{delete_by_params_object:["facetFilters"],facetFilters:["string"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",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",default:"",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",displayName:"Numeric Filters (String)",name:"numericFilters_string",default:"",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",displayName:"Tag Filters (String)",name:"tagFilters_string",default:"",displayOptions:{show:{delete_by_params_object:["tagFilters"],tagFilters:["string"],resource:["Records"],operation:["deleteBy"]}}},{type:"string",placeholder:"40.71,-74.01",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",default:"",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",description:"Maximum search radius around a central location in meters.",typeOptions:{minValue:1},displayName:"Around Radius (Integer)",name:"aroundRadius_number",default:"",displayOptions:{show:{delete_by_params_object:["aroundRadius"],aroundRadius:["integer"],resource:["Records"],operation:["deleteBy"]}}},{type:"options",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",default:"",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",displayName:"Inside Bounding Box (String)",name:"insideBoundingBox_string",default:"",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.
|
|
337
|
+
`,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:"json",displayName:"Multiple Properties",name:"multiple_properties_object",description:void 0,required:!1,default:"{}",routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{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:"={{ $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:"json",displayName:"Multiple Properties",name:"multiple_properties_object",description:void 0,required:!1,default:"{}",routing:{request:{body:"={{ $value }}"}},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.
|
|
338
338
|
|
|
339
339
|
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
340
340
|
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
@@ -346,9 +346,7 @@ Polygons are defined by 3 to 10,000 points. Each point is represented by its lat
|
|
|
346
346
|
Provide multiple polygons as nested arrays.
|
|
347
347
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
348
348
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
349
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
350
|
-
If not specified, all retrievable attributes are returned.
|
|
351
|
-
`,required:!1},{type:"string",placeholder:"product-1",description:"Object ID for the record to retrieve.",displayName:"Object ID",name:"objectID_string_requests",default:""},{type:"string",placeholder:"books",description:"Index from which to retrieve the records.",displayName:"Index Name",name:"indexName_string_requests",default:""}]}],routing:{send:{type:"body",value:'={{ $parameter.values?.map(item => ({ attributesToRetrieve: typeof item.attributesToRetrieve_json_requests !== "undefined" ? JSON.parse(item.attributesToRetrieve_json_requests) : undefined, objectID: typeof item.objectID_string_requests !== "undefined" ? item.objectID_string_requests : undefined, indexName: typeof item.indexName_string_requests !== "undefined" ? item.indexName_string_requests : undefined })) }}',property:"requests"}},displayOptions:{show:{get_objects_params_object:["requests_fixedCollection"],resource:["Records"],operation:["getObjects"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",required:!0,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 }}"}}]}}}}},{type:"number",default:1,routing:{request:{qs:{getVersion:"={{ $value }}"}}},displayName:"Get Version",name:"getVersion_number",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",required:!0,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 }}"}}]}}}}},{type:"boolean",routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",default:"",displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{type:"multiOptions",name:"index_settings",displayName:"Index Settings",description:"Index settings.",default:[],options:[{name:"Attributes For Faceting",value:"attributesforfaceting_json"},{name:"Replicas",value:"replicas_json"},{name:"Pagination Limited To",value:"paginationlimitedto_number"},{name:"Unretrievable Attributes",value:"unretrievableattributes_json"},{name:"Disable Typo Tolerance On Words",value:"disabletypotoleranceonwords_json"},{name:"Attributes To Transliterate",value:"attributestotransliterate_json"},{name:"Camel Case Attributes",value:"camelcaseattributes_json"},{name:"Index Languages",value:"indexlanguages_json"},{name:"Disable Prefix On Attributes",value:"disableprefixonattributes_json"},{name:"Allow Compression Of Integer Array",value:"allowcompressionofintegerarray_boolean"},{name:"Numeric Attributes For Filtering",value:"numericattributesforfiltering_json"},{name:"Separators To Index",value:"separatorstoindex_string"},{name:"Searchable Attributes",value:"searchableattributes_json"},{name:"Custom Normalization",value:"customnormalization_string"},{name:"Attribute For Distinct",value:"attributefordistinct_string"},{name:"Max Facet Hits",value:"maxfacethits_number"},{name:"Keep Diacritics On Characters",value:"keepdiacriticsoncharacters_string"},{name:"Custom Ranking",value:"customranking_json"},{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 Object",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 Object",value:"rendering_content_object"},{name:"Enable Re Ranking",value:"enablereranking_boolean"},{name:"Re Ranking Apply Filter",value:"rerankingapplyfilter"}],displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
349
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"insidePolygon"}},displayOptions:{show:{delete_by_params_object:["insidePolygon_json"],resource:["Records"],operation:["deleteBy"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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 }}"}}]}}}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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"]}}},{type:"boolean",default:!0,routing:{request:{qs:{createIfNotExists:"={{ $value }}"}}},displayName:"Create If Not Exists",name:"createIfNotExists_boolean",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"json",displayName:"Multiple Properties",name:"multiple_properties_object",description:"Attributes to update.",required:!1,default:"{}",routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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 }}"}}]}}}}},{displayName:"Batch Write Params",name:"batch_write_params_object",type:"multiOptions",description:"Batch parameters.",required:!0,default:[],options:[{name:"Requests",value:"requests_json"}],displayOptions:{show:{resource:["Records"],operation:["batch"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ $value }}",property:"requests"}},displayOptions:{show:{batch_write_params_object:["requests_json"],resource:["Records"],operation:["batch"]}}},{displayName:"Batch Params",name:"batch_params_object",type:"multiOptions",description:"Batch parameters.",required:!0,default:[],options:[{name:"Requests",value:"requests_json"}],displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ $value }}",property:"requests"}},displayOptions:{show:{batch_params_object:["requests_json"],resource:["Records"],operation:["multipleBatch"]}}},{displayName:"Get Objects Params",name:"get_objects_params_object",type:"multiOptions",description:"Request parameters.",required:!0,default:[],options:[{name:"Requests",value:"requests_json"}],displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ $value }}",property:"requests"}},displayOptions:{show:{get_objects_params_object:["requests_json"],resource:["Records"],operation:["getObjects"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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 }}"}}]}}}}},{type:"number",default:1,routing:{request:{qs:{getVersion:"={{ $value }}"}}},displayName:"Get Version",name:"getVersion_number",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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 }}"}}]}}}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{type:"multiOptions",name:"index_settings",displayName:"Index Settings",description:"Index settings.",default:[],options:[{name:"Attributes For Faceting",value:"attributesforfaceting_json"},{name:"Replicas",value:"replicas_json"},{name:"Pagination Limited To",value:"paginationlimitedto_number"},{name:"Unretrievable Attributes",value:"unretrievableattributes_json"},{name:"Disable Typo Tolerance On Words",value:"disabletypotoleranceonwords_json"},{name:"Attributes To Transliterate",value:"attributestotransliterate_json"},{name:"Camel Case Attributes",value:"camelcaseattributes_json"},{name:"Decompounded Attributes",value:"decompounded_attributes_object"},{name:"Index Languages",value:"indexlanguages_json"},{name:"Disable Prefix On Attributes",value:"disableprefixonattributes_json"},{name:"Allow Compression Of Integer Array",value:"allowcompressionofintegerarray_boolean"},{name:"Numeric Attributes For Filtering",value:"numericattributesforfiltering_json"},{name:"Separators To Index",value:"separatorstoindex_string"},{name:"Searchable Attributes",value:"searchableattributes_json"},{name:"Custom Normalization",value:"custom_normalization_object"},{name:"Attribute For Distinct",value:"attributefordistinct_string"},{name:"Max Facet Hits",value:"maxfacethits_number"},{name:"Keep Diacritics On Characters",value:"keepdiacriticsoncharacters_string"},{name:"Custom Ranking",value:"customranking_json"},{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:{resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
352
350
|
|
|
353
351
|
Facets are attributes that let you categorize search results.
|
|
354
352
|
They can be used for filtering search results.
|
|
@@ -367,7 +365,7 @@ Attribute names are case-sensitive.
|
|
|
367
365
|
Evaluates the facet count _after_ deduplication with \`distinct\`.
|
|
368
366
|
This ensures accurate facet counts.
|
|
369
367
|
You can apply this modifier to searchable facets: \`afterDistinct(searchable(ATTRIBUTE))\`.
|
|
370
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
368
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesForFaceting"}},displayOptions:{show:{index_settings:["attributesforfaceting_json"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
371
369
|
|
|
372
370
|
Replicas are copies of a primary index with the same records but different settings, synonyms, or rules.
|
|
373
371
|
If you want to offer a different ranking or sorting of your search results, you'll use replica indices.
|
|
@@ -380,7 +378,7 @@ If you omit a replica from this list, the replica turns into a regular, standalo
|
|
|
380
378
|
- \`virtual("REPLICA")\`.
|
|
381
379
|
Create a virtual replica,
|
|
382
380
|
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).
|
|
383
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
381
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"replicas"}},displayOptions:{show:{index_settings:["replicas_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"number",placeholder:"100",default:1e3,description:`Maximum number of search results that can be obtained through pagination.
|
|
384
382
|
|
|
385
383
|
Higher pagination limits might slow down your search.
|
|
386
384
|
For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
|
|
@@ -389,27 +387,27 @@ For pagination limits above 1,000, the sorting of results beyond the 1,000th hit
|
|
|
389
387
|
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),
|
|
390
388
|
but don't want to include it in the search results.
|
|
391
389
|
Attribute names are case-sensitive.
|
|
392
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
390
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"unretrievableAttributes"}},displayOptions:{show:{index_settings:["unretrievableattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
393
391
|
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.
|
|
394
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
392
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableTypoToleranceOnWords"}},displayOptions:{show:{index_settings:["disabletypotoleranceonwords_json"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
395
393
|
|
|
396
394
|
Transliteration supports searching in any of the Japanese writing systems.
|
|
397
395
|
To support transliteration, you must set the indexing language to Japanese.
|
|
398
396
|
Attribute names are case-sensitive.
|
|
399
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
397
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToTransliterate"}},displayOptions:{show:{index_settings:["attributestotransliterate_json"],resource:["Indices"],operation:["setSettings"]}}},{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.
|
|
400
398
|
Attribute names are case-sensitive.
|
|
401
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
399
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"camelCaseAttributes"}},displayOptions:{show:{index_settings:["camelcaseattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Decompounded Attributes",name:"decompounded_attributes_object",description:"Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding).\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:"{}",routing:{send:{type:"body",property:"decompoundedAttributes",value:"={{ $value }}"}},displayOptions:{show:{index_settings:["decompounded_attributes_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Index Languages",name:"indexLanguages_json",default:"[]",description:`Languages for language-specific processing steps, such as word detection and dictionary settings.
|
|
402
400
|
|
|
403
401
|
**You should always specify an indexing language.**
|
|
404
402
|
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),
|
|
405
403
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
406
404
|
This can lead to unexpected search results.
|
|
407
405
|
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).
|
|
408
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
406
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"indexLanguages"}},displayOptions:{show:{index_settings:["indexlanguages_json"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
409
407
|
Attribute names are case-sensitive.
|
|
410
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
408
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disablePrefixOnAttributes"}},displayOptions:{show:{index_settings:["disableprefixonattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:`Whether arrays with exclusively non-negative integers should be compressed for better performance.
|
|
411
409
|
If true, the compressed arrays may be reordered.
|
|
412
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"allowCompressionOfIntegerArray"}},displayName:"Allow Compression Of Integer Array",name:"allowCompressionOfIntegerArray_boolean",
|
|
410
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"allowCompressionOfIntegerArray"}},displayName:"Allow Compression Of Integer Array",name:"allowCompressionOfIntegerArray_boolean",displayOptions:{show:{index_settings:["allowcompressionofintegerarray_boolean"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
413
411
|
Attribute names are case-sensitive.
|
|
414
412
|
|
|
415
413
|
By default, all numeric attributes are available as numerical filters.
|
|
@@ -421,7 +419,7 @@ To turn off filtering for all numeric attributes, specify an attribute that does
|
|
|
421
419
|
|
|
422
420
|
- \`equalOnly("ATTRIBUTE")\`.
|
|
423
421
|
Support only filtering based on equality comparisons \`=\` and \`!=\`.
|
|
424
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
422
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"numericAttributesForFiltering"}},displayOptions:{show:{index_settings:["numericattributesforfiltering_json"],resource:["Indices"],operation:["setSettings"]}}},{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',routing:{send:{type:"body",value:"={{ $value }}",property:"separatorsToIndex"}},displayName:"Separators To Index",name:"separatorsToIndex_string",displayOptions:{show:{index_settings:["separatorstoindex_string"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Searchable Attributes",name:"searchableAttributes_json",default:"[]",description:`Attributes used for searching. Attribute names are case-sensitive.
|
|
425
423
|
|
|
426
424
|
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.
|
|
427
425
|
With a non-empty list, Algolia only returns results with matches in the selected attributes.
|
|
@@ -437,9 +435,9 @@ For more information, see [Searchable attributes](https://www.algolia.com/doc/gu
|
|
|
437
435
|
Ignore the position of a match within the attribute.
|
|
438
436
|
|
|
439
437
|
Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
|
|
440
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
438
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"searchableAttributes"}},displayOptions:{show:{index_settings:["searchableattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Custom Normalization",name:"custom_normalization_object",description:`Characters and their normalized replacements.
|
|
441
439
|
This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization).
|
|
442
|
-
`,
|
|
440
|
+
`,required:!1,default:"{}",routing:{send:{type:"body",property:"customNormalization",value:"={{ $value }}"}},displayOptions:{show:{index_settings:["custom_normalization_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",placeholder:"url",default:"",description:`Attribute that should be used to establish groups of results.
|
|
443
441
|
Attribute names are case-sensitive.
|
|
444
442
|
|
|
445
443
|
All records with the same value for this attribute are considered a group.
|
|
@@ -448,12 +446,12 @@ how many items per group are included in the search results.
|
|
|
448
446
|
|
|
449
447
|
If you want to use the same attribute also for faceting, use the \`afterDistinct\` modifier of the \`attributesForFaceting\` setting.
|
|
450
448
|
This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
|
451
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"attributeForDistinct"}},displayName:"Attribute For Distinct",name:"attributeForDistinct_string",
|
|
449
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"attributeForDistinct"}},displayName:"Attribute For Distinct",name:"attributeForDistinct_string",displayOptions:{show:{index_settings:["attributefordistinct_string"],resource:["Indices"],operation:["setSettings"]}}},{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:{index_settings:["maxfacethits_number"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",placeholder:"øé",default:"",description:`Characters for which diacritics should be preserved.
|
|
452
450
|
|
|
453
451
|
By default, Algolia removes diacritics from letters.
|
|
454
452
|
For example, \`é\` becomes \`e\`. If this causes issues in your search,
|
|
455
453
|
you can specify characters that should keep their diacritics.
|
|
456
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"keepDiacriticsOnCharacters"}},displayName:"Keep Diacritics On Characters",name:"keepDiacriticsOnCharacters_string",
|
|
454
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"keepDiacriticsOnCharacters"}},displayName:"Keep Diacritics On Characters",name:"keepDiacriticsOnCharacters_string",displayOptions:{show:{index_settings:["keepdiacriticsoncharacters_string"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
457
455
|
Attribute names are case-sensitive.
|
|
458
456
|
|
|
459
457
|
The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.
|
|
@@ -472,7 +470,7 @@ Boolean attributes are sorted based on their alphabetical order.
|
|
|
472
470
|
If you use two or more custom ranking attributes,
|
|
473
471
|
[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,
|
|
474
472
|
or the other attributes will never be applied.
|
|
475
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
473
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"customRanking"}},displayOptions:{show:{index_settings:["customranking_json"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToRetrieve"}},displayOptions:{show:{index_settings:["attributestoretrieve_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
476
474
|
|
|
477
475
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
478
476
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -489,19 +487,19 @@ you put the sorting attribute at the top of the list.
|
|
|
489
487
|
Before you modify the default setting,
|
|
490
488
|
you should test your changes in the dashboard,
|
|
491
489
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
492
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
490
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"ranking"}},displayOptions:{show:{index_settings:["ranking_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
493
491
|
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).
|
|
494
492
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
495
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{index_settings:["relevancystrictness_number"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
493
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"relevancyStrictness"}},displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{index_settings:["relevancystrictness_number"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToHighlight"}},displayOptions:{show:{index_settings:["attributestohighlight_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
496
494
|
Attribute names are case-sensitive
|
|
497
495
|
Snippets provide additional context to matched words.
|
|
498
496
|
If you enable snippets, they include 10 words, including the matched word.
|
|
499
497
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
500
498
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
501
499
|
where \`NUMBER\` is the number of words to be extracted.
|
|
502
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
500
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"attributesToSnippet"}},displayOptions:{show:{index_settings:["attributestosnippet_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPreTag"}},displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{index_settings:["highlightpretag_string"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",routing:{send:{type:"body",value:"={{ $value }}",property:"highlightPostTag"}},displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{index_settings:["highlightposttag_string"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",routing:{send:{type:"body",value:"={{ $value }}",property:"snippetEllipsisText"}},displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{index_settings:["snippetellipsistext_string"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
503
501
|
By default, all items are highlighted and snippeted.
|
|
504
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",
|
|
502
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"restrictHighlightAndSnippetArrays"}},displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{index_settings:["restricthighlightandsnippetarrays_boolean"],resource:["Indices"],operation:["setSettings"]}}},{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:{index_settings:["hitsperpage_number"],resource:["Indices"],operation:["setSettings"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor1Typo"}},displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{index_settings:["minwordsizefor1typo_number"],resource:["Indices"],operation:["setSettings"]}}},{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).",routing:{send:{type:"body",value:"={{ $value }}",property:"minWordSizefor2Typos"}},displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{index_settings:["minwordsizefor2typos_number"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"typoTolerance",displayName:"Typo Tolerance",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Typo tolerance",value:"typo_tolerance"}],routing:{send:{type:"body",property:"typoTolerance",value:'={{ typeof $parameter.typoTolerance_boolean !== "undefined" ? $parameter.typoTolerance_boolean : typeof $parameter.typoTolerance_options !== "undefined" ? $parameter.typoTolerance_options : undefined }}'}},displayOptions:{show:{index_settings:["typotolerance"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!0,description:"Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.",displayName:"Typo Tolerance (Boolean)",name:"typoTolerance_boolean",displayOptions:{show:{typoTolerance:["boolean"],index_settings:["typotolerance"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",default:"",description:"- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",options:[{name:"min",value:"min"},{name:"strict",value:"strict"},{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Typo Tolerance (Typo Tolerance)",name:"typoTolerance_options",displayOptions:{show:{typoTolerance:["typo_tolerance"],index_settings:["typotolerance"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
505
503
|
Turn off this setting to reduce the number of irrelevant matches
|
|
506
504
|
when searching in large sets of similar numbers.
|
|
507
505
|
`,routing:{send:{type:"body",value:"={{ $value }}",property:"allowTyposOnNumericTokens"}},displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{index_settings:["allowtyposonnumerictokens_boolean"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
@@ -511,7 +509,7 @@ Returning only exact matches can help when
|
|
|
511
509
|
- Reducing the number of matches when you have too many.
|
|
512
510
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
513
511
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
514
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
512
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableTypoToleranceOnAttributes"}},displayOptions:{show:{index_settings:["disabletypotoleranceonattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",options:[{name:"Array",value:"array"},{name:"Boolean string",value:"boolean_string"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"ignorePlurals",value:'={{ typeof $parameter.ignorePlurals_json !== "undefined" ? JSON.parse($parameter.ignorePlurals_json) : typeof $parameter.ignorePlurals_options !== "undefined" ? $parameter.ignorePlurals_options : typeof $parameter.ignorePlurals_boolean !== "undefined" ? $parameter.ignorePlurals_boolean : undefined }}'}},displayOptions:{show:{index_settings:["ignoreplurals"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Ignore Plurals (Array)",name:"ignorePlurals_json",default:"[]",description:"ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",required:!1,displayOptions:{show:{ignorePlurals:["array"],index_settings:["ignoreplurals"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",default:"",options:[{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Ignore Plurals (Boolean String)",name:"ignorePlurals_options",displayOptions:{show:{ignorePlurals:["boolean_string"],index_settings:["ignoreplurals"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:"If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.\nIf false, singulars, plurals, and other declensions won't be considered equivalent.\n",displayName:"Ignore Plurals (Boolean)",name:"ignorePlurals_boolean",displayOptions:{show:{ignorePlurals:["boolean"],index_settings:["ignoreplurals"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"removeStopWords",displayName:"Remove Stop Words",default:"",options:[{name:"Array",value:"array"},{name:"Boolean",value:"boolean"}],routing:{send:{type:"body",property:"removeStopWords",value:'={{ typeof $parameter.removeStopWords_json !== "undefined" ? JSON.parse($parameter.removeStopWords_json) : typeof $parameter.removeStopWords_boolean !== "undefined" ? $parameter.removeStopWords_boolean : undefined }}'}},displayOptions:{show:{index_settings:["removestopwords"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Remove Stop Words (Array)",name:"removeStopWords_json",default:"[]",description:"ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.",required:!1,displayOptions:{show:{removeStopWords:["array"],index_settings:["removestopwords"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:"If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n",displayName:"Remove Stop Words (Boolean)",name:"removeStopWords_boolean",displayOptions:{show:{removeStopWords:["boolean"],index_settings:["removestopwords"],resource:["Indices"],operation:["setSettings"]}}},{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
|
|
515
513
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
516
514
|
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.
|
|
517
515
|
To support this, you must place the CJK language **first**
|
|
@@ -520,7 +518,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
520
518
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
521
519
|
This can lead to unexpected search results.
|
|
522
520
|
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).
|
|
523
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
521
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"queryLanguages"}},displayOptions:{show:{index_settings:["querylanguages_json"],resource:["Indices"],operation:["setSettings"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"decompoundQuery"}},displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{index_settings:["decompoundquery_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"enableRules"}},displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{index_settings:["enablerules_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",routing:{send:{type:"body",value:"={{ $value }}",property:"enablePersonalization"}},displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{index_settings:["enablepersonalization_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
524
522
|
|
|
525
523
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
526
524
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -552,13 +550,13 @@ This setting only applies to indices, for which Algolia enabled NeuralSearch for
|
|
|
552
550
|
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],routing:{send:{type:"body",value:"={{ $value }}",property:"mode"}},displayName:"Mode",name:"mode_options",displayOptions:{show:{index_settings:["mode_options"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Semantic Search",name:"semantic_search_object",type:"multiOptions",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:[],options:[{name:"Event Sources",value:"eventSources_semanticSearch"}],routing:{send:{type:"body",property:"semanticSearch",value:'={{ { "eventSources": typeof $parameter.eventSources_json_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_json_semanticSearch) : typeof $parameter.eventSources_null_semanticSearch !== "undefined" ? JSON.parse($parameter.eventSources_null_semanticSearch) : undefined } }}'}},displayOptions:{show:{index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"eventSources_semanticSearch",displayName:"Event Sources",default:"",options:[{name:"Array",value:"array"},{name:"Null",value:"null"}],displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Event Sources (Array)",name:"eventSources_json_semanticSearch",default:"[]",description:`Indices from which to collect click and conversion events.
|
|
553
551
|
|
|
554
552
|
If null, the current index and all its replicas are used.
|
|
555
|
-
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",
|
|
553
|
+
`,required:!1,displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["array"],index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{semantic_search_object:["eventSources_semanticSearch"],eventSources_semanticSearch:["null"],index_settings:["semantic_search_object"],resource:["Indices"],operation:["setSettings"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntax"}},displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{index_settings:["advancedsyntax_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"optionalWords",displayName:"Optional Words",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Optional words array",value:"optional_words_array"}],routing:{send:{type:"body",property:"optionalWords",value:'={{ typeof $parameter.optionalWords_string !== "undefined" ? $parameter.optionalWords_string : typeof $parameter.optionalWords_null !== "undefined" ? JSON.parse($parameter.optionalWords_null) : typeof $parameter.optionalWords_json !== "undefined" ? JSON.parse($parameter.optionalWords_json) : undefined }}'}},displayOptions:{show:{index_settings:["optionalwords"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"",displayName:"Optional Words (String)",name:"optionalWords_string",displayOptions:{show:{optionalWords:["string"],index_settings:["optionalwords"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Optional Words (Null)",name:"optionalWords_null",default:"null",description:void 0,required:!1,disabledOptions:{show:{optionalWords:["null"]}},displayOptions:{show:{optionalWords:["null"],index_settings:["optionalwords"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Optional Words (Optional Words Array)",name:"optionalWords_json",default:"[]",description:"List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).",required:!1,displayOptions:{show:{optionalWords:["optional_words_array"],index_settings:["optionalwords"],resource:["Indices"],operation:["setSettings"]}}},{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).
|
|
556
554
|
Attribute names are case-sensitive
|
|
557
555
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
558
556
|
such as product descriptions.
|
|
559
557
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
560
558
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
561
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
559
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"disableExactOnAttributes"}},displayOptions:{show:{index_settings:["disableexactonattributes_json"],resource:["Indices"],operation:["setSettings"]}}},{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.
|
|
562
560
|
|
|
563
561
|
- \`attribute\`.
|
|
564
562
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -583,11 +581,11 @@ For example
|
|
|
583
581
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
584
582
|
- \`multiWordsSynonym\`.
|
|
585
583
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
586
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
584
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"alternativesAsExact"}},displayOptions:{show:{index_settings:["alternativesasexact_json"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"advancedSyntaxFeatures"}},displayOptions:{show:{index_settings:["advancedsyntaxfeatures_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"options",name:"distinct",displayName:"Distinct",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Integer",value:"integer"}],routing:{send:{type:"body",property:"distinct",value:'={{ typeof $parameter.distinct_boolean !== "undefined" ? $parameter.distinct_boolean : typeof $parameter.distinct_number !== "undefined" ? $parameter.distinct_number : undefined }}'}},displayOptions:{show:{index_settings:["distinct"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!1,description:"Whether deduplication is turned on. If true, only one member of a group is shown in the search results.",displayName:"Distinct (Boolean)",name:"distinct_boolean",displayOptions:{show:{distinct:["boolean"],index_settings:["distinct"],resource:["Indices"],operation:["setSettings"]}}},{type:"number",default:"",description:"Number of members of a group of records to include in the search results.\n\n- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",typeOptions:{minValue:0,maxValue:4},displayName:"Distinct (Integer)",name:"distinct_number",displayOptions:{show:{distinct:["integer"],index_settings:["distinct"],resource:["Indices"],operation:["setSettings"]}}},{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',routing:{send:{type:"body",value:"={{ $value }}",property:"replaceSynonymsInHighlight"}},displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{index_settings:["replacesynonymsinhighlight_boolean"],resource:["Indices"],operation:["setSettings"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
587
585
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
588
586
|
by equally scoring matches that are farther apart
|
|
589
587
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
590
|
-
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{index_settings:["minproximity_number"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{
|
|
588
|
+
`,typeOptions:{minValue:1,maxValue:7},routing:{send:{type:"body",value:"={{ $value }}",property:"minProximity"}},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{index_settings:["minproximity_number"],resource:["Indices"],operation:["setSettings"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"responseFields"}},displayOptions:{show:{index_settings:["responsefields_json"],resource:["Indices"],operation:["setSettings"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},routing:{send:{type:"body",value:"={{ $value }}",property:"maxValuesPerFacet"}},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{index_settings:["maxvaluesperfacet_number"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
591
589
|
- \`count\`.
|
|
592
590
|
Facet values are retrieved by decreasing count.
|
|
593
591
|
The count is the number of matching records containing this facet value
|
|
@@ -595,32 +593,32 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
595
593
|
Retrieve facet values alphabetically
|
|
596
594
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
597
595
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
598
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{index_settings:["sortfacetvaluesby_string"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",
|
|
596
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"sortFacetValuesBy"}},displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{index_settings:["sortfacetvaluesby_string"],resource:["Indices"],operation:["setSettings"]}}},{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",routing:{send:{type:"body",value:"={{ $value }}",property:"attributeCriteriaComputedByMinProximity"}},displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{index_settings:["attributecriteriacomputedbyminproximity_boolean"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Rendering Content",name:"rendering_content_object",type:"multiOptions",description:`Extra data that can be used in the search UI.
|
|
599
597
|
|
|
600
598
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
601
599
|
without changing your frontend code.
|
|
602
|
-
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect
|
|
600
|
+
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect URL",value:"redirect_url_object_renderingContent"},{name:"Widgets",value:"widgets_object_renderingContent"}],routing:{send:{type:"body",property:"renderingContent",value:'={{ { "facetOrdering": { "facets": { "order": typeof $parameter.order_json_facets_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.order_json_facets_facetOrdering_renderingContent) : undefined }, "values": typeof $parameter.values_object_facetOrdering_renderingContent !== "undefined" ? JSON.parse($parameter.values_object_facetOrdering_renderingContent) : undefined }, "redirect": { "url": typeof $parameter.url_string_redirect_renderingContent !== "undefined" ? $parameter.url_string_redirect_renderingContent : undefined }, "widgets": { "banners": typeof $parameter.banners_json_widgets_renderingContent !== "undefined" ? JSON.parse($parameter.banners_json_widgets_renderingContent) : undefined } } }}'}},displayOptions:{show:{index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Facet Ordering",name:"facet_ordering_object_renderingContent",type:"multiOptions",description:"Order of facet names and facet values in your UI.",required:!1,default:[],options:[{name:"Facets",value:"facets_object_facetOrdering"},{name:"Values",value:"values_object_facetOrdering"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Facets",name:"facets_object_facetOrdering_renderingContent",type:"multiOptions",description:"Order of facet names.",required:!1,default:[],options:[{name:"Order",value:"order_json_facets"}],displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Order",name:"order_json_facets_facetOrdering_renderingContent",default:"[]",description:`Explicit order of facets or facet values.
|
|
603
601
|
|
|
604
602
|
This setting lets you always show specific facets or facet values at the top of the list.
|
|
605
|
-
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{
|
|
603
|
+
`,required:!1,displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent:["order_json_facets"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Values",name:"values_object_facetOrdering_renderingContent",description:"Order of facet values. One object for each facet.",required:!1,default:"{}",displayOptions:{show:{rendering_content_object:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent:["values_object_facetOrdering"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Redirect URL",name:"redirect_url_object_renderingContent",type:"multiOptions",description:"The redirect rule container.",required:!1,default:[],options:[{name:"Url",value:"url_string_redirect"}],displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"string",default:"",displayName:"Url",name:"url_string_redirect_renderingContent",displayOptions:{show:{rendering_content_object:["redirect_url_object_renderingContent"],redirect_url_object_renderingContent:["url_string_redirect"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{displayName:"Widgets",name:"widgets_object_renderingContent",type:"multiOptions",description:"Widgets returned from any rules that are applied to the current search.",required:!1,default:[],options:[{name:"Banners",value:"banners_json_widgets"}],displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"json",displayName:"Banners",name:"banners_json_widgets_renderingContent",default:"[]",description:"Banners defined in the Merchandising Studio for a given search.",required:!1,displayOptions:{show:{rendering_content_object:["widgets_object_renderingContent"],widgets_object_renderingContent:["banners_json_widgets"],index_settings:["rendering_content_object"],resource:["Indices"],operation:["setSettings"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
606
604
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
607
|
-
`,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",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string",
|
|
608
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"placeholder"}},displayName:"Placeholder",name:"placeholder_string",
|
|
605
|
+
`,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:"={{ $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:"={{ $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.
|
|
606
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"placeholder"}},displayName:"Placeholder",name:"placeholder_string",displayOptions:{show:{synonym_hit_object:["placeholder_string"],resource:["Synonyms"],operation:["saveSynonym"]}}},{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:{send:{type:"body",value:"={{ $value }}",property:"replacements"}},displayOptions:{show:{synonym_hit_object:["replacements_json"],resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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,displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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 }}"}}]}}}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}},{type:"boolean",default:!1,routing:{request:{qs:{replaceExistingSynonyms:"={{ $value }}"}}},displayName:"Replace Existing Synonyms",name:"replaceExistingSynonyms_boolean",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}},{type:"json",displayName:"Synonym Hits",name:"synonymHits_json",default:"[]",description:"Matching synonyms.",required:!1,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,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 }}"}}]}}}}},{type:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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:"Search Synonyms Params",name:"search_synonyms_params_object",type:"multiOptions",description:void 0,required:!1,default:[],options:[{name:"Query",value:"query_string"},{name:"Type",value:"type_options"},{name:"Page",value:"page_number"},{name:"Hits Per Page",value:"hitsPerPage_number"}],displayOptions:{show:{resource:["Synonyms"],operation:["searchSynonyms"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",displayOptions:{show:{search_synonyms_params_object:["query_string"],resource:["Synonyms"],operation:["searchSynonyms"]}}},{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:{search_synonyms_params_object:["type_options"],resource:["Synonyms"],operation:["searchSynonyms"]}}},{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_synonyms_params_object:["page_number"],resource:["Synonyms"],operation:["searchSynonyms"]}}},{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_synonyms_params_object:["hitsPerPage_number"],resource:["Synonyms"],operation:["searchSynonyms"]}}},{displayName:"Api Key",name:"api_key_object",type:"multiOptions",description:"API key object.",required:!0,default:[],options:[{name:"Acl",value:"acl_json"},{name:"Description",value:"description_string"},{name:"Indexes",value:"indexes_json"},{name:"Max Hits Per Query",value:"maxHitsPerQuery_number"},{name:"Max Queries Per IPPer Hour",value:"maxQueriesPerIPPerHour_number"},{name:"Query Parameters",value:"queryParameters_string"},{name:"Referers",value:"referers_json"},{name:"Validity",value:"validity_number"}],displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}},{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
609
607
|
The required ACL is listed in each endpoint's reference.
|
|
610
608
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
611
|
-
`,required:!
|
|
609
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ $value }}",property:"acl"}},displayOptions:{show:{api_key_object:["acl_json"],resource:["Api Keys"],operation:["addApiKey"]}}},{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",displayOptions:{show:{api_key_object:["description_string"],resource:["Api Keys"],operation:["addApiKey"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"indexes"}},displayOptions:{show:{api_key_object:["indexes_json"],resource:["Api Keys"],operation:["addApiKey"]}}},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
612
610
|
By default, there's no limit.
|
|
613
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxHitsPerQuery"}},displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number",
|
|
611
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxHitsPerQuery"}},displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number",displayOptions:{show:{api_key_object:["maxHitsPerQuery_number"],resource:["Api Keys"],operation:["addApiKey"]}}},{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.
|
|
614
612
|
|
|
615
613
|
If this limit is reached, the API returns an error with status code \`429\`.
|
|
616
614
|
By default, there's no limit.
|
|
617
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxQueriesPerIPPerHour"}},displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number",
|
|
615
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxQueriesPerIPPerHour"}},displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number",displayOptions:{show:{api_key_object:["maxQueriesPerIPPerHour_number"],resource:["Api Keys"],operation:["addApiKey"]}}},{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.
|
|
618
616
|
|
|
619
617
|
To restrict this API key to specific IP addresses, add the \`restrictSources\` parameter.
|
|
620
618
|
You can only add a single source, but you can provide a range of IP addresses.
|
|
621
619
|
|
|
622
620
|
Creating an API key fails if the request is made from an IP address outside the restricted range.
|
|
623
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"queryParameters"}},displayName:"Query Parameters",name:"queryParameters_string",
|
|
621
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"queryParameters"}},displayName:"Query Parameters",name:"queryParameters_string",displayOptions:{show:{api_key_object:["queryParameters_string"],resource:["Api Keys"],operation:["addApiKey"]}}},{type:"json",displayName:"Referers",name:"referers_json",default:"[]",description:`Allowed HTTP referrers for this API key.
|
|
624
622
|
|
|
625
623
|
By default, all referrers are allowed.
|
|
626
624
|
You can use leading and trailing wildcard characters (\`*\`):
|
|
@@ -631,24 +629,24 @@ You can use leading and trailing wildcard characters (\`*\`):
|
|
|
631
629
|
|
|
632
630
|
Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
|
|
633
631
|
For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
|
|
634
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
632
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"referers"}},displayOptions:{show:{api_key_object:["referers_json"],resource:["Api Keys"],operation:["addApiKey"]}}},{type:"number",placeholder:"86400",default:"",description:`Duration (in seconds) after which the API key expires.
|
|
635
633
|
By default, API keys don't expire.
|
|
636
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"validity"}},displayName:"Validity",name:"validity_number",
|
|
634
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"validity"}},displayName:"Validity",name:"validity_number",displayOptions:{show:{api_key_object:["validity_number"],resource:["Api Keys"],operation:["addApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,displayOptions:{show:{resource:["Api Keys"],operation:["getApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{displayName:"Api Key",name:"api_key_object",type:"multiOptions",description:"API key object.",required:!0,default:[],options:[{name:"Acl",value:"acl_json"},{name:"Description",value:"description_string"},{name:"Indexes",value:"indexes_json"},{name:"Max Hits Per Query",value:"maxHitsPerQuery_number"},{name:"Max Queries Per IPPer Hour",value:"maxQueriesPerIPPerHour_number"},{name:"Query Parameters",value:"queryParameters_string"},{name:"Referers",value:"referers_json"},{name:"Validity",value:"validity_number"}],displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
637
635
|
The required ACL is listed in each endpoint's reference.
|
|
638
636
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
639
|
-
`,required:!
|
|
637
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ $value }}",property:"acl"}},displayOptions:{show:{api_key_object:["acl_json"],resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",displayOptions:{show:{api_key_object:["description_string"],resource:["Api Keys"],operation:["updateApiKey"]}}},{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,routing:{send:{type:"body",value:"={{ $value }}",property:"indexes"}},displayOptions:{show:{api_key_object:["indexes_json"],resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
640
638
|
By default, there's no limit.
|
|
641
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxHitsPerQuery"}},displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number",
|
|
639
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxHitsPerQuery"}},displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number",displayOptions:{show:{api_key_object:["maxHitsPerQuery_number"],resource:["Api Keys"],operation:["updateApiKey"]}}},{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.
|
|
642
640
|
|
|
643
641
|
If this limit is reached, the API returns an error with status code \`429\`.
|
|
644
642
|
By default, there's no limit.
|
|
645
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxQueriesPerIPPerHour"}},displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number",
|
|
643
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"maxQueriesPerIPPerHour"}},displayName:"Max Queries Per IPPer Hour",name:"maxQueriesPerIPPerHour_number",displayOptions:{show:{api_key_object:["maxQueriesPerIPPerHour_number"],resource:["Api Keys"],operation:["updateApiKey"]}}},{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.
|
|
646
644
|
|
|
647
645
|
To restrict this API key to specific IP addresses, add the \`restrictSources\` parameter.
|
|
648
646
|
You can only add a single source, but you can provide a range of IP addresses.
|
|
649
647
|
|
|
650
648
|
Creating an API key fails if the request is made from an IP address outside the restricted range.
|
|
651
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"queryParameters"}},displayName:"Query Parameters",name:"queryParameters_string",
|
|
649
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"queryParameters"}},displayName:"Query Parameters",name:"queryParameters_string",displayOptions:{show:{api_key_object:["queryParameters_string"],resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"json",displayName:"Referers",name:"referers_json",default:"[]",description:`Allowed HTTP referrers for this API key.
|
|
652
650
|
|
|
653
651
|
By default, all referrers are allowed.
|
|
654
652
|
You can use leading and trailing wildcard characters (\`*\`):
|
|
@@ -659,29 +657,29 @@ You can use leading and trailing wildcard characters (\`*\`):
|
|
|
659
657
|
|
|
660
658
|
Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
|
|
661
659
|
For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
|
|
662
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
660
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"referers"}},displayOptions:{show:{api_key_object:["referers_json"],resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"number",placeholder:"86400",default:"",description:`Duration (in seconds) after which the API key expires.
|
|
663
661
|
By default, API keys don't expire.
|
|
664
|
-
`,routing:{send:{type:"body",value:"={{ $value }}",property:"validity"}},displayName:"Validity",name:"validity_number",
|
|
662
|
+
`,routing:{send:{type:"body",value:"={{ $value }}",property:"validity"}},displayName:"Validity",name:"validity_number",displayOptions:{show:{api_key_object:["validity_number"],resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,displayOptions:{show:{resource:["Api Keys"],operation:["deleteApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,displayOptions:{show:{resource:["Api Keys"],operation:["restoreApiKey"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,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:"boolean",default:!1,routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Rule",name:"rule_object",type:"multiOptions",description:"Rule object.",required:!0,default:[],options:[{name:"Object ID",value:"objectID_string"},{name:"Conditions",value:"conditions_json"},{name:"Consequence",value:"consequence_object"},{name:"Description",value:"description_string"},{name:"Enabled",value:"enabled_boolean"},{name:"Validity",value:"validity_json"}],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",displayOptions:{show:{rule_object:["objectID_string"],resource:["Rules"],operation:["saveRule"]}},required:!0},{type:"json",displayName:"Conditions",name:"conditions_json",default:"[]",description:`Conditions that trigger a rule.
|
|
665
663
|
|
|
666
664
|
Some consequences require specific conditions or don't require any condition.
|
|
667
665
|
For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
|
|
668
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
666
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $value }}",property:"conditions"}},displayOptions:{show:{rule_object:["conditions_json"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Consequence",name:"consequence_object",type:"multiOptions",description:`Effect of the rule.
|
|
669
667
|
|
|
670
668
|
For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
|
|
671
|
-
`,required:!1,default:[],options:[{name:"Consequence Params",value:"consequence_params_consequence"},{name:"Promote",value:"promote_json_consequence"},{name:"Filter Promotes",value:"filterPromotes_boolean_consequence"},{name:"Hide",value:"hide_fixedCollection_consequence"}],routing:{send:{type:"body",property:"consequence",value:'={{ { "similarQuery": typeof $parameter.similarQuery_string_params_consequence !== "undefined" ? $parameter.similarQuery_string_params_consequence : undefined, "filters": typeof $parameter.filters_string_params_consequence !== "undefined" ? $parameter.filters_string_params_consequence : undefined, "facetFilters": typeof $parameter.facetFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.facetFilters_json_params_consequence) : typeof $parameter.facetFilters_string_params_consequence !== "undefined" ? $parameter.facetFilters_string_params_consequence : undefined, "optionalFilters": typeof $parameter.optionalFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.optionalFilters_json_params_consequence) : typeof $parameter.optionalFilters_string_params_consequence !== "undefined" ? $parameter.optionalFilters_string_params_consequence : undefined, "numericFilters": typeof $parameter.numericFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.numericFilters_json_params_consequence) : typeof $parameter.numericFilters_string_params_consequence !== "undefined" ? $parameter.numericFilters_string_params_consequence : undefined, "tagFilters": typeof $parameter.tagFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.tagFilters_json_params_consequence) : typeof $parameter.tagFilters_string_params_consequence !== "undefined" ? $parameter.tagFilters_string_params_consequence : undefined, "sumOrFiltersScores": typeof $parameter.sumOrFiltersScores_boolean_params_consequence !== "undefined" ? $parameter.sumOrFiltersScores_boolean_params_consequence : undefined, "restrictSearchableAttributes": typeof $parameter.restrictSearchableAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.restrictSearchableAttributes_json_params_consequence) : undefined, "facets": typeof $parameter.facets_json_params_consequence !== "undefined" ? JSON.parse($parameter.facets_json_params_consequence) : undefined, "facetingAfterDistinct": typeof $parameter.facetingAfterDistinct_boolean_params_consequence !== "undefined" ? $parameter.facetingAfterDistinct_boolean_params_consequence : undefined, "page": typeof $parameter.page_number_params_consequence !== "undefined" ? $parameter.page_number_params_consequence : undefined, "offset": typeof $parameter.offset_number_params_consequence !== "undefined" ? $parameter.offset_number_params_consequence : undefined, "length": typeof $parameter.length_number_params_consequence !== "undefined" ? $parameter.length_number_params_consequence : undefined, "aroundLatLng": typeof $parameter.aroundLatLng_string_params_consequence !== "undefined" ? $parameter.aroundLatLng_string_params_consequence : undefined, "aroundLatLngViaIP": typeof $parameter.aroundLatLngViaIP_boolean_params_consequence !== "undefined" ? $parameter.aroundLatLngViaIP_boolean_params_consequence : undefined, "aroundRadius": typeof $parameter.aroundRadius_number_params_consequence !== "undefined" ? $parameter.aroundRadius_number_params_consequence : typeof $parameter.aroundRadius_options_params_consequence !== "undefined" ? $parameter.aroundRadius_options_params_consequence : undefined, "aroundPrecision": typeof $parameter.aroundPrecision_number_params_consequence !== "undefined" ? $parameter.aroundPrecision_number_params_consequence : typeof $parameter.aroundPrecision_fixedCollection_params_consequence.aroundPrecision_fixedCollection_values !== "undefined" ? $parameter.aroundPrecision_fixedCollection_params_consequence.aroundPrecision_fixedCollection_values?.map(item => ({ from: typeof item.from_number_aroundPrecision !== "undefined" ? item.from_number_aroundPrecision : undefined, value: typeof item.value_number_aroundPrecision !== "undefined" ? item.value_number_aroundPrecision : undefined })) : undefined, "minimumAroundRadius": typeof $parameter.minimumAroundRadius_number_params_consequence !== "undefined" ? $parameter.minimumAroundRadius_number_params_consequence : undefined, "insideBoundingBox": typeof $parameter.insideBoundingBox_string_params_consequence !== "undefined" ? $parameter.insideBoundingBox_string_params_consequence : typeof $parameter.insideBoundingBox_null_params_consequence !== "undefined" ? JSON.parse($parameter.insideBoundingBox_null_params_consequence) : typeof $parameter.insideBoundingBox_json_params_consequence !== "undefined" ? JSON.parse($parameter.insideBoundingBox_json_params_consequence) : undefined, "insidePolygon": typeof $parameter.insidePolygon_json_params_consequence !== "undefined" ? JSON.parse($parameter.insidePolygon_json_params_consequence) : undefined, "naturalLanguages": typeof $parameter.naturalLanguages_json_params_consequence !== "undefined" ? JSON.parse($parameter.naturalLanguages_json_params_consequence) : undefined, "ruleContexts": typeof $parameter.ruleContexts_json_params_consequence !== "undefined" ? JSON.parse($parameter.ruleContexts_json_params_consequence) : undefined, "personalizationImpact": typeof $parameter.personalizationImpact_number_params_consequence !== "undefined" ? $parameter.personalizationImpact_number_params_consequence : undefined, "userToken": typeof $parameter.userToken_string_params_consequence !== "undefined" ? $parameter.userToken_string_params_consequence : undefined, "getRankingInfo": typeof $parameter.getRankingInfo_boolean_params_consequence !== "undefined" ? $parameter.getRankingInfo_boolean_params_consequence : undefined, "synonyms": typeof $parameter.synonyms_boolean_params_consequence !== "undefined" ? $parameter.synonyms_boolean_params_consequence : undefined, "clickAnalytics": typeof $parameter.clickAnalytics_boolean_params_consequence !== "undefined" ? $parameter.clickAnalytics_boolean_params_consequence : undefined, "analytics": typeof $parameter.analytics_boolean_params_consequence !== "undefined" ? $parameter.analytics_boolean_params_consequence : undefined, "analyticsTags": typeof $parameter.analyticsTags_json_params_consequence !== "undefined" ? JSON.parse($parameter.analyticsTags_json_params_consequence) : undefined, "percentileComputation": typeof $parameter.percentileComputation_boolean_params_consequence !== "undefined" ? $parameter.percentileComputation_boolean_params_consequence : undefined, "enableABTest": typeof $parameter.enableABTest_boolean_params_consequence !== "undefined" ? $parameter.enableABTest_boolean_params_consequence : undefined, "attributesToRetrieve": typeof $parameter.attributesToRetrieve_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToRetrieve_json_params_consequence) : undefined, "ranking": typeof $parameter.ranking_json_params_consequence !== "undefined" ? JSON.parse($parameter.ranking_json_params_consequence) : undefined, "relevancyStrictness": typeof $parameter.relevancyStrictness_number_params_consequence !== "undefined" ? $parameter.relevancyStrictness_number_params_consequence : undefined, "attributesToHighlight": typeof $parameter.attributesToHighlight_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToHighlight_json_params_consequence) : undefined, "attributesToSnippet": typeof $parameter.attributesToSnippet_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToSnippet_json_params_consequence) : undefined, "highlightPreTag": typeof $parameter.highlightPreTag_string_params_consequence !== "undefined" ? $parameter.highlightPreTag_string_params_consequence : undefined, "highlightPostTag": typeof $parameter.highlightPostTag_string_params_consequence !== "undefined" ? $parameter.highlightPostTag_string_params_consequence : undefined, "snippetEllipsisText": typeof $parameter.snippetEllipsisText_string_params_consequence !== "undefined" ? $parameter.snippetEllipsisText_string_params_consequence : undefined, "restrictHighlightAndSnippetArrays": typeof $parameter.restrictHighlightAndSnippetArrays_boolean_params_consequence !== "undefined" ? $parameter.restrictHighlightAndSnippetArrays_boolean_params_consequence : undefined, "hitsPerPage": typeof $parameter.hitsPerPage_number_params_consequence !== "undefined" ? $parameter.hitsPerPage_number_params_consequence : undefined, "minWordSizefor1Typo": typeof $parameter.minWordSizefor1Typo_number_params_consequence !== "undefined" ? $parameter.minWordSizefor1Typo_number_params_consequence : undefined, "minWordSizefor2Typos": typeof $parameter.minWordSizefor2Typos_number_params_consequence !== "undefined" ? $parameter.minWordSizefor2Typos_number_params_consequence : undefined, "typoTolerance": typeof $parameter.typoTolerance_boolean_params_consequence !== "undefined" ? $parameter.typoTolerance_boolean_params_consequence : typeof $parameter.typoTolerance_options_params_consequence !== "undefined" ? $parameter.typoTolerance_options_params_consequence : undefined, "allowTyposOnNumericTokens": typeof $parameter.allowTyposOnNumericTokens_boolean_params_consequence !== "undefined" ? $parameter.allowTyposOnNumericTokens_boolean_params_consequence : undefined, "disableTypoToleranceOnAttributes": typeof $parameter.disableTypoToleranceOnAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.disableTypoToleranceOnAttributes_json_params_consequence) : undefined, "ignorePlurals": typeof $parameter.ignorePlurals_json_params_consequence !== "undefined" ? JSON.parse($parameter.ignorePlurals_json_params_consequence) : typeof $parameter.ignorePlurals_options_params_consequence !== "undefined" ? $parameter.ignorePlurals_options_params_consequence : typeof $parameter.ignorePlurals_boolean_params_consequence !== "undefined" ? $parameter.ignorePlurals_boolean_params_consequence : undefined, "removeStopWords": typeof $parameter.removeStopWords_json_params_consequence !== "undefined" ? JSON.parse($parameter.removeStopWords_json_params_consequence) : typeof $parameter.removeStopWords_boolean_params_consequence !== "undefined" ? $parameter.removeStopWords_boolean_params_consequence : undefined, "queryLanguages": typeof $parameter.queryLanguages_json_params_consequence !== "undefined" ? JSON.parse($parameter.queryLanguages_json_params_consequence) : undefined, "decompoundQuery": typeof $parameter.decompoundQuery_boolean_params_consequence !== "undefined" ? $parameter.decompoundQuery_boolean_params_consequence : undefined, "enableRules": typeof $parameter.enableRules_boolean_params_consequence !== "undefined" ? $parameter.enableRules_boolean_params_consequence : undefined, "enablePersonalization": typeof $parameter.enablePersonalization_boolean_params_consequence !== "undefined" ? $parameter.enablePersonalization_boolean_params_consequence : undefined, "queryType": typeof $parameter.queryType_options_params_consequence !== "undefined" ? $parameter.queryType_options_params_consequence : undefined, "removeWordsIfNoResults": typeof $parameter.removeWordsIfNoResults_options_params_consequence !== "undefined" ? $parameter.removeWordsIfNoResults_options_params_consequence : undefined, "mode": typeof $parameter.mode_options_params_consequence !== "undefined" ? $parameter.mode_options_params_consequence : undefined, "semanticSearch": { "eventSources": typeof $parameter.eventSources_json_semanticSearch_params_consequence !== "undefined" ? JSON.parse($parameter.eventSources_json_semanticSearch_params_consequence) : typeof $parameter.eventSources_null_semanticSearch_params_consequence !== "undefined" ? JSON.parse($parameter.eventSources_null_semanticSearch_params_consequence) : undefined }, "advancedSyntax": typeof $parameter.advancedSyntax_boolean_params_consequence !== "undefined" ? $parameter.advancedSyntax_boolean_params_consequence : undefined, "optionalWords": typeof $parameter.optionalWords_string_params_consequence !== "undefined" ? $parameter.optionalWords_string_params_consequence : typeof $parameter.optionalWords_null_params_consequence !== "undefined" ? JSON.parse($parameter.optionalWords_null_params_consequence) : typeof $parameter.optionalWords_json_params_consequence !== "undefined" ? JSON.parse($parameter.optionalWords_json_params_consequence) : undefined, "disableExactOnAttributes": typeof $parameter.disableExactOnAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.disableExactOnAttributes_json_params_consequence) : undefined, "exactOnSingleWordQuery": typeof $parameter.exactOnSingleWordQuery_options_params_consequence !== "undefined" ? $parameter.exactOnSingleWordQuery_options_params_consequence : undefined, "alternativesAsExact": typeof $parameter.alternativesAsExact_json_params_consequence !== "undefined" ? JSON.parse($parameter.alternativesAsExact_json_params_consequence) : undefined, "advancedSyntaxFeatures": typeof $parameter.advancedSyntaxFeatures_json_params_consequence !== "undefined" ? JSON.parse($parameter.advancedSyntaxFeatures_json_params_consequence) : undefined, "distinct": typeof $parameter.distinct_boolean_params_consequence !== "undefined" ? $parameter.distinct_boolean_params_consequence : typeof $parameter.distinct_number_params_consequence !== "undefined" ? $parameter.distinct_number_params_consequence : undefined, "replaceSynonymsInHighlight": typeof $parameter.replaceSynonymsInHighlight_boolean_params_consequence !== "undefined" ? $parameter.replaceSynonymsInHighlight_boolean_params_consequence : undefined, "minProximity": typeof $parameter.minProximity_number_params_consequence !== "undefined" ? $parameter.minProximity_number_params_consequence : undefined, "responseFields": typeof $parameter.responseFields_json_params_consequence !== "undefined" ? JSON.parse($parameter.responseFields_json_params_consequence) : undefined, "maxValuesPerFacet": typeof $parameter.maxValuesPerFacet_number_params_consequence !== "undefined" ? $parameter.maxValuesPerFacet_number_params_consequence : undefined, "sortFacetValuesBy": typeof $parameter.sortFacetValuesBy_string_params_consequence !== "undefined" ? $parameter.sortFacetValuesBy_string_params_consequence : undefined, "attributeCriteriaComputedByMinProximity": typeof $parameter.attributeCriteriaComputedByMinProximity_boolean_params_consequence !== "undefined" ? $parameter.attributeCriteriaComputedByMinProximity_boolean_params_consequence : undefined, "renderingContent": { }, "enableReRanking": typeof $parameter.enableReRanking_boolean_params_consequence !== "undefined" ? $parameter.enableReRanking_boolean_params_consequence : undefined, "reRankingApplyFilter": typeof $parameter.reRankingApplyFilter_json_params_consequence !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_json_params_consequence) : typeof $parameter.reRankingApplyFilter_string_params_consequence !== "undefined" ? $parameter.reRankingApplyFilter_string_params_consequence : typeof $parameter.reRankingApplyFilter_null_params_consequence !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_null_params_consequence) : undefined, "query": typeof $parameter.consequence_query_object_object_params_consequence !== "undefined" ? { "remove": typeof $parameter.remove_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.remove_json_query_params_consequence) : undefined, "edits": typeof $parameter.edits_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.edits_json_query_params_consequence) : undefined } : typeof $parameter.remove_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.remove_json_query_params_consequence) : typeof $parameter.edits_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.edits_json_query_params_consequence) : typeof $parameter.query_string_params_consequence !== "undefined" ? $parameter.query_string_params_consequence : undefined, "automaticFacetFilters": typeof $parameter.automaticFacetFilters_fixedCollection_params_consequence.automaticFacetFilters_fixedCollection_values !== "undefined" ? $parameter.automaticFacetFilters_fixedCollection_params_consequence.automaticFacetFilters_fixedCollection_values?.map(item => ({ facet: typeof item.facet_string_automaticFacetFilters !== "undefined" ? item.facet_string_automaticFacetFilters : undefined, score: typeof item.score_number_automaticFacetFilters !== "undefined" ? item.score_number_automaticFacetFilters : undefined, disjunctive: typeof item.disjunctive_boolean_automaticFacetFilters !== "undefined" ? item.disjunctive_boolean_automaticFacetFilters : undefined })) : typeof $parameter.automaticFacetFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.automaticFacetFilters_json_params_consequence) : undefined, "automaticOptionalFacetFilters": typeof $parameter.automaticOptionalFacetFilters_fixedCollection_params_consequence.automaticOptionalFacetFilters_fixedCollection_values !== "undefined" ? $parameter.automaticOptionalFacetFilters_fixedCollection_params_consequence.automaticOptionalFacetFilters_fixedCollection_values?.map(item => ({ facet: typeof item.facet_string_automaticOptionalFacetFilters !== "undefined" ? item.facet_string_automaticOptionalFacetFilters : undefined, score: typeof item.score_number_automaticOptionalFacetFilters !== "undefined" ? item.score_number_automaticOptionalFacetFilters : undefined, disjunctive: typeof item.disjunctive_boolean_automaticOptionalFacetFilters !== "undefined" ? item.disjunctive_boolean_automaticOptionalFacetFilters : undefined })) : typeof $parameter.automaticOptionalFacetFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.automaticOptionalFacetFilters_json_params_consequence) : undefined, "renderingContent": { }, "promote": typeof $parameter.promote_json_consequence !== "undefined" ? JSON.parse($parameter.promote_json_consequence) : undefined, "filterPromotes": typeof $parameter.filterPromotes_boolean_consequence !== "undefined" ? $parameter.filterPromotes_boolean_consequence : undefined, "hide": $parameter.hide_fixedCollection_consequence.hide_fixedCollection_values?.map(item => ({ objectID: typeof item.objectID_string_hide !== "undefined" ? item.objectID_string_hide : undefined })) } }}'}},displayOptions:{show:{rule_object:["consequence_object"],resource:["Rules"],operation:["saveRule"]}}},{type:"multiOptions",name:"consequence_params_consequence",displayName:"Consequence Params",description:void 0,default:[],options:[{name:"Similar Query",value:"similarquery_string_params"},{name:"Filters",value:"filters_string_params"},{name:"Facet Filters Params",value:"facetfilters_params"},{name:"Optional Filters Params",value:"optionalfilters_params"},{name:"Numeric Filters Params",value:"numericfilters_params"},{name:"Tag Filters Params",value:"tagfilters_params"},{name:"Sum Or Filters Scores",value:"sumorfiltersscores_boolean_params"},{name:"Restrict Searchable Attributes",value:"restrictsearchableattributes_json_params"},{name:"Facets",value:"facets_json_params"},{name:"Faceting After Distinct",value:"facetingafterdistinct_boolean_params"},{name:"Page",value:"page_number_params"},{name:"Offset",value:"offset_number_params"},{name:"Length",value:"length_number_params"},{name:"Around Lat Lng",value:"aroundlatlng_string_params"},{name:"Around Lat Lng Via IP",value:"aroundlatlngviaip_boolean_params"},{name:"Around Radius Params",value:"aroundradius_params"},{name:"Around Precision Params",value:"aroundprecision_params"},{name:"Minimum Around Radius",value:"minimumaroundradius_number_params"},{name:"Inside Bounding Box Params",value:"insideboundingbox_params"},{name:"Inside Polygon",value:"insidepolygon_json_params"},{name:"Natural Languages",value:"naturallanguages_json_params"},{name:"Rule Contexts",value:"rulecontexts_json_params"},{name:"Personalization Impact",value:"personalizationimpact_number_params"},{name:"User Token",value:"usertoken_string_params"},{name:"Get Ranking Info",value:"getrankinginfo_boolean_params"},{name:"Synonyms",value:"synonyms_boolean_params"},{name:"Click Analytics",value:"clickanalytics_boolean_params"},{name:"Analytics",value:"analytics_boolean_params"},{name:"Analytics Tags",value:"analyticstags_json_params"},{name:"Percentile Computation",value:"percentilecomputation_boolean_params"},{name:"Enable ABTest",value:"enableabtest_boolean_params"},{name:"Attributes To Retrieve",value:"attributestoretrieve_json_params"},{name:"Ranking",value:"ranking_json_params"},{name:"Relevancy Strictness",value:"relevancystrictness_number_params"},{name:"Attributes To Highlight",value:"attributestohighlight_json_params"},{name:"Attributes To Snippet",value:"attributestosnippet_json_params"},{name:"Highlight Pre Tag",value:"highlightpretag_string_params"},{name:"Highlight Post Tag",value:"highlightposttag_string_params"},{name:"Snippet Ellipsis Text",value:"snippetellipsistext_string_params"},{name:"Restrict Highlight And Snippet Arrays",value:"restricthighlightandsnippetarrays_boolean_params"},{name:"Hits Per Page",value:"hitsperpage_number_params"},{name:"Min Word Sizefor1Typo",value:"minwordsizefor1typo_number_params"},{name:"Min Word Sizefor2Typos",value:"minwordsizefor2typos_number_params"},{name:"Typo Tolerance Params",value:"typotolerance_params"},{name:"Allow Typos On Numeric Tokens",value:"allowtyposonnumerictokens_boolean_params"},{name:"Disable Typo Tolerance On Attributes",value:"disabletypotoleranceonattributes_json_params"},{name:"Ignore Plurals Params",value:"ignoreplurals_params"},{name:"Remove Stop Words Params",value:"removestopwords_params"},{name:"Query Languages",value:"querylanguages_json_params"},{name:"Decompound Query",value:"decompoundquery_boolean_params"},{name:"Enable Rules",value:"enablerules_boolean_params"},{name:"Enable Personalization",value:"enablepersonalization_boolean_params"},{name:"Query Type",value:"querytype_options_params"},{name:"Remove Words If No Results",value:"removewordsifnoresults_options_params"},{name:"Mode",value:"mode_options_params"},{name:"Semantic Search Object Params",value:"semantic_search_object_params"},{name:"Advanced Syntax",value:"advancedsyntax_boolean_params"},{name:"Optional Words Params",value:"optionalwords_params"},{name:"Disable Exact On Attributes",value:"disableexactonattributes_json_params"},{name:"Exact On Single Word Query",value:"exactonsinglewordquery_options_params"},{name:"Alternatives As Exact",value:"alternativesasexact_json_params"},{name:"Advanced Syntax Features",value:"advancedsyntaxfeatures_json_params"},{name:"Distinct Params",value:"distinct_params"},{name:"Replace Synonyms In Highlight",value:"replacesynonymsinhighlight_boolean_params"},{name:"Min Proximity",value:"minproximity_number_params"},{name:"Response Fields",value:"responsefields_json_params"},{name:"Max Values Per Facet",value:"maxvaluesperfacet_number_params"},{name:"Sort Facet Values By",value:"sortfacetvaluesby_string_params"},{name:"Attribute Criteria Computed By Min Proximity",value:"attributecriteriacomputedbyminproximity_boolean_params"},{name:"Rendering Content Object Params",value:"rendering_content_object_params"},{name:"Enable Re Ranking",value:"enablereranking_boolean_params"},{name:"Re Ranking Apply Filter Params",value:"rerankingapplyfilter_params"},{name:"Query Params",value:"query_params"},{name:"Automatic Facet Filters Params",value:"automaticfacetfilters_params"},{name:"Automatic Optional Facet Filters Params",value:"automaticoptionalfacetfilters_params"},{name:"Rendering Content Object Params",value:"rendering_content_object_params"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",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_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["similarquery_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",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_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["filters_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"facetFilters_params_consequence",displayName:"Facet Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],facetFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",displayName:"Facet Filters (String)",name:"facetFilters_string_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],facetFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"optionalFilters_params_consequence",displayName:"Optional Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],optionalFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",displayName:"Optional Filters (String)",name:"optionalFilters_string_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],optionalFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"numericFilters_params_consequence",displayName:"Numeric Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],numericFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",displayName:"Numeric Filters (String)",name:"numericFilters_string_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],numericFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"tagFilters_params_consequence",displayName:"Tag Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],tagFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",displayName:"Tag Filters (String)",name:"tagFilters_string_params_consequence",default:"",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],tagFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",description:`Whether to sum all filter scores
|
|
669
|
+
`,required:!0,default:[],options:[{name:"Consequence Params",value:"consequence_params_consequence"},{name:"Promote",value:"promote_json_consequence"},{name:"Filter Promotes",value:"filterPromotes_boolean_consequence"},{name:"Hide",value:"hide_json_consequence"},{name:"User Data",value:"user_data_object_consequence"}],routing:{send:{type:"body",property:"consequence",value:'={{ { "similarQuery": typeof $parameter.similarQuery_string_params_consequence !== "undefined" ? $parameter.similarQuery_string_params_consequence : undefined, "filters": typeof $parameter.filters_string_params_consequence !== "undefined" ? $parameter.filters_string_params_consequence : undefined, "facetFilters": typeof $parameter.facetFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.facetFilters_json_params_consequence) : typeof $parameter.facetFilters_string_params_consequence !== "undefined" ? $parameter.facetFilters_string_params_consequence : undefined, "optionalFilters": typeof $parameter.optionalFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.optionalFilters_json_params_consequence) : typeof $parameter.optionalFilters_string_params_consequence !== "undefined" ? $parameter.optionalFilters_string_params_consequence : undefined, "numericFilters": typeof $parameter.numericFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.numericFilters_json_params_consequence) : typeof $parameter.numericFilters_string_params_consequence !== "undefined" ? $parameter.numericFilters_string_params_consequence : undefined, "tagFilters": typeof $parameter.tagFilters_json_params_consequence !== "undefined" ? JSON.parse($parameter.tagFilters_json_params_consequence) : typeof $parameter.tagFilters_string_params_consequence !== "undefined" ? $parameter.tagFilters_string_params_consequence : undefined, "sumOrFiltersScores": typeof $parameter.sumOrFiltersScores_boolean_params_consequence !== "undefined" ? $parameter.sumOrFiltersScores_boolean_params_consequence : undefined, "restrictSearchableAttributes": typeof $parameter.restrictSearchableAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.restrictSearchableAttributes_json_params_consequence) : undefined, "facets": typeof $parameter.facets_json_params_consequence !== "undefined" ? JSON.parse($parameter.facets_json_params_consequence) : undefined, "facetingAfterDistinct": typeof $parameter.facetingAfterDistinct_boolean_params_consequence !== "undefined" ? $parameter.facetingAfterDistinct_boolean_params_consequence : undefined, "page": typeof $parameter.page_number_params_consequence !== "undefined" ? $parameter.page_number_params_consequence : undefined, "offset": typeof $parameter.offset_number_params_consequence !== "undefined" ? $parameter.offset_number_params_consequence : undefined, "length": typeof $parameter.length_number_params_consequence !== "undefined" ? $parameter.length_number_params_consequence : undefined, "aroundLatLng": typeof $parameter.aroundLatLng_string_params_consequence !== "undefined" ? $parameter.aroundLatLng_string_params_consequence : undefined, "aroundLatLngViaIP": typeof $parameter.aroundLatLngViaIP_boolean_params_consequence !== "undefined" ? $parameter.aroundLatLngViaIP_boolean_params_consequence : undefined, "aroundRadius": typeof $parameter.aroundRadius_number_params_consequence !== "undefined" ? $parameter.aroundRadius_number_params_consequence : typeof $parameter.aroundRadius_options_params_consequence !== "undefined" ? $parameter.aroundRadius_options_params_consequence : undefined, "aroundPrecision": typeof $parameter.aroundPrecision_number_params_consequence !== "undefined" ? $parameter.aroundPrecision_number_params_consequence : typeof $parameter.aroundPrecision_json_params_consequence !== "undefined" ? JSON.parse($parameter.aroundPrecision_json_params_consequence) : undefined, "minimumAroundRadius": typeof $parameter.minimumAroundRadius_number_params_consequence !== "undefined" ? $parameter.minimumAroundRadius_number_params_consequence : undefined, "insideBoundingBox": typeof $parameter.insideBoundingBox_string_params_consequence !== "undefined" ? $parameter.insideBoundingBox_string_params_consequence : typeof $parameter.insideBoundingBox_null_params_consequence !== "undefined" ? JSON.parse($parameter.insideBoundingBox_null_params_consequence) : typeof $parameter.insideBoundingBox_json_params_consequence !== "undefined" ? JSON.parse($parameter.insideBoundingBox_json_params_consequence) : undefined, "insidePolygon": typeof $parameter.insidePolygon_json_params_consequence !== "undefined" ? JSON.parse($parameter.insidePolygon_json_params_consequence) : undefined, "naturalLanguages": typeof $parameter.naturalLanguages_json_params_consequence !== "undefined" ? JSON.parse($parameter.naturalLanguages_json_params_consequence) : undefined, "ruleContexts": typeof $parameter.ruleContexts_json_params_consequence !== "undefined" ? JSON.parse($parameter.ruleContexts_json_params_consequence) : undefined, "personalizationImpact": typeof $parameter.personalizationImpact_number_params_consequence !== "undefined" ? $parameter.personalizationImpact_number_params_consequence : undefined, "userToken": typeof $parameter.userToken_string_params_consequence !== "undefined" ? $parameter.userToken_string_params_consequence : undefined, "getRankingInfo": typeof $parameter.getRankingInfo_boolean_params_consequence !== "undefined" ? $parameter.getRankingInfo_boolean_params_consequence : undefined, "synonyms": typeof $parameter.synonyms_boolean_params_consequence !== "undefined" ? $parameter.synonyms_boolean_params_consequence : undefined, "clickAnalytics": typeof $parameter.clickAnalytics_boolean_params_consequence !== "undefined" ? $parameter.clickAnalytics_boolean_params_consequence : undefined, "analytics": typeof $parameter.analytics_boolean_params_consequence !== "undefined" ? $parameter.analytics_boolean_params_consequence : undefined, "analyticsTags": typeof $parameter.analyticsTags_json_params_consequence !== "undefined" ? JSON.parse($parameter.analyticsTags_json_params_consequence) : undefined, "percentileComputation": typeof $parameter.percentileComputation_boolean_params_consequence !== "undefined" ? $parameter.percentileComputation_boolean_params_consequence : undefined, "enableABTest": typeof $parameter.enableABTest_boolean_params_consequence !== "undefined" ? $parameter.enableABTest_boolean_params_consequence : undefined, "attributesToRetrieve": typeof $parameter.attributesToRetrieve_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToRetrieve_json_params_consequence) : undefined, "ranking": typeof $parameter.ranking_json_params_consequence !== "undefined" ? JSON.parse($parameter.ranking_json_params_consequence) : undefined, "relevancyStrictness": typeof $parameter.relevancyStrictness_number_params_consequence !== "undefined" ? $parameter.relevancyStrictness_number_params_consequence : undefined, "attributesToHighlight": typeof $parameter.attributesToHighlight_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToHighlight_json_params_consequence) : undefined, "attributesToSnippet": typeof $parameter.attributesToSnippet_json_params_consequence !== "undefined" ? JSON.parse($parameter.attributesToSnippet_json_params_consequence) : undefined, "highlightPreTag": typeof $parameter.highlightPreTag_string_params_consequence !== "undefined" ? $parameter.highlightPreTag_string_params_consequence : undefined, "highlightPostTag": typeof $parameter.highlightPostTag_string_params_consequence !== "undefined" ? $parameter.highlightPostTag_string_params_consequence : undefined, "snippetEllipsisText": typeof $parameter.snippetEllipsisText_string_params_consequence !== "undefined" ? $parameter.snippetEllipsisText_string_params_consequence : undefined, "restrictHighlightAndSnippetArrays": typeof $parameter.restrictHighlightAndSnippetArrays_boolean_params_consequence !== "undefined" ? $parameter.restrictHighlightAndSnippetArrays_boolean_params_consequence : undefined, "hitsPerPage": typeof $parameter.hitsPerPage_number_params_consequence !== "undefined" ? $parameter.hitsPerPage_number_params_consequence : undefined, "minWordSizefor1Typo": typeof $parameter.minWordSizefor1Typo_number_params_consequence !== "undefined" ? $parameter.minWordSizefor1Typo_number_params_consequence : undefined, "minWordSizefor2Typos": typeof $parameter.minWordSizefor2Typos_number_params_consequence !== "undefined" ? $parameter.minWordSizefor2Typos_number_params_consequence : undefined, "typoTolerance": typeof $parameter.typoTolerance_boolean_params_consequence !== "undefined" ? $parameter.typoTolerance_boolean_params_consequence : typeof $parameter.typoTolerance_options_params_consequence !== "undefined" ? $parameter.typoTolerance_options_params_consequence : undefined, "allowTyposOnNumericTokens": typeof $parameter.allowTyposOnNumericTokens_boolean_params_consequence !== "undefined" ? $parameter.allowTyposOnNumericTokens_boolean_params_consequence : undefined, "disableTypoToleranceOnAttributes": typeof $parameter.disableTypoToleranceOnAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.disableTypoToleranceOnAttributes_json_params_consequence) : undefined, "ignorePlurals": typeof $parameter.ignorePlurals_json_params_consequence !== "undefined" ? JSON.parse($parameter.ignorePlurals_json_params_consequence) : typeof $parameter.ignorePlurals_options_params_consequence !== "undefined" ? $parameter.ignorePlurals_options_params_consequence : typeof $parameter.ignorePlurals_boolean_params_consequence !== "undefined" ? $parameter.ignorePlurals_boolean_params_consequence : undefined, "removeStopWords": typeof $parameter.removeStopWords_json_params_consequence !== "undefined" ? JSON.parse($parameter.removeStopWords_json_params_consequence) : typeof $parameter.removeStopWords_boolean_params_consequence !== "undefined" ? $parameter.removeStopWords_boolean_params_consequence : undefined, "queryLanguages": typeof $parameter.queryLanguages_json_params_consequence !== "undefined" ? JSON.parse($parameter.queryLanguages_json_params_consequence) : undefined, "decompoundQuery": typeof $parameter.decompoundQuery_boolean_params_consequence !== "undefined" ? $parameter.decompoundQuery_boolean_params_consequence : undefined, "enableRules": typeof $parameter.enableRules_boolean_params_consequence !== "undefined" ? $parameter.enableRules_boolean_params_consequence : undefined, "enablePersonalization": typeof $parameter.enablePersonalization_boolean_params_consequence !== "undefined" ? $parameter.enablePersonalization_boolean_params_consequence : undefined, "queryType": typeof $parameter.queryType_options_params_consequence !== "undefined" ? $parameter.queryType_options_params_consequence : undefined, "removeWordsIfNoResults": typeof $parameter.removeWordsIfNoResults_options_params_consequence !== "undefined" ? $parameter.removeWordsIfNoResults_options_params_consequence : undefined, "mode": typeof $parameter.mode_options_params_consequence !== "undefined" ? $parameter.mode_options_params_consequence : undefined, "semanticSearch": { "eventSources": typeof $parameter.eventSources_json_semanticSearch_params_consequence !== "undefined" ? JSON.parse($parameter.eventSources_json_semanticSearch_params_consequence) : typeof $parameter.eventSources_null_semanticSearch_params_consequence !== "undefined" ? JSON.parse($parameter.eventSources_null_semanticSearch_params_consequence) : undefined }, "advancedSyntax": typeof $parameter.advancedSyntax_boolean_params_consequence !== "undefined" ? $parameter.advancedSyntax_boolean_params_consequence : undefined, "optionalWords": typeof $parameter.optionalWords_string_params_consequence !== "undefined" ? $parameter.optionalWords_string_params_consequence : typeof $parameter.optionalWords_null_params_consequence !== "undefined" ? JSON.parse($parameter.optionalWords_null_params_consequence) : typeof $parameter.optionalWords_json_params_consequence !== "undefined" ? JSON.parse($parameter.optionalWords_json_params_consequence) : undefined, "disableExactOnAttributes": typeof $parameter.disableExactOnAttributes_json_params_consequence !== "undefined" ? JSON.parse($parameter.disableExactOnAttributes_json_params_consequence) : undefined, "exactOnSingleWordQuery": typeof $parameter.exactOnSingleWordQuery_options_params_consequence !== "undefined" ? $parameter.exactOnSingleWordQuery_options_params_consequence : undefined, "alternativesAsExact": typeof $parameter.alternativesAsExact_json_params_consequence !== "undefined" ? JSON.parse($parameter.alternativesAsExact_json_params_consequence) : undefined, "advancedSyntaxFeatures": typeof $parameter.advancedSyntaxFeatures_json_params_consequence !== "undefined" ? JSON.parse($parameter.advancedSyntaxFeatures_json_params_consequence) : undefined, "distinct": typeof $parameter.distinct_boolean_params_consequence !== "undefined" ? $parameter.distinct_boolean_params_consequence : typeof $parameter.distinct_number_params_consequence !== "undefined" ? $parameter.distinct_number_params_consequence : undefined, "replaceSynonymsInHighlight": typeof $parameter.replaceSynonymsInHighlight_boolean_params_consequence !== "undefined" ? $parameter.replaceSynonymsInHighlight_boolean_params_consequence : undefined, "minProximity": typeof $parameter.minProximity_number_params_consequence !== "undefined" ? $parameter.minProximity_number_params_consequence : undefined, "responseFields": typeof $parameter.responseFields_json_params_consequence !== "undefined" ? JSON.parse($parameter.responseFields_json_params_consequence) : undefined, "maxValuesPerFacet": typeof $parameter.maxValuesPerFacet_number_params_consequence !== "undefined" ? $parameter.maxValuesPerFacet_number_params_consequence : undefined, "sortFacetValuesBy": typeof $parameter.sortFacetValuesBy_string_params_consequence !== "undefined" ? $parameter.sortFacetValuesBy_string_params_consequence : undefined, "attributeCriteriaComputedByMinProximity": typeof $parameter.attributeCriteriaComputedByMinProximity_boolean_params_consequence !== "undefined" ? $parameter.attributeCriteriaComputedByMinProximity_boolean_params_consequence : undefined, "renderingContent": { }, "enableReRanking": typeof $parameter.enableReRanking_boolean_params_consequence !== "undefined" ? $parameter.enableReRanking_boolean_params_consequence : undefined, "reRankingApplyFilter": typeof $parameter.reRankingApplyFilter_json_params_consequence !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_json_params_consequence) : typeof $parameter.reRankingApplyFilter_string_params_consequence !== "undefined" ? $parameter.reRankingApplyFilter_string_params_consequence : typeof $parameter.reRankingApplyFilter_null_params_consequence !== "undefined" ? JSON.parse($parameter.reRankingApplyFilter_null_params_consequence) : undefined, "query": typeof $parameter.consequence_query_object_object_params_consequence !== "undefined" ? { "remove": typeof $parameter.remove_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.remove_json_query_params_consequence) : undefined, "edits": typeof $parameter.edits_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.edits_json_query_params_consequence) : undefined } : typeof $parameter.remove_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.remove_json_query_params_consequence) : typeof $parameter.edits_json_query_params_consequence !== "undefined" ? JSON.parse($parameter.edits_json_query_params_consequence) : typeof $parameter.query_string_params_consequence !== "undefined" ? $parameter.query_string_params_consequence : undefined, "automaticFacetFilters": typeof $parameter.automaticFacetFilters_array_params_consequence !== "undefined" ? JSON.parse($parameter.automaticFacetFilters_array_params_consequence) : undefined, "automaticOptionalFacetFilters": typeof $parameter.automaticOptionalFacetFilters_array_params_consequence !== "undefined" ? JSON.parse($parameter.automaticOptionalFacetFilters_array_params_consequence) : undefined, "renderingContent": { }, "promote": typeof $parameter.promote_json_consequence !== "undefined" ? JSON.parse($parameter.promote_json_consequence) : undefined, "filterPromotes": typeof $parameter.filterPromotes_boolean_consequence !== "undefined" ? $parameter.filterPromotes_boolean_consequence : undefined, "hide": typeof $parameter.hide_json_consequence !== "undefined" ? JSON.parse($parameter.hide_json_consequence) : undefined, "userData": typeof $parameter.user_data_object_consequence !== "undefined" ? JSON.parse($parameter.user_data_object_consequence) : undefined } }}'}},displayOptions:{show:{rule_object:["consequence_object"],resource:["Rules"],operation:["saveRule"]}}},{type:"multiOptions",name:"consequence_params_consequence",displayName:"Consequence Params",description:void 0,default:[],options:[{name:"Similar Query",value:"similarquery_string_params"},{name:"Filters",value:"filters_string_params"},{name:"Facet Filters",value:"facetfilters_params"},{name:"Optional Filters",value:"optionalfilters_params"},{name:"Numeric Filters",value:"numericfilters_params"},{name:"Tag Filters",value:"tagfilters_params"},{name:"Sum Or Filters Scores",value:"sumorfiltersscores_boolean_params"},{name:"Restrict Searchable Attributes",value:"restrictsearchableattributes_json_params"},{name:"Facets",value:"facets_json_params"},{name:"Faceting After Distinct",value:"facetingafterdistinct_boolean_params"},{name:"Page",value:"page_number_params"},{name:"Offset",value:"offset_number_params"},{name:"Length",value:"length_number_params"},{name:"Around Lat Lng",value:"aroundlatlng_string_params"},{name:"Around Lat Lng Via IP",value:"aroundlatlngviaip_boolean_params"},{name:"Around Radius",value:"aroundradius_params"},{name:"Around Precision",value:"aroundprecision_params"},{name:"Minimum Around Radius",value:"minimumaroundradius_number_params"},{name:"Inside Bounding Box",value:"insideboundingbox_params"},{name:"Inside Polygon",value:"insidepolygon_json_params"},{name:"Natural Languages",value:"naturallanguages_json_params"},{name:"Rule Contexts",value:"rulecontexts_json_params"},{name:"Personalization Impact",value:"personalizationimpact_number_params"},{name:"User Token",value:"usertoken_string_params"},{name:"Get Ranking Info",value:"getrankinginfo_boolean_params"},{name:"Synonyms",value:"synonyms_boolean_params"},{name:"Click Analytics",value:"clickanalytics_boolean_params"},{name:"Analytics",value:"analytics_boolean_params"},{name:"Analytics Tags",value:"analyticstags_json_params"},{name:"Percentile Computation",value:"percentilecomputation_boolean_params"},{name:"Enable ABTest",value:"enableabtest_boolean_params"},{name:"Attributes To Retrieve",value:"attributestoretrieve_json_params"},{name:"Ranking",value:"ranking_json_params"},{name:"Relevancy Strictness",value:"relevancystrictness_number_params"},{name:"Attributes To Highlight",value:"attributestohighlight_json_params"},{name:"Attributes To Snippet",value:"attributestosnippet_json_params"},{name:"Highlight Pre Tag",value:"highlightpretag_string_params"},{name:"Highlight Post Tag",value:"highlightposttag_string_params"},{name:"Snippet Ellipsis Text",value:"snippetellipsistext_string_params"},{name:"Restrict Highlight And Snippet Arrays",value:"restricthighlightandsnippetarrays_boolean_params"},{name:"Hits Per Page",value:"hitsperpage_number_params"},{name:"Min Word Sizefor1Typo",value:"minwordsizefor1typo_number_params"},{name:"Min Word Sizefor2Typos",value:"minwordsizefor2typos_number_params"},{name:"Typo Tolerance",value:"typotolerance_params"},{name:"Allow Typos On Numeric Tokens",value:"allowtyposonnumerictokens_boolean_params"},{name:"Disable Typo Tolerance On Attributes",value:"disabletypotoleranceonattributes_json_params"},{name:"Ignore Plurals",value:"ignoreplurals_params"},{name:"Remove Stop Words",value:"removestopwords_params"},{name:"Query Languages",value:"querylanguages_json_params"},{name:"Decompound Query",value:"decompoundquery_boolean_params"},{name:"Enable Rules",value:"enablerules_boolean_params"},{name:"Enable Personalization",value:"enablepersonalization_boolean_params"},{name:"Query Type",value:"querytype_options_params"},{name:"Remove Words If No Results",value:"removewordsifnoresults_options_params"},{name:"Mode",value:"mode_options_params"},{name:"Semantic Search",value:"semantic_search_object_params"},{name:"Advanced Syntax",value:"advancedsyntax_boolean_params"},{name:"Optional Words",value:"optionalwords_params"},{name:"Disable Exact On Attributes",value:"disableexactonattributes_json_params"},{name:"Exact On Single Word Query",value:"exactonsinglewordquery_options_params"},{name:"Alternatives As Exact",value:"alternativesasexact_json_params"},{name:"Advanced Syntax Features",value:"advancedsyntaxfeatures_json_params"},{name:"Distinct",value:"distinct_params"},{name:"Replace Synonyms In Highlight",value:"replacesynonymsinhighlight_boolean_params"},{name:"Min Proximity",value:"minproximity_number_params"},{name:"Response Fields",value:"responsefields_json_params"},{name:"Max Values Per Facet",value:"maxvaluesperfacet_number_params"},{name:"Sort Facet Values By",value:"sortfacetvaluesby_string_params"},{name:"Attribute Criteria Computed By Min Proximity",value:"attributecriteriacomputedbyminproximity_boolean_params"},{name:"Rendering Content",value:"rendering_content_object_params"},{name:"Enable Re Ranking",value:"enablereranking_boolean_params"},{name:"Re Ranking Apply Filter",value:"rerankingapplyfilter_params"},{name:"Query",value:"query_params"},{name:"Automatic Facet Filters",value:"automaticfacetfilters_params"},{name:"Automatic Optional Facet Filters",value:"automaticoptionalfacetfilters_params"},{name:"Rendering Content",value:"rendering_content_object_params"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["similarquery_string_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["filters_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"facetFilters_params_consequence",displayName:"Facet Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Facet Filters (Array)",name:"facetFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],facetFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Facet Filters (String)",name:"facetFilters_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetfilters_params"],facetFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"optionalFilters_params_consequence",displayName:"Optional Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Optional Filters (Array)",name:"optionalFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],optionalFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Optional Filters (String)",name:"optionalFilters_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalfilters_params"],optionalFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"numericFilters_params_consequence",displayName:"Numeric Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Numeric Filters (Array)",name:"numericFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],numericFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Numeric Filters (String)",name:"numericFilters_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["numericfilters_params"],numericFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"tagFilters_params_consequence",displayName:"Tag Filters",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Tag Filters (Array)",name:"tagFilters_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],tagFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Tag Filters (String)",name:"tagFilters_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["tagfilters_params"],tagFilters_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
672
670
|
If true, all filter scores are summed.
|
|
673
671
|
Otherwise, the maximum filter score is kept.
|
|
674
672
|
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).
|
|
675
|
-
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean_params_consequence",
|
|
673
|
+
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["sumorfiltersscores_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Restrict Searchable Attributes",name:"restrictSearchableAttributes_json_params_consequence",default:"[]",description:`Restricts a search to a subset of your searchable attributes.
|
|
676
674
|
Attribute names are case-sensitive.
|
|
677
675
|
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["restrictsearchableattributes_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Facets",name:"facets_json_params_consequence",default:"[]",description:`Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
678
676
|
To retrieve all facets, use the wildcard character \`*\`.
|
|
679
677
|
For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
|
|
680
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facets_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",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_params_consequence",
|
|
678
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facets_json_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["facetingafterdistinct_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["page_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",displayName:"Offset",name:"offset_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["offset_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},displayName:"Length",name:"length_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["length_number_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundlatlng_string_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundlatlngviaip_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"aroundRadius_params_consequence",displayName:"Around Radius",default:"",options:[{name:"Integer",value:"integer"},{name:"All",value:"all"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundradius_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:"",description:"Maximum search radius around a central location in meters.",typeOptions:{minValue:1},displayName:"Around Radius (Integer)",name:"aroundRadius_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundradius_params"],aroundRadius_params_consequence:["integer"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundradius_params"],aroundRadius_params_consequence:["all"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"aroundPrecision_params_consequence",displayName:"Around Precision",default:"",options:[{name:"Integer",value:"integer"},{name:"Range objects",value:"range_objects"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundprecision_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:10,description:`Distance in meters to group results by similar distances.
|
|
681
679
|
|
|
682
680
|
For example, if you set \`aroundPrecision\` to 100, records wihin 100 meters to the central coordinate are considered to have the same distance,
|
|
683
681
|
as are records between 100 and 199 meters.
|
|
684
|
-
`,displayName:"Around Precision (Integer)",name:"aroundPrecision_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundprecision_params"],aroundPrecision_params_consequence:["integer"],resource:["Rules"],operation:["saveRule"]}}},{type:"
|
|
682
|
+
`,displayName:"Around Precision (Integer)",name:"aroundPrecision_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundprecision_params"],aroundPrecision_params_consequence:["integer"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Around Precision (Range Objects)",name:"aroundPrecision_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["aroundprecision_params"],aroundPrecision_params_consequence:["range_objects"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["minimumaroundradius_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"insideBoundingBox_params_consequence",displayName:"Inside Bounding Box",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Inside bounding box array",value:"inside_bounding_box_array"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["insideboundingbox_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Inside Bounding Box (String)",name:"insideBoundingBox_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["insideboundingbox_params"],insideBoundingBox_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Inside Bounding Box (Null)",name:"insideBoundingBox_null_params_consequence",default:"null",description:void 0,required:!1,disabledOptions:{show:{insideBoundingBox:["null"]}},displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["insideboundingbox_params"],insideBoundingBox_params_consequence:["null"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Inside Bounding Box (Inside Bounding Box Array)",name:"insideBoundingBox_json_params_consequence",default:"[]",description:`Coordinates for a rectangular area in which to search.
|
|
685
683
|
|
|
686
684
|
Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:
|
|
687
685
|
\`[p1 lat, p1 long, p2 lat, p2 long]\`.
|
|
@@ -698,11 +696,11 @@ This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
|
698
696
|
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rulecontexts_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
699
697
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
700
698
|
For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
701
|
-
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["personalizationimpact_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"test-user-123",description:`Unique pseudonymous or anonymous user identifier.
|
|
699
|
+
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["personalizationimpact_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
702
700
|
|
|
703
701
|
This helps with analytics and click and conversion events.
|
|
704
702
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
705
|
-
`,displayName:"User Token",name:"userToken_string_params_consequence",
|
|
703
|
+
`,displayName:"User Token",name:"userToken_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["usertoken_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",displayName:"Get Ranking Info",name:"getRankingInfo_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["getrankinginfo_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",displayName:"Synonyms",name:"synonyms_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["synonyms_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["clickanalytics_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",displayName:"Analytics",name:"analytics_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["analytics_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Analytics Tags",name:"analyticsTags_json_params_consequence",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:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["analyticstags_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",displayName:"Percentile Computation",name:"percentileComputation_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["percentilecomputation_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",displayName:"Enable ABTest",name:"enableABTest_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enableabtest_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json_params_consequence",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:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["attributestoretrieve_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Ranking",name:"ranking_json_params_consequence",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
706
704
|
|
|
707
705
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
708
706
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -729,9 +727,9 @@ If you enable snippets, they include 10 words, including the matched word.
|
|
|
729
727
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
730
728
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
731
729
|
where \`NUMBER\` is the number of words to be extracted.
|
|
732
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["attributestosnippet_json_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["highlightpretag_string_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["highlightposttag_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["snippetellipsistext_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
730
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["attributestosnippet_json_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["highlightpretag_string_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["highlightposttag_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["snippetellipsistext_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
733
731
|
By default, all items are highlighted and snippeted.
|
|
734
|
-
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean_params_consequence",
|
|
732
|
+
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["restricthighlightandsnippetarrays_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["hitsperpage_number_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["minwordsizefor1typo_number_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["minwordsizefor2typos_number_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"typoTolerance_params_consequence",displayName:"Typo Tolerance",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Typo tolerance",value:"typo_tolerance"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["typotolerance_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.",displayName:"Typo Tolerance (Boolean)",name:"typoTolerance_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["typotolerance_params"],typoTolerance_params_consequence:["boolean"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",default:"",description:"- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",options:[{name:"min",value:"min"},{name:"strict",value:"strict"},{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Typo Tolerance (Typo Tolerance)",name:"typoTolerance_options_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["typotolerance_params"],typoTolerance_params_consequence:["typo_tolerance"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
735
733
|
Turn off this setting to reduce the number of irrelevant matches
|
|
736
734
|
when searching in large sets of similar numbers.
|
|
737
735
|
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["allowtyposonnumerictokens_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Disable Typo Tolerance On Attributes",name:"disableTypoToleranceOnAttributes_json_params_consequence",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).
|
|
@@ -741,7 +739,7 @@ Returning only exact matches can help when
|
|
|
741
739
|
- Reducing the number of matches when you have too many.
|
|
742
740
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
743
741
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
744
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["disabletypotoleranceonattributes_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"ignorePlurals_params_consequence",displayName:"Ignore Plurals",default:"",options:[{name:"Array",value:"array"},{name:"Boolean string",value:"boolean_string"},{name:"Boolean",value:"boolean"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Ignore Plurals (Array)",name:"ignorePlurals_json_params_consequence",default:"[]",description:"ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],ignorePlurals_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",options:[{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Ignore Plurals (Boolean String)",name:"ignorePlurals_options_params_consequence",
|
|
742
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["disabletypotoleranceonattributes_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"ignorePlurals_params_consequence",displayName:"Ignore Plurals",default:"",options:[{name:"Array",value:"array"},{name:"Boolean string",value:"boolean_string"},{name:"Boolean",value:"boolean"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Ignore Plurals (Array)",name:"ignorePlurals_json_params_consequence",default:"[]",description:"ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],ignorePlurals_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",default:"",options:[{name:"true",value:"true"},{name:"false",value:"false"}],displayName:"Ignore Plurals (Boolean String)",name:"ignorePlurals_options_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],ignorePlurals_params_consequence:["boolean_string"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:"If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.\nIf false, singulars, plurals, and other declensions won't be considered equivalent.\n",displayName:"Ignore Plurals (Boolean)",name:"ignorePlurals_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["ignoreplurals_params"],ignorePlurals_params_consequence:["boolean"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"removeStopWords_params_consequence",displayName:"Remove Stop Words",default:"",options:[{name:"Array",value:"array"},{name:"Boolean",value:"boolean"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["removestopwords_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Remove Stop Words (Array)",name:"removeStopWords_json_params_consequence",default:"[]",description:"ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["removestopwords_params"],removeStopWords_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:"If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n",displayName:"Remove Stop Words (Boolean)",name:"removeStopWords_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["removestopwords_params"],removeStopWords_params_consequence:["boolean"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json_params_consequence",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
745
743
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
746
744
|
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.
|
|
747
745
|
To support this, you must place the CJK language **first**
|
|
@@ -750,7 +748,7 @@ If you don't specify an indexing language, the search engine uses all [supported
|
|
|
750
748
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
751
749
|
This can lead to unexpected search results.
|
|
752
750
|
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).
|
|
753
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["querylanguages_json_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["decompoundquery_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enablerules_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean_params_consequence",
|
|
751
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["querylanguages_json_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["decompoundquery_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enablerules_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enablepersonalization_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
754
752
|
|
|
755
753
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
756
754
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -782,7 +780,7 @@ This setting only applies to indices, for which Algolia enabled NeuralSearch for
|
|
|
782
780
|
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["mode_options_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Semantic Search",name:"semantic_search_object_params_consequence",type:"multiOptions",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:[],options:[{name:"Event Sources",value:"eventSources_semanticSearch"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"eventSources_semanticSearch_params_consequence",displayName:"Event Sources",default:"",options:[{name:"Array",value:"array"},{name:"Null",value:"null"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],semantic_search_object_params_consequence:["eventSources_semanticSearch"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Event Sources (Array)",name:"eventSources_json_semanticSearch_params_consequence",default:"[]",description:`Indices from which to collect click and conversion events.
|
|
783
781
|
|
|
784
782
|
If null, the current index and all its replicas are used.
|
|
785
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],semantic_search_object_params_consequence:["eventSources_semanticSearch"],eventSources_semanticSearch_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch_params_consequence",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],semantic_search_object_params_consequence:["eventSources_semanticSearch"],eventSources_semanticSearch_params_consequence:["null"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",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_params_consequence",
|
|
783
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],semantic_search_object_params_consequence:["eventSources_semanticSearch"],eventSources_semanticSearch_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Event Sources (Null)",name:"eventSources_null_semanticSearch_params_consequence",default:"null",description:void 0,required:!1,disabledOptions:{show:{eventSources:["null"]}},displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["semantic_search_object_params"],semantic_search_object_params_consequence:["eventSources_semanticSearch"],eventSources_semanticSearch_params_consequence:["null"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["advancedsyntax_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"optionalWords_params_consequence",displayName:"Optional Words",default:"",options:[{name:"String",value:"string"},{name:"Null",value:"null"},{name:"Optional words array",value:"optional_words_array"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalwords_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Optional Words (String)",name:"optionalWords_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalwords_params"],optionalWords_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Optional Words (Null)",name:"optionalWords_null_params_consequence",default:"null",description:void 0,required:!1,disabledOptions:{show:{optionalWords:["null"]}},displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalwords_params"],optionalWords_params_consequence:["null"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Optional Words (Optional Words Array)",name:"optionalWords_json_params_consequence",default:"[]",description:"List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["optionalwords_params"],optionalWords_params_consequence:["optional_words_array"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Disable Exact On Attributes",name:"disableExactOnAttributes_json_params_consequence",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).
|
|
786
784
|
Attribute names are case-sensitive
|
|
787
785
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
788
786
|
such as product descriptions.
|
|
@@ -813,7 +811,7 @@ For example
|
|
|
813
811
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
814
812
|
- \`multiWordsSynonym\`.
|
|
815
813
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
816
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["alternativesasexact_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json_params_consequence",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:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["advancedsyntaxfeatures_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"distinct_params_consequence",displayName:"Distinct",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Integer",value:"integer"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["distinct_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",description:"Whether deduplication is turned on. If true, only one member of a group is shown in the search results.",displayName:"Distinct (Boolean)",name:"distinct_boolean_params_consequence",
|
|
814
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["alternativesasexact_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json_params_consequence",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:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["advancedsyntaxfeatures_json_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"distinct_params_consequence",displayName:"Distinct",default:"",options:[{name:"Boolean",value:"boolean"},{name:"Integer",value:"integer"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["distinct_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:"Whether deduplication is turned on. If true, only one member of a group is shown in the search results.",displayName:"Distinct (Boolean)",name:"distinct_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["distinct_params"],distinct_params_consequence:["boolean"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:"",description:"Number of members of a group of records to include in the search results.\n\n- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",typeOptions:{minValue:0,maxValue:4},displayName:"Distinct (Integer)",name:"distinct_number_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["distinct_params"],distinct_params_consequence:["integer"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["replacesynonymsinhighlight_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
817
815
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
818
816
|
by equally scoring matches that are farther apart
|
|
819
817
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
@@ -825,36 +823,36 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
825
823
|
Retrieve facet values alphabetically
|
|
826
824
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
827
825
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
828
|
-
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["sortfacetvaluesby_string_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",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_params_consequence",
|
|
826
|
+
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["sortfacetvaluesby_string_params"],resource:["Rules"],operation:["saveRule"]}}},{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_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["attributecriteriacomputedbyminproximity_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Rendering Content",name:"rendering_content_object_params_consequence",type:"multiOptions",description:`Extra data that can be used in the search UI.
|
|
829
827
|
|
|
830
828
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
831
829
|
without changing your frontend code.
|
|
832
|
-
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect
|
|
830
|
+
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect URL",value:"redirect_url_object_renderingContent"},{name:"Widgets",value:"widgets_object_renderingContent"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Facet Ordering",name:"facet_ordering_object_renderingContent_params_consequence",type:"multiOptions",description:"Order of facet names and facet values in your UI.",required:!1,default:[],options:[{name:"Facets",value:"facets_object_facetOrdering"},{name:"Values",value:"values_object_facetOrdering"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Facets",name:"facets_object_facetOrdering_renderingContent_params_consequence",type:"multiOptions",description:"Order of facet names.",required:!1,default:[],options:[{name:"Order",value:"order_json_facets"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Order",name:"order_json_facets_facetOrdering_renderingContent_params_consequence",default:"[]",description:`Explicit order of facets or facet values.
|
|
833
831
|
|
|
834
832
|
This setting lets you always show specific facets or facet values at the top of the list.
|
|
835
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent_params_consequence:["order_json_facets"],resource:["Rules"],operation:["saveRule"]}}},{
|
|
833
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent_params_consequence:["order_json_facets"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Values",name:"values_object_facetOrdering_renderingContent_params_consequence",description:"Order of facet values. One object for each facet.",required:!1,default:"{}",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["values_object_facetOrdering"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Redirect URL",name:"redirect_url_object_renderingContent_params_consequence",type:"multiOptions",description:"The redirect rule container.",required:!1,default:[],options:[{name:"Url",value:"url_string_redirect"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["redirect_url_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Url",name:"url_string_redirect_renderingContent_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["redirect_url_object_renderingContent"],redirect_url_object_renderingContent_params_consequence:["url_string_redirect"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Widgets",name:"widgets_object_renderingContent_params_consequence",type:"multiOptions",description:"Widgets returned from any rules that are applied to the current search.",required:!1,default:[],options:[{name:"Banners",value:"banners_json_widgets"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["widgets_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Banners",name:"banners_json_widgets_renderingContent_params_consequence",default:"[]",description:"Banners defined in the Merchandising Studio for a given search.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["widgets_object_renderingContent"],widgets_object_renderingContent_params_consequence:["banners_json_widgets"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
836
834
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
837
|
-
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enablereranking_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"reRankingApplyFilter_params_consequence",displayName:"Re Ranking Apply Filter",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"},{name:"Null",value:"null"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Array)",name:"reRankingApplyFilter_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],reRankingApplyFilter_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string_params_consequence",
|
|
835
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["enablereranking_boolean_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"reRankingApplyFilter_params_consequence",displayName:"Re Ranking Apply Filter",default:"",options:[{name:"Array",value:"array"},{name:"String",value:"string"},{name:"Null",value:"null"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Array)",name:"reRankingApplyFilter_json_params_consequence",default:"[]",description:void 0,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],reRankingApplyFilter_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Re Ranking Apply Filter (String)",name:"reRankingApplyFilter_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],reRankingApplyFilter_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Re Ranking Apply Filter (Null)",name:"reRankingApplyFilter_null_params_consequence",default:"null",description:void 0,required:!1,disabledOptions:{show:{reRankingApplyFilter:["null"]}},displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rerankingapplyfilter_params"],reRankingApplyFilter_params_consequence:["null"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"query_params_consequence",displayName:"Query",default:"",options:[{name:"Consequence query object",value:"consequence_query_object"},{name:"String",value:"string"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["query_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Consequence Query Object",name:"consequence_query_object_object_params_consequence",type:"multiOptions",description:void 0,required:!1,default:[],options:[{name:"Remove",value:"remove_json_query"},{name:"Edits",value:"edits_json_query"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["query_params"],query_params_consequence:["consequence_query_object"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Remove",name:"remove_json_query_params_consequence",default:"[]",description:"Words to remove from the search query.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["query_params"],query_params_consequence:["consequence_query_object"],consequence_query_object_object_params_consequence:["remove_json_query"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Edits",name:"edits_json_query_params_consequence",default:"[]",description:"Changes to make to the search query.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["query_params"],query_params_consequence:["consequence_query_object"],consequence_query_object_object_params_consequence:["edits_json_query"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Query (String)",name:"query_string_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["query_params"],query_params_consequence:["string"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"automaticFacetFilters_params_consequence",displayName:"Automatic Facet Filters",default:"",options:[{name:"Array",value:"array"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["automaticfacetfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Automatic Facet Filters (Array)",name:"automaticFacetFilters_array_params_consequence",type:"json",description:"",required:!1,default:"[]",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["automaticfacetfilters_params"],automaticFacetFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",name:"automaticOptionalFacetFilters_params_consequence",displayName:"Automatic Optional Facet Filters",default:"",options:[{name:"Array",value:"array"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["automaticoptionalfacetfilters_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Automatic Optional Facet Filters (Array)",name:"automaticOptionalFacetFilters_array_params_consequence",type:"json",description:"",required:!1,default:"[]",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["automaticoptionalfacetfilters_params"],automaticOptionalFacetFilters_params_consequence:["array"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Rendering Content",name:"rendering_content_object_params_consequence",type:"multiOptions",description:`Extra data that can be used in the search UI.
|
|
838
836
|
|
|
839
837
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
840
838
|
without changing your frontend code.
|
|
841
|
-
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect
|
|
839
|
+
`,required:!1,default:[],options:[{name:"Facet Ordering",value:"facet_ordering_object_renderingContent"},{name:"Redirect URL",value:"redirect_url_object_renderingContent"},{name:"Widgets",value:"widgets_object_renderingContent"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Facet Ordering",name:"facet_ordering_object_renderingContent_params_consequence",type:"multiOptions",description:"Order of facet names and facet values in your UI.",required:!1,default:[],options:[{name:"Facets",value:"facets_object_facetOrdering"},{name:"Values",value:"values_object_facetOrdering"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Facets",name:"facets_object_facetOrdering_renderingContent_params_consequence",type:"multiOptions",description:"Order of facet names.",required:!1,default:[],options:[{name:"Order",value:"order_json_facets"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Order",name:"order_json_facets_facetOrdering_renderingContent_params_consequence",default:"[]",description:`Explicit order of facets or facet values.
|
|
842
840
|
|
|
843
841
|
This setting lets you always show specific facets or facet values at the top of the list.
|
|
844
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent_params_consequence:["order_json_facets"],resource:["Rules"],operation:["saveRule"]}}},{
|
|
842
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["facets_object_facetOrdering"],facets_object_facetOrdering_renderingContent_params_consequence:["order_json_facets"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Values",name:"values_object_facetOrdering_renderingContent_params_consequence",description:"Order of facet values. One object for each facet.",required:!1,default:"{}",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["facet_ordering_object_renderingContent"],facet_ordering_object_renderingContent_params_consequence:["values_object_facetOrdering"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Redirect URL",name:"redirect_url_object_renderingContent_params_consequence",type:"multiOptions",description:"The redirect rule container.",required:!1,default:[],options:[{name:"Url",value:"url_string_redirect"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["redirect_url_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",default:"",displayName:"Url",name:"url_string_redirect_renderingContent_params_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["redirect_url_object_renderingContent"],redirect_url_object_renderingContent_params_consequence:["url_string_redirect"],resource:["Rules"],operation:["saveRule"]}}},{displayName:"Widgets",name:"widgets_object_renderingContent_params_consequence",type:"multiOptions",description:"Widgets returned from any rules that are applied to the current search.",required:!1,default:[],options:[{name:"Banners",value:"banners_json_widgets"}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["widgets_object_renderingContent"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Banners",name:"banners_json_widgets_renderingContent_params_consequence",default:"[]",description:"Banners defined in the Merchandising Studio for a given search.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["consequence_params_consequence"],consequence_params_consequence:["rendering_content_object_params"],rendering_content_object_params_consequence:["widgets_object_renderingContent"],widgets_object_renderingContent_params_consequence:["banners_json_widgets"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Promote",name:"promote_json_consequence",default:"[]",description:`Records you want to pin to a specific position in the search results.
|
|
845
843
|
|
|
846
844
|
You can promote up to 300 records, either individually, or as groups of up to 100 records each.
|
|
847
|
-
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["promote_json_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",description:`Determines whether promoted records must also match active filters for the consequence to apply.
|
|
845
|
+
`,required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["promote_json_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"boolean",default:!1,description:`Determines whether promoted records must also match active filters for the consequence to apply.
|
|
848
846
|
|
|
849
847
|
This ensures user-applied filters take priority and irrelevant matches aren't shown.
|
|
850
848
|
For example, if you promote a record with \`color: red\` but the user filters for \`color: blue\`,
|
|
851
849
|
the "red" record won't be shown.
|
|
852
850
|
|
|
853
851
|
> In the Algolia dashboard, when you use the **Pin an item** consequence, \`filterPromotes\` appears as the checkbox: **Pinned items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters).
|
|
854
|
-
`,displayName:"Filter Promotes",name:"filterPromotes_boolean_consequence",default:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["filterPromotes_boolean_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"fixedCollection",displayName:"Hide",name:"hide_fixedCollection_consequence",default:"",description:"Records you want to hide from the search results.",required:!1,typeOptions:{multipleValues:!0},options:[{name:"hide_fixedCollection_values",displayName:"Hide",values:[{type:"string",placeholder:"test-record-123",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string_hide",default:""}]}],displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["hide_fixedCollection_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"string",placeholder:"Display a promotional banner",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",default:"",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:"fixedCollection",displayName:"Validity",name:"validity_fixedCollection",default:"",description:"Time periods when the rule is active.",required:!1,typeOptions:{multipleValues:!0},options:[{name:"validity_fixedCollection_values",displayName:"Validity",values:[{type:"number",description:"When the rule should start to be active, in Unix epoch time.",displayName:"From",name:"from_number_validity",default:""},{type:"number",description:"When the rule should stop to be active, in Unix epoch time.",displayName:"Until",name:"until_number_validity",default:""}]}],routing:{send:{type:"body",value:'={{ $parameter.values?.map(item => ({ from: typeof item.from_number_validity !== "undefined" ? item.from_number_validity : undefined, until: typeof item.until_number_validity !== "undefined" ? item.until_number_validity : undefined })) }}',property:"validity"}},displayOptions:{show:{rule_object:["validity_fixedCollection"],resource:["Rules"],operation:["saveRule"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Unique identifier of a rule object.",displayName:"Object ID",name:"objectID_string",default:"",required:!0,displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}},{type:"boolean",routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",default:"",displayOptions:{show:{resource:["Rules"],operation:["deleteRule"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",default:"",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"boolean",routing:{request:{qs:{clearExistingRules:"={{ $value }}"}}},displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",default:"",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"json",displayName:"Json",name:"json",default:"",description:"Rules to add or replace.",required:!1,routing:void 0,displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",routing:{request:{qs:{forwardToReplicas:"={{ $value }}"}}},displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",default:"",displayOptions:{show:{resource:["Rules"],operation:["clearRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",description:"Search query for rules.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",default:"",displayOptions:{show:{search_rules_params_object:["query_string"],resource:["Rules"],operation:["searchRules"]}}},{type:"options",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",default:"",displayOptions:{show:{search_rules_params_object:["anchoring_options"],resource:["Rules"],operation:["searchRules"]}}},{type:"string",placeholder:"mobile",description:"Only return rules that match the context (exact match).",routing:{send:{type:"body",value:"={{ $value }}",property:"context"}},displayName:"Context",name:"context_string",default:"",displayOptions:{show:{search_rules_params_object:["context_string"],resource:["Rules"],operation:["searchRules"]}}},{type:"number",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",default:"",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",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",default:"",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",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",default:"",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",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",default:!1,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:!1,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",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",default:"",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",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",default:"",displayOptions:{show:{search_dictionary_entries_params_object:["query_string"],resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"number",description:"Page of search results to retrieve.",typeOptions:{minValue:0},routing:{send:{type:"body",value:"={{ $value }}",property:"page"}},displayName:"Page",name:"page_number",default:0,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",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",default:"",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.
|
|
852
|
+
`,displayName:"Filter Promotes",name:"filterPromotes_boolean_consequence",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["filterPromotes_boolean_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"Hide",name:"hide_json_consequence",default:"[]",description:"Records you want to hide from the search results.",required:!1,displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["hide_json_consequence"],resource:["Rules"],operation:["saveRule"]}}},{type:"json",displayName:"User Data",name:"user_data_object_consequence",description:"A JSON object with custom data that will be appended to the `userData` array in the response.\nThis object isn't interpreted by the API and is limited to 1 kB of minified JSON.\n",required:!1,default:"{}",displayOptions:{show:{rule_object:["consequence_object"],consequence_object:["user_data_object_consequence"],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:"={{ $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:"={{ $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:"={{ $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.
|
|
855
853
|
`,required:!0,default:[],options:[{name:"Standard Entries",value:"standard_entries_object"}],displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{displayName:"Standard Entries",name:"standard_entries_object",type:"multiOptions",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.
|
|
856
|
-
`,required:!1,default:[],options:[{name:"Plurals",value:"plurals_disableStandardEntries"},{name:"Stopwords",value:"stopwords_disableStandardEntries"},{name:"Compounds",value:"compounds_disableStandardEntries"}],routing:{send:{type:"body",property:"disableStandardEntries",value:'={{ { "plurals": typeof $parameter.plurals_boolean_disableStandardEntries !== "undefined" ? $parameter.plurals_boolean_disableStandardEntries : typeof $parameter.plurals_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.plurals_null_disableStandardEntries) : undefined, "stopwords": typeof $parameter.stopwords_boolean_disableStandardEntries !== "undefined" ? $parameter.stopwords_boolean_disableStandardEntries : typeof $parameter.stopwords_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.stopwords_null_disableStandardEntries) : undefined, "compounds": typeof $parameter.compounds_boolean_disableStandardEntries !== "undefined" ? $parameter.compounds_boolean_disableStandardEntries : typeof $parameter.compounds_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.compounds_null_disableStandardEntries) : undefined } }}'}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"plurals_disableStandardEntries",displayName:"Plurals",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"fixedCollection",displayName:"Plurals (Object)",name:"plurals_boolean_disableStandardEntries",default:"",description:"Key-value pair of a language ISO code and a boolean value.",typeOptions:{multipleValues:!0},options:[{name:"plurals_boolean",displayName:"Plurals",values:[]}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],plurals_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Plurals (Null)",name:"plurals_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{plurals:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],plurals_disableStandardEntries:["null"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"stopwords_disableStandardEntries",displayName:"Stopwords",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"fixedCollection",displayName:"Stopwords (Object)",name:"stopwords_boolean_disableStandardEntries",default:"",description:"Key-value pair of a language ISO code and a boolean value.",typeOptions:{multipleValues:!0},options:[{name:"stopwords_boolean",displayName:"Stopwords",values:[]}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],stopwords_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Stopwords (Null)",name:"stopwords_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{stopwords:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],stopwords_disableStandardEntries:["null"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"compounds_disableStandardEntries",displayName:"Compounds",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"fixedCollection",displayName:"Compounds (Object)",name:"compounds_boolean_disableStandardEntries",default:"",description:"Key-value pair of a language ISO code and a boolean value.",typeOptions:{multipleValues:!0},options:[{name:"compounds_boolean",displayName:"Compounds",values:[]}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],compounds_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Compounds (Null)",name:"compounds_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{compounds:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],compounds_disableStandardEntries:["null"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"string",placeholder:"user1",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",default:"",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",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",default:"",displayOptions:{show:{assign_user_id_params_object:["cluster_string"],resource:["Clusters"],operation:["assignUserId"]}}},{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",typeOptions:{minValue:0},displayName:"Page (Integer)",name:"page_number",default:"",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",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",default:"",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",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",default:"",displayOptions:{show:{batch_assign_user_ids_params_object:["cluster_string"],resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!1,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",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",default:"",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}},{type:"string",placeholder:"user1",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",default:"",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",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",default:"",displayOptions:{show:{search_user_ids_params_object:["query_string"],resource:["Clusters"],operation:["searchUserIds"]}}},{type:"string",placeholder:"c11-test",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"clusterName"}},displayName:"Cluster Name",name:"clusterName_string",default:"",displayOptions:{show:{search_user_ids_params_object:["clusterName_string"],resource:["Clusters"],operation:["searchUserIds"]}}},{type:"number",description:"Page of search results to retrieve.",typeOptions:{minValue:0},routing:{send:{type:"body",value:"={{ $value }}",property:"page"}},displayName:"Page",name:"page_number",default:0,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",routing:{request:{qs:{getClusters:"={{ $value }}"}}},displayName:"Get Clusters",name:"getClusters_boolean",default:"",displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}},{type:"fixedCollection",displayName:"Sources",name:"sources_fixedCollection",default:"",description:"Sources.",required:!1,typeOptions:{multipleValues:!0},options:[{name:"sources_fixedCollection_values",displayName:"Sources",values:[{type:"string",placeholder:"10.0.0.1/32",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",default:""},{type:"string",placeholder:"Server subnet",description:"Source description.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",default:""}]}],routing:void 0,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",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",default:"",displayOptions:{show:{source_object:["source_string"],resource:["Vaults"],operation:["appendSource"]}}},{type:"string",placeholder:"Server subnet",description:"Source description.",routing:{send:{type:"body",value:"={{ $value }}",property:"description"}},displayName:"Description",name:"description_string",default:"",displayOptions:{show:{source_object:["description_string"],resource:["Vaults"],operation:["appendSource"]}}},{type:"string",placeholder:"10.0.0.1/32",displayName:"Source",name:"source_string",default:"",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}},{type:"number",routing:{request:{qs:{offset:"={{ $value }}"}}},displayName:"Offset",name:"offset_number",default:0,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",displayName:"Index Name (String)",name:"indexName_string",default:"",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",displayName:"Task ID",name:"taskID_number",default:"",required:!0,displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",displayName:"Task ID",name:"taskID_number",default:"",required:!0,displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",displayName:"Index Name",name:"indexName_string",default:"",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",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",default:"",displayOptions:{show:{operation_index_params_object:["operation_options"],resource:["Indices"],operation:["operationIndex"]}}},{type:"string",placeholder:"products",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",default:"",displayOptions:{show:{operation_index_params_object:["destination_string"],resource:["Indices"],operation:["operationIndex"]}}},{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
854
|
+
`,required:!0,default:[],options:[{name:"Plurals",value:"plurals_disableStandardEntries"},{name:"Stopwords",value:"stopwords_disableStandardEntries"},{name:"Compounds",value:"compounds_disableStandardEntries"}],routing:{send:{type:"body",property:"disableStandardEntries",value:'={{ { "plurals": typeof $parameter.plurals_object_disableStandardEntries !== "undefined" ? JSON.parse($parameter.plurals_object_disableStandardEntries) : typeof $parameter.plurals_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.plurals_null_disableStandardEntries) : undefined, "stopwords": typeof $parameter.stopwords_object_disableStandardEntries !== "undefined" ? JSON.parse($parameter.stopwords_object_disableStandardEntries) : typeof $parameter.stopwords_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.stopwords_null_disableStandardEntries) : undefined, "compounds": typeof $parameter.compounds_object_disableStandardEntries !== "undefined" ? JSON.parse($parameter.compounds_object_disableStandardEntries) : typeof $parameter.compounds_null_disableStandardEntries !== "undefined" ? JSON.parse($parameter.compounds_null_disableStandardEntries) : undefined } }}'}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"plurals_disableStandardEntries",displayName:"Plurals",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Plurals (Object)",name:"plurals_object_disableStandardEntries",description:"Key-value pair of a language ISO code and a boolean value.",required:!1,default:"{}",displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],plurals_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Plurals (Null)",name:"plurals_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{plurals:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["plurals_disableStandardEntries"],plurals_disableStandardEntries:["null"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"stopwords_disableStandardEntries",displayName:"Stopwords",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Stopwords (Object)",name:"stopwords_object_disableStandardEntries",description:"Key-value pair of a language ISO code and a boolean value.",required:!1,default:"{}",displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],stopwords_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Stopwords (Null)",name:"stopwords_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{stopwords:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["stopwords_disableStandardEntries"],stopwords_disableStandardEntries:["null"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"options",name:"compounds_disableStandardEntries",displayName:"Compounds",default:"",options:[{name:"Object",value:"object"},{name:"Null",value:"null"}],displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Compounds (Object)",name:"compounds_object_disableStandardEntries",description:"Key-value pair of a language ISO code and a boolean value.",required:!1,default:"{}",displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],compounds_disableStandardEntries:["object"],resource:["Dictionaries"],operation:["setDictionarySettings"]}}},{type:"json",displayName:"Compounds (Null)",name:"compounds_null_disableStandardEntries",default:"null",description:void 0,required:!1,disabledOptions:{show:{compounds:["null"]}},displayOptions:{show:{dictionary_settings_params_object:["standard_entries_object"],standard_entries_object:["compounds_disableStandardEntries"],compounds_disableStandardEntries:["null"],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:"={{ $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:"={{ $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.**
|
|
857
855
|
|
|
858
856
|
If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.
|
|
859
857
|
If you omit the \`scope\` parameter, everything is copied: records, settings, synonyms, and rules.
|
|
860
|
-
`,required:!1,routing:{send:{type:"body",value:"={{
|
|
858
|
+
`,required:!1,routing:{send:{type:"body",value:"={{ $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 p{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:c,group:[]}}}exports.Algolia=p;
|