diff --git a/schema/latest/pipelines-schema.json b/schema/latest/pipelines-schema.json index 59425573..8b17a296 100644 --- a/schema/latest/pipelines-schema.json +++ b/schema/latest/pipelines-schema.json @@ -312,7 +312,7 @@ "description": "Trigger will indicate whether or not to trigger the stage.", "properties": { "expression": { - "description": "Custom trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#advanced-editor).", + "description": "Custom trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#advanced-editor).", "title": "Trigger Expression", "type": "string" } @@ -486,12 +486,8 @@ "type": "string" }, "value": { - "description": "To define the matching values to boost results, for e.g show items with '['holiday-sale', 'premium values']' for 'tag' data field above other items.", - "items": { - "type": "string" - }, - "title": "Value", - "type": "array" + "description": "To define the matching values to boost results, for e.g show items with '['holiday-sale', 'premium values']' for 'tag' data field above other items. This key also supports other types of values in order to support `range` and `geo` type of queries.\n\nTo use with `geo` for boosting, value can be ```yaml\nlocation: '23.7555,76.4444'\ndistance: 100\nunit:'km'\n```\n\nTo use with `range` for boosting, value can be ```yaml\nstart: 23\nend: 45\n```", + "title": "Value" } }, "type": "object" @@ -809,7 +805,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -910,12 +909,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -1006,6 +1037,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -1014,9 +1046,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -1872,7 +1906,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "geo": { - "description": "Default query settings applicable to 'geo' type of queries. You can find all the properties at [here](https://docs.appbase.io/docs/search/reactivesearch-api/reference).", + "description": "Default query settings applicable to 'geo' type of queries. You can find all the properties at [here](https://docs.reactivesearch.io/docs/search/reactivesearch-api/reference).", "properties": { "AIConfig": { "description": "Configuration for the AnswerAI part of the query. This will only be considered if 'enableAI' is set to 'true'", @@ -2015,7 +2049,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -2116,12 +2153,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -2212,6 +2281,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -2220,9 +2290,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -2823,7 +2895,7 @@ "type": "object" }, "range": { - "description": "Default query settings applicable to 'range' type of queries. You can find all the properties at [here](https://docs.appbase.io/docs/search/reactivesearch-api/reference).", + "description": "Default query settings applicable to 'range' type of queries. You can find all the properties at [here](https://docs.reactivesearch.io/docs/search/reactivesearch-api/reference).", "properties": { "AIConfig": { "description": "Configuration for the AnswerAI part of the query. This will only be considered if 'enableAI' is set to 'true'", @@ -2966,7 +3038,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -3067,12 +3142,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -3163,6 +3270,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -3171,9 +3279,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -3774,7 +3884,7 @@ "type": "object" }, "search": { - "description": "Default query settings applicable to 'search' type of queries. You can find all the properties at [here](https://docs.appbase.io/docs/search/reactivesearch-api/reference).", + "description": "Default query settings applicable to 'search' type of queries. You can find all the properties at [here](https://docs.reactivesearch.io/docs/search/reactivesearch-api/reference).", "properties": { "AIConfig": { "description": "Configuration for the AnswerAI part of the query. This will only be considered if 'enableAI' is set to 'true'", @@ -3917,7 +4027,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -4018,12 +4131,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -4114,6 +4259,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -4122,9 +4268,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -4725,7 +4873,7 @@ "type": "object" }, "suggestion": { - "description": "Default query settings applicable to 'suggestion' type of queries. You can find all the properties at [here](https://docs.appbase.io/docs/search/reactivesearch-api/reference).", + "description": "Default query settings applicable to 'suggestion' type of queries. You can find all the properties at [here](https://docs.reactivesearch.io/docs/search/reactivesearch-api/reference).", "properties": { "AIConfig": { "description": "Configuration for the AnswerAI part of the query. This will only be considered if 'enableAI' is set to 'true'", @@ -4868,7 +5016,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -4969,12 +5120,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -5065,6 +5248,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -5073,9 +5257,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -5676,7 +5862,7 @@ "type": "object" }, "term": { - "description": "Default query settings applicable to 'term' type of queries. You can find all the properties at [here](https://docs.appbase.io/docs/search/reactivesearch-api/reference).", + "description": "Default query settings applicable to 'term' type of queries. You can find all the properties at [here](https://docs.reactivesearch.io/docs/search/reactivesearch-api/reference).", "properties": { "AIConfig": { "description": "Configuration for the AnswerAI part of the query. This will only be considered if 'enableAI' is set to 'true'", @@ -5819,7 +6005,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -5920,12 +6109,44 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -6016,6 +6237,7 @@ "properties": { "body": true, "headers": { + "description": "Headers can be essential to alter the response received from hitting a particular URL. Headers can be passed during validating by using the `headers` field.\n\nFor eg, a `Content-Type` header can be passed in the following way:\n\n```yml\nglobal_envs:\n - label: ES URL\n key: ES_URL\n value: http://localhost:9200\n validate:\n headers:\n \"Content-Type\": \"application/json\"\n```", "patternProperties": { ".*": { "type": "string" @@ -6024,9 +6246,11 @@ "type": "object" }, "method": { + "description": "It might be important to specify the method field in order to get the `expected_status`. This can be done by passing the method as a string. By default the value is set to `GET`.\n\nSome of the other valid options are:\n\n- `POST`\n- `PUT`\n- `PATCH`", "type": "string" }, "url": { + "description": "The `url` field is used to specify the URL that is supposed to be hit during validating the global environment before adding it.", "type": "string" } }, @@ -6785,10 +7009,10 @@ "type": "array" }, "trigger": { - "description": "Trigger expression is to define the condition of Pipeline invocation. For example, only execute pipeline if query is \\'mobile phone\\'. Check the documentation at [here](https://docs.appbase.io/docs/search/rules/#configure-if-condition).\n\nFollowing is an example trigger for a pipeline that searches for mobile phones:\n\n```yml\ntrigger:\n type: always\n expression: $query exactlyMatches \"iphone x\"\n```\n\nAbove trigger will **always** run and execute the expression provided to it.", + "description": "Trigger expression is to define the condition of Pipeline invocation. For example, only execute pipeline if query is \\'mobile phone\\'. Check the documentation at [here](https://docs.reactivesearch.io/docs/search/rules/#configure-if-condition).\n\nFollowing is an example trigger for a pipeline that searches for mobile phones:\n\n```yml\ntrigger:\n type: always\n expression: $query exactlyMatches \"iphone x\"\n```\n\nAbove trigger will **always** run and execute the expression provided to it.", "properties": { "expression": { - "description": "Custom trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#advanced-editor).", + "description": "Custom trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#advanced-editor).", "title": "Trigger Expression", "type": "string" }, @@ -6806,7 +7030,7 @@ "type": "object" }, "type": { - "description": "Type of trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#configure-if-condition).", + "description": "Type of trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#configure-if-condition).", "enum": [ "always", "filter", diff --git a/schema/latest/schema.json b/schema/latest/schema.json index 6afaa8a0..1ab0ab10 100644 --- a/schema/latest/schema.json +++ b/schema/latest/schema.json @@ -91,7 +91,9 @@ "range", "enableAI", "AIConfig", - "compoundClause" + "compoundClause", + "enableDocumentSuggestions", + "documentSuggestionsConfig" ], "properties": { "AIConfig": { @@ -278,7 +280,10 @@ }, "compoundClause": { "description": "Configure whether the DSL query is generated with the compound clause of 'must' (default for 'search' and 'geo') or 'filter' (default for 'range' and 'term'). Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn't relevant (e.g. term", - "engine": "opensearch", + "engine": [ + "opensearch", + "elasticsearch" + ], "title": "Compound Clause", "type": "integer" }, @@ -414,6 +419,30 @@ "title": "distinctFieldConfig", "type": "object" }, + "documentSuggestionsConfig": { + "additionalProperties": false, + "description": "additional options to specify for document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "properties": { + "from": { + "type": "integer" + }, + "maxChars": { + "type": "integer" + }, + "sectionLabel": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "title": "documentSuggestionsConfig", + "type": "object" + }, "enableAI": { "description": "Whether or not to enable Answer AI to inject AI based answer in the response", "engine": "opensearch", @@ -421,6 +450,15 @@ "title": "enableAI", "type": "boolean" }, + "enableDocumentSuggestions": { + "description": "whether or not to enable document suggestions", + "engine": [ + "elasticsearch", + "opensearch" + ], + "title": "enableDocumentSuggestions", + "type": "boolean" + }, "enableEndpointSuggestions": { "description": "whether or not to enable endpoint suggestions", "engine": [ @@ -628,7 +666,7 @@ "items": { "type": "number" }, - "markdownDescription": "To set the search weight for the database fields, useful when you are using more than one [dataField](/docs/search/reactivesearch-api/reference/#datafield). This prop accepts an array of `floats`. A higher number implies a higher relevance weight for the corresponding field in the search results.\n\nFor example, the below query has two data fields defined and each field has a different field weight.\n\n```js\n{\n query: [{\n id: \"book-search\",\n dataField: [\"original_title\", \"description\"],\n fieldWeights: [3, 1],\n value: \"harry\"\n }]\n}\n```\n\n| \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eType\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eApplicable on query of type\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eRequired\u003c/p\u003e |\n| ------------ | --------------------------- | -------- |\n| `Array\u003cint\u003e` | `search`,`suggestion` | false |\n\n\u003e Note: The `fieldWeights` property has been marked as deprecated in \u003cb\u003ev7.47.0\u003c/b\u003e and would be removed in the next major version of appbase.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.", + "markdownDescription": "To set the search weight for the database fields, useful when you are using more than one [dataField](/docs/search/reactivesearch-api/reference/#datafield). This prop accepts an array of `floats`. A higher number implies a higher relevance weight for the corresponding field in the search results.\n\nFor example, the below query has two data fields defined and each field has a different field weight.\n\n```js\n{\n query: [{\n id: \"book-search\",\n dataField: [\"original_title\", \"description\"],\n fieldWeights: [3, 1],\n value: \"harry\"\n }]\n}\n```\n\n| \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eType\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eApplicable on query of type\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eRequired\u003c/p\u003e |\n| ------------ | --------------------------- | -------- |\n| `Array\u003cint\u003e` | `search`,`suggestion` | false |\n\n\u003e Note: The `fieldWeights` property has been marked as deprecated in \u003cb\u003ev7.47.0\u003c/b\u003e and would be removed in the next major version of reactivesearch.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.", "title": "fieldWeights", "type": "array" }, @@ -657,7 +695,7 @@ "mongodb", "opensearch" ], - "markdownDescription": "Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account. For example, with a substitution of one character, `fox` can become `box`. Read more about it in the elastic search https://www.elastic.co/guide/en/elasticsearch/guide/current/fuzziness.html.\n\n| \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eType\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eApplicable on query of type\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eRequired\u003c/p\u003e |\n| -------------- | --------------------------- | -------- |\n| `int | string` | `search`, `suggestion` | false |\n\n\u003e Note:\n\u003e\n\u003e This property doesn\\'t work when the value of [queryFormat](/docs/search/reactivesearch-api/reference/#queryformat) property is set to `and`.\"", + "markdownDescription": "Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account. For example, with a substitution of one character, `fox` can become `box`. Read more about it in the elastic search https://www.elastic.co/guide/en/elasticsearch/guide/current/fuzziness.html.\n\n| \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eType\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eApplicable on query of type\u003c/p\u003e | \u003cp style=\"margin: 0px;\" class=\"table-header-text\"\u003eRequired\u003c/p\u003e |\n| -------------- | --------------------------- | -------- |\n| `int, string` | `search`, `suggestion` | false |\n\n\u003e Note:\n\u003e\n\u003e This property doesn\\'t work when the value of [queryFormat](/docs/search/reactivesearch-api/reference/#queryformat) property is set to `and`.\"", "playgroundURL": { "elasticsearch": "https://play.reactivesearch.io/embed/FfBZDt4981lxD2At3KuK", "mongodb": "https://play.reactivesearch.io/embed/CGaSSGlTPUOPmL4wv6Xb", @@ -1364,7 +1402,7 @@ "elasticsearch", "opensearch" ], - "markdownDescription": "`Object` It allows you to set the custom events which can be used to build your own analytics on top of the Appbase.io analytics. Further, these events can be used to filter the analytics stats from the Appbase.io dashboard. In the below example, we\\'re setting up two custom events that will be recorded with each search request.\n\n```js\n{\n query: [...],\n settings: {\n customEvents: {\n platform: \"android\",\n user_segment: \"paid\"\n }\n }\n}\n```", + "markdownDescription": "`Object` It allows you to set the custom events which can be used to build your own analytics on top of the ReactiveSearch.io analytics. Further, these events can be used to filter the analytics stats from the ReactiveSearch.io dashboard. In the below example, we\\'re setting up two custom events that will be recorded with each search request.\n\n```js\n{\n query: [...],\n settings: {\n customEvents: {\n platform: \"android\",\n user_segment: \"paid\"\n }\n }\n}\n```", "title": "customEvents", "type": "object" }, @@ -1403,7 +1441,7 @@ "solr", "opensearch" ], - "markdownDescription": "`bool` defaults to `false`. If `true` then it'll enable the recording of Appbase.io analytics.", + "markdownDescription": "`bool` defaults to `false`. If `true` then it'll enable the recording of ReactiveSearch.io analytics.", "title": "recordAnalytics", "type": "boolean" }, @@ -1429,7 +1467,7 @@ "elasticsearch", "opensearch" ], - "markdownDescription": "`String` It allows you to define the user id which will be used to record the Appbase.io analytics.", + "markdownDescription": "`String` It allows you to define the user id which will be used to record the ReactiveSearch.io analytics.", "title": "userId", "type": "string" }