@coveo/platform-client 37.3.0 → 37.5.0-alpha.0

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

@@ -1,15 +1,15 @@
-import { New } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { CaseClassificationConfigurationModel, CaseClassificationContentFields, CaseClassificationContentFieldsParams, CaseClassificationDocumentGroupPreview, CaseClassificationDocumentGroupPreviewParams } from './CaseClassificationConfigurationInterfaces';
-export default class CaseClassificationConfiguration extends Resource {
-    static baseUrl: string;
-    static modelUrl: string;
-    static fieldsUrl: string;
-    static previewUrl: string;
-    create(configModel: New<CaseClassificationConfigurationModel, 'modelId'>): Promise<CaseClassificationConfigurationModel>;
-    delete(modelId: string): Promise<Record<string, unknown>>;
-    get(modelId: string): Promise<CaseClassificationConfigurationModel>;
-    update(configModel: CaseClassificationConfigurationModel): Promise<CaseClassificationConfigurationModel>;
-    fields(params: CaseClassificationContentFieldsParams): Promise<CaseClassificationContentFields>;
-    preview(params: CaseClassificationDocumentGroupPreviewParams): Promise<CaseClassificationDocumentGroupPreview>;
-}
+import { New } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { CaseClassificationConfigurationModel, CaseClassificationContentFields, CaseClassificationContentFieldsParams, CaseClassificationDocumentGroupPreview, CaseClassificationDocumentGroupPreviewParams } from './CaseClassificationConfigurationInterfaces';
+export default class CaseClassificationConfiguration extends Resource {
+    static baseUrl: string;
+    static modelUrl: string;
+    static fieldsUrl: string;
+    static previewUrl: string;
+    create(configModel: New<CaseClassificationConfigurationModel, 'modelId'>): Promise<CaseClassificationConfigurationModel>;
+    delete(modelId: string): Promise<Record<string, unknown>>;
+    get(modelId: string): Promise<CaseClassificationConfigurationModel>;
+    update(configModel: CaseClassificationConfigurationModel): Promise<CaseClassificationConfigurationModel>;
+    fields(params: CaseClassificationContentFieldsParams): Promise<CaseClassificationContentFields>;
+    preview(params: CaseClassificationDocumentGroupPreviewParams): Promise<CaseClassificationDocumentGroupPreview>;
+}

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

