@coveo/platform-client 56.0.0 → 56.2.0

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

@@ -1,16 +1,17 @@
+export * from './CaseClassificationConfiguration/index.js';
+export * from './DNEConfiguration/index.js';
+export * from './DocumentInterfaces.js';
+export * from './FilterConditions.js';
+export * from './IAPRConfiguration/index.js';
 export * from './MachineLearning.js';
 export * from './MachineLearningInterfaces.js';
-export * from './FilterConditions.js';
-export * from './DocumentInterfaces.js';
-export * from './Models/index.js';
+export * from './ModelDetailedInfo/index.js';
 export * from './ModelInformation/index.js';
 export * from './ModelListing/index.js';
-export * from './DNEConfiguration/index.js';
-export * from './CaseClassificationConfiguration/index.js';
-export * from './SmartSnippetsConfiguration/index.js';
+export * from './Models/index.js';
 export * from './PQSConfiguration/index.js';
+export * from './RGAConfiguration/index.js';
 export * from './SemanticEncoderConfiguration/index.js';
-export * from './IAPRConfiguration/index.js';
+export * from './SmartSnippetsConfiguration/index.js';
 export * from './UserActionHistoryConfiguration/index.js';
-export * from './RGAConfiguration/index.js';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/MachineLearning/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,uCAAuC,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yCAAyC,CAAC;AACxD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/MachineLearning/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2CAA2C,CAAC"}

package/dist/types/resources/Extensions/Extensions.d.ts

@@ -2,27 +2,70 @@ import Resource from '../Resource.js';
 import { CreateExtension, ExtensionCompileCode, ExtensionCompileResult, ExtensionContentVersionModel, ExtensionModel } from './ExtensionsInterfaces.js';
 export default class Extension extends Resource {
     static baseUrl: string;
+    /**
+     * Creates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extension The configuration to use for the new extension.
+     * @returns The newly created extension.
+     */
     create(extension: CreateExtension): Promise<ExtensionModel>;
+    /**
+     * Updates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extensionId The unique identifier of the extension to update.
+     * @param options The new configuration to use for the updated extension.
+     * @returns The updated extension.
+     */
     update(extensionId: string, options: CreateExtension): Promise<ExtensionModel>;
+    /**
+     * Deletes an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extensionId The unique identifier of the extension to delete.
+     * @returns
+     */
     delete(extensionId: string): Promise<void>;
+    /**
+     * Enables a disabled [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     *
+     * Note: Disabled extensions are not executed.
+     * @param extensionId The unique identifier of the extension to enable.
+     * @returns
+     */
     enable(extensionId: string): Promise<void>;
+    /**
+     * Disables an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     *
+     * Note: Disabled extensions are not executed.
+     * @param extensionId The unique identifier of the extension to disable.
+     * @param reason The reason why the extension is disabled.
+     * @returns
+     */
     disable(extensionId: string, reason?: string): Promise<void>;
+    /**
+     * Shows an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extensionId Shows an extension in a Coveo Cloud organization.
+     * @returns The extension specified by the provided id.
+     */
     get(extensionId: string): Promise<ExtensionModel>;
+    /**
+     * Lists all [extensions](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @returns A list of extensions.
+     */
     list(): Promise<ExtensionModel[]>;
     /**
      * Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
-     * @param extensionId
+     * @param extensionId he unique identifier of the target extension.
+     * @returns A list of versions of the extension.
      */
     listVersions(extensionId: string): Promise<ExtensionContentVersionModel[]>;
     /**
      * Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
-     * @param extensionId
-     * @param versionId
+     * @param extensionId The unique identifier of the target extension.
+     * @param versionId The unique identifier of the extension version to show.
+     * @returns The extension specified by the provided id and version id.
      */
     getVersion(extensionId: string, versionId: string): Promise<ExtensionModel>;
     /**
-     * Validates the extension's script
+     * Tries to compile code that would be used in an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
      * @param extensionCode The code to compile
+     * @returns Details regarding the outcome of an extension script compilation.
      */
     validateCode(extensionCode: ExtensionCompileCode): Promise<ExtensionCompileResult>;
 }

package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts

@@ -1,56 +1,192 @@
 import { GranularResource } from '../../Entry.js';
 import { DataStreamType, ExtensionLanguageType } from '../Enums.js';
 type Version = 'v1' | 'v2';
