@coveo/quantic 3.36.1 → 3.36.2

package/docs/out/quantic-docs.json

@@ -412,7 +412,7 @@
                         "name": "queryCorrectionMode",
                         "attribute": "query-correction-mode",
                         "access": "@api",
-                        "description": "<p>Defines which query correction system to use.\n<code>legacy</code>: Query correction is powered by the legacy index system. This system relies on an algorithm using solely the index content to compute the suggested terms.\n<code>next</code>: Query correction is powered by a machine learning system, requiring a valid query suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.\nThe <code>legacy</code> system will send two requests to the API to get the suggestions, while the <code>next</code> system will send one request.</p>",
+                        "description": "<p>Defines which query correction system to use.\n<code>legacy</code>: Query correction is powered by the legacy index system. This system relies on an algorithm using solely the index content to compute the suggested terms.\n<code>next</code>: Query correction is powered by a machine learning system, requiring a valid Query Suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.\nThe <code>legacy</code> system will send two requests to the API to get the suggestions, while the <code>next</code> system will send one request.</p>",
                         "required": false,
                         "defaultValue": "'legacy'",
                         "type": "string"
@@ -972,7 +972,7 @@
             {
                 "name": "QuanticGeneratedAnswer",
                 "attribute": "quantic-generated-answer",
-                "description": "<p>The <code>QuanticGeneratedAnswer</code> component automatically generates an answer using Coveo machine learning models to answer the query executed by the user.\nThis component includes a slot, &quot;no-answer-message&quot;, which allows for rendering a custom message when no answer is generated.</p>",
+                "description": "<p>The <code>QuanticGeneratedAnswer</code> component automatically generates an answer using Coveo Machine Learning models to answer the query executed by the user.\nThis component includes a slot, &quot;no-answer-message&quot;, which allows for rendering a custom message when no answer is generated.</p>",
                 "categories": [
                     "Search"
                 ],
@@ -1583,7 +1583,7 @@
                         "name": "disableDynamicNavigation",
                         "attribute": "disable-dynamic-navigation",
                         "access": "@api",
-                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the dynamic navigation experience</a>.</p>",
+                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the Dynamic Navigation Experience</a>.</p>",
                         "required": false,
                         "defaultValue": "`false`",
                         "type": "boolean"
@@ -1648,7 +1648,7 @@
                         "name": "disableDynamicNavigation",
                         "attribute": "disable-dynamic-navigation",
                         "access": "@api",
-                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the dynamic navigation experience</a>.</p>",
+                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the Dynamic Navigation Experience</a>.</p>",
                         "required": false,
                         "defaultValue": "`false`",
                         "type": "boolean"
@@ -2071,7 +2071,7 @@
             {
                 "name": "QuanticSearchInterface",
                 "attribute": "quantic-search-interface",
-                "description": "<p>The <code>QuanticSearchInterface</code> component handles the headless search engine and localization configurations.\nA single instance should be used for each instance of the Coveo Headless search engine.</p>\n<p>The <code>timezone</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=admin_supported_timezone.htm&amp;type=5&amp;language=en_US\">Time Zone settings</a> of the Salesforce org.\nIt is used to correctly interpret dates in the query expression, facets, and result items.</p>\n<p>The <code>locale</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=sf.setting_your_language.htm&amp;type=5\">Language Settings</a>.\nCoveo Machine Learning models use this information to provide contextually relevant output.\nMoreover, this information can be referred to in query expressions and QPL statements by using the <code>$locale</code> object.</p>",
+                "description": "<p>The <code>QuanticSearchInterface</code> component handles the headless search engine and localization configurations.\nA single instance should be used for each instance of the Coveo Headless search engine.</p>\n<p>The <code>timezone</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=admin_supported_timezone.htm&amp;type=5&amp;language=en_US\">Time Zone settings</a> of the Salesforce org.\nIt is used to correctly interpret dates in the query expression, facets, and result items.</p>\n<p>The <code>locale</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=sf.admin_supported_locales.htm&amp;type=5\">Supported Locales</a>.\nCoveo Machine Learning models use this information to provide contextually relevant output.\nMoreover, this information can be referred to in query expressions and QPL statements by using the <code>$locale</code> object.</p>",
                 "categories": [
                     "Search"
                 ],
@@ -2246,7 +2246,7 @@
             {
                 "name": "QuanticSmartSnippetSuggestions",
                 "attribute": "quantic-smart-snippet-suggestions",
-                "description": "<p>The <code>QuanticSmartSnippetSuggestions</code> component displays additional queries for which a Coveo Smart Snippets model can provide relevant excerpts.</p>",
+                "description": "<p>The <code>QuanticSmartSnippetSuggestions</code> component displays additional queries for which a Coveo Smart Snippet model can provide relevant excerpts.</p>",
                 "categories": [
                     "Search"
                 ],
@@ -3092,7 +3092,7 @@
             {
                 "name": "QuanticResultLink",
                 "attribute": "quantic-result-link",
-                "description": "<p>The <code>QuanticResultLink</code> component creates a clickable link from a result that points to the original item.\nIf the result is a Salesforce record or a Salesforce Knowledge article it will open the link in a new salesforce console subtab.\nOtherwise, it will open the link in the browser tab.</p>",
+                "description": "<p>The <code>QuanticResultLink</code> component creates a clickable link from a result that points to the original item.\nIf the result is a Salesforce record or a Salesforce Knowledge article it will open the link in a new Salesforce console subtab.\nOtherwise, it will open the link in the browser tab.</p>",
                 "categories": [
                     "Result Template"
                 ],
@@ -4022,7 +4022,7 @@
                 ]
             },
             {
-                "name": "quanticPlaceholder",
+                "name": "QuanticPlaceholder",
                 "attribute": "quantic-placeholder",
                 "description": "<p>The <code>QuanticPlaceholder</code> component is used internally to display a loading placeholder for certain components.</p>",
                 "categories": [
@@ -4408,7 +4408,7 @@
                         "name": "queryCorrectionMode",
                         "attribute": "query-correction-mode",
                         "access": "@api",
-                        "description": "<p>Defines which query correction system to use.\n<code>legacy</code>: Query correction is powered by the legacy index system. This system relies on an algorithm using solely the index content to compute the suggested terms.\n<code>next</code>: Query correction is powered by a machine learning system, requiring a valid query suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.\nThe <code>legacy</code> system will send two requests to the API to get the suggestions, while the <code>next</code> system will send one request.</p>",
+                        "description": "<p>Defines which query correction system to use.\n<code>legacy</code>: Query correction is powered by the legacy index system. This system relies on an algorithm using solely the index content to compute the suggested terms.\n<code>next</code>: Query correction is powered by a machine learning system, requiring a valid Query Suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.\nThe <code>legacy</code> system will send two requests to the API to get the suggestions, while the <code>next</code> system will send one request.</p>",
                         "required": false,
                         "defaultValue": "'legacy'",
                         "type": "string"
@@ -5315,7 +5315,7 @@
                         "name": "disableDynamicNavigation",
                         "attribute": "disable-dynamic-navigation",
                         "access": "@api",
-                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the dynamic navigation experience</a>.</p>",
+                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the Dynamic Navigation Experience</a>.</p>",
                         "required": false,
                         "defaultValue": "`false`",
                         "type": "boolean"
@@ -5380,7 +5380,7 @@
                         "name": "disableDynamicNavigation",
                         "attribute": "disable-dynamic-navigation",
                         "access": "@api",
-                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the dynamic navigation experience</a>.</p>",
+                        "description": "<p>Indicates whether to disable the dynamic navigation feature according to <a href=\"https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne\">the Dynamic Navigation Experience</a>.</p>",
                         "required": false,
                         "defaultValue": "`false`",
                         "type": "boolean"
@@ -6299,7 +6299,7 @@
             {
                 "name": "QuanticRecommendationInterface",
                 "attribute": "quantic-recommendation-interface",
-                "description": "<p>The <code>QuanticRecommendationInterface</code> component initializes the headless recommendation engine and handles localization configurations.\nA single instance should be used for each instance of the Coveo Headless recommendation engine.</p>\n<p>The <code>timezone</code> used in the recommendation engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=admin_supported_timezone.htm&amp;type=5&amp;language=en_US\">Time Zone settings</a> of the Salesforce org.\nIt is used to correctly interpret dates in the query expression, facets, and result items.</p>\n<p>The <code>locale</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=sf.setting_your_language.htm&amp;type=5\">Language Settings</a>.\nCoveo Machine Learning models use this information to provide contextually relevant output.\nMoreover, this information can be referred to in query expressions and QPL statements by using the <code>$locale</code> object.</p>",
+                "description": "<p>The <code>QuanticRecommendationInterface</code> component initializes the headless recommendation engine and handles localization configurations.\nA single instance should be used for each instance of the Coveo Headless recommendation engine.</p>\n<p>The <code>timezone</code> used in the recommendation engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=admin_supported_timezone.htm&amp;type=5&amp;language=en_US\">Time Zone settings</a> of the Salesforce org.\nIt is used to correctly interpret dates in the query expression, facets, and result items.</p>\n<p>The <code>locale</code> used in the search engine options is taken from the <a href=\"https://help.salesforce.com/s/articleView?id=sf.admin_supported_locales.htm&amp;type=5\">Supported Locales</a>.\nCoveo Machine Learning models use this information to provide contextually relevant output.\nMoreover, this information can be referred to in query expressions and QPL statements by using the <code>$locale</code> object.</p>",
                 "categories": [
                     "Recommendation"
                 ],

package/force-app/main/default/lwc/quanticDidYouMean/quanticDidYouMean.js

@@ -50,7 +50,7 @@ export default class QuanticDidYouMean extends LightningElement {
   /**
    * Defines which query correction system to use.
    * `legacy`: Query correction is powered by the legacy index system. This system relies on an algorithm using solely the index content to compute the suggested terms.
-   * `next`: Query correction is powered by a machine learning system, requiring a valid query suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.
+   * `next`: Query correction is powered by a machine learning system, requiring a valid Query Suggestion model configured in your Coveo environment to function properly. This system relies on machine learning algorithms to compute the suggested terms.
    * The `legacy` system will send two requests to the API to get the suggestions, while the `next` system will send one request.
    * @api
    * @type {string}

package/force-app/main/default/lwc/quanticGeneratedAnswer/quanticGeneratedAnswer.js

@@ -56,7 +56,7 @@ const GENERATED_ANSWER_DATA_KEY = 'coveo-generated-answer-data';
 const DEFAULT_CITATION_FIELDS = ['sfid', 'sfkbid', 'sfkavid', 'filetype'];
 
 /**
- * The `QuanticGeneratedAnswer` component automatically generates an answer using Coveo machine learning models to answer the query executed by the user.
+ * The `QuanticGeneratedAnswer` component automatically generates an answer using Coveo Machine Learning models to answer the query executed by the user.
  * This component includes a slot, "no-answer-message", which allows for rendering a custom message when no answer is generated.
  * @category Search
  * @slot no-answer-message - Slot that allows the rendering of a custom message when no answer is generated.

package/force-app/main/default/lwc/quanticPlaceholder/quanticPlaceholder.js

@@ -6,7 +6,7 @@ import {LightningElement, api} from 'lwc';
  * @example
  * <c-quantic-placeholder variant="card"></c-quantic-placeholder>
  */
-export default class quanticPlaceholder extends LightningElement {
+export default class QuanticPlaceholder extends LightningElement {
   /**
    * The type of placeholder to display.
    * @api

package/force-app/main/default/lwc/quanticRecommendationInterface/quanticRecommendationInterface.js

@@ -23,7 +23,7 @@ import {LightningElement, api} from 'lwc';
  * It is used to correctly interpret dates in the query expression, facets, and result items.
  *
  *
- * The `locale` used in the search engine options is taken from the [Language Settings](https://help.salesforce.com/s/articleView?id=sf.setting_your_language.htm&type=5).
+ * The `locale` used in the search engine options is taken from the [Supported Locales](https://help.salesforce.com/s/articleView?id=sf.admin_supported_locales.htm&type=5).
  * Coveo Machine Learning models use this information to provide contextually relevant output.
  * Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.
  * @category Recommendation

package/force-app/main/default/lwc/quanticRefineModalContent/quanticRefineModalContent.js

@@ -66,7 +66,7 @@ export default class QuanticRefineModalContent extends LightningElement {
    */
   @api hideSort;
   /**
-   * Indicates whether to disable the dynamic navigation feature according to [the dynamic navigation experience](https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne).
+   * Indicates whether to disable the dynamic navigation feature according to [the Dynamic Navigation Experience](https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne).
    * @api
    * @type {boolean}
    * @defaultValue `false`

package/force-app/main/default/lwc/quanticRefineToggle/quanticRefineToggle.js

@@ -76,7 +76,7 @@ export default class QuanticRefineToggle extends LightningElement {
    */
   @api title = this.labels.sortAndFilters;
   /**
-   * Indicates whether to disable the dynamic navigation feature according to [the dynamic navigation experience](https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne).
+   * Indicates whether to disable the dynamic navigation feature according to [the Dynamic Navigation Experience](https://docs.coveo.com/en/3383/leverage-machine-learning/about-dynamic-navigation-experience-dne).
    * @api
    * @type {boolean}
    * @defaultValue `false`

package/force-app/main/default/lwc/quanticResultLink/quanticResultLink.js

@@ -18,7 +18,7 @@ const documentTypesRequiringParentRecord = ['CaseComment'];
 
 /**
  * The `QuanticResultLink` component creates a clickable link from a result that points to the original item.
- * If the result is a Salesforce record or a Salesforce Knowledge article it will open the link in a new salesforce console subtab.
+ * If the result is a Salesforce record or a Salesforce Knowledge article it will open the link in a new Salesforce console subtab.
  * Otherwise, it will open the link in the browser tab.
  * @category Result Template
  * @example

package/force-app/main/default/lwc/quanticSearchInterface/quanticSearchInterface.js

@@ -24,7 +24,7 @@ import {LightningElement, api} from 'lwc';
  * It is used to correctly interpret dates in the query expression, facets, and result items.
  *
  *
- * The `locale` used in the search engine options is taken from the [Language Settings](https://help.salesforce.com/s/articleView?id=sf.setting_your_language.htm&type=5).
+ * The `locale` used in the search engine options is taken from the [Supported Locales](https://help.salesforce.com/s/articleView?id=sf.admin_supported_locales.htm&type=5).
  * Coveo Machine Learning models use this information to provide contextually relevant output.
  * Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.
  * @category Search

package/force-app/main/default/lwc/quanticSmartSnippetSuggestions/quanticSmartSnippetSuggestions.js

@@ -18,7 +18,7 @@ import {LightningElement, api} from 'lwc';
  */
 
 /**
- * The `QuanticSmartSnippetSuggestions` component displays additional queries for which a Coveo Smart Snippets model can provide relevant excerpts.
+ * The `QuanticSmartSnippetSuggestions` component displays additional queries for which a Coveo Smart Snippet model can provide relevant excerpts.
  * @category Search
  * @example
  *  <c-quantic-smart-snippet-suggestions engine-id={engineId}></c-quantic-smart-snippet-suggestions>