@coveo/platform-client 54.4.0 → 54.5.0

package/dist/cjs/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js

@@ -7,16 +7,30 @@ class CaseClassificationConfiguration extends Resource_js_1.default {
     static baseUrl = `/rest/organizations/${APICore_js_1.default.orgPlaceholder}/machinelearning/configuration/caseclassif`;
     static modelUrl = `${CaseClassificationConfiguration.baseUrl}/model`;
     static fieldsUrl = `${CaseClassificationConfiguration.baseUrl}/fields`;
+    static fieldDocumentCountUrl = `${CaseClassificationConfiguration.baseUrl}/fields/{fieldName}/documentCount`;
+    static fieldValueCountUrl = `${CaseClassificationConfiguration.baseUrl}/fields/{fieldName}/valueCount`;
     static previewUrl = `${CaseClassificationConfiguration.baseUrl}/preview`;
+    /**
+     * @deprecated create(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use MachineLearning `register(registration: RegistrationModel)` instead.
+     */
     create(configModel) {
         return this.api.post(CaseClassificationConfiguration.modelUrl, configModel);
     }
+    /**
+     * @deprecated delete(modelId: string) is kept for backward compatibility. You should now use Models `delete(modelId: string)` instead.
+     */
     delete(modelId) {
         return this.api.delete(`${CaseClassificationConfiguration.modelUrl}/${modelId}`);
     }
+    /**
+     * @deprecated get(modelId: string) is kept for backward compatibility. You should now use Models `get(modelId: string)` instead.
+     */
     get(modelId) {
         return this.api.get(`${CaseClassificationConfiguration.modelUrl}/${modelId}`);
     }
+    /**
+     * @deprecated update(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use Models `update(modelId: string, update: RegistrationModel)` instead.
+     */
     update(configModel) {
         return this.api.put(`${CaseClassificationConfiguration.modelUrl}/${configModel.modelId}`, configModel);
     }
@@ -26,6 +40,12 @@ class CaseClassificationConfiguration extends Resource_js_1.default {
     preview(params) {
         return this.api.post(CaseClassificationConfiguration.previewUrl, params);
     }
+    documentCount(params) {
+        return this.api.post(CaseClassificationConfiguration.fieldDocumentCountUrl, params);
+    }
+    valueCount(params) {
+        return this.api.post(CaseClassificationConfiguration.fieldValueCountUrl, params);
+    }
 }
 exports.default = CaseClassificationConfiguration;
 //# sourceMappingURL=CaseClassificationConfiguration.js.map

package/dist/cjs/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaseClassificationConfiguration.js","sourceRoot":"","sources":["../../../../../src/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.ts"],"names":[],"mappings":";;;AAAA,6EAAsC;AAEtC,4EAAyC;AASzC,MAAqB,+BAAgC,SAAQ,qBAAQ;IACjE,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,4CAA4C,CAAC;IACvG,MAAM,CAAC,QAAQ,GAAG,GAAG,+BAA+B,CAAC,OAAO,QAAQ,CAAC;IACrE,MAAM,CAAC,SAAS,GAAG,GAAG,+BAA+B,CAAC,OAAO,SAAS,CAAC;IACvE,MAAM,CAAC,UAAU,GAAG,GAAG,+BAA+B,CAAC,OAAO,UAAU,CAAC;IAEzE,MAAM,CAAC,WAAiE;QACpE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,QAAQ,EACxC,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,GAAG,CAAC,OAAe;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAC3D,CAAC;IACN,CAAC;IAED,MAAM,CAAC,WAAiD;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE,EACpE,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,MAA6C;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkC,+BAA+B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,CAAC,MAAoD;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,UAAU,EAC1C,MAAM,CACT,CAAC;IACN,CAAC;;AAvCL,kDAwCC"}
+{"version":3,"file":"CaseClassificationConfiguration.js","sourceRoot":"","sources":["../../../../../src/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.ts"],"names":[],"mappings":";;;AAAA,6EAAsC;AAEtC,4EAAyC;AAYzC,MAAqB,+BAAgC,SAAQ,qBAAQ;IACjE,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,4CAA4C,CAAC;IACvG,MAAM,CAAC,QAAQ,GAAG,GAAG,+BAA+B,CAAC,OAAO,QAAQ,CAAC;IACrE,MAAM,CAAC,SAAS,GAAG,GAAG,+BAA+B,CAAC,OAAO,SAAS,CAAC;IACvE,MAAM,CAAC,qBAAqB,GAAG,GAAG,+BAA+B,CAAC,OAAO,mCAAmC,CAAC;IAC7G,MAAM,CAAC,kBAAkB,GAAG,GAAG,+BAA+B,CAAC,OAAO,gCAAgC,CAAC;IAEvG,MAAM,CAAC,UAAU,GAAG,GAAG,+BAA+B,CAAC,OAAO,UAAU,CAAC;IAEzE;;OAEG;IACH,MAAM,CAAC,WAAiE;QACpE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,QAAQ,EACxC,WAAW,CACd,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,OAAe;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAC3D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAiD;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE,EACpE,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,MAA6C;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkC,+BAA+B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,CAAC,MAAoD;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,UAAU,EAC1C,MAAM,CACT,CAAC;IACN,CAAC;IAED,aAAa,CAAC,MAA0C;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,+BAA+B,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC5G,CAAC;IAED,UAAU,CAAC,MAA0C;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkB,+BAA+B,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACtG,CAAC;;AA9DL,kDA+DC"}

package/dist/esm/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js

@@ -4,16 +4,30 @@ export default class CaseClassificationConfiguration extends Resource {
     static baseUrl = `/rest/organizations/${API.orgPlaceholder}/machinelearning/configuration/caseclassif`;
     static modelUrl = `${CaseClassificationConfiguration.baseUrl}/model`;
     static fieldsUrl = `${CaseClassificationConfiguration.baseUrl}/fields`;
+    static fieldDocumentCountUrl = `${CaseClassificationConfiguration.baseUrl}/fields/{fieldName}/documentCount`;
+    static fieldValueCountUrl = `${CaseClassificationConfiguration.baseUrl}/fields/{fieldName}/valueCount`;
     static previewUrl = `${CaseClassificationConfiguration.baseUrl}/preview`;
+    /**
+     * @deprecated create(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use MachineLearning `register(registration: RegistrationModel)` instead.
+     */
     create(configModel) {
         return this.api.post(CaseClassificationConfiguration.modelUrl, configModel);
     }
+    /**
+     * @deprecated delete(modelId: string) is kept for backward compatibility. You should now use Models `delete(modelId: string)` instead.
+     */
     delete(modelId) {
         return this.api.delete(`${CaseClassificationConfiguration.modelUrl}/${modelId}`);
     }
+    /**
+     * @deprecated get(modelId: string) is kept for backward compatibility. You should now use Models `get(modelId: string)` instead.
+     */
     get(modelId) {
         return this.api.get(`${CaseClassificationConfiguration.modelUrl}/${modelId}`);
     }
+    /**
+     * @deprecated update(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use Models `update(modelId: string, update: RegistrationModel)` instead.
+     */
     update(configModel) {
         return this.api.put(`${CaseClassificationConfiguration.modelUrl}/${configModel.modelId}`, configModel);
     }
@@ -23,5 +37,11 @@ export default class CaseClassificationConfiguration extends Resource {
     preview(params) {
         return this.api.post(CaseClassificationConfiguration.previewUrl, params);
     }
+    documentCount(params) {
+        return this.api.post(CaseClassificationConfiguration.fieldDocumentCountUrl, params);
+    }
+    valueCount(params) {
+        return this.api.post(CaseClassificationConfiguration.fieldValueCountUrl, params);
+    }
 }
 //# sourceMappingURL=CaseClassificationConfiguration.js.map

package/dist/esm/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaseClassificationConfiguration.js","sourceRoot":"","sources":["../../../../../src/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAEtC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AASzC,MAAM,CAAC,OAAO,OAAO,+BAAgC,SAAQ,QAAQ;IACjE,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,4CAA4C,CAAC;IACvG,MAAM,CAAC,QAAQ,GAAG,GAAG,+BAA+B,CAAC,OAAO,QAAQ,CAAC;IACrE,MAAM,CAAC,SAAS,GAAG,GAAG,+BAA+B,CAAC,OAAO,SAAS,CAAC;IACvE,MAAM,CAAC,UAAU,GAAG,GAAG,+BAA+B,CAAC,OAAO,UAAU,CAAC;IAEzE,MAAM,CAAC,WAAiE;QACpE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,QAAQ,EACxC,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,GAAG,CAAC,OAAe;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAC3D,CAAC;IACN,CAAC;IAED,MAAM,CAAC,WAAiD;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE,EACpE,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,MAA6C;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkC,+BAA+B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,CAAC,MAAoD;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,UAAU,EAC1C,MAAM,CACT,CAAC;IACN,CAAC"}
+{"version":3,"file":"CaseClassificationConfiguration.js","sourceRoot":"","sources":["../../../../../src/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAEtC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAYzC,MAAM,CAAC,OAAO,OAAO,+BAAgC,SAAQ,QAAQ;IACjE,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,4CAA4C,CAAC;IACvG,MAAM,CAAC,QAAQ,GAAG,GAAG,+BAA+B,CAAC,OAAO,QAAQ,CAAC;IACrE,MAAM,CAAC,SAAS,GAAG,GAAG,+BAA+B,CAAC,OAAO,SAAS,CAAC;IACvE,MAAM,CAAC,qBAAqB,GAAG,GAAG,+BAA+B,CAAC,OAAO,mCAAmC,CAAC;IAC7G,MAAM,CAAC,kBAAkB,GAAG,GAAG,+BAA+B,CAAC,OAAO,gCAAgC,CAAC;IAEvG,MAAM,CAAC,UAAU,GAAG,GAAG,+BAA+B,CAAC,OAAO,UAAU,CAAC;IAEzE;;OAEG;IACH,MAAM,CAAC,WAAiE;QACpE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,QAAQ,EACxC,WAAW,CACd,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,OAAe;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,OAAO,EAAE,CAC3D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAiD;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,+BAA+B,CAAC,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE,EACpE,WAAW,CACd,CAAC;IACN,CAAC;IAED,MAAM,CAAC,MAA6C;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkC,+BAA+B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,CAAC,MAAoD;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,+BAA+B,CAAC,UAAU,EAC1C,MAAM,CACT,CAAC;IACN,CAAC;IAED,aAAa,CAAC,MAA0C;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,+BAA+B,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC5G,CAAC;IAED,UAAU,CAAC,MAA0C;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkB,+BAA+B,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACtG,CAAC"}

package/dist/types/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.d.ts

@@ -1,15 +1,31 @@
 import { New } from '../../BaseInterfaces.js';
 import Resource from '../../Resource.js';
-import { CaseClassificationConfigurationModel, CaseClassificationContentFields, CaseClassificationContentFieldsParams, CaseClassificationDocumentGroupPreview, CaseClassificationDocumentGroupPreviewParams } from './CaseClassificationConfigurationInterfaces.js';
+import { CaseClassificationConfigurationModel, CaseClassificationContentFields, CaseClassificationContentFieldsParams, CaseClassificationDocumentGroupPreview, CaseClassificationDocumentGroupPreviewParams, CaseClassificationFieldCountParams, FieldDocumentCount, FieldValueCount } from './CaseClassificationConfigurationInterfaces.js';
 export default class CaseClassificationConfiguration extends Resource {
     static baseUrl: string;
     static modelUrl: string;
     static fieldsUrl: string;
+    static fieldDocumentCountUrl: string;
+    static fieldValueCountUrl: string;
     static previewUrl: string;
+    /**
+     * @deprecated create(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use MachineLearning `register(registration: RegistrationModel)` instead.
+     */
     create(configModel: New<CaseClassificationConfigurationModel, 'modelId'>): Promise<CaseClassificationConfigurationModel>;
+    /**
+     * @deprecated delete(modelId: string) is kept for backward compatibility. You should now use Models `delete(modelId: string)` instead.
+     */
     delete(modelId: string): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated get(modelId: string) is kept for backward compatibility. You should now use Models `get(modelId: string)` instead.
+     */
     get(modelId: string): Promise<CaseClassificationConfigurationModel>;
+    /**
+     * @deprecated update(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use Models `update(modelId: string, update: RegistrationModel)` instead.
+     */
     update(configModel: CaseClassificationConfigurationModel): Promise<CaseClassificationConfigurationModel>;
     fields(params: CaseClassificationContentFieldsParams): Promise<CaseClassificationContentFields>;
     preview(params: CaseClassificationDocumentGroupPreviewParams): Promise<CaseClassificationDocumentGroupPreview>;
+    documentCount(params: CaseClassificationFieldCountParams): Promise<FieldDocumentCount>;
+    valueCount(params: CaseClassificationFieldCountParams): Promise<FieldValueCount>;
 }

package/dist/types/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfigurationInterfaces.d.ts

@@ -42,7 +42,7 @@ export interface CaseClassificationConfigurationModel {
      */
     modelDisplayName: string;
     /**
-     * The names of the sources containing the cases to use for model building.
+     * The names of the sources that contain the cases that the model will use.
      */
     sources: string[];
     /**
@@ -55,8 +55,7 @@ export interface CaseClassificationConfigurationModel {
      */
     caseIdField: string;
     /**
-     * The time period for which to extract cases for model building.
-     * Must contain an export period or a start time and end time.
+     * The case creation date range for the cases the model will use.
      */
     caseExtractionPeriod?: ExtractionPeriod;
     /**
@@ -70,7 +69,7 @@ export interface CaseClassificationConfigurationModel {
      */
     fieldsToPredict: string[];
     /**
-     * The field value to use as language.
+     * The name of the field that contains the value to use as the language.
      */
     languageField?: string;
 }
@@ -85,11 +84,11 @@ export interface CaseClassificationDocumentGroupPreviewParams {
      */
     caseFilterConditions: FilterConditions[];
     /**
-     * The field value to use as language.
+     * The name of the field that contains the value to use as the language.
      */
     languageField: string;
     /**
-     * The names of the sources containing the cases to use for model building.
+     * The names of the sources that contain the cases that the model will use.
      */
     sources: string[];
 }
@@ -121,8 +120,7 @@ export interface CaseClassificationDocumentGroupPreview {
 }
 export interface CaseClassificationContentFieldsParams {
     /**
-     * The time period for which to extract cases for model building.
-     * Must contain an export period or a start time and end time.
+     * The case creation date range for the cases the model will use.
      */
     caseExtractionPeriod: ExtractionPeriod;
     /**
@@ -134,7 +132,7 @@ export interface CaseClassificationContentFieldsParams {
      */
     languageField: string;
     /**
-     * The names of the sources containing the cases to use for model building.
+     * The names of the sources that contain the cases that the model will use.
      */
     sources: string[];
 }
@@ -145,3 +143,65 @@ export interface CaseClassificationContentFields {
     fields: CaseClassificationContentField[];
     query: string;
 }
+interface CaseClassificationFieldCountAdvancedMode {
+    /**
+     * The query to use when building the model.
+     */
+    advancedQuery: string;
+    /**
+     * The names of the sources that contain the cases that the model will use.
+     */
+    sources?: never;
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions?: never;
+    /**
+     * The name of the field that contains the value to use as the language.
+     */
+    languageField?: never;
+    /**
+     * The case creation date range for the cases the model will use.
+     */
+    caseExtractionPeriod?: never;
+}
+interface CaseClassificationFieldCountStandardMode {
+    /**
+     * The names of the sources that contain the cases that the model will use.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions?: FilterConditions[];
+    /**
+     * The name of the field that contains the value to use as the language.
+     */
+    languageField: string;
+    /**
+     * The case creation date range for the cases the model will use.
+     */
+    caseExtractionPeriod: ExtractionPeriod;
+    /**
+     * The query to use when building the model.
+     */
+    advancedQuery?: never;
+}
+export type CaseClassificationFieldCountParams = CaseClassificationFieldCountAdvancedMode | CaseClassificationFieldCountStandardMode;
+export interface FieldValueCount {
+    /**
+     * The count of values matching a field.
+     */
+    valueCount: number;
+    /**
+     * Indicates the presence of more values than the one returned in the count.
+     */
+    areMoreValuesAvailable: boolean;
+}
+export interface FieldDocumentCount {
+    /**
+     * The count of items matching a field.
+     */
+    documentCount: number;
+}
+export {};

package/package.json

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