+export interface ExtensionHealthModel {
+    /**
+     * A qualitative health indicator.
+     *
+     */
+    healthIndicator: 'GOOD' | 'WARNING' | 'PROBLEMATIC' | 'UNKNOWN';
+    /**
+     * Additional details if healthIndicator value is `WARNING` or `PROBLEMATIC`.
+     */
+    reason: string;
+}
+export interface ExtensionDisabledStatusModel {
+    /**
+     * The extension disablement date (in number of milliseconds since UNIX epoch).
+     * @example 1556034174000
+     */
+    disabledDate: number;
+    /**
+     * The reason why the extension was disabled.
+     */
+    reason: string;
+}
+export interface ExtensionStatisticsModel {
+    /**
+     * The average extension execution duration in seconds.
+     */
+    averageDurationInSeconds: number;
+    /**
+     * The number of extension executions for which the script returned an error.
+     */
+    numberOfErrors: number;
+    /**
+     * The total number of executions of the extension.
+     */
+    numberOfExecutions: number;
+    /**
+     * The number of times the extension was not executed due to any of the following reasons:
+     * - The extension condition was evaluated to false.
+     * - The extension timed out.
+     * - The extension was disabled.
+     */
+    numberOfSkips: number;
+    /**
+     * The number of executions that reached the maximum execution time (default of 5 seconds).
+     */
+    numberOfTimeouts: number;
+}
+export interface ExtensionStatusModel {
+    /**
+     * Execution statistics pertaining to an extension over the past 24 hours (for all items from all sources to which the extension applies).
+     */
+    dailyStatistics: ExtensionStatisticsModel;
+    /**
+     * Information regarding the disabled state of an extension, if applicable.
+     */
+    disabledStatus?: ExtensionDisabledStatusModel;
+    /**
+     * Information regarding a health characteristic of the extension.
+     */
+    durationHealth: ExtensionHealthModel;
+    /**
+     * The last date at which the extension was automatically disabled by the service, (in number of milliseconds since UNIX epoch).
+     * @example 1533916446000
+     */
+    lastAutoDisablingDate: number;
+    /**
+     * @deprecated use lastAutoDisablingDate instead.
+     */
+    lastDisablingDate: number;
+    /**
+     * Information regarding a health characteristic of the extension.
+     */
+    timeoutHealth: ExtensionHealthModel;
+    /**
+     * A qualitative indicator of the likelihood that the extension will time out.
+     *
+     */
+    timeoutLikeliness: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
+}
+export interface ExtensionUsedByModel {
+    /**
+     * The unique identifier of the source.
+     * @example mycoveocloudv2organizationg8tp8wu3-tqv7hb5wfju45im3lnuvtw2moq
+     */
+    sourceId: string;
+    /**
+     * The name of the source.
+     * @example mysource
+     */
+    sourceName: string;
+}
 export interface ExtensionModel {
+    /**
+     * The api version.
+     */
     apiVersion: Version;
+    /**
+     * The body of the extension (user script), written in Python using the [document object](https://docs.coveo.com/en/34/index-content/document-object-python-api-reference).
+     */
     content: string;
+    /**
+     * The creation date of the extension (in number of milliseconds since UNIX epoch).
+     * @example 1556034174000
+     */
     createdDate: number;
+    /**
+     * A description of the extension
+     */
     description: string;
+    /**
+     * Whether the extension is enabled.
+     *
+     * Note: Disabled extensions are not executed.
+     */
     enabled: boolean;
+    /**
+     * The unique identifier of the extension.
+     * @example mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy
+     */
     id: string;
+    /**
+     * The Python version.
+     */
     language: ExtensionLanguageType;
+    /**
+     * The last modification date of the extension (in number of milliseconds since UNIX epoch).
+     * @example 1556308241000
+     */
     lastModified: number;
+    /**
+     * The name of the extension.
+     */
     name: string;
+    /**
+     * The [data streams](https://docs.coveo.com/en/2891/glossary/data-stream) required by the extension.
+     */
     requiredDataStreams: DataStreamType[];
-    status: {
-        dailyStatistics: {
-            averageDurationInSeconds: number;
-            numberOfErrors: number;
-            numberOfExecutions: number;
-            numberOfSkips: number;
-            numberOfTimeouts: number;
-        };
-        disabledStatus?: {
-            disabledDate: number;
-            reason: string;
-        };
-        durationHealth: {
-            healthIndicator: string;
-            reason: string;
-        };
-        lastAutoDisablingDate: number;
-        lastDisablingDate: number;
-        timeoutHealth: {
-            healthIndicator: string;
-            reason: string;
-        };
-        timeoutLikeliness: string;
-    };
-    usedBy: [
-        {
-            sourceId: string;
-            sourceName: string;
-        }
-    ];
+    /**
+     * Status details of an extension.
+     */
+    status: ExtensionStatusModel;
+    /**
+     * The sources the extension applies to.
+     *
+     * Note: Only returned when performing GET/PUT /extensions/{extensionId} requests.
+     */
+    usedBy: ExtensionUsedByModel[];
+    /**
+     * Whether the extension uses vault parameters or not.
+     */
+    useVault?: boolean;
+    /**
+     * The unique identifier of the extension version.
+     * @example hdJSDb4hTkdnsCynNtF.d657FgLSDydcj
+     */
     versionId: string;
 }
 export interface CreateExtension extends GranularResource {
+    /**
+     * The body of the extension (user script), written in Python using the [document object](https://docs.coveo.com/en/34/index-content/document-object-python-api-reference).
+     */
     content: string;
+    /**
+     * A name for the extension.
+     */
     name: string;
+    /**
+     * The api version.
+     */
     apiVersion?: Version;
+    /**
+     * A description of the extension.
+     */
     description?: string;
+    /**
+     * The Python version.
+     */
     language?: ExtensionLanguageType;
+    /**
+     * The [data streams](https://docs.coveo.com/en/2891/glossary/data-stream) required by the extension.
+     */
     requiredDataStreams?: DataStreamType[];
+    /**
+     * Whether the extension uses vault parameters or not.
+     */
+    useVault?: boolean;
 }
 export interface ExtensionCompileCode {
     /**

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

@@ -2,15 +2,16 @@ import API from '../../APICore.js';
 import Resource from '../Resource.js';
 import CaseClassificationConfiguration from './CaseClassificationConfiguration/CaseClassificationConfiguration.js';
 import DNEConfiguration from './DNEConfiguration/DNEConfiguration.js';
-import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration.js';
+import IAPRConfiguration from './IAPRConfiguration/IAPRConfiguration.js';
 import { MLModelCreated, RegistrationModel } from './MachineLearningInterfaces.js';
+import ModelDetailedInfo from './ModelDetailedInfo/ModelDetailedInfo.js';
+import ModelListing from './ModelListing/ModelListing.js';
 import Models from './Models/Models.js';
 import PQSConfiguration from './PQSConfiguration/PQSConfiguration.js';
-import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration.js';
-import IAPRConfiguration from './IAPRConfiguration/IAPRConfiguration.js';
-import ModelListing from './ModelListing/ModelListing.js';
 import RelevanceGenerativeAnsweringConfiguration from './RGAConfiguration/RelevanceGenerativeAnsweringConfiguration.js';
 import SemanticEncoderConfiguration from './SemanticEncoderConfiguration/SemanticEncoderConfiguration.js';
+import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration.js';
+import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration.js';
 export default class MachineLearning extends Resource {
     protected api: API;
     protected serverlessApi: API;
@@ -25,6 +26,7 @@ export default class MachineLearning extends Resource {
     modelListing: ModelListing;
     relevanceGenerativeAnsweringConfig: RelevanceGenerativeAnsweringConfiguration;
     semanticEncoderConfig: SemanticEncoderConfiguration;
+    modelDetailedInfo: ModelDetailedInfo;
     constructor(api: API, serverlessApi: API);
     register(registration: RegistrationModel): Promise<MLModelCreated>;
 }

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

@@ -85,3 +85,14 @@ export interface MLModelCreated extends New<MLModel> {
     startTime?: number;
     resourceId?: string;
 }
+export declare enum MLModelStatus {
+    ARCHIVED = "ARCHIVED",
+    SOON_TO_BE_ARCHIVED = "SOON_TO_BE_ARCHIVED",
+    BUILD_IN_PROGRESS = "BUILD_IN_PROGRESS",
+    ERROR = "ERROR",
+    ERROR_INTERNAL = "ERROR_INTERNAL",
+    LIMITED = "LIMITED",
+    NOT_ASSOCIATED = "NOT_ASSOCIATED",
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}

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

@@ -0,0 +1,6 @@
+import Resource from '../../Resource.js';
+import { ModelWithDetails } from './ModelDetailedInfoInterfaces.js';
+export default class ModelDetailedInfo extends Resource {
+    static baseUrl: string;
+    get(modelId: string): Promise<ModelWithDetails>;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.d.ts

@@ -0,0 +1,95 @@
+import { MLModelStatus } from '../MachineLearningInterfaces.js';
+import { ModelDetails } from './details/ModelDetails.js';
+export interface ModelAssociation {
+    /**
+     * The unique identifier of the query pipeline to which the model is associated.
+     * @example 38b08160-d7d4-4626-8e03-53587c23415d
+     */
+    parentId: string;
+    /**
+     * The unique identifier of the model association.
+     * @example 917af358-13fd-4c8e-94af-7cf649bddc48
+     */
+    id: string;
+    /**
+     * The name of the query pipeline or case assist configuration the model is associated with.
+     * @example association name
+     */
+    name: string;
+    /**
+     * The type of the association.
+     * @example QUERY_PIPELINE
+     */
+    associationType: 'QUERY_PIPELINE' | 'CASE_ASSIST';
+}
+export interface ModelIssues {
+    /**
+     * A description of an error or limitation present in the model.
+     */
+    description: string;
+    /**
+     * The recommended action to perform to resolve the error or limitation.
+     */
+    troubleshoot: string;
+}
+export interface ModelStatusInfo {
+    /**
+     * The status of the model.
+     * @example ACTIVE
+     */
+    modelStatus: MLModelStatus;
+    /**
+     * The remaining days until the model is archived.
+     * @example 2
+     */
+    daysUntilArchival: number;
+}
+export interface ModelWithDetails {
+    /**
+     * The id of the engine.
+     * @Example topclicks
+     */
+    engineId: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     * @example My_Model_ID
+     */
+    modelId: string;
+    /**
+     * The name of the model configuration.
+     * @example My model
+     */
+    modelDisplayName: string;
+    /**
+     * The associations related to this model.
+     * @example [{
+     *    "parentId": "38b08160-d7d4-4626-8e03-53587c23415d",
+     *    "id": "917af358-13fd-4c8e-94af-7cf649bddc48",
+     *    "name": "test pipeline",
+     *    "associationType": "QUERY_PIPELINE"
+     * }]
+     */
+    modelAssociations: ModelAssociation[];
+    /**
+     * The date and time the model was last updated.
+     * @example 1691762520000
+     */
+    estimatedPreviousModelUpdateTime: number;
+    /**
+     * The date and time the model is scheduled to start its next update.
+     * @example 1691762520000
+     */
+    nextModelUpdateTime: number;
+    /**
+     * The description and troubleshooting messages for a model error or limitation.
+     */
+    modelIssues: ModelIssues[];
+    /**
+     * The detailed information about the model.
+     */
+    modelDetails?: ModelDetails;
+    /**
+     * The current status of the model.
+     */
+    modelStatusInfo: ModelStatusInfo;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.d.ts

@@ -0,0 +1,21 @@
+import { ModelDetailsBuildingStats } from './ModelDetailsBuildingStats.js';
+import { ModelDetailsLanguages } from './ModelDetailsLanguages.js';
+import { ModelDetailsSubModels } from './ModelDetailsSubModels.js';
+export interface ModelDetails {
+    possibleRecommendations?: number;
+    totalQueries?: number;
+    recommendationsPerLanguage?: Map<string, number>;
+    userContextFields?: string[];
+    contentIDKeys?: string[];
+    candidatesPerFilters?: Map<string, number>;
+    contextCandidateExamples?: Map<string, string[]>;
+    languages?: Map<string, ModelDetailsLanguages>;
+    candidateExamples?: Map<string, string[]>;
+    candidatesPerLanguages?: Map<string, number>;
+    minClickCountPerLang?: Map<string, number>;
+    subModels?: {
+        [key: string]: ModelDetailsSubModels;
+    };
+    candidates?: number;
+    modelDetailedBuildingStats?: ModelDetailsBuildingStats;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.d.ts

@@ -0,0 +1,30 @@
+import { ModelDetailsCommerceEvents } from './ModelDetailsCommerceEvents.js';
+import { ModelDetailsStatsPerSource } from './ModelDetailsStatsPerSource.js';
+export interface ModelDetailsBuildingStats {
+    documentWithSnippetRatio?: number;
+    headerCount?: number;
+    snippetCount?: number;
+    meanSnippetLength?: number;
+    documentCount?: number;
+    documentWithSnippetCount?: number;
+    searchEventCount?: number;
+    clickEventCount?: number;
+    viewEventCount?: number;
+    customEventCount?: number;
+    segmentedVisitsCount?: number;
+    searchCount?: number;
+    clickCount?: number;
+    viewCount?: number;
+    visitsCount?: number;
+    facetSelectEventCount?: number;
+    snippetsPerDocument?: {
+        min?: number;
+        max?: number;
+        mean?: number;
+    };
+    invalidHtmlDocumentCount?: number;
+    documentWithoutIdCount?: number;
+    documentWithDuplicatedIdCount?: number;
+    commerceEventCounts?: ModelDetailsCommerceEvents;
+    modelDetailedStatsPerSource?: ModelDetailsStatsPerSource[];
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.d.ts

@@ -0,0 +1,6 @@
+export interface ModelDetailsCommerceEvents {
+    removeFromCart?: number;
+    addToCart?: number;
+    addPurchase?: number;
+    detailView?: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.d.ts

@@ -0,0 +1,8 @@
+export interface ModelDetailsLanguages {
+    queries?: number;
+    words?: number;
+    stopwords?: number;
+    topfacets?: string[];
+    contextKeysToDocuments?: Map<string, number>;
+    docPerFilters?: Map<string, number>;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.d.ts

@@ -0,0 +1,7 @@
+export interface ModelDetailsStatsPerSource {
+    sourceName: string;
+    documentCount: number;
+    invalidHtmlDocumentCount: number;
+    documentWithoutIdCount: number;
+    documentWithDuplicatedIdCount: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.d.ts

@@ -0,0 +1,5 @@
+export interface ModelDetailsSubModels {
+    numOfItems?: number;
+    candidates?: string[] | string[][];
+    numOfUsers?: number;
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/index.d.ts

@@ -0,0 +1,6 @@
+export * from './ModelDetails.js';
+export * from './ModelDetailsBuildingStats.js';
+export * from './ModelDetailsCommerceEvents.js';
+export * from './ModelDetailsLanguages.js';
+export * from './ModelDetailsStatsPerSource.js';
+export * from './ModelDetailsSubModels.js';

package/dist/types/resources/MachineLearning/ModelDetailedInfo/index.d.ts

@@ -0,0 +1,3 @@
+export * from './details/index.js';
+export * from './ModelDetailedInfo.js';
+export * from './ModelDetailedInfoInterfaces.js';

package/dist/types/resources/MachineLearning/ModelListing/ModelListingInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { MLModelStatus } from '../MachineLearningInterfaces.js';
 export interface MLListingModel {
     /**
      * The model display name in the Coveo Administration console.
@@ -50,7 +51,7 @@ export interface MLModelStatusInfo {
      * The status of the model.
      * @Example `ACTIVE`
      */
-    modelStatus: 'ARCHIVED' | 'SOON_TO_BE_ARCHIVED' | 'BUILD_IN_PROGRESS' | 'ERROR' | 'ERROR_INTERNAL' | 'LIMITED' | 'NOT_ASSOCIATED' | 'ACTIVE' | 'INACTIVE';
+    modelStatus: MLModelStatus;
     /**
      * The remaining days until the model is archived.
      * @Example `4`

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

@@ -1,15 +1,16 @@
+export * from './CaseClassificationConfiguration/index.js';
+export * from './DNEConfiguration/index.js';
+export * from './DocumentInterfaces.js';
+export * from './FilterConditions.js';
+export * from './IAPRConfiguration/index.js';
 export * from './MachineLearning.js';
 export * from './MachineLearningInterfaces.js';
-export * from './FilterConditions.js';
-export * from './DocumentInterfaces.js';
-export * from './Models/index.js';
+export * from './ModelDetailedInfo/index.js';
 export * from './ModelInformation/index.js';
 export * from './ModelListing/index.js';
-export * from './DNEConfiguration/index.js';
-export * from './CaseClassificationConfiguration/index.js';
-export * from './SmartSnippetsConfiguration/index.js';
+export * from './Models/index.js';
 export * from './PQSConfiguration/index.js';
+export * from './RGAConfiguration/index.js';
 export * from './SemanticEncoderConfiguration/index.js';
-export * from './IAPRConfiguration/index.js';
+export * from './SmartSnippetsConfiguration/index.js';
 export * from './UserActionHistoryConfiguration/index.js';
-export * from './RGAConfiguration/index.js';

package/package.json

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