@@ -1,147 +1,147 @@
-import { FilterConditions } from '../FilterConditions';
-export declare enum Operator {
-    Equals = "EQUALS",
-    NotEquals = "NOT_EQUALS"
-}
-export declare type CaseClassificationDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
-export interface DateField {
-    /**
-     * The field to use as date.
-     */
-    dateField?: string;
-}
-export interface FixedExtractionPeriod {
-    /**
-     * Date in milliseconds that indicates the beginning of the time interval to include cases.
-     * The date format is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
-     */
-    startTime: number;
-    /**
-     * Date in milliseconds that indicates the end of the time interval to include cases.
-     * The date format is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
-     */
-    endTime: number;
-}
-export interface IntervalExtractionPeriod {
-    /**
-     * The period to export data from. The exportPeriod uses the moment when the model was generated as a base.
-     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
-     * Example: P3Y6M4DT12H30M5S Represents a duration of three years, six months, four days, twelve hours, thirty minutes, and five seconds.
-     */
-    exportPeriod: string;
-}
-export declare type ExtractionPeriod = DateField & (FixedExtractionPeriod | IntervalExtractionPeriod);
-export interface CaseClassificationConfigurationModel {
-    /**
-     * The unique ID of the model.
-     */
-    modelId: string;
-    /**
-     * The model name to display.
-     * Example: My First Model
-     */
-    modelDisplayName: string;
-    /**
-     * The names of the sources containing the cases to use for model building.
-     */
-    sources: string[];
-    /**
-     * An array of filtering conditions.
-     */
-    caseFilterConditions?: FilterConditions[];
-    /**
-     * The field containing the case ID
-     * Example: sfid
-     */
-    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.
-     */
-    caseExtractionPeriod?: ExtractionPeriod;
-    /**
-     * The case fields to use for model training.
-     * Example: [subject, reason, category]
-     */
-    fieldsForModelTraining: string[];
-    /**
-     * The case fields the model should predict.
-     * Example: [subject, reason, category]
-     */
-    fieldsToPredict: string[];
-    /**
-     * The field value to use as language.
-     */
-    languageField?: string;
-}
-export interface CaseClassificationDocumentGroupPreviewParams {
-    /**
-     * The time period for which to extract cases for model building.
-     * Must contain an export period or a start time and end time.
-     */
-    caseExtractionPeriod: ExtractionPeriod;
-    /**
-     * An array of filtering conditions.
-     */
-    caseFilterConditions: FilterConditions[];
-    /**
-     * The field value to use as language.
-     */
-    languageField: string;
-    /**
-     * The names of the sources containing the cases to use for model building.
-     */
-    sources: string[];
-}
-export interface CaseClassificationDocumentGroupPreview {
-    /**
-     * The query that was used to fetch document information.
-     */
-    query: string;
-    /**
-     * Status indicating whether there are enough candidates for learning.
-     */
-    documentRequirementStatus: CaseClassificationDocumentRequirementStatus;
-    /**
-     * The total number of documents in all sources.
-     */
-    numberOfDocuments: number;
-    /**
-     * The number of documents matching the configured conditions.
-     */
-    numberOfDocumentsMatchingConditions: number;
-    /**
-     * The number of English documents matching the configured conditions.
-     */
-    numberOfDocumentsMatchingConditionsAndInEnglish: number;
-    /**
-     * The number of documents that are candidates for learning.
-     */
-    numberOfValidDocuments: number;
-}
-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.
-     */
-    caseExtractionPeriod: ExtractionPeriod;
-    /**
-     * An array of filtering conditions.
-     */
-    caseFilterConditions: FilterConditions[];
-    /**
-     * The field value to use as language.
-     */
-    languageField: string;
-    /**
-     * The names of the sources containing the cases to use for model building.
-     */
-    sources: string[];
-}
-export interface CaseClassificationContentField {
-    name: string;
-}
-export interface CaseClassificationContentFields {
-    fields: CaseClassificationContentField[];
-    query: string;
-}
+import { FilterConditions } from '../FilterConditions';
+export declare enum Operator {
+    Equals = "EQUALS",
+    NotEquals = "NOT_EQUALS"
+}
+export declare type CaseClassificationDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
+export interface DateField {
+    /**
+     * The field to use as date.
+     */
+    dateField?: string;
+}
+export interface FixedExtractionPeriod {
+    /**
+     * Date in milliseconds that indicates the beginning of the time interval to include cases.
+     * The date format is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
+     */
+    startTime: number;
+    /**
+     * Date in milliseconds that indicates the end of the time interval to include cases.
+     * The date format is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
+     */
+    endTime: number;
+}
+export interface IntervalExtractionPeriod {
+    /**
+     * The period to export data from. The exportPeriod uses the moment when the model was generated as a base.
+     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
+     * Example: P3Y6M4DT12H30M5S Represents a duration of three years, six months, four days, twelve hours, thirty minutes, and five seconds.
+     */
+    exportPeriod: string;
+}
+export declare type ExtractionPeriod = DateField & (FixedExtractionPeriod | IntervalExtractionPeriod);
+export interface CaseClassificationConfigurationModel {
+    /**
+     * The unique ID of the model.
+     */
+    modelId: string;
+    /**
+     * The model name to display.
+     * Example: My First Model
+     */
+    modelDisplayName: string;
+    /**
+     * The names of the sources containing the cases to use for model building.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    caseFilterConditions?: FilterConditions[];
+    /**
+     * The field containing the case ID
+     * Example: sfid
+     */
+    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.
+     */
+    caseExtractionPeriod?: ExtractionPeriod;
+    /**
+     * The case fields to use for model training.
+     * Example: [subject, reason, category]
+     */
+    fieldsForModelTraining: string[];
+    /**
+     * The case fields the model should predict.
+     * Example: [subject, reason, category]
+     */
+    fieldsToPredict: string[];
+    /**
+     * The field value to use as language.
+     */
+    languageField?: string;
+}
+export interface CaseClassificationDocumentGroupPreviewParams {
+    /**
+     * The time period for which to extract cases for model building.
+     * Must contain an export period or a start time and end time.
+     */
+    caseExtractionPeriod: ExtractionPeriod;
+    /**
+     * An array of filtering conditions.
+     */
+    caseFilterConditions: FilterConditions[];
+    /**
+     * The field value to use as language.
+     */
+    languageField: string;
+    /**
+     * The names of the sources containing the cases to use for model building.
+     */
+    sources: string[];
+}
+export interface CaseClassificationDocumentGroupPreview {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * Status indicating whether there are enough candidates for learning.
+     */
+    documentRequirementStatus: CaseClassificationDocumentRequirementStatus;
+    /**
+     * The total number of documents in all sources.
+     */
+    numberOfDocuments: number;
+    /**
+     * The number of documents matching the configured conditions.
+     */
+    numberOfDocumentsMatchingConditions: number;
+    /**
+     * The number of English documents matching the configured conditions.
+     */
+    numberOfDocumentsMatchingConditionsAndInEnglish: number;
+    /**
+     * The number of documents that are candidates for learning.
+     */
+    numberOfValidDocuments: number;
+}
+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.
+     */
+    caseExtractionPeriod: ExtractionPeriod;
+    /**
+     * An array of filtering conditions.
+     */
+    caseFilterConditions: FilterConditions[];
+    /**
+     * The field value to use as language.
+     */
+    languageField: string;
+    /**
+     * The names of the sources containing the cases to use for model building.
+     */
+    sources: string[];
+}
+export interface CaseClassificationContentField {
+    name: string;
+}
+export interface CaseClassificationContentFields {
+    fields: CaseClassificationContentField[];
+    query: string;
+}

