edge-impulse-api 1.93.27 → 1.93.28

package/build/browser/edge-impulse-api.d.ts

@@ -6320,6 +6320,20 @@ export class OrganizationBlocksApi {
             [name: string]: string;
         }) => void;
     }): Promise<GetOrganizationTransferLearningBlockResponse>;
+    /**
+     * Retrieve a transfer learning block by its customBlockRef. customBlockRef is a stable string key used by CI to create and update blocks. Unlike transferLearningId, which Studio assigns after create, it is provided by the publisher on create.
+     * @summary Get transfer learning block by customBlockRef
+     * @param organizationId Organization ID
+     * @param customBlockRef
+     */
+    getOrganizationTransferLearningBlockByRef(organizationId: number, customBlockRef: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
+    }): Promise<GetOrganizationTransferLearningBlockResponse>;
     /**
      * Get a transformation block.
      * @summary Get transformation block
@@ -14562,6 +14576,10 @@ export type AddOrganizationTransferLearningBlockRequest = {
     */
     repositoryUrl?: string;
     /**
+    * Unique stable string key used to create and find this custom block.
+    */
+    customBlockRef?: string;
+    /**
     * List of parameters, spec'ed according to
     * https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks
     */
@@ -25828,6 +25846,10 @@ export type OrganizationTransferLearningBlock = {
     */
     repositoryUrl?: string;
     /**
+    * Unique stable string key used to create and find this custom block.
+    */
+    customBlockRef?: string;
+    /**
     * List of parameters, spec'ed according to
     * https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks
     */
@@ -26805,6 +26827,9 @@ export type ProjectDataSummary = {
     * Labels in the training set
     */
     labels: string[];
+    /**
+    * Number of files in the training set
+    */
     dataCount: number;
 };
 
@@ -27270,9 +27295,48 @@ export type ProjectInfoResponse = {
     dataSummary: ProjectDataSummary;
     dataSummaryPerCategory: {
         training: ProjectDataSummary;
-        testing: ProjectDataSummary;
-        validation: ProjectDataSummary;
-        postProcessing: ProjectDataSummary;
+        testing: ProjectDataSummary & {
+            /**
+            * Total length (in ms.) of all data in the testing set
+            */
+            totalLengthMs: number;
+            /**
+            * Labels in the testing set
+            */
+            labels: string[];
+            /**
+            * Number of files in the testing set
+            */
+            dataCount: number;
+        };
+        validation: ProjectDataSummary & {
+            /**
+            * Total length (in ms.) of all data in the validation set
+            */
+            totalLengthMs: number;
+            /**
+            * Labels in the validation set
+            */
+            labels: string[];
+            /**
+            * Number of files in the validation set
+            */
+            dataCount: number;
+        };
+        postProcessing: ProjectDataSummary & {
+            /**
+            * Total length (in ms.) of all data in the post-processing set
+            */
+            totalLengthMs: number;
+            /**
+            * Labels in the post-processing set
+            */
+            labels: string[];
+            /**
+            * Number of files in the post-processing set
+            */
+            dataCount: number;
+        };
     };
     computeTime: {
         /**
@@ -29354,6 +29418,10 @@ export type TransferLearningModel = {
     * URL to the source code of this custom learn block.
     */
     repositoryUrl?: string;
+    /**
+    * Unique stable string key used to create and find this custom block.
+    */
+    customBlockRef?: string;
     author: string;
     blockType: BlockType;
     customParameters?: DSPGroupItem[];

package/build/browser/edge-impulse-api.js

@@ -28894,6 +28894,82 @@ class OrganizationBlocksApi {
         }
         return resp;
     }
+    /**
+     * Retrieve a transfer learning block by its customBlockRef. customBlockRef is a stable string key used by CI to create and update blocks. Unlike transferLearningId, which Studio assigns after create, it is provided by the publisher on create.
+     * @summary Get transfer learning block by customBlockRef
+     * @param organizationId Organization ID
+     * @param customBlockRef
+     */
+    async getOrganizationTransferLearningBlockByRef(organizationId, customBlockRef, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/transfer-learning/ref/{customBlockRef}'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)))
+            .replace('{' + 'customBlockRef' + '}', encodeURIComponent(String(customBlockRef)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            ...(typeof window === "undefined" ? { "User-Agent": "edgeimpulse-api nodejs" } : {}),
+            'Content-Type': 'application/json',
+            ...this.defaultHeaders,
+        };
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams;
+        // verify required parameter 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling getOrganizationTransferLearningBlockByRef.');
+        }
+        // verify required parameter 'customBlockRef' is not null or undefined
+        if (customBlockRef === null || customBlockRef === undefined) {
+            throw new Error('Required parameter customBlockRef was null or undefined when calling getOrganizationTransferLearningBlockByRef.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        const resp = this.handleResponse(response, 'GetOrganizationTransferLearningBlockResponse');
+        if (options === null || options === void 0 ? void 0 : options.responseHeadersCallback) {
+            const headerCb = options.responseHeadersCallback;
+            // on next tick, so we have time to handle the response
+            setTimeout(() => {
+                headerCb(Object.fromEntries(response.headers.entries()));
+            }, 0);
+        }
+        return resp;
+    }
     /**
      * Get a transformation block.
      * @summary Get transformation block