@coveo/platform-client 48.5.1 → 49.1.0

package/dist/types/resources/MachineLearning/IAPRConfiguration/IAPRConfigurationInterfaces.d.ts

@@ -8,4 +8,10 @@ export interface IAPRConfigurationModel {
      * The model display name in the Coveo Administration console.
      */
     modelDisplayName: string;
+    /**
+     * The trackingIds that usage analytics events must contain for the model to use those events in its learning process. The model will use an event if it contains at least one of the specified IDs
+     *
+     * @Example: [ "sport" ]
+     */
+    trackingIds: string[];
 }

package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts

@@ -37,4 +37,10 @@ export interface PQSConfigurationModel {
      * The filter to apply to the 'Click' and 'Search' event dimensions of the UA data to learn from when rebuilding the model.
      */
     searchEventFilter?: string;
+    /**
+     * The trackingIds that usage analytics events must contain for the model to use those events in its learning process. The model will use an event if it contains at least one of the specified IDs
+     *
+     * @Example: [ "sport" ]
+     */
+    trackingIds: string[];
 }

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts

@@ -36,7 +36,7 @@ export interface SmartSnippetsConfigurationModel {
      */
     documentTypes?: DocumentType[];
 }
-export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
+export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS' | 'NB_OF_DOCUMENTS_OVER_LIMIT';
 export interface SmartSnippetsDocumentGroupPreviewParams {
     /**
      * The sources to consider.
@@ -54,28 +54,42 @@ export interface SmartSnippetsDocumentGroupPreviewParams {
 export interface SmartSnippetsDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
+     *
+     * @Example @source==("Salesforce Notifier")
      */
     query: string;
     /**
-     * Status indicating whether there are enough candidates for learning.
+     * @Deprecated use `numberOfDocumentsInSources` instead
      */
-    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
+    numberOfDocuments: number;
     /**
-     * The total number of documents in all sources.
+     * The total number of documents in the selected sources.
      */
-    numberOfDocuments: number;
+    numberOfDocumentsInSources: number;
+    /**
+     * The number of documents that are candidates for learning.
+     */
+    numberOfValidDocuments: number;
     /**
-     * The number of documents that match the conditions.
+     * @Deprecated use `numberOfDocumentsInSourcesMatchingFilters` instead
      */
     numberOfDocumentsMatchingConditions: number;
     /**
-     * The number of documents that match the conditions and have a permanent id.
+     * The number of documents in the selected sources that match the conditions.
+     */
+    numberOfDocumentsInSourcesMatchingFilters: number;
+    /**
+     * @Deprecated use `numberOfDocumentsInSourcesMatchingFiltersWithPermanentId` instead
      */
     numberOfDocumentsWithPermanentId: number;
     /**
-     * The number of documents that are candidates for learning.
+     * The number of documents in the selected sources that match the conditions and have a permanentid
      */
-    numberOfValidDocuments: number;
+    numberOfDocumentsInSourcesMatchingFiltersWithPermanentId: number;
+    /**
+     * Status for the number of required documents to build the model.
+     */
+    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
 }
 export interface SmartSnippetsContentFieldsParams {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "48.5.1",
+    "version": "49.1.0",
     "description": "",
     "type": "module",
     "exports": {