package/dist/definitions/resources/MachineLearning/CaseClassificationConfiguration/index.d.ts

@@ -1,2 +1,2 @@
-export * from './CaseClassificationConfiguration';
-export * from './CaseClassificationConfigurationInterfaces';
+export * from './CaseClassificationConfiguration';
+export * from './CaseClassificationConfigurationInterfaces';

package/dist/definitions/resources/MachineLearning/DNEConfiguration/DNEConfiguration.d.ts

@@ -1,15 +1,15 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { AutoSelectionFieldCandidateModel, DNEConfigurationModel, DNENewConfigurationModel, DocumentExtractionPreviewModel, DocumentExtractionPreviewParams, DocumentExtractionQueryModel, ListCandidateFieldsParams } from './DNEConfigurationInterfaces';
-export default class DNEConfiguration extends Resource {
-    static baseUrl: string;
-    listFields(params?: ListCandidateFieldsParams): Promise<PageModel<AutoSelectionFieldCandidateModel, "items">>;
-    getDocumentExtractionPreview(params?: DocumentExtractionPreviewParams): Promise<DocumentExtractionPreviewModel>;
-    getDocumentExtractionQuery(model: DocumentExtractionQueryModel): Promise<string>;
-    parseDocumentExtractionQuery(query: string): Promise<DocumentExtractionQueryModel>;
-    createWithoutQuery(newModel: DNENewConfigurationModel, documentExtractionQueryModel: DocumentExtractionQueryModel): Promise<DNEConfigurationModel>;
-    createWithQuery(newModel: DNENewConfigurationModel): Promise<DNEConfigurationModel>;
-    delete(modelId: string): Promise<void>;
-    get(modelId: string): Promise<DNEConfigurationModel>;
-    update(modelId: string, modelConfig: DNEConfigurationModel): Promise<DNEConfigurationModel>;
-}
+import { PageModel } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { AutoSelectionFieldCandidateModel, DNEConfigurationModel, DNENewConfigurationModel, DocumentExtractionPreviewModel, DocumentExtractionPreviewParams, DocumentExtractionQueryModel, ListCandidateFieldsParams } from './DNEConfigurationInterfaces';
+export default class DNEConfiguration extends Resource {
+    static baseUrl: string;
+    listFields(params?: ListCandidateFieldsParams): Promise<PageModel<AutoSelectionFieldCandidateModel, "items">>;
+    getDocumentExtractionPreview(params?: DocumentExtractionPreviewParams): Promise<DocumentExtractionPreviewModel>;
+    getDocumentExtractionQuery(model: DocumentExtractionQueryModel): Promise<string>;
+    parseDocumentExtractionQuery(query: string): Promise<DocumentExtractionQueryModel>;
+    createWithoutQuery(newModel: DNENewConfigurationModel, documentExtractionQueryModel: DocumentExtractionQueryModel): Promise<DNEConfigurationModel>;
+    createWithQuery(newModel: DNENewConfigurationModel): Promise<DNEConfigurationModel>;
+    delete(modelId: string): Promise<void>;
+    get(modelId: string): Promise<DNEConfigurationModel>;
+    update(modelId: string, modelConfig: DNEConfigurationModel): Promise<DNEConfigurationModel>;
+}

