feat(mlx): add the modelassociations call (#905)

* feat(mlx): add the modelassociations call

* fix: add documentation and test

src/resources/MachineLearning/MachineLearning.ts

@@ -4,6 +4,7 @@ import CaseClassificationConfiguration from './CaseClassificationConfiguration/C
 import DNEConfiguration from './DNEConfiguration/DNEConfiguration.js';
 import IAPRConfiguration from './IAPRConfiguration/IAPRConfiguration.js';
 import {MLModelCreated, RegistrationModel} from './MachineLearningInterfaces.js';
+import ModelAssociations from './ModelAssociations/ModelAssociations.js';
 import ModelDetailedInfo from './ModelDetailedInfo/ModelDetailedInfo.js';
 import ModelListing from './ModelListing/ModelListing.js';
 import Models from './Models/Models.js';
@@ -27,6 +28,7 @@ export default class MachineLearning extends Resource {
     relevanceGenerativeAnsweringConfig: RelevanceGenerativeAnsweringConfiguration;
     semanticEncoderConfig: SemanticEncoderConfiguration;
     modelDetailedInfo: ModelDetailedInfo;
+    modelAssociations: ModelAssociations;
 
     constructor(
         protected api: API,
@@ -45,6 +47,7 @@ export default class MachineLearning extends Resource {
         this.relevanceGenerativeAnsweringConfig = new RelevanceGenerativeAnsweringConfiguration(api, serverlessApi);
         this.semanticEncoderConfig = new SemanticEncoderConfiguration(api, serverlessApi);
         this.modelDetailedInfo = new ModelDetailedInfo(api, serverlessApi);
+        this.modelAssociations = new ModelAssociations(api, serverlessApi);
     }
 
     register(registration: RegistrationModel) {

src/resources/MachineLearning/ModelAssociations/ModelAssociations.ts

@@ -0,0 +1,18 @@
+import API from '../../../APICore.js';
+import {PageModel} from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import {AssociationItem, ModelAssociationsListParams} from './ModelAssociationsInterfaces.js';
+
+export default class ModelAssociations extends Resource {
+    static baseUrl = `/rest/organizations/${API.orgPlaceholder}/machinelearning/configuration/querypipelines`;
+
+    /**
+     * Lists the organization associations corresponding to the specified pipelineId.
+     * @param pipelineId The unique identifier of the query pipeline.
+     * @param params The pagination parameters.
+     * @returns A list of associated models
+     */
+    list(pipelineId: string, params: ModelAssociationsListParams): Promise<PageModel<AssociationItem>> {
+        return this.api.get(this.buildPath(`${ModelAssociations.baseUrl}/${pipelineId}/associations`, params));
+    }
+}

src/resources/MachineLearning/ModelAssociations/ModelAssociationsInterfaces.ts

@@ -0,0 +1,62 @@
+import {ConditionModel} from '../../Pipelines/index.js';
+import {MLModelStatus} from '../MachineLearningInterfaces.js';
+
+export interface ModelAssociationsListParams {
+    /*
+     * The 0-based number of the page of results to list. Default: 0
+     */
+    page: number;
+    /*
+     * The maximum number of results to include per page.. Default: 100
+     */
+    pageSize: number;
+}
+export interface AssociationItem {
+    /**
+     * The unique identifier of the model association.
+     */
+    associationId: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     */
+    modelId: string;
+    /**
+     * The id of the engine.
+     */
+    engineId?: string;
+    /**
+     * The name of the model configuration.
+     */
+    modelDisplayName?: string;
+    /**
+     * The current status of the model.
+     * @example { modelStatus: "BUILDING", daysUntilArchival : 3 }
+     */
+    modelStatusInfo?: {
+        /**
+         * The status of the model.
+         * @example "ACTIVE"
+         */
+        modelStatus: MLModelStatus;
+        /**
+         * The remaining days until the model is archived.
+         */
+        daysUntilArchival?: number;
+    };
+    /**
+     * The condition that must be met to trigger the model association.
+     */
+    condition?: ConditionModel;
+    /**
+     * The position at which this model association is evaluated in the query pipeline, relative to other model associations.
+     */
+    position: number;
+    /**
+     * Whether the Coveo Administration Console should show the advanced configuration for this association.
+     */
+    useAdvancedConfiguration?: boolean;
+    /**
+     * The additional parameters to send to Coveo ML.
+     */
+    customQueryParameters?: {submodel: string};
+}

src/resources/MachineLearning/ModelAssociations/index.ts

@@ -0,0 +1,2 @@
+export * from './ModelAssociations.js';
+export * from './ModelAssociationsInterfaces.js';

src/resources/MachineLearning/ModelAssociations/tests/ModelAssociations.spec.ts

@@ -0,0 +1,26 @@
+import API from '../../../../APICore.js';
+import ModelAssociations from '../ModelAssociations.js';
+
+jest.mock('../../../../APICore');
+
+describe('ModelAssociations', () => {
+    let modelAssociations: ModelAssociations;
+    const api = new API({accessToken: 'some-token'});
+    const serverlessApi = new API({accessToken: 'some-token'});
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        modelAssociations = new ModelAssociations(api, serverlessApi);
+    });
+
+    describe('createPQSModel', () => {
+        it('should make a GET call to the specific IAPRConfiguration url', async () => {
+            const pipelineId = '123';
+            await modelAssociations.list(pipelineId, {page: 1, pageSize: 25});
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith(
+                `${ModelAssociations.baseUrl}/${pipelineId}/associations?page=1&pageSize=25`,
+            );
+        });
+    });
+});

src/resources/MachineLearning/index.ts

@@ -5,6 +5,7 @@ export * from './FilterConditions.js';
 export * from './IAPRConfiguration/index.js';
 export * from './MachineLearning.js';
 export * from './MachineLearningInterfaces.js';
+export * from './ModelAssociations/index.js';
 export * from './ModelDetailedInfo/index.js';
 export * from './ModelInformation/index.js';
 export * from './ModelListing/index.js';

src/resources/MachineLearning/tests/MachineLearning.spec.ts

@@ -4,6 +4,7 @@ import DNEConfiguration from '../DNEConfiguration/DNEConfiguration.js';
 import IAPRConfiguration from '../IAPRConfiguration/IAPRConfiguration.js';
 import MachineLearning from '../MachineLearning.js';
 import {RegistrationModel} from '../MachineLearningInterfaces.js';
+import ModelAssociations from '../ModelAssociations/ModelAssociations.js';
 import ModelDetailedInfo from '../ModelDetailedInfo/ModelDetailedInfo.js';
 import Models from '../Models/Models.js';
 import PQSConfiguration from '../PQSConfiguration/PQSConfiguration.js';
@@ -72,4 +73,9 @@ describe('MachineLearning', () => {
         expect(ml.modelDetailedInfo).toBeDefined();
         expect(ml.modelDetailedInfo).toBeInstanceOf(ModelDetailedInfo);
     });
+
+    it('should register the modelAssociations resource', () => {
+        expect(ml.modelAssociations).toBeDefined();
+        expect(ml.modelAssociations).toBeInstanceOf(ModelAssociations);
+    });
 });