@algolia/n8n-nodes-algolia 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.14.0",o={name:l,version:p},d=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["browse"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Browse Params",name:"browseParams_options",default:"search_parameters_as_object",options:[{name:"Search Parameters As Object",value:"search_parameters_as_object"},{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"}],required:!1},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
2
2
|
If true, all filter scores are summed.
|
|
3
3
|
Otherwise, the maximum filter score is kept.
|
|
4
4
|
For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
|
|
5
|
-
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{browseParams_options:["
|
|
5
|
+
`,displayName:"Sum Or Filters Scores",name:"sumOrFiltersScores_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Restrict Searchable Attributes",name:"restrictSearchableAttributes_json",default:"[]",description:`Restricts a search to a subset of your searchable attributes.
|
|
6
6
|
Attribute names are case-sensitive.
|
|
7
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
7
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Facets",name:"facets_json",default:"[]",description:`Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
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,displayOptions:{show:{browseParams_options:["
|
|
10
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether faceting should be applied after deduplication with `distinct`\nThis leads to accurate facet counts when using faceting in combination with `distinct`.\nIt's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,\nas `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.\n",displayName:"Faceting After Distinct",name:"facetingAfterDistinct_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Position of the first hit to retrieve.",displayName:"Offset",name:"offset_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Number of hits to retrieve (used in combination with `offset`).",typeOptions:{minValue:0,maxValue:1e3},displayName:"Length",name:"length_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to obtain the coordinates from the request's IP address.",displayName:"Around Lat Lng Via IP",name:"aroundLatLngViaIP_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"aroundPrecision",displayName:"Around Precision",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:"",description:"Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",typeOptions:{minValue:1},displayName:"Minimum Around Radius",name:"minimumAroundRadius_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
11
11
|
|
|
12
12
|
Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
|
|
13
13
|
Provide multiple polygons as nested arrays.
|
|
14
14
|
For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
|
15
15
|
This parameter is ignored if you also specify \`insideBoundingBox\`.
|
|
16
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
16
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Natural Languages",name:"naturalLanguages_json",default:"[]",description:"ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)\n- Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.\n- Sets `removeWordsIfNoResults` to `allOptional`.\n- Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.\n",required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Rule Contexts",name:"ruleContexts_json",default:"[]",description:`Assigns a rule context to the search query
|
|
17
17
|
[Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
|
|
18
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
18
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:100,description:`Impact that Personalization should have on this search
|
|
19
19
|
The higher this value is, the more Personalization determines the ranking compared to other factors.
|
|
20
20
|
For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
21
|
-
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{browseParams_options:["
|
|
21
|
+
`,typeOptions:{minValue:0,maxValue:100},displayName:"Personalization Impact",name:"personalizationImpact_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"test-user-123",default:"",description:`Unique pseudonymous or anonymous user identifier.
|
|
22
22
|
|
|
23
23
|
This helps with analytics and click and conversion events.
|
|
24
24
|
For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
|
25
|
-
`,displayName:"User Token",name:"userToken_string",displayOptions:{show:{browseParams_options:["
|
|
25
|
+
`,displayName:"User Token",name:"userToken_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether the search response should include detailed ranking information.",displayName:"Get Ranking Info",name:"getRankingInfo_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to take into account an index's synonyms for this search.",displayName:"Synonyms",name:"synonyms_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to include a `queryID` attribute in the response\nThe query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).\n",displayName:"Click Analytics",name:"clickAnalytics_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether this search will be included in Analytics.",displayName:"Analytics",name:"analytics_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Analytics Tags",name:"analyticsTags_json",default:"[]",description:"Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).",required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to include this search when calculating processing-time percentiles.",displayName:"Percentile Computation",name:"percentileComputation_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to enable A/B testing for this search.",displayName:"Enable ABTest",name:"enableABTest_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Retrieve",name:"attributesToRetrieve_json",default:"[]",description:'Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`.\n- The `objectID` attribute is always included.\n',required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Ranking",name:"ranking_json",default:"[]",description:`Determines the order in which Algolia returns your results.
|
|
26
26
|
|
|
27
27
|
By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).
|
|
28
28
|
The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
|
|
@@ -37,40 +37,40 @@ you put the sorting attribute at the top of the list.
|
|
|
37
37
|
Sort the index by the values of an attribute, in descending order.
|
|
38
38
|
|
|
39
39
|
Before you modify the default setting,
|
|
40
|
-
|
|
40
|
+
test your changes in the dashboard,
|
|
41
41
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
42
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
42
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
43
43
|
You can only set \`relevancyStrictness\` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
|
|
44
44
|
Use this setting to strike a balance between the relevance and number of returned results.
|
|
45
|
-
`,displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{browseParams_options:["
|
|
45
|
+
`,displayName:"Relevancy Strictness",name:"relevancyStrictness_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Highlight",name:"attributesToHighlight_json",default:"[]",description:"Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).\n",required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Attributes To Snippet",name:"attributesToSnippet_json",default:"[]",description:`Attributes for which to enable snippets.
|
|
46
46
|
Attribute names are case-sensitive
|
|
47
47
|
Snippets provide additional context to matched words.
|
|
48
48
|
If you enable snippets, they include 10 words, including the matched word.
|
|
49
49
|
The matched word will also be wrapped by HTML tags for highlighting.
|
|
50
50
|
You can adjust the number of words with the following notation: \`ATTRIBUTE:NUMBER\`,
|
|
51
51
|
where \`NUMBER\` is the number of words to be extracted.
|
|
52
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
52
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",default:"<em>",description:"HTML tag to insert before the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Pre Tag",name:"highlightPreTag_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",default:"</em>",description:"HTML tag to insert after the highlighted parts in all highlighted results and snippets.",displayName:"Highlight Post Tag",name:"highlightPostTag_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",default:"…",description:"String used as an ellipsis indicator when a snippet is truncated.",displayName:"Snippet Ellipsis Text",name:"snippetEllipsisText_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
|
|
53
53
|
By default, all items are highlighted and snippeted.
|
|
54
|
-
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{browseParams_options:["
|
|
54
|
+
`,displayName:"Restrict Highlight And Snippet Arrays",name:"restrictHighlightAndSnippetArrays_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:4,description:"Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).",displayName:"Min Word Sizefor1Typo",name:"minWordSizefor1Typo_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:8,description:"Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).",displayName:"Min Word Sizefor2Typos",name:"minWordSizefor2Typos_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"typoTolerance",displayName:"Typo Tolerance",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:`Whether to allow typos on numbers in the search query
|
|
55
55
|
Turn off this setting to reduce the number of irrelevant matches
|
|
56
56
|
when searching in large sets of similar numbers.
|
|
57
|
-
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{browseParams_options:["
|
|
57
|
+
`,displayName:"Allow Typos On Numeric Tokens",name:"allowTyposOnNumericTokens_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Disable Typo Tolerance On Attributes",name:"disableTypoToleranceOnAttributes_json",default:"[]",description:`Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).
|
|
58
58
|
Attribute names are case-sensitive
|
|
59
59
|
Returning only exact matches can help when
|
|
60
60
|
- [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes).
|
|
61
61
|
- Reducing the number of matches when you have too many.
|
|
62
62
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
63
63
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
64
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
64
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
|
|
65
65
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
66
66
|
This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.
|
|
67
|
-
To support this,
|
|
68
|
-
**
|
|
67
|
+
To support this, place the CJK language **first**.
|
|
68
|
+
**Always specify a query language.**
|
|
69
69
|
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),
|
|
70
70
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
71
71
|
This can lead to unexpected search results.
|
|
72
72
|
For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
|
|
73
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
73
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to split compound words in the query into their building blocks\nFor more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",displayName:"Decompound Query",name:"decompoundQuery_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:"Whether to enable rules.",displayName:"Enable Rules",name:"enableRules_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to enable Personalization.",displayName:"Enable Personalization",name:"enablePersonalization_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"options",default:"prefixLast",description:`Determines if and how query words are interpreted as prefixes.
|
|
74
74
|
|
|
75
75
|
By default, only the last query word is treated as a prefix (\`prefixLast\`).
|
|
76
76
|
To turn off prefix search, use \`prefixNone\`.
|
|
@@ -78,7 +78,7 @@ Avoid \`prefixAll\`, which treats all query words as prefixes.
|
|
|
78
78
|
This might lead to counterintuitive results and makes your search slower.
|
|
79
79
|
|
|
80
80
|
For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching).
|
|
81
|
-
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],displayName:"Query Type",name:"queryType_options",displayOptions:{show:{browseParams_options:["
|
|
81
|
+
`,options:[{name:"prefixLast",value:"prefixLast"},{name:"prefixAll",value:"prefixAll"},{name:"prefixNone",value:"prefixNone"}],displayName:"Query Type",name:"queryType_options",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"options",placeholder:"firstWords",default:"none",description:`Strategy for removing words from the query when it doesn't return any results.
|
|
82
82
|
This helps to avoid returning empty search results.
|
|
83
83
|
|
|
84
84
|
- \`none\`.
|
|
@@ -96,16 +96,16 @@ This helps to avoid returning empty search results.
|
|
|
96
96
|
Treat all words as optional.
|
|
97
97
|
|
|
98
98
|
For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results).
|
|
99
|
-
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],displayName:"Remove Words If No Results",name:"removeWordsIfNoResults_options",displayOptions:{show:{browseParams_options:["
|
|
99
|
+
`,options:[{name:"none",value:"none"},{name:"lastWords",value:"lastWords"},{name:"firstWords",value:"firstWords"},{name:"allOptional",value:"allOptional"}],displayName:"Remove Words If No Results",name:"removeWordsIfNoResults_options",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"options",default:"keywordSearch",description:`Search mode the index will use to query for results.
|
|
100
100
|
|
|
101
101
|
This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
|
|
102
|
-
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options",displayOptions:{show:{browseParams_options:["
|
|
102
|
+
`,options:[{name:"neuralSearch",value:"neuralSearch"},{name:"keywordSearch",value:"keywordSearch"}],displayName:"Mode",name:"mode_options",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",description:"Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",required:!1,default:"{}",displayName:"Semantic Search",name:"semantic_search_object",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",displayName:"Advanced Syntax",name:"advancedSyntax_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalWords",displayName:"Optional Words",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Disable Exact On Attributes",name:"disableExactOnAttributes_json",default:"[]",description:`Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
|
|
103
103
|
Attribute names are case-sensitive
|
|
104
104
|
This can be useful for attributes with long values, where the likelihood of an exact match is high,
|
|
105
105
|
such as product descriptions.
|
|
106
106
|
Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
|
|
107
107
|
This reduces the impact of individual attributes with a lot of content on ranking.
|
|
108
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
108
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"options",default:"attribute",description:`Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.
|
|
109
109
|
|
|
110
110
|
- \`attribute\`.
|
|
111
111
|
The Exact ranking criterion is 1 if the query word and attribute value are the same.
|
|
@@ -119,7 +119,7 @@ This reduces the impact of individual attributes with a lot of content on rankin
|
|
|
119
119
|
The query word must have at least 3 characters and must not be a stop word.
|
|
120
120
|
Only exact matches will be highlighted,
|
|
121
121
|
partial and prefix matches won't.
|
|
122
|
-
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],displayName:"Exact On Single Word Query",name:"exactOnSingleWordQuery_options",displayOptions:{show:{browseParams_options:["
|
|
122
|
+
`,options:[{name:"attribute",value:"attribute"},{name:"none",value:"none"},{name:"word",value:"word"}],displayName:"Exact On Single Word Query",name:"exactOnSingleWordQuery_options",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Alternatives As Exact",name:"alternativesAsExact_json",default:"[]",description:`Determine which plurals and synonyms should be considered an exact matches
|
|
123
123
|
By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching.
|
|
124
124
|
For example
|
|
125
125
|
- "swimsuit" and "swimsuits" are treated the same
|
|
@@ -130,11 +130,11 @@ For example
|
|
|
130
130
|
Single-word synonyms, such as "NY" = "NYC", are considered exact matches
|
|
131
131
|
- \`multiWordsSynonym\`.
|
|
132
132
|
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
|
|
133
|
-
`,required:!1,displayOptions:{show:{browseParams_options:["
|
|
133
|
+
`,required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Advanced Syntax Features",name:"advancedSyntaxFeatures_json",default:"[]",description:'Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain "search" but not "engine"\nThis setting only has an effect if `advancedSyntax` is true.\n',required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"distinct",displayName:"Distinct",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:'Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either "home" or "house" are included in the search results,\nand either "home" or "house" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of "house" are replaced by "home" in the highlighted response.\n',displayName:"Replace Synonyms In Highlight",name:"replaceSynonymsInHighlight_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:1,description:`Minimum proximity score for two matching words
|
|
134
134
|
This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
|
|
135
135
|
by equally scoring matches that are farther apart
|
|
136
136
|
For example, if \`minProximity\` is 2, neighboring matches and matches with one word between them would have the same score.
|
|
137
|
-
`,typeOptions:{minValue:1,maxValue:7},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{browseParams_options:["
|
|
137
|
+
`,typeOptions:{minValue:1,maxValue:7},displayName:"Min Proximity",name:"minProximity_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Response Fields",name:"responseFields_json",default:"[]",description:"Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",required:!1,displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"number",default:100,description:"Maximum number of facet values to return for each facet.",typeOptions:{maxValue:1e3},displayName:"Max Values Per Facet",name:"maxValuesPerFacet_number",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",default:"count",description:`Order in which to retrieve facet values
|
|
138
138
|
- \`count\`.
|
|
139
139
|
Facet values are retrieved by decreasing count.
|
|
140
140
|
The count is the number of matching records containing this facet value
|
|
@@ -142,17 +142,17 @@ For example, if \`minProximity\` is 2, neighboring matches and matches with one
|
|
|
142
142
|
Retrieve facet values alphabetically
|
|
143
143
|
This setting doesn't influence how facet values are displayed in your UI (see \`renderingContent\`).
|
|
144
144
|
For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
|
145
|
-
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{browseParams_options:["
|
|
145
|
+
`,displayName:"Sort Facet Values By",name:"sortFacetValuesBy_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:"Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",displayName:"Attribute Criteria Computed By Min Proximity",name:"attributeCriteriaComputedByMinProximity_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",description:`Extra data that can be used in the search UI.
|
|
146
146
|
|
|
147
147
|
You can use this to control aspects of your search UI, such as the order of facet names and values
|
|
148
148
|
without changing your frontend code.
|
|
149
|
-
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object",displayOptions:{show:{browseParams_options:["
|
|
149
|
+
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
150
150
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
151
|
-
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{browseParams_options:["
|
|
151
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"jMDY3M2MwM2QwMWUxMmQwYWI0ZTN",default:"",description:`Cursor to get the next page of the response.
|
|
152
152
|
|
|
153
153
|
The parameter must match the value returned in the response of a previous request.
|
|
154
154
|
The last page of the response does not return a \`cursor\` attribute.
|
|
155
|
-
`,displayName:"Cursor",name:"cursor_string",displayOptions:{show:{browseParams_options:["browse_params_object"]}}}],routing:{request:{body:{params:"={{ $value.params_string }}",query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}",cursor:"={{ $value.cursor_string }}"}}},displayOptions:{show:{resource:["Search"],operation:["browse"]}}}],u=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Search"],operation:["search"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",default:"",description:"Strategy for multiple search queries:\n\n- `none`. Run all queries.\n- `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.\n",options:[{name:"none",value:"none"},{name:"stopIfEnoughMatches",value:"stopIfEnoughMatches"}],displayName:"Strategy",name:"strategy_options"}],routing:{request:{body:{strategy:"={{ $value.strategy_options }}"}}},displayOptions:{show:{resource:["Search"],operation:["search"]}}}],c=[{type:"string",default:"",displayName:"Facet Name",name:"facetName_string",required:!0,description:"Facet attribute in which to search for values.\n\nThis attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.\n",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string"},{type:"string",placeholder:"george",default:"",description:"Text to search inside the facet's values.",displayName:"Facet Query",name:"facetQuery_string"},{type:"number",default:10,description:"Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).",typeOptions:{maxValue:100},displayName:"Max Facet Hits",name:"maxFacetHits_number"}],routing:{request:{body:{params:"={{ $value.params_string }}",facetQuery:"={{ $value.facetQuery_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}}],m=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Search Params",name:"searchParams_options",default:"search_parameters_as_query_string_object",options:[{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"},{name:"Search Parameters As Object",value:"search_parameters_as_object"}],required:!1},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string",displayOptions:{show:{searchParams_options:["search_parameters_as_query_string_object"]}}},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
155
|
+
`,displayName:"Cursor",name:"cursor_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string",displayOptions:{show:{browseParams_options:["search_parameters_as_query_string_object"]}}}],routing:{request:{body:{query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}",cursor:"={{ $value.cursor_string }}",params:"={{ $value.params_string }}"}}},displayOptions:{show:{resource:["Search"],operation:["browse"]}}}],u=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Search"],operation:["search"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",default:"",description:"Strategy for multiple search queries:\n\n- `none`. Run all queries.\n- `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.\n",options:[{name:"none",value:"none"},{name:"stopIfEnoughMatches",value:"stopIfEnoughMatches"}],displayName:"Strategy",name:"strategy_options"}],routing:{request:{body:{strategy:"={{ $value.strategy_options }}"}}},displayOptions:{show:{resource:["Search"],operation:["search"]}}}],c=[{type:"string",default:"",displayName:"Facet Name",name:"facetName_string",required:!0,description:"Facet attribute in which to search for values.\n\nThis attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.\n",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string"},{type:"string",placeholder:"george",default:"",description:"Text to search inside the facet's values.",displayName:"Facet Query",name:"facetQuery_string"},{type:"number",default:10,description:"Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).",typeOptions:{maxValue:100},displayName:"Max Facet Hits",name:"maxFacetHits_number"}],routing:{request:{body:{params:"={{ $value.params_string }}",facetQuery:"={{ $value.facetQuery_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchForFacetValues"]}}}],m=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Search Params",name:"searchParams_options",default:"search_parameters_as_query_string_object",options:[{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"},{name:"Search Parameters As Object",value:"search_parameters_as_object"}],required:!1},{type:"string",placeholder:"hitsPerPage=2&getRankingInfo=1",default:"",description:"Search parameters as a URL-encoded query string.",displayName:"Params",name:"params_string",displayOptions:{show:{searchParams_options:["search_parameters_as_query_string_object"]}}},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
156
156
|
If true, all filter scores are summed.
|
|
157
157
|
Otherwise, the maximum filter score is kept.
|
|
158
158
|
For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
|
|
@@ -191,7 +191,7 @@ you put the sorting attribute at the top of the list.
|
|
|
191
191
|
Sort the index by the values of an attribute, in descending order.
|
|
192
192
|
|
|
193
193
|
Before you modify the default setting,
|
|
194
|
-
|
|
194
|
+
test your changes in the dashboard,
|
|
195
195
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
196
196
|
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
197
197
|
You can only set \`relevancyStrictness\` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
|
|
@@ -215,11 +215,11 @@ Returning only exact matches can help when
|
|
|
215
215
|
- Reducing the number of matches when you have too many.
|
|
216
216
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
217
217
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
218
|
-
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
218
|
+
`,required:!1,displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
|
|
219
219
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
220
220
|
This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.
|
|
221
|
-
To support this,
|
|
222
|
-
**
|
|
221
|
+
To support this, place the CJK language **first**.
|
|
222
|
+
**Always specify a query language.**
|
|
223
223
|
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),
|
|
224
224
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
225
225
|
This can lead to unexpected search results.
|
|
@@ -302,7 +302,7 @@ You can use this to control aspects of your search UI, such as the order of face
|
|
|
302
302
|
without changing your frontend code.
|
|
303
303
|
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
304
304
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
305
|
-
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}}],routing:{request:{body:{params:"={{ $value.params_string }}",query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}}],h=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Search an index",value:"searchSingleIndex",action:"Search an index",description:"Searches a single index and returns matching search results as hits.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/query"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits","params","query"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}},{name:"Search multiple indices",value:"search",action:"Search multiple indices",description:"Sends multiple search requests to one or more indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/queries"}}},{name:"Search for facet values",value:"searchForFacetValues",action:"Search for facet values",description:"Searches for values of a specified facet attribute.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/facets/{{ $parameter.facetName_string }}/query"}}},{name:"Browse for records",value:"browse",action:"Browse for records",description:"Retrieves records from an index, up to 1,000 per request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/browse"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits","params","query"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["hits","params","query"]}}],displayOptions:{show:{resource:["Search"]}}}],y=[...h,{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex","browse"]}}},...d,...u,...c,...m],g=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}}],f=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["batch"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["batch"]}}}],b=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["clearObjects"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],w=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",name:"facetFilters",displayName:"Facet Filters",default:""},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string"},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:""},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:""},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string"},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:""},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:""},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
305
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:"",displayOptions:{show:{searchParams_options:["search_parameters_as_object"]}}}],routing:{request:{body:{params:"={{ $value.params_string }}",query:"={{ $value.query_string }}",similarQuery:"={{ $value.similarQuery_string }}",filters:"={{ $value.filters_string }}",facetFilters:"={{ JSON.parse($value.facetFilters) }}",optionalFilters:"={{ JSON.parse($value.optionalFilters) }}",numericFilters:"={{ JSON.parse($value.numericFilters) }}",tagFilters:"={{ JSON.parse($value.tagFilters) }}",sumOrFiltersScores:"={{ $value.sumOrFiltersScores_boolean }}",restrictSearchableAttributes:"={{ JSON.parse($value.restrictSearchableAttributes_json) }}",facets:"={{ JSON.parse($value.facets_json) }}",facetingAfterDistinct:"={{ $value.facetingAfterDistinct_boolean }}",page:"={{ $value.page_number }}",offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",aroundLatLng:"={{ $value.aroundLatLng_string }}",aroundLatLngViaIP:"={{ $value.aroundLatLngViaIP_boolean }}",aroundRadius:"={{ JSON.parse($value.aroundRadius) }}",aroundPrecision:"={{ JSON.parse($value.aroundPrecision) }}",minimumAroundRadius:"={{ $value.minimumAroundRadius_number }}",insideBoundingBox:"={{ JSON.parse($value.insideBoundingBox) }}",insidePolygon:"={{ JSON.parse($value.insidePolygon_json) }}",naturalLanguages:"={{ JSON.parse($value.naturalLanguages_json) }}",ruleContexts:"={{ JSON.parse($value.ruleContexts_json) }}",personalizationImpact:"={{ $value.personalizationImpact_number }}",userToken:"={{ $value.userToken_string }}",getRankingInfo:"={{ $value.getRankingInfo_boolean }}",synonyms:"={{ $value.synonyms_boolean }}",clickAnalytics:"={{ $value.clickAnalytics_boolean }}",analytics:"={{ $value.analytics_boolean }}",analyticsTags:"={{ JSON.parse($value.analyticsTags_json) }}",percentileComputation:"={{ $value.percentileComputation_boolean }}",enableABTest:"={{ $value.enableABTest_boolean }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex"]}}}],h=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Search an index",value:"searchSingleIndex",action:"Search an index",description:"Searches a single index and returns matching search results as hits.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/query"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["hits"]}},{name:"Search multiple indices",value:"search",action:"Search multiple indices",description:"Sends multiple search requests to one or more indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/queries"}}},{name:"Search for facet values",value:"searchForFacetValues",action:"Search for facet values",description:"Searches for values of a specified facet attribute.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/facets/{{ $parameter.facetName_string }}/query"}}},{name:"Browse for records",value:"browse",action:"Browse for records",description:"Retrieves records from an index, up to 1,000 per request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/browse"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["hits"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["hits"]}}],displayOptions:{show:{resource:["Search"]}}}],y=[...h,{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Search"],operation:["searchSingleIndex","browse"]}}},...d,...u,...c,...m],g=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["addOrUpdateObject"]}}}],f=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["batch"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["batch"]}}}],b=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["clearObjects"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],w=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["deleteBy"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",name:"facetFilters",displayName:"Facet Filters",default:""},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string"},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:""},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:""},{type:"string",placeholder:"40.71,-74.01",default:"",description:"Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",displayName:"Around Lat Lng",name:"aroundLatLng_string"},{type:"json",name:"aroundRadius",displayName:"Around Radius",default:""},{type:"json",name:"insideBoundingBox",displayName:"Inside Bounding Box",default:""},{type:"json",displayName:"Inside Polygon",name:"insidePolygon_json",default:"[]",description:`Coordinates of a polygon in which to search.
|
|
306
306
|
|
|
307
307
|
Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
|
|
308
308
|
Provide multiple polygons as nested arrays.
|
|
@@ -316,7 +316,7 @@ By default, all retrievable attributes are returned.
|
|
|
316
316
|
|
|
317
317
|
Attributes included in \`unretrievableAttributes\`
|
|
318
318
|
won't be retrieved unless the request is authenticated with the admin API key.
|
|
319
|
-
`,required:!1}],routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}}],N=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}}],x=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}}],O=[{type:"json",description:"Attributes to update.",required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!0,displayName:"Create If Not Exists",name:"createIfNotExists_boolean",description:"Whether to create a new record if it doesn't exist."}],routing:{request:{qs:{createIfNotExists:"={{ $value.createIfNotExists_boolean }}"}}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}}],P=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],A=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}}],T=[...A,...g,...f,...b,...w,..._,...v,...N,...x,...O,...P],q=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],S=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:1,displayName:"Get Version",name:"getVersion_number",description:"When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility."}],routing:{request:{qs:{getVersion:"={{ $value.getVersion_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}}],I=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}}],j=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}],$=[{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
319
|
+
`,required:!1}],routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}}],N=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}}],x=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}}],O=[{type:"json",description:"Attributes to update.",required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!0,displayName:"Create If Not Exists",name:"createIfNotExists_boolean",description:"Whether to create a new record if it doesn't exist."}],routing:{request:{qs:{createIfNotExists:"={{ $value.createIfNotExists_boolean }}"}}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}}],P=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],A=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}}],T=[...A,...g,...f,...b,...w,..._,...v,...N,...x,...O,...P],q=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],S=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:1,displayName:"Get Version",name:"getVersion_number",description:"When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility."}],routing:{request:{qs:{getVersion:"={{ $value.getVersion_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}}],j=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}}],I=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}],$=[{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
320
320
|
|
|
321
321
|
If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.
|
|
322
322
|
If you omit the \`scope\` parameter, everything is copied: records, settings, synonyms, and rules.
|
|
@@ -372,7 +372,7 @@ Attribute names are case-sensitive.
|
|
|
372
372
|
Attribute names are case-sensitive.
|
|
373
373
|
`,required:!1},{type:"json",description:"Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding).\nAttribute names are case-sensitive.\n\nCompound words are formed by combining two or more individual words,\nand are particularly prevalent in Germanic languages—for example, \"firefighter\".\nWith decompounding, the individual components are indexed separately.\n\nYou can specify different lists for different languages.\nDecompounding is supported for these languages:\nDutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",required:!1,default:"{}",displayName:"Decompounded Attributes",name:"decompounded_attributes_object"},{type:"json",displayName:"Index Languages",name:"indexLanguages_json",default:"[]",description:`Languages for language-specific processing steps, such as word detection and dictionary settings.
|
|
374
374
|
|
|
375
|
-
**
|
|
375
|
+
**Always specify an indexing language.**
|
|
376
376
|
If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages),
|
|
377
377
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
378
378
|
This can lead to unexpected search results.
|
|
@@ -459,7 +459,7 @@ you put the sorting attribute at the top of the list.
|
|
|
459
459
|
Sort the index by the values of an attribute, in descending order.
|
|
460
460
|
|
|
461
461
|
Before you modify the default setting,
|
|
462
|
-
|
|
462
|
+
test your changes in the dashboard,
|
|
463
463
|
and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
464
464
|
`,required:!1},{type:"number",placeholder:"90",default:100,description:`Relevancy threshold below which less relevant results aren't included in the results
|
|
465
465
|
You can only set \`relevancyStrictness\` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
|
|
@@ -483,11 +483,11 @@ Returning only exact matches can help when
|
|
|
483
483
|
- Reducing the number of matches when you have too many.
|
|
484
484
|
This can happen with attributes that are long blocks of text, such as product descriptions
|
|
485
485
|
Consider alternatives such as \`disableTypoToleranceOnWords\` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
486
|
-
`,required:!1},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:""},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:""},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
486
|
+
`,required:!1},{type:"json",name:"ignorePlurals",displayName:"Ignore Plurals",default:""},{type:"json",name:"removeStopWords",displayName:"Remove Stop Words",default:""},{type:"json",displayName:"Query Languages",name:"queryLanguages_json",default:"[]",description:`Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
|
|
487
487
|
This setting sets a default list of languages used by the \`removeStopWords\` and \`ignorePlurals\` settings.
|
|
488
488
|
This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.
|
|
489
|
-
To support this,
|
|
490
|
-
**
|
|
489
|
+
To support this, place the CJK language **first**.
|
|
490
|
+
**Always specify a query language.**
|
|
491
491
|
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),
|
|
492
492
|
or the languages you specified with the \`ignorePlurals\` or \`removeStopWords\` parameters.
|
|
493
493
|
This can lead to unexpected search results.
|
|
@@ -570,11 +570,11 @@ You can use this to control aspects of your search UI, such as the order of face
|
|
|
570
570
|
without changing your frontend code.
|
|
571
571
|
`,required:!1,default:"{}",displayName:"Rendering Content",name:"rendering_content_object"},{type:"boolean",default:!0,description:`Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)
|
|
572
572
|
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
|
573
|
-
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean"},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:""}],routing:{request:{body:{attributesForFaceting:"={{ JSON.parse($value.attributesForFaceting_json) }}",replicas:"={{ JSON.parse($value.replicas_json) }}",paginationLimitedTo:"={{ $value.paginationLimitedTo_number }}",unretrievableAttributes:"={{ JSON.parse($value.unretrievableAttributes_json) }}",disableTypoToleranceOnWords:"={{ JSON.parse($value.disableTypoToleranceOnWords_json) }}",attributesToTransliterate:"={{ JSON.parse($value.attributesToTransliterate_json) }}",camelCaseAttributes:"={{ JSON.parse($value.camelCaseAttributes_json) }}",decompoundedAttributes:"={{ JSON.parse($value.decompounded_attributes_object) }}",indexLanguages:"={{ JSON.parse($value.indexLanguages_json) }}",disablePrefixOnAttributes:"={{ JSON.parse($value.disablePrefixOnAttributes_json) }}",allowCompressionOfIntegerArray:"={{ $value.allowCompressionOfIntegerArray_boolean }}",numericAttributesForFiltering:"={{ JSON.parse($value.numericAttributesForFiltering_json) }}",separatorsToIndex:"={{ $value.separatorsToIndex_string }}",searchableAttributes:"={{ JSON.parse($value.searchableAttributes_json) }}",customNormalization:"={{ JSON.parse($value.custom_normalization_object) }}",attributeForDistinct:"={{ $value.attributeForDistinct_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}",keepDiacriticsOnCharacters:"={{ $value.keepDiacriticsOnCharacters_string }}",customRanking:"={{ JSON.parse($value.customRanking_json) }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}}],k=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Delete an index",value:"deleteIndex",action:"Delete an index",description:"Deletes an index and all its settings.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve index settings",value:"getSettings",action:"Retrieve index settings",description:"Retrieves an object with non-null index settings.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"]}},{name:"Update index settings",value:"setSettings",action:"Update index settings",description:"Update the specified index settings.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"}}},{name:"Check task status",value:"getTask",action:"Check task status",description:"Checks the status of a given task.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/task/{{ $parameter.taskID_number }}"}}},{name:"Copy or move an index",value:"operationIndex",action:"Copy or move an index",description:"Copies or moves (renames) an index within the same Algolia application.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/operation"}}},{name:"List indices",value:"listIndices",action:"List indices",description:"Lists all indices in the current Algolia application.",routing:{request:{method:"GET",url:"=/1/indexes"}}}],displayOptions:{show:{resource:["Indices"]}}}],D=[...k,{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},...q,...S,...I,...j,...$,...R],F=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}}}],E=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}}],W=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}}}],L=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"synonymID",default:"",description:"Unique identifier of a synonym object.",routing:{send:{type:"body",value:"={{ $value }}",property:"objectID"}},displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],routing:{send:{type:"body",value:"={{ $value }}",property:"type"}},displayName:"Type",name:"type_options",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Synonyms",name:"synonyms_json",default:"[]",description:"Words or phrases considered equivalent.",required:!1},{type:"string",placeholder:"car",default:"",description:"Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms)).",displayName:"Input",name:"input_string"},{type:"string",placeholder:"car",default:"",description:"Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections)).",displayName:"Word",name:"word_string"},{type:"json",displayName:"Corrections",name:"corrections_json",default:"[]",description:"Words to be matched in records.",required:!1},{type:"string",placeholder:"<Street>",default:"",description:`[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records.
|
|
573
|
+
`,displayName:"Enable Re Ranking",name:"enableReRanking_boolean"},{type:"json",name:"reRankingApplyFilter",displayName:"Re Ranking Apply Filter",default:""}],routing:{request:{body:{attributesForFaceting:"={{ JSON.parse($value.attributesForFaceting_json) }}",replicas:"={{ JSON.parse($value.replicas_json) }}",paginationLimitedTo:"={{ $value.paginationLimitedTo_number }}",unretrievableAttributes:"={{ JSON.parse($value.unretrievableAttributes_json) }}",disableTypoToleranceOnWords:"={{ JSON.parse($value.disableTypoToleranceOnWords_json) }}",attributesToTransliterate:"={{ JSON.parse($value.attributesToTransliterate_json) }}",camelCaseAttributes:"={{ JSON.parse($value.camelCaseAttributes_json) }}",decompoundedAttributes:"={{ JSON.parse($value.decompounded_attributes_object) }}",indexLanguages:"={{ JSON.parse($value.indexLanguages_json) }}",disablePrefixOnAttributes:"={{ JSON.parse($value.disablePrefixOnAttributes_json) }}",allowCompressionOfIntegerArray:"={{ $value.allowCompressionOfIntegerArray_boolean }}",numericAttributesForFiltering:"={{ JSON.parse($value.numericAttributesForFiltering_json) }}",separatorsToIndex:"={{ $value.separatorsToIndex_string }}",searchableAttributes:"={{ JSON.parse($value.searchableAttributes_json) }}",customNormalization:"={{ JSON.parse($value.custom_normalization_object) }}",attributeForDistinct:"={{ $value.attributeForDistinct_string }}",maxFacetHits:"={{ $value.maxFacetHits_number }}",keepDiacriticsOnCharacters:"={{ $value.keepDiacriticsOnCharacters_string }}",customRanking:"={{ JSON.parse($value.customRanking_json) }}",attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}",ranking:"={{ JSON.parse($value.ranking_json) }}",relevancyStrictness:"={{ $value.relevancyStrictness_number }}",attributesToHighlight:"={{ JSON.parse($value.attributesToHighlight_json) }}",attributesToSnippet:"={{ JSON.parse($value.attributesToSnippet_json) }}",highlightPreTag:"={{ $value.highlightPreTag_string }}",highlightPostTag:"={{ $value.highlightPostTag_string }}",snippetEllipsisText:"={{ $value.snippetEllipsisText_string }}",restrictHighlightAndSnippetArrays:"={{ $value.restrictHighlightAndSnippetArrays_boolean }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",minWordSizefor1Typo:"={{ $value.minWordSizefor1Typo_number }}",minWordSizefor2Typos:"={{ $value.minWordSizefor2Typos_number }}",typoTolerance:"={{ JSON.parse($value.typoTolerance) }}",allowTyposOnNumericTokens:"={{ $value.allowTyposOnNumericTokens_boolean }}",disableTypoToleranceOnAttributes:"={{ JSON.parse($value.disableTypoToleranceOnAttributes_json) }}",ignorePlurals:"={{ JSON.parse($value.ignorePlurals) }}",removeStopWords:"={{ JSON.parse($value.removeStopWords) }}",queryLanguages:"={{ JSON.parse($value.queryLanguages_json) }}",decompoundQuery:"={{ $value.decompoundQuery_boolean }}",enableRules:"={{ $value.enableRules_boolean }}",enablePersonalization:"={{ $value.enablePersonalization_boolean }}",queryType:"={{ $value.queryType_options }}",removeWordsIfNoResults:"={{ $value.removeWordsIfNoResults_options }}",mode:"={{ $value.mode_options }}",semanticSearch:"={{ JSON.parse($value.semantic_search_object) }}",advancedSyntax:"={{ $value.advancedSyntax_boolean }}",optionalWords:"={{ JSON.parse($value.optionalWords) }}",disableExactOnAttributes:"={{ JSON.parse($value.disableExactOnAttributes_json) }}",exactOnSingleWordQuery:"={{ $value.exactOnSingleWordQuery_options }}",alternativesAsExact:"={{ JSON.parse($value.alternativesAsExact_json) }}",advancedSyntaxFeatures:"={{ JSON.parse($value.advancedSyntaxFeatures_json) }}",distinct:"={{ JSON.parse($value.distinct) }}",replaceSynonymsInHighlight:"={{ $value.replaceSynonymsInHighlight_boolean }}",minProximity:"={{ $value.minProximity_number }}",responseFields:"={{ JSON.parse($value.responseFields_json) }}",maxValuesPerFacet:"={{ $value.maxValuesPerFacet_number }}",sortFacetValuesBy:"={{ $value.sortFacetValuesBy_string }}",attributeCriteriaComputedByMinProximity:"={{ $value.attributeCriteriaComputedByMinProximity_boolean }}",renderingContent:"={{ JSON.parse($value.rendering_content_object) }}",enableReRanking:"={{ $value.enableReRanking_boolean }}",reRankingApplyFilter:"={{ JSON.parse($value.reRankingApplyFilter) }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Indices"],operation:["setSettings"]}}}],k=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Delete an index",value:"deleteIndex",action:"Delete an index",description:"Deletes an index and all its settings.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve index settings",value:"getSettings",action:"Retrieve index settings",description:"Retrieves an object with non-null index settings.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"},output:{postReceive:[async function(t){return this.getNodeParameter("simplify",0)?t.map(r=>{const a=r.json||{},s=new Map;return["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"].forEach(e=>{a[e]!==void 0&&s.set(e,a[e])}),{json:Object.fromEntries(s)}}):t}]}},inputSchema:{simplifiedOutput:["advancedSyntax","advancedSyntaxFeatures","allowCompressionOfIntegerArray","allowTyposOnNumericTokens","alternativesAsExact","attributeCriteriaComputedByMinProximity","attributeForDistinct","attributesForFaceting","attributesToHighlight","attributesToRetrieve"]}},{name:"Update index settings",value:"setSettings",action:"Update index settings",description:"Update the specified index settings.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/settings"}}},{name:"Check task status",value:"getTask",action:"Check task status",description:"Checks the status of a given task.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/task/{{ $parameter.taskID_number }}"}}},{name:"Copy or move an index",value:"operationIndex",action:"Copy or move an index",description:"Copies or moves (renames) an index within the same Algolia application.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/operation"}}},{name:"List indices",value:"listIndices",action:"List indices",description:"Lists all indices in the current Algolia application.",routing:{request:{method:"GET",url:"=/1/indexes"}}}],displayOptions:{show:{resource:["Indices"]}}}],D=[...k,{displayName:"Simplify",name:"simplify",type:"boolean",default:!1,description:"Whether to return a simplified version of the response instead of the raw data",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}},...q,...S,...j,...I,...$,...R],F=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["clearSynonyms"]}}}],E=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["deleteSynonym"]}}}],W=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["getSynonym"]}}}],L=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"synonymID",default:"",displayName:"Object ID",name:"objectID_string",required:!0,description:"Unique identifier of a synonym object.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"string",placeholder:"synonymID",default:"",description:"Unique identifier of a synonym object.",routing:{send:{type:"body",value:"={{ $value }}",property:"objectID"}},displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],routing:{send:{type:"body",value:"={{ $value }}",property:"type"}},displayName:"Type",name:"type_options",required:!0,displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Synonyms",name:"synonyms_json",default:"[]",description:"Words or phrases considered equivalent.",required:!1},{type:"string",placeholder:"car",default:"",description:"Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms)).",displayName:"Input",name:"input_string"},{type:"string",placeholder:"car",default:"",description:"Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections)).",displayName:"Word",name:"word_string"},{type:"json",displayName:"Corrections",name:"corrections_json",default:"[]",description:"Words to be matched in records.",required:!1},{type:"string",placeholder:"<Street>",default:"",description:`[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records.
|
|
574
574
|
`,displayName:"Placeholder",name:"placeholder_string"},{type:"json",displayName:"Replacements",name:"replacements_json",default:"[]",description:"Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders).",required:!1}],routing:{request:{body:{synonyms:"={{ JSON.parse($value.synonyms_json) }}",input:"={{ $value.input_string }}",word:"={{ $value.word_string }}",corrections:"={{ JSON.parse($value.corrections_json) }}",placeholder:"={{ $value.placeholder_string }}",replacements:"={{ JSON.parse($value.replacements_json) }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonym"]}}}],C=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Matching synonyms.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Replace Existing Synonyms",name:"replaceExistingSynonyms_boolean",description:"Whether to replace all synonyms in the index with the ones sent with this request."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",replaceExistingSynonyms:"={{ $value.replaceExistingSynonyms_boolean }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["saveSynonyms"]}}}],B=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Synonyms"],operation:["searchSynonyms"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string"},{type:"options",placeholder:"onewaysynonym",default:"",description:"Synonym type.",options:[{name:"synonym",value:"synonym"},{name:"onewaysynonym",value:"onewaysynonym"},{name:"altcorrection1",value:"altcorrection1"},{name:"altcorrection2",value:"altcorrection2"},{name:"placeholder",value:"placeholder"},{name:"oneWaySynonym",value:"oneWaySynonym"},{name:"altCorrection1",value:"altCorrection1"},{name:"altCorrection2",value:"altCorrection2"}],displayName:"Type",name:"type_options"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{query:"={{ $value.query_string }}",type:"={{ $value.type_options }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Synonyms"],operation:["searchSynonyms"]}}}],z=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a synonym",value:"getSynonym",action:"Retrieve a synonym",description:"Retrieves a synonym by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a synonym",value:"saveSynonym",action:"Create or replace a synonym",description:"If a synonym with the specified object ID doesn't exist, Algolia adds a new one.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Delete a synonym",value:"deleteSynonym",action:"Delete a synonym",description:"Deletes a synonym by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/{{ $parameter.objectID_string }}"}}},{name:"Create or replace synonyms",value:"saveSynonyms",action:"Create or replace synonyms",description:"If a synonym with the `objectID` doesn't exist, Algolia adds a new one.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/batch"}}},{name:"Delete all synonyms",value:"clearSynonyms",action:"Delete all synonyms",description:"Deletes all synonyms from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/clear"}}},{name:"Search for synonyms",value:"searchSynonyms",action:"Search for synonyms",description:"Searches for synonyms in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/synonyms/search"}}}],displayOptions:{show:{resource:["Synonyms"]}}}],U=[...z,...F,...E,...W,...L,...C,...B],M=[{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
575
575
|
The required ACL is listed in each endpoint's reference.
|
|
576
576
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
577
|
-
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_"
|
|
577
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_"\n- `*_dev` matches all indices ending with "_dev"\n- `*_products_*` matches all indices containing "_products_".\n',required:!1},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
578
578
|
By default, there's no limit.
|
|
579
579
|
`,displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number"},{type:"number",default:"",description:`Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour.
|
|
580
580
|
|
|
@@ -602,7 +602,7 @@ By default, API keys don't expire.
|
|
|
602
602
|
`,displayName:"Validity",name:"validity_number"}],routing:{request:{body:{description:"={{ $value.description_string }}",indexes:"={{ JSON.parse($value.indexes_json) }}",maxHitsPerQuery:"={{ $value.maxHitsPerQuery_number }}",maxQueriesPerIPPerHour:"={{ $value.maxQueriesPerIPPerHour_number }}",queryParameters:"={{ $value.queryParameters_string }}",referers:"={{ JSON.parse($value.referers_json) }}",validity:"={{ $value.validity_number }}"}}},displayOptions:{show:{resource:["Api Keys"],operation:["addApiKey"]}}}],J=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["deleteApiKey"]}}}],V=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["getApiKey"]}}}],H=[{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["restoreApiKey"]}}}],G=[{type:"json",displayName:"Acl",name:"acl_json",default:"[]",description:`Permissions that determine the type of API requests this key can make.
|
|
603
603
|
The required ACL is listed in each endpoint's reference.
|
|
604
604
|
For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
605
|
-
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_"
|
|
605
|
+
`,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"acl"}},displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{type:"string",placeholder:"ALGOLIA_API_KEY",default:"",displayName:"Key",name:"key_string",required:!0,description:"API key.",displayOptions:{show:{resource:["Api Keys"],operation:["updateApiKey"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Used for indexing by the CLI",default:"",description:"Description of an API key to help you identify this API key.",displayName:"Description",name:"description_string"},{type:"json",displayName:"Indexes",name:"indexes_json",default:"[]",description:'Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with "dev_"\n- `*_dev` matches all indices ending with "_dev"\n- `*_products_*` matches all indices containing "_products_".\n',required:!1},{type:"number",default:"",description:`Maximum number of results this API key can retrieve in one query.
|
|
606
606
|
By default, there's no limit.
|
|
607
607
|
`,displayName:"Max Hits Per Query",name:"maxHitsPerQuery_number"},{type:"number",default:"",description:`Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour.
|
|
608
608
|
|
|
@@ -634,9 +634,9 @@ For more information, see [Consequences](https://www.algolia.com/doc/guides/mana
|
|
|
634
634
|
|
|
635
635
|
Some consequences require specific conditions or don't require any condition.
|
|
636
636
|
For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
|
|
637
|
-
`,required:!1},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",displayName:"Description",name:"description_string"},{type:"boolean",default:!0,description:"Whether the rule is active.",displayName:"Enabled",name:"enabled_boolean"},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1}],routing:{request:{body:{conditions:"={{ JSON.parse($value.conditions_json) }}",description:"={{ $value.description_string }}",enabled:"={{ $value.enabled_boolean }}",validity:"={{ JSON.parse($value.validity_json) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}}],te=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",description:"Whether existing rules should be deleted before adding this batch."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",clearExistingRules:"={{ $value.clearExistingRules_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}}],ae=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query for rules.",displayName:"Query",name:"query_string"},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],displayName:"Anchoring",name:"anchoring_options"},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",displayName:"Context",name:"context_string"},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"json",name:"enabled",displayName:"Enabled",default:""}],routing:{request:{body:{query:"={{ $value.query_string }}",anchoring:"={{ $value.anchoring_options }}",context:"={{ $value.context_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",enabled:"={{ JSON.parse($value.enabled) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}}],se=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}}],re=[...se,...Y,...X,...Z,...ee,...te,...ae],ne=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean"}],routing:{request:{body:{clearExistingDictionaryEntries:"={{ $value.clearExistingDictionaryEntries_boolean }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}}],ie=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],displayName:"Language",name:"language_options"}],routing:{request:{body:{page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",language:"={{ $value.language_options }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}}],oe=[{type:"json",description:`Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.
|
|
637
|
+
`,required:!1},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",displayName:"Description",name:"description_string"},{type:"boolean",default:!0,description:"Whether the rule is active.",displayName:"Enabled",name:"enabled_boolean"},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1},{type:"json",displayName:"Tags",name:"tags_json",default:"[]",description:void 0,required:!1},{type:"string",default:"",displayName:"Scope",name:"scope_string"}],routing:{request:{body:{conditions:"={{ JSON.parse($value.conditions_json) }}",description:"={{ $value.description_string }}",enabled:"={{ $value.enabled_boolean }}",validity:"={{ JSON.parse($value.validity_json) }}",tags:"={{ JSON.parse($value.tags_json) }}",scope:"={{ $value.scope_string }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}}],te=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",description:"Whether existing rules should be deleted before adding this batch."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",clearExistingRules:"={{ $value.clearExistingRules_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}}],ae=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query for rules.",displayName:"Query",name:"query_string"},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],displayName:"Anchoring",name:"anchoring_options"},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",displayName:"Context",name:"context_string"},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"json",name:"enabled",displayName:"Enabled",default:""}],routing:{request:{body:{query:"={{ $value.query_string }}",anchoring:"={{ $value.anchoring_options }}",context:"={{ $value.context_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",enabled:"={{ JSON.parse($value.enabled) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}}],se=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}}],re=[...se,...Y,...X,...Z,...ee,...te,...ae],ne=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean"}],routing:{request:{body:{clearExistingDictionaryEntries:"={{ $value.clearExistingDictionaryEntries_boolean }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}}],ie=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],displayName:"Language",name:"language_options"}],routing:{request:{body:{page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",language:"={{ $value.language_options }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}}],oe=[{type:"json",description:`Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.
|
|
638
638
|
`,required:!0,default:"{}",routing:{send:{type:"body",property:"disableStandardEntries",value:"={{ JSON.parse($value) }}"}},displayName:"Disable Standard Entries",name:"disable_standard_entries_object",displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}}],le=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}}],pe=[...le,...ne,...ie,...oe],de=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}}],ue=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"users"}},displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}}],ce=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}}],me=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Get Clusters",name:"getClusters_boolean",description:"Whether to include the cluster's pending mapping state in the response."}],routing:{request:{qs:{getClusters:"={{ $value.getClusters_boolean }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}}],he=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}}],ye=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["removeUserId"]}}}],ge=[{type:"string",default:"",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",displayName:"Cluster Name",name:"clusterName_string"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{clusterName:"={{ $value.clusterName_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}}],fe=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}}],be=[...fe,...de,...ue,...ce,...me,...he,...ye,...ge],we=[{type:"string",placeholder:"10.0.0.1/32",default:"",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Server subnet",default:"",description:"Source description.",displayName:"Description",name:"description_string"}],routing:{request:{body:{description:"={{ $value.description_string }}"}}},displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}}],_e=[{type:"string",placeholder:"10.0.0.1/32",default:"",displayName:"Source",name:"source_string",required:!0,description:"IP address range of the source.",displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}}],ve=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Sources.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Vaults"],operation:["replaceSources"]}}}],Ne=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}}],xe=[...Ne,...we,..._e,...ve],Oe=[{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}}],Pe=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:"",displayName:"Offset",name:"offset_number",description:"First log entry to retrieve. The most recent entries are listed first."},{type:"number",default:10,typeOptions:{maxValue:1e3},displayName:"Length",name:"length_number",description:"Maximum number of entries to retrieve."},{type:"json",name:"indexName",displayName:"Index Name",default:"",description:`Index for which to retrieve log entries.
|
|
639
639
|
By default, log entries are retrieved for all indices.
|
|
640
640
|
`},{type:"options",default:"all",options:[{name:"all",value:"all"},{name:"query",value:"query"},{name:"build",value:"build"},{name:"error",value:"error"}],displayName:"Type",name:"type_options",description:`Type of log entries to retrieve.
|
|
641
641
|
By default, all log entries are retrieved.
|
|
642
|
-
`}],routing:{request:{qs:{offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",indexName:"={{ JSON.parse($value.indexName) }}",type:"={{ $value.type_options }}"}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}}],Ae=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}}],Te=[...Ae,...Oe,...Pe],qe=[{displayName:"Resource",name:"resource",type:"options",default:"",description:"Select the resource to work with",options:[{name:"Advanced",value:"Advanced",description:"Query your logs"},{name:"Api Keys",value:"Api Keys",description:"Manage your API keys"},{name:"Clusters",value:"Clusters",description:"Multi-cluster operations"},{name:"Dictionaries",value:"Dictionaries",description:"Manage your dictionaries"},{name:"Indices",value:"Indices",description:"Manage your indices and index settings"},{name:"Records",value:"Records",description:"Add, update, and delete records from your indices"},{name:"Rules",value:"Rules",description:"Create, update, delete, and search for rules"},{name:"Search",value:"Search",description:"Search one or more indices for matching records or facet values"},{name:"Synonyms",value:"Synonyms",description:"Create, update, delete, and search for synonyms"},{name:"Vaults",value:"Vaults",description:"Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest"}]}],Se=[...qe,...y,...T,...D,...U,...K,...re,...pe,...be,...xe,...Te];class
|
|
642
|
+
`}],routing:{request:{qs:{offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",indexName:"={{ JSON.parse($value.indexName) }}",type:"={{ $value.type_options }}"}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}}],Ae=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}}],Te=[...Ae,...Oe,...Pe],qe=[{displayName:"Resource",name:"resource",type:"options",default:"",description:"Select the resource to work with",options:[{name:"Advanced",value:"Advanced",description:"Query your logs"},{name:"Api Keys",value:"Api Keys",description:"Manage your API keys"},{name:"Clusters",value:"Clusters",description:"Multi-cluster operations"},{name:"Dictionaries",value:"Dictionaries",description:"Manage your dictionaries"},{name:"Indices",value:"Indices",description:"Manage your indices and index settings"},{name:"Records",value:"Records",description:"Add, update, and delete records from your indices"},{name:"Rules",value:"Rules",description:"Create, update, delete, and search for rules"},{name:"Search",value:"Search",description:"Search one or more indices for matching records or facet values"},{name:"Synonyms",value:"Synonyms",description:"Create, update, delete, and search for synonyms"},{name:"Vaults",value:"Vaults",description:"Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest"}]}],Se=[...qe,...y,...T,...D,...U,...K,...re,...pe,...be,...xe,...Te];class je{constructor(){this.description={name:"algolia",displayName:"Algolia",description:"Use Algolia in your n8n workflows",subtitle:'={{ $parameter.operation.replace(/([a-z])([A-Z])/g, "$1 $2").toTitleCase() }}',icon:"file:../../algolia.svg",defaults:{name:"Algolia"},credentials:[{name:"algoliaApi",required:!0}],requestDefaults:{baseURL:"=https://{{ $credentials.appId }}.algolia.net",headers:{"User-Agent":`${o.name} (${o.version})`}},version:1,inputs:[i.NodeConnectionTypes.Main],outputs:[i.NodeConnectionTypes.Main],properties:Se,group:[]}}}exports.Algolia=je;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/n8n-nodes-algolia",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"description": "Algolia nodes for n8n",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"n8n-community-node-package",
|
|
@@ -28,7 +28,8 @@
|
|
|
28
28
|
"lintfix": "n8n-node lint --fix",
|
|
29
29
|
"generate-properties": "npx tsx scripts/generate-properties/index.ts",
|
|
30
30
|
"generate-readme-operations": "npx tsx scripts/generate-readme-operations.ts",
|
|
31
|
-
"generate": "npm run generate-properties && npm run generate-readme-operations"
|
|
31
|
+
"generate": "npm run generate-properties && npm run generate-readme-operations",
|
|
32
|
+
"release": "shipjs prepare"
|
|
32
33
|
},
|
|
33
34
|
"files": [
|
|
34
35
|
"dist"
|
|
@@ -52,7 +53,7 @@
|
|
|
52
53
|
"openapi-types": "12.1.3",
|
|
53
54
|
"prettier": "^3.5.3",
|
|
54
55
|
"shelljs": "^0.10.0",
|
|
55
|
-
"shipjs": "
|
|
56
|
+
"shipjs": "0.28.2",
|
|
56
57
|
"tsc-alias": "^1.8.16",
|
|
57
58
|
"tsx": "^4.7.0",
|
|
58
59
|
"typescript": "^5.8.2",
|