package/dist/definitions/resources/MachineLearning/DNEConfiguration/DNEConfigurationInterfaces.d.ts

@@ -1,41 +1,41 @@
-import { Paginated } from '../../BaseInterfaces';
-import { IntervalUnit } from '../../Enums';
-export interface AutoSelectionFieldCandidateModel {
-    name?: string;
-    description?: string;
-}
-export interface ListCandidateFieldsParams extends Paginated {
-    filter?: string;
-}
-export interface DocumentExtractionPreviewModel {
-    numberOfDocuments?: number;
-    recommendedNumberOfDocuments?: number;
-    sources?: DocumentSourceModel[];
-}
-export interface DocumentSourceModel {
-    name?: string;
-    numberOfDocuments?: number;
-}
-export interface DocumentExtractionPreviewParams {
-    fields?: string[];
-    maximumNumberOfSources?: number;
-}
-export interface DocumentExtractionQueryModel {
-    fields?: string[];
-    sources?: string[];
-}
-export interface DNEConfigurationModel extends DNENewConfigurationModel {
-    documentGroupId?: string;
-    modelId?: string;
-}
-export interface DNENewConfigurationModel {
-    commonFilter?: string;
-    documentExtractionQuery?: string;
-    exportPeriod?: string;
-    fieldsToAutoSelect?: string[];
-    intervalTime?: number;
-    intervalUnit?: IntervalUnit;
-    modelDisplayName: string;
-    searchEventFilter?: string;
-    viewAllContent?: boolean;
-}
+import { Paginated } from '../../BaseInterfaces';
+import { IntervalUnit } from '../../Enums';
+export interface AutoSelectionFieldCandidateModel {
+    name?: string;
+    description?: string;
+}
+export interface ListCandidateFieldsParams extends Paginated {
+    filter?: string;
+}
+export interface DocumentExtractionPreviewModel {
+    numberOfDocuments?: number;
+    recommendedNumberOfDocuments?: number;
+    sources?: DocumentSourceModel[];
+}
+export interface DocumentSourceModel {
+    name?: string;
+    numberOfDocuments?: number;
+}
+export interface DocumentExtractionPreviewParams {
+    fields?: string[];
+    maximumNumberOfSources?: number;
+}
+export interface DocumentExtractionQueryModel {
+    fields?: string[];
+    sources?: string[];
+}
+export interface DNEConfigurationModel extends DNENewConfigurationModel {
+    documentGroupId?: string;
+    modelId?: string;
+}
+export interface DNENewConfigurationModel {
+    commonFilter?: string;
+    documentExtractionQuery?: string;
+    exportPeriod?: string;
+    fieldsToAutoSelect?: string[];
+    intervalTime?: number;
+    intervalUnit?: IntervalUnit;
+    modelDisplayName: string;
+    searchEventFilter?: string;
+    viewAllContent?: boolean;
+}

package/dist/definitions/resources/MachineLearning/DNEConfiguration/index.d.ts

@@ -1,2 +1,2 @@
-export * from './DNEConfiguration';
-export * from './DNEConfigurationInterfaces';
+export * from './DNEConfiguration';
+export * from './DNEConfigurationInterfaces';

package/dist/definitions/resources/MachineLearning/FilterConditions.d.ts

@@ -1,18 +1,18 @@
-import { Operator } from './CaseClassificationConfiguration';
-export interface FilterConditions {
-    /**
-     * The name of the field.
-     * Example: status
-     */
-    field: string;
-    /**
-     * The operator to use to evaluate the condition.
-     * Must be EQUALS or NOT_EQUALS
-     */
-    operator: Operator;
-    /**
-     * The value to use for the condition.
-     * Example: completed
-     */
-    value: string;
-}
+import { Operator } from './CaseClassificationConfiguration';
+export interface FilterConditions {
+    /**
+     * The name of the field.
+     * Example: status
+     */
+    field: string;
+    /**
+     * The operator to use to evaluate the condition.
+     * Must be EQUALS or NOT_EQUALS
+     */
+    operator: Operator;
+    /**
+     * The value to use for the condition.
+     * Example: completed
+     */
+    value: string;
+}

package/dist/definitions/resources/MachineLearning/MachineLearning.d.ts

@@ -1,26 +1,26 @@
-import API from '../../APICore';
-import Resource from '../Resource';
-import CaseClassificationConfiguration from './CaseClassificationConfiguration/CaseClassificationConfiguration';
-import DNEConfiguration from './DNEConfiguration/DNEConfiguration';
-import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration';
-import { MLModelCreated, RegistrationModel } from './MachineLearningInterfaces';
-import ModelConfiguration from './ModelConfiguration/ModelConfiguration';
-import ModelInformation from './ModelInformation/ModelInformation';
-import Models from './Models/Models';
-import PQSConfiguration from './PQSConfiguration/PQSConfiguration';
-import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration';
-export default class MachineLearning extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    static baseUrl: string;
-    models: Models;
-    modelInfo: ModelInformation;
-    modelConfig: ModelConfiguration;
-    dneConfig: DNEConfiguration;
-    caseClassificationConfig: CaseClassificationConfiguration;
-    smartSnippetsConfig: SmartSnippetsConfiguration;
-    userActionHistoryConfig: UserActionHistoryConfiguration;
-    pqsConfig: PQSConfiguration;
-    constructor(api: API, serverlessApi: API);
-    register(registration: RegistrationModel): Promise<MLModelCreated>;
-}
+import API from '../../APICore';
+import Resource from '../Resource';
+import CaseClassificationConfiguration from './CaseClassificationConfiguration/CaseClassificationConfiguration';
+import DNEConfiguration from './DNEConfiguration/DNEConfiguration';
+import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration';
+import { MLModelCreated, RegistrationModel } from './MachineLearningInterfaces';
+import ModelConfiguration from './ModelConfiguration/ModelConfiguration';
+import ModelInformation from './ModelInformation/ModelInformation';
+import Models from './Models/Models';
+import PQSConfiguration from './PQSConfiguration/PQSConfiguration';
+import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration';
+export default class MachineLearning extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    models: Models;
+    modelInfo: ModelInformation;
+    modelConfig: ModelConfiguration;
+    dneConfig: DNEConfiguration;
+    caseClassificationConfig: CaseClassificationConfiguration;
+    smartSnippetsConfig: SmartSnippetsConfiguration;
+    userActionHistoryConfig: UserActionHistoryConfiguration;
+    pqsConfig: PQSConfiguration;
+    constructor(api: API, serverlessApi: API);
+    register(registration: RegistrationModel): Promise<MLModelCreated>;
+}