edge-impulse-api 1.93.19 → 1.93.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/browser/edge-impulse-api.d.ts +613 -15
- package/build/browser/edge-impulse-api.js +1381 -174
- package/build/browser/edge-impulse-api.js.map +1 -1
- package/build/library/sdk/api/deploymentApi.d.ts +31 -0
- package/build/library/sdk/api/deploymentApi.js +144 -0
- package/build/library/sdk/api/deploymentApi.js.map +1 -1
- package/build/library/sdk/api/organizationBlocksApi.d.ts +114 -0
- package/build/library/sdk/api/organizationBlocksApi.js +514 -0
- package/build/library/sdk/api/organizationBlocksApi.js.map +1 -1
- package/build/library/sdk/api/organizationDataApi.d.ts +13 -0
- package/build/library/sdk/api/organizationDataApi.js +68 -0
- package/build/library/sdk/api/organizationDataApi.js.map +1 -1
- package/build/library/sdk/api/projectsApi.d.ts +56 -0
- package/build/library/sdk/api/projectsApi.js +316 -0
- package/build/library/sdk/api/projectsApi.js.map +1 -1
- package/build/library/sdk/model/actorProjectApiKey.d.ts +2 -0
- package/build/library/sdk/model/actorProjectApiKey.js.map +1 -1
- package/build/library/sdk/model/addOrganizationExtensionBlockRequest.d.ts +59 -0
- package/build/library/sdk/model/addOrganizationExtensionBlockRequest.js +6 -0
- package/build/library/sdk/model/addOrganizationExtensionBlockRequest.js.map +1 -0
- package/build/library/sdk/model/addProjectActiveExtensionRequest.d.ts +3 -0
- package/build/library/sdk/model/addProjectActiveExtensionRequest.js +4 -0
- package/build/library/sdk/model/addProjectActiveExtensionRequest.js.map +1 -0
- package/build/library/sdk/model/addProjectApiKeyRequest.d.ts +6 -3
- package/build/library/sdk/model/addProjectApiKeyRequest.js +0 -2
- package/build/library/sdk/model/addProjectApiKeyRequest.js.map +1 -1
- package/build/library/sdk/model/apiKeyExtension.d.ts +4 -0
- package/build/library/sdk/model/apiKeyExtension.js +4 -0
- package/build/library/sdk/model/apiKeyExtension.js.map +1 -0
- package/build/library/sdk/model/buildPublicDeploymentJobRequest.d.ts +5 -0
- package/build/library/sdk/model/buildPublicDeploymentJobRequest.js +4 -0
- package/build/library/sdk/model/buildPublicDeploymentJobRequest.js.map +1 -0
- package/build/library/sdk/model/buildPublicDeploymentJobResponse.d.ts +20 -0
- package/build/library/sdk/model/buildPublicDeploymentJobResponse.js +4 -0
- package/build/library/sdk/model/buildPublicDeploymentJobResponse.js.map +1 -0
- package/build/library/sdk/model/createOrganizationBucketRequest.d.ts +3 -0
- package/build/library/sdk/model/createOrganizationBucketRequest.js +4 -0
- package/build/library/sdk/model/createOrganizationBucketRequest.js.map +1 -0
- package/build/library/sdk/model/createOrganizationBucketResponse.d.ts +18 -0
- package/build/library/sdk/model/createOrganizationBucketResponse.js +4 -0
- package/build/library/sdk/model/createOrganizationBucketResponse.js.map +1 -0
- package/build/library/sdk/model/deploymentHistory.d.ts +4 -0
- package/build/library/sdk/model/extension.d.ts +35 -0
- package/build/library/sdk/model/extension.js +6 -0
- package/build/library/sdk/model/extension.js.map +1 -0
- package/build/library/sdk/model/extensionVisibility.d.ts +7 -0
- package/build/library/sdk/model/extensionVisibility.js +6 -0
- package/build/library/sdk/model/extensionVisibility.js.map +1 -0
- package/build/library/sdk/model/getCurrentApiKeyInfoResponse.d.ts +14 -0
- package/build/library/sdk/model/getCurrentApiKeyInfoResponse.js +4 -0
- package/build/library/sdk/model/getCurrentApiKeyInfoResponse.js.map +1 -0
- package/build/library/sdk/model/getOrganizationExtensionBlockResponse.d.ts +12 -0
- package/build/library/sdk/model/getOrganizationExtensionBlockResponse.js +4 -0
- package/build/library/sdk/model/getOrganizationExtensionBlockResponse.js.map +1 -0
- package/build/library/sdk/model/getProjectActiveExtensionsResponse.d.ts +12 -0
- package/build/library/sdk/model/getProjectActiveExtensionsResponse.js +4 -0
- package/build/library/sdk/model/getProjectActiveExtensionsResponse.js.map +1 -0
- package/build/library/sdk/model/getPublicDeploymentStatusResponse.d.ts +33 -0
- package/build/library/sdk/model/getPublicDeploymentStatusResponse.js +4 -0
- package/build/library/sdk/model/getPublicDeploymentStatusResponse.js.map +1 -0
- package/build/library/sdk/model/jobLogItem.d.ts +7 -0
- package/build/library/sdk/model/jobLogItem.js +6 -0
- package/build/library/sdk/model/jobLogItem.js.map +1 -0
- package/build/library/sdk/model/jobLogsResponse.d.ts +2 -2
- package/build/library/sdk/model/listOrganizationExtensionBlocksResponse.d.ts +12 -0
- package/build/library/sdk/model/listOrganizationExtensionBlocksResponse.js +4 -0
- package/build/library/sdk/model/listOrganizationExtensionBlocksResponse.js.map +1 -0
- package/build/library/sdk/model/listProjectAvailableExtensionsResponse.d.ts +16 -0
- package/build/library/sdk/model/listProjectAvailableExtensionsResponse.js +4 -0
- package/build/library/sdk/model/listProjectAvailableExtensionsResponse.js.map +1 -0
- package/build/library/sdk/model/logStdoutResponse.d.ts +2 -2
- package/build/library/sdk/model/models.d.ts +20 -1
- package/build/library/sdk/model/models.js +23 -1
- package/build/library/sdk/model/models.js.map +1 -1
- package/build/library/sdk/model/projectApiKey.d.ts +2 -0
- package/build/library/sdk/model/projectApiKey.js.map +1 -1
- package/build/library/sdk/model/projectApiKeyRole.d.ts +2 -0
- package/build/library/sdk/model/projectApiKeyRole.js +6 -0
- package/build/library/sdk/model/projectApiKeyRole.js.map +1 -0
- package/build/library/sdk/model/projectExtension.d.ts +37 -0
- package/build/library/sdk/model/projectExtension.js +6 -0
- package/build/library/sdk/model/projectExtension.js.map +1 -0
- package/build/library/sdk/model/projectInfoResponse.d.ts +4 -0
- package/build/library/sdk/model/projectInfoResponse.js.map +1 -1
- package/build/library/sdk/model/removeProjectActiveExtensionResponse.d.ts +14 -0
- package/build/library/sdk/model/removeProjectActiveExtensionResponse.js +4 -0
- package/build/library/sdk/model/removeProjectActiveExtensionResponse.js.map +1 -0
- package/build/library/sdk/model/setKerasParameterRequest.d.ts +5 -0
- package/build/library/sdk/model/setKerasParameterRequest.js.map +1 -1
- package/build/library/sdk/model/storageProvider.d.ts +1 -1
- package/build/library/sdk/model/storageProvider.js +1 -1
- package/build/library/sdk/model/storageProvider.js.map +1 -1
- package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.d.ts +59 -0
- package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.js +6 -0
- package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.js.map +1 -0
- package/build/library/sdk/model/updateProjectRequest.d.ts +4 -0
- package/build/library/sdk/model/updateProjectRequest.js.map +1 -1
- package/package.json +1 -1
- package/build/library/sdk/model/logStdoutResponseAllOfStdout.d.ts +0 -7
- package/build/library/sdk/model/logStdoutResponseAllOfStdout.js +0 -6
- package/build/library/sdk/model/logStdoutResponseAllOfStdout.js.map +0 -1
|
@@ -2261,6 +2261,9 @@ export enum DeploymentApiApiKeys {
|
|
|
2261
2261
|
JWTAuthentication = 1,
|
|
2262
2262
|
JWTHttpHeaderAuthentication = 2
|
|
2263
2263
|
}
|
|
2264
|
+
type buildPublicDeploymentJobQueryParams = {
|
|
2265
|
+
impulseId?: number;
|
|
2266
|
+
};
|
|
2264
2267
|
type downloadBuildQueryParams = {
|
|
2265
2268
|
type: string;
|
|
2266
2269
|
modelType?: KerasModelTypeEnum;
|
|
@@ -2300,6 +2303,7 @@ type getSyntiantPosteriorQueryParams = {
|
|
|
2300
2303
|
};
|
|
2301
2304
|
type listDeploymentHistoryQueryParams = {
|
|
2302
2305
|
impulseId?: number;
|
|
2306
|
+
deploymentFormat?: string;
|
|
2303
2307
|
limit?: number;
|
|
2304
2308
|
offset?: number;
|
|
2305
2309
|
};
|
|
@@ -2335,6 +2339,18 @@ export class DeploymentApi {
|
|
|
2335
2339
|
setDefaultAuthentication(auth: Authentication): void;
|
|
2336
2340
|
setApiKey(key: DeploymentApiApiKeys, value: string | undefined): void;
|
|
2337
2341
|
set accessToken(token: string);
|
|
2342
|
+
/**
|
|
2343
|
+
* Create a deployment job for a _public_ project. You can only create deployments for \"wasm\" and \"wasm-browser-simd\" deployment types. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via `getPublicDeploymentStatus`. When this step is complete use `downloadHistoricDeployment` to download the artefacts using deploymentVersion. Updates are _NOT_ streamed over the websocket API (for security reasons); but can be obtained via `getPublicDeploymentStatus`.
|
|
2344
|
+
* @summary Build deployment (public)
|
|
2345
|
+
* @param projectId Project ID
|
|
2346
|
+
* @param buildPublicDeploymentJobRequest
|
|
2347
|
+
* @param impulseId Impulse ID. If this is unset then the default impulse is used.
|
|
2348
|
+
*/
|
|
2349
|
+
buildPublicDeploymentJob(projectId: number, buildPublicDeploymentJobRequest: BuildPublicDeploymentJobRequest, queryParams?: buildPublicDeploymentJobQueryParams, options?: {
|
|
2350
|
+
headers: {
|
|
2351
|
+
[name: string]: string;
|
|
2352
|
+
};
|
|
2353
|
+
}): Promise<BuildPublicDeploymentJobResponse>;
|
|
2338
2354
|
/**
|
|
2339
2355
|
* DEPRECATED, use downloadHistoricDeployment instead. Download the build artefacts for a project.
|
|
2340
2356
|
* @summary Download
|
|
@@ -2445,6 +2461,17 @@ export class DeploymentApi {
|
|
|
2445
2461
|
[name: string]: string;
|
|
2446
2462
|
};
|
|
2447
2463
|
}): Promise<GetModelMonitoringDeploymentsResponse>;
|
|
2464
|
+
/**
|
|
2465
|
+
* Get the status of a deployment job created through buildPublicDeploymentJob.
|
|
2466
|
+
* @summary Get status of build job (public)
|
|
2467
|
+
* @param projectId Project ID
|
|
2468
|
+
* @param jobId Job ID
|
|
2469
|
+
*/
|
|
2470
|
+
getPublicDeploymentStatus(projectId: number, jobId: number, options?: {
|
|
2471
|
+
headers: {
|
|
2472
|
+
[name: string]: string;
|
|
2473
|
+
};
|
|
2474
|
+
}): Promise<GetPublicDeploymentStatusResponse>;
|
|
2448
2475
|
/**
|
|
2449
2476
|
* Get the current posterior parameters for the Syntiant deployment target
|
|
2450
2477
|
* @summary Get Syntiant posterior parameters
|
|
@@ -2470,6 +2497,7 @@ export class DeploymentApi {
|
|
|
2470
2497
|
* @summary List deployment history
|
|
2471
2498
|
* @param projectId Project ID
|
|
2472
2499
|
* @param impulseId Impulse ID. If this is unset, data for all impulses is returned.
|
|
2500
|
+
* @param deploymentFormat
|
|
2473
2501
|
* @param limit Maximum number of results
|
|
2474
2502
|
* @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
|
|
2475
2503
|
*/
|
|
@@ -4978,6 +5006,21 @@ export type addOrganizationDeployBlockFormParams = {
|
|
|
4978
5006
|
sourceCodeDownloadStaffOnly?: boolean;
|
|
4979
5007
|
parameters?: Array<object>;
|
|
4980
5008
|
};
|
|
5009
|
+
export type addOrganizationExtensionBlockFormParams = {
|
|
5010
|
+
name: string;
|
|
5011
|
+
onlyAvailableInProjectId?: number;
|
|
5012
|
+
description: string;
|
|
5013
|
+
url: string;
|
|
5014
|
+
repositoryUrl?: string;
|
|
5015
|
+
logo?: RequestFile;
|
|
5016
|
+
navbarIcon?: string;
|
|
5017
|
+
navbarLocation: string;
|
|
5018
|
+
requiredApiKeyRole: ProjectApiKeyRole;
|
|
5019
|
+
visibility?: ExtensionVisibility;
|
|
5020
|
+
publicProjectTierAvailability?: PublicProjectTierAvailability;
|
|
5021
|
+
indBlockNoLongerAvailable?: boolean;
|
|
5022
|
+
blockNoLongerAvailableReason?: string;
|
|
5023
|
+
};
|
|
4981
5024
|
export type updateOrganizationDeployBlockFormParams = {
|
|
4982
5025
|
name?: string;
|
|
4983
5026
|
dockerContainer?: string;
|
|
@@ -4997,6 +5040,21 @@ export type updateOrganizationDeployBlockFormParams = {
|
|
|
4997
5040
|
sourceCodeDownloadStaffOnly?: boolean;
|
|
4998
5041
|
parameters?: Array<object>;
|
|
4999
5042
|
};
|
|
5043
|
+
export type updateOrganizationExtensionBlockFormParams = {
|
|
5044
|
+
name?: string;
|
|
5045
|
+
onlyAvailableInProjectId?: number;
|
|
5046
|
+
description?: string;
|
|
5047
|
+
url?: string;
|
|
5048
|
+
repositoryUrl?: string;
|
|
5049
|
+
logo?: RequestFile;
|
|
5050
|
+
navbarIcon?: string;
|
|
5051
|
+
navbarLocation?: string;
|
|
5052
|
+
requiredApiKeyRole?: ProjectApiKeyRole;
|
|
5053
|
+
visibility?: ExtensionVisibility;
|
|
5054
|
+
publicProjectTierAvailability?: PublicProjectTierAvailability;
|
|
5055
|
+
indBlockNoLongerAvailable?: boolean;
|
|
5056
|
+
blockNoLongerAvailableReason?: string;
|
|
5057
|
+
};
|
|
5000
5058
|
export type OrganizationBlocksApiOpts = {
|
|
5001
5059
|
extraHeaders?: Record<string, string>;
|
|
5002
5060
|
};
|
|
@@ -5058,6 +5116,29 @@ export class OrganizationBlocksApi {
|
|
|
5058
5116
|
[name: string]: string;
|
|
5059
5117
|
};
|
|
5060
5118
|
}): Promise<EntityCreatedResponse>;
|
|
5119
|
+
/**
|
|
5120
|
+
* Adds an extension block.
|
|
5121
|
+
* @summary Add extension block
|
|
5122
|
+
* @param organizationId Organization ID
|
|
5123
|
+
* @param name Extension block name.
|
|
5124
|
+
* @param description Extension block description.
|
|
5125
|
+
* @param url URL loaded by the extension.
|
|
5126
|
+
* @param navbarLocation Studio navigation location for the extension.
|
|
5127
|
+
* @param requiredApiKeyRole
|
|
5128
|
+
* @param onlyAvailableInProjectId Required if \\\"visibility\\\" is \\\"project\\\". If set, this extension is scoped to this specific project.
|
|
5129
|
+
* @param repositoryUrl Optional source repository URL for the extension.
|
|
5130
|
+
* @param logo Optional logo image for the extension.
|
|
5131
|
+
* @param navbarIcon Optional Font Awesome icon class for the navigation item.
|
|
5132
|
+
* @param visibility
|
|
5133
|
+
* @param publicProjectTierAvailability
|
|
5134
|
+
* @param indBlockNoLongerAvailable Whether this extension is no longer available.
|
|
5135
|
+
* @param blockNoLongerAvailableReason Reason this extension is no longer available.
|
|
5136
|
+
*/
|
|
5137
|
+
addOrganizationExtensionBlock(organizationId: number, params: addOrganizationExtensionBlockFormParams, options?: {
|
|
5138
|
+
headers: {
|
|
5139
|
+
[name: string]: string;
|
|
5140
|
+
};
|
|
5141
|
+
}): Promise<EntityCreatedResponse>;
|
|
5061
5142
|
/**
|
|
5062
5143
|
* Adds a secret.
|
|
5063
5144
|
* @summary Add secret
|
|
@@ -5113,6 +5194,17 @@ export class OrganizationBlocksApi {
|
|
|
5113
5194
|
[name: string]: string;
|
|
5114
5195
|
};
|
|
5115
5196
|
}): Promise<GenericApiResponse>;
|
|
5197
|
+
/**
|
|
5198
|
+
* Deletes an extension block.
|
|
5199
|
+
* @summary Delete extension block
|
|
5200
|
+
* @param organizationId Organization ID
|
|
5201
|
+
* @param extensionId Extension ID
|
|
5202
|
+
*/
|
|
5203
|
+
deleteOrganizationExtensionBlock(organizationId: number, extensionId: number, options?: {
|
|
5204
|
+
headers: {
|
|
5205
|
+
[name: string]: string;
|
|
5206
|
+
};
|
|
5207
|
+
}): Promise<GenericApiResponse>;
|
|
5116
5208
|
/**
|
|
5117
5209
|
* Deletes a secret
|
|
5118
5210
|
* @summary Delete secret
|
|
@@ -5212,6 +5304,17 @@ export class OrganizationBlocksApi {
|
|
|
5212
5304
|
[name: string]: string;
|
|
5213
5305
|
};
|
|
5214
5306
|
}): Promise<GetOrganizationDspBlockResponse>;
|
|
5307
|
+
/**
|
|
5308
|
+
* Gets an extension block.
|
|
5309
|
+
* @summary Get extension block
|
|
5310
|
+
* @param organizationId Organization ID
|
|
5311
|
+
* @param extensionId Extension ID
|
|
5312
|
+
*/
|
|
5313
|
+
getOrganizationExtensionBlock(organizationId: number, extensionId: number, options?: {
|
|
5314
|
+
headers: {
|
|
5315
|
+
[name: string]: string;
|
|
5316
|
+
};
|
|
5317
|
+
}): Promise<GetOrganizationExtensionBlockResponse>;
|
|
5215
5318
|
/**
|
|
5216
5319
|
* Gets a transfer learning block.
|
|
5217
5320
|
* @summary Get transfer learning block
|
|
@@ -5265,6 +5368,16 @@ export class OrganizationBlocksApi {
|
|
|
5265
5368
|
[name: string]: string;
|
|
5266
5369
|
};
|
|
5267
5370
|
}): Promise<ListOrganizationDspBlocksResponse>;
|
|
5371
|
+
/**
|
|
5372
|
+
* Retrieve all extension blocks for this organization.
|
|
5373
|
+
* @summary Get extension blocks
|
|
5374
|
+
* @param organizationId Organization ID
|
|
5375
|
+
*/
|
|
5376
|
+
listOrganizationExtensionBlocks(organizationId: number, options?: {
|
|
5377
|
+
headers: {
|
|
5378
|
+
[name: string]: string;
|
|
5379
|
+
};
|
|
5380
|
+
}): Promise<ListOrganizationExtensionBlocksResponse>;
|
|
5268
5381
|
/**
|
|
5269
5382
|
* Retrieve all secrets.
|
|
5270
5383
|
* @summary Get secrets
|
|
@@ -5356,6 +5469,30 @@ export class OrganizationBlocksApi {
|
|
|
5356
5469
|
[name: string]: string;
|
|
5357
5470
|
};
|
|
5358
5471
|
}): Promise<GenericApiResponse>;
|
|
5472
|
+
/**
|
|
5473
|
+
* Updates an extension block. Only values in the body will be updated.
|
|
5474
|
+
* @summary Update extension block
|
|
5475
|
+
* @param organizationId Organization ID
|
|
5476
|
+
* @param extensionId Extension ID
|
|
5477
|
+
* @param name Extension block name.
|
|
5478
|
+
* @param onlyAvailableInProjectId Required if \\\"visibility\\\" is \\\"project\\\". If set, this extension is scoped to this specific project.
|
|
5479
|
+
* @param description Extension block description.
|
|
5480
|
+
* @param url URL loaded by the extension.
|
|
5481
|
+
* @param repositoryUrl Optional source repository URL for the extension.
|
|
5482
|
+
* @param logo Optional logo image for the extension.
|
|
5483
|
+
* @param navbarIcon Optional Font Awesome icon class for the navigation item.
|
|
5484
|
+
* @param navbarLocation Studio navigation location for the extension.
|
|
5485
|
+
* @param requiredApiKeyRole
|
|
5486
|
+
* @param visibility
|
|
5487
|
+
* @param publicProjectTierAvailability
|
|
5488
|
+
* @param indBlockNoLongerAvailable Whether this extension is no longer available.
|
|
5489
|
+
* @param blockNoLongerAvailableReason Reason this extension is no longer available.
|
|
5490
|
+
*/
|
|
5491
|
+
updateOrganizationExtensionBlock(organizationId: number, extensionId: number, params: updateOrganizationExtensionBlockFormParams, options?: {
|
|
5492
|
+
headers: {
|
|
5493
|
+
[name: string]: string;
|
|
5494
|
+
};
|
|
5495
|
+
}): Promise<GenericApiResponse>;
|
|
5359
5496
|
/**
|
|
5360
5497
|
* Updates a transfer learning block. Only values in the body will be updated.
|
|
5361
5498
|
* @summary Update transfer learning block
|
|
@@ -5820,6 +5957,17 @@ export class OrganizationDataApi {
|
|
|
5820
5957
|
[name: string]: string;
|
|
5821
5958
|
};
|
|
5822
5959
|
}): Promise<StartJobResponse>;
|
|
5960
|
+
/**
|
|
5961
|
+
* Create a new storage bucket in the Edge Impulse infra. This API is only available through JWT token authentication.
|
|
5962
|
+
* @summary Create storage bucket
|
|
5963
|
+
* @param organizationId Organization ID
|
|
5964
|
+
* @param createOrganizationBucketRequest
|
|
5965
|
+
*/
|
|
5966
|
+
createOrganizationBucket(organizationId: number, createOrganizationBucketRequest: CreateOrganizationBucketRequest, options?: {
|
|
5967
|
+
headers: {
|
|
5968
|
+
[name: string]: string;
|
|
5969
|
+
};
|
|
5970
|
+
}): Promise<CreateOrganizationBucketResponse>;
|
|
5823
5971
|
/**
|
|
5824
5972
|
* Creates a signed link to securely upload data to s3 bucket directly from the client.
|
|
5825
5973
|
* @summary Create pre-signed S3 upload link
|
|
@@ -8274,6 +8422,17 @@ export class ProjectsApi {
|
|
|
8274
8422
|
[name: string]: string;
|
|
8275
8423
|
};
|
|
8276
8424
|
}): Promise<EntityCreatedResponse>;
|
|
8425
|
+
/**
|
|
8426
|
+
* Adds an extension to a project. This API is only available through JWT token authentication.
|
|
8427
|
+
* @summary Add extension to project
|
|
8428
|
+
* @param projectId Project ID
|
|
8429
|
+
* @param addProjectActiveExtensionRequest
|
|
8430
|
+
*/
|
|
8431
|
+
addProjectActiveExtension(projectId: number, addProjectActiveExtensionRequest: AddProjectActiveExtensionRequest, options?: {
|
|
8432
|
+
headers: {
|
|
8433
|
+
[name: string]: string;
|
|
8434
|
+
};
|
|
8435
|
+
}): Promise<GenericApiResponse>;
|
|
8277
8436
|
/**
|
|
8278
8437
|
* Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key. For OAuth-based third-party integrations, prefer `/api/{projectId}/apikeys/ingestiononly`.
|
|
8279
8438
|
* @summary Add API key
|
|
@@ -8432,6 +8591,15 @@ export class ProjectsApi {
|
|
|
8432
8591
|
[name: string]: string;
|
|
8433
8592
|
};
|
|
8434
8593
|
}): Promise<GetCsvWizardUploadedFileInfo>;
|
|
8594
|
+
/**
|
|
8595
|
+
* Only available when authenticating with a project API key. Returns the current role and project ID that you\'re authenticated with.
|
|
8596
|
+
* @summary Get info about current API key
|
|
8597
|
+
*/
|
|
8598
|
+
getCurrentApiKeyInfo(options?: {
|
|
8599
|
+
headers: {
|
|
8600
|
+
[name: string]: string;
|
|
8601
|
+
};
|
|
8602
|
+
}): Promise<GetCurrentApiKeyInfoResponse>;
|
|
8435
8603
|
/**
|
|
8436
8604
|
* Retrieve the HMAC development key for a project. This key are specifically marked to be used during development. This key can be `undefined` if no development keys are set.
|
|
8437
8605
|
* @summary Get HMAC development key
|
|
@@ -8463,6 +8631,16 @@ export class ProjectsApi {
|
|
|
8463
8631
|
[name: string]: string;
|
|
8464
8632
|
};
|
|
8465
8633
|
}): Promise<GetAIActionResponse>;
|
|
8634
|
+
/**
|
|
8635
|
+
* Lists all extensions that are active for this project.
|
|
8636
|
+
* @summary List active extensions
|
|
8637
|
+
* @param projectId Project ID
|
|
8638
|
+
*/
|
|
8639
|
+
getProjectActiveExtensions(projectId: number, options?: {
|
|
8640
|
+
headers: {
|
|
8641
|
+
[name: string]: string;
|
|
8642
|
+
};
|
|
8643
|
+
}): Promise<GetProjectActiveExtensionsResponse>;
|
|
8466
8644
|
/**
|
|
8467
8645
|
* Get a list of axes that are present in the training data.
|
|
8468
8646
|
* @summary Get data axes summary
|
|
@@ -8629,6 +8807,16 @@ export class ProjectsApi {
|
|
|
8629
8807
|
[name: string]: string;
|
|
8630
8808
|
};
|
|
8631
8809
|
}): Promise<ListApiKeysResponse>;
|
|
8810
|
+
/**
|
|
8811
|
+
* Lists all available extensions that can be added to this project.
|
|
8812
|
+
* @summary List available extensions
|
|
8813
|
+
* @param projectId Project ID
|
|
8814
|
+
*/
|
|
8815
|
+
listProjectAvailableExtensions(projectId: number, options?: {
|
|
8816
|
+
headers: {
|
|
8817
|
+
[name: string]: string;
|
|
8818
|
+
};
|
|
8819
|
+
}): Promise<ListProjectAvailableExtensionsResponse>;
|
|
8632
8820
|
/**
|
|
8633
8821
|
* Retrieve all HMAC keys.
|
|
8634
8822
|
* @summary Get HMAC keys
|
|
@@ -8736,6 +8924,17 @@ export class ProjectsApi {
|
|
|
8736
8924
|
[name: string]: string;
|
|
8737
8925
|
};
|
|
8738
8926
|
}): Promise<GenericApiResponse>;
|
|
8927
|
+
/**
|
|
8928
|
+
* Removes an existing extension from a project.
|
|
8929
|
+
* @summary Remove extension from project
|
|
8930
|
+
* @param projectId Project ID
|
|
8931
|
+
* @param extensionId Extension ID
|
|
8932
|
+
*/
|
|
8933
|
+
removeProjectActiveExtension(projectId: number, extensionId: number, options?: {
|
|
8934
|
+
headers: {
|
|
8935
|
+
[name: string]: string;
|
|
8936
|
+
};
|
|
8937
|
+
}): Promise<RemoveProjectActiveExtensionResponse>;
|
|
8739
8938
|
/**
|
|
8740
8939
|
* Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
|
|
8741
8940
|
* @summary Revoke API key
|
|
@@ -11686,6 +11885,7 @@ export type ActorProjectApiKey = {
|
|
|
11686
11885
|
* OAuth client_id that created this API key through an OAuth-scoped key endpoint.
|
|
11687
11886
|
*/
|
|
11688
11887
|
createdViaOAuthClientId?: string;
|
|
11888
|
+
createdForExtension?: ApiKeyExtension;
|
|
11689
11889
|
type: ActorProjectApiKeyTypeEnum;
|
|
11690
11890
|
};
|
|
11691
11891
|
export type ActorProjectApiKeyRoleEnum = 'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment' | 'wladmin';
|
|
@@ -11955,6 +12155,62 @@ export type AddOrganizationDspBlockRequest = {
|
|
|
11955
12155
|
};
|
|
11956
12156
|
|
|
11957
12157
|
|
|
12158
|
+
export type AddOrganizationExtensionBlockRequest = {
|
|
12159
|
+
/**
|
|
12160
|
+
* Extension block name.
|
|
12161
|
+
*/
|
|
12162
|
+
name: string;
|
|
12163
|
+
/**
|
|
12164
|
+
* Required if "visibility" is "project". If set, this extension is scoped to this specific project.
|
|
12165
|
+
*/
|
|
12166
|
+
onlyAvailableInProjectId?: number | null;
|
|
12167
|
+
/**
|
|
12168
|
+
* Extension block description.
|
|
12169
|
+
*/
|
|
12170
|
+
description: string;
|
|
12171
|
+
/**
|
|
12172
|
+
* URL loaded by the extension.
|
|
12173
|
+
*/
|
|
12174
|
+
url: string;
|
|
12175
|
+
/**
|
|
12176
|
+
* Optional source repository URL for the extension.
|
|
12177
|
+
*/
|
|
12178
|
+
repositoryUrl?: string;
|
|
12179
|
+
/**
|
|
12180
|
+
* Optional logo image for the extension.
|
|
12181
|
+
*/
|
|
12182
|
+
logo?: {
|
|
12183
|
+
fieldname: string;
|
|
12184
|
+
originalname: string;
|
|
12185
|
+
encoding: string;
|
|
12186
|
+
mimetype: string;
|
|
12187
|
+
buffer: ArrayBuffer;
|
|
12188
|
+
size: number;
|
|
12189
|
+
}[];
|
|
12190
|
+
/**
|
|
12191
|
+
* Optional Font Awesome icon class for the navigation item.
|
|
12192
|
+
*/
|
|
12193
|
+
navbarIcon?: string;
|
|
12194
|
+
/**
|
|
12195
|
+
* Studio navigation location for the extension.
|
|
12196
|
+
*/
|
|
12197
|
+
navbarLocation: AddOrganizationExtensionBlockRequestNavbarLocationEnum;
|
|
12198
|
+
requiredApiKeyRole: ProjectApiKeyRole;
|
|
12199
|
+
visibility?: ExtensionVisibility;
|
|
12200
|
+
publicProjectTierAvailability?: PublicProjectTierAvailability;
|
|
12201
|
+
/**
|
|
12202
|
+
* Whether this extension is no longer available.
|
|
12203
|
+
*/
|
|
12204
|
+
indBlockNoLongerAvailable?: boolean;
|
|
12205
|
+
/**
|
|
12206
|
+
* Reason this extension is no longer available.
|
|
12207
|
+
*/
|
|
12208
|
+
blockNoLongerAvailableReason?: string;
|
|
12209
|
+
};
|
|
12210
|
+
export type AddOrganizationExtensionBlockRequestNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
|
|
12211
|
+
export const AddOrganizationExtensionBlockRequestNavbarLocationEnumValues: string[];
|
|
12212
|
+
|
|
12213
|
+
|
|
11958
12214
|
export type AddOrganizationSecretRequest = {
|
|
11959
12215
|
name: string;
|
|
11960
12216
|
description: string;
|
|
@@ -12078,6 +12334,11 @@ export type AddOrganizationTransformationBlockRequestOperatesOnEnum = 'file' | '
|
|
|
12078
12334
|
export const AddOrganizationTransformationBlockRequestOperatesOnEnumValues: string[];
|
|
12079
12335
|
|
|
12080
12336
|
|
|
12337
|
+
export type AddProjectActiveExtensionRequest = {
|
|
12338
|
+
extensionId: number;
|
|
12339
|
+
};
|
|
12340
|
+
|
|
12341
|
+
|
|
12081
12342
|
export type AddProjectApiKeyRequest = {
|
|
12082
12343
|
/**
|
|
12083
12344
|
* Description of the key
|
|
@@ -12092,14 +12353,16 @@ export type AddProjectApiKeyRequest = {
|
|
|
12092
12353
|
* Whether this key should be used as a development key.
|
|
12093
12354
|
*/
|
|
12094
12355
|
isDevelopmentKey: boolean;
|
|
12095
|
-
role:
|
|
12356
|
+
role: ProjectApiKeyRole;
|
|
12096
12357
|
/**
|
|
12097
12358
|
* Optional: time to live in seconds.
|
|
12098
12359
|
*/
|
|
12099
12360
|
ttl?: number;
|
|
12361
|
+
/**
|
|
12362
|
+
* Optional: extension ID when this API key is created for a project extension.
|
|
12363
|
+
*/
|
|
12364
|
+
extensionId?: number;
|
|
12100
12365
|
};
|
|
12101
|
-
export type AddProjectApiKeyRequestRoleEnum = 'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment';
|
|
12102
|
-
export const AddProjectApiKeyRequestRoleEnumValues: string[];
|
|
12103
12366
|
|
|
12104
12367
|
|
|
12105
12368
|
export type AdditionalMetric = {
|
|
@@ -13370,6 +13633,12 @@ export type AnomalyTrainedFeaturesResponse = {
|
|
|
13370
13633
|
};
|
|
13371
13634
|
|
|
13372
13635
|
|
|
13636
|
+
export type ApiKeyExtension = {
|
|
13637
|
+
id: number;
|
|
13638
|
+
name: string;
|
|
13639
|
+
};
|
|
13640
|
+
|
|
13641
|
+
|
|
13373
13642
|
/**
|
|
13374
13643
|
* Specifies limits for your specific application, as available RAM and ROM for the model's operation and the maximum
|
|
13375
13644
|
* allowed latency.
|
|
@@ -13673,6 +13942,34 @@ export type BuildOrganizationOnDeviceModelRequest = {
|
|
|
13673
13942
|
};
|
|
13674
13943
|
|
|
13675
13944
|
|
|
13945
|
+
export type BuildPublicDeploymentJobRequest = {
|
|
13946
|
+
deploymentType: string;
|
|
13947
|
+
modelType: KerasModelVariantEnum;
|
|
13948
|
+
};
|
|
13949
|
+
|
|
13950
|
+
|
|
13951
|
+
export type BuildPublicDeploymentJobResponse = {
|
|
13952
|
+
/**
|
|
13953
|
+
* Whether the operation succeeded
|
|
13954
|
+
*/
|
|
13955
|
+
success: boolean;
|
|
13956
|
+
/**
|
|
13957
|
+
* Optional error description (set if 'success' was false)
|
|
13958
|
+
*/
|
|
13959
|
+
error?: string;
|
|
13960
|
+
/**
|
|
13961
|
+
* Set if a job was created (or was already running) for this deployment. Use this ID to poll to the job logs via
|
|
13962
|
+
* 'GetPublicDeploymentStatusResponse'.
|
|
13963
|
+
*/
|
|
13964
|
+
jobId?: number;
|
|
13965
|
+
/**
|
|
13966
|
+
* Deployment version. Use `downloadHistoricDeployment` to download the deployment using this identifier (once the
|
|
13967
|
+
* job is finished).
|
|
13968
|
+
*/
|
|
13969
|
+
deploymentVersion: number;
|
|
13970
|
+
};
|
|
13971
|
+
|
|
13972
|
+
|
|
13676
13973
|
export type CalculateDataQualityMetricsRequest = {
|
|
13677
13974
|
/**
|
|
13678
13975
|
* Type of representation to use for calculating metrics.
|
|
@@ -14352,6 +14649,31 @@ export type CreateNewEmptyImpulseResponse = {
|
|
|
14352
14649
|
};
|
|
14353
14650
|
|
|
14354
14651
|
|
|
14652
|
+
export type CreateOrganizationBucketRequest = {
|
|
14653
|
+
name: string;
|
|
14654
|
+
};
|
|
14655
|
+
|
|
14656
|
+
|
|
14657
|
+
export type CreateOrganizationBucketResponse = {
|
|
14658
|
+
/**
|
|
14659
|
+
* Whether the operation succeeded
|
|
14660
|
+
*/
|
|
14661
|
+
success: boolean;
|
|
14662
|
+
/**
|
|
14663
|
+
* Optional error description (set if 'success' was false)
|
|
14664
|
+
*/
|
|
14665
|
+
error?: string;
|
|
14666
|
+
/**
|
|
14667
|
+
* Unique identifier of the created entity.
|
|
14668
|
+
*/
|
|
14669
|
+
id: number;
|
|
14670
|
+
/**
|
|
14671
|
+
* Newly created bucket name
|
|
14672
|
+
*/
|
|
14673
|
+
bucket: string;
|
|
14674
|
+
};
|
|
14675
|
+
|
|
14676
|
+
|
|
14355
14677
|
export type CreateOrganizationPortalRequest = {
|
|
14356
14678
|
/**
|
|
14357
14679
|
* The name of the upload portal.
|
|
@@ -16070,6 +16392,10 @@ export type DeploymentHistory = {
|
|
|
16070
16392
|
*/
|
|
16071
16393
|
impulseHasChangedSinceDeployment: boolean;
|
|
16072
16394
|
downloadUrl: string;
|
|
16395
|
+
/**
|
|
16396
|
+
* If set, then this deployment was created by an anonymous user through buildPublicDeploymentJob.
|
|
16397
|
+
*/
|
|
16398
|
+
createdByBuildPublicDeploymentJob: boolean;
|
|
16073
16399
|
};
|
|
16074
16400
|
|
|
16075
16401
|
|
|
@@ -17110,6 +17436,48 @@ export type ExportWavDataRequest = {
|
|
|
17110
17436
|
};
|
|
17111
17437
|
|
|
17112
17438
|
|
|
17439
|
+
export type Extension = {
|
|
17440
|
+
id: number;
|
|
17441
|
+
ownerOrganizationId: number;
|
|
17442
|
+
ownerOrganizationName: string;
|
|
17443
|
+
onlyAvailableInProjectId?: number;
|
|
17444
|
+
name: string;
|
|
17445
|
+
created: Date;
|
|
17446
|
+
createdByUser?: CreatedUpdatedByUser;
|
|
17447
|
+
description: string;
|
|
17448
|
+
visibility: ExtensionVisibility;
|
|
17449
|
+
publicProjectTierAvailability: PublicProjectTierAvailability;
|
|
17450
|
+
url: string;
|
|
17451
|
+
repositoryUrl?: string;
|
|
17452
|
+
navbarLocation: ExtensionNavbarLocationEnum;
|
|
17453
|
+
lastUpdated: Date;
|
|
17454
|
+
lastUpdatedByUser?: CreatedUpdatedByUser;
|
|
17455
|
+
/**
|
|
17456
|
+
* If set, then this block is no longer available; and blockNoLongerAvailableReason will be set.
|
|
17457
|
+
*/
|
|
17458
|
+
indBlockNoLongerAvailable: boolean;
|
|
17459
|
+
/**
|
|
17460
|
+
* In Markdown format. Set if `indBlockNoLongerAvailable` is true, contains migration information for existing users
|
|
17461
|
+
* of this block.
|
|
17462
|
+
*/
|
|
17463
|
+
blockNoLongerAvailableReason?: string;
|
|
17464
|
+
logo?: string;
|
|
17465
|
+
navbarIcon?: string;
|
|
17466
|
+
requiredApiKeyRole: ProjectApiKeyRole;
|
|
17467
|
+
};
|
|
17468
|
+
export type ExtensionNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
|
|
17469
|
+
export const ExtensionNavbarLocationEnumValues: string[];
|
|
17470
|
+
|
|
17471
|
+
|
|
17472
|
+
/**
|
|
17473
|
+
* Whether this block is available for a single project (onlyAvailableInProjectId will be set), for your whole
|
|
17474
|
+
* organization, or for everyone in Edge Impulse (if so, publicProjectTierAvailability can be used to limit availability
|
|
17475
|
+
* scope). If not specified, this will default to 'organization'.
|
|
17476
|
+
*/
|
|
17477
|
+
export type ExtensionVisibility = 'project' | 'organization' | 'everyone';
|
|
17478
|
+
export const ExtensionVisibilityValues: string[];
|
|
17479
|
+
|
|
17480
|
+
|
|
17113
17481
|
/**
|
|
17114
17482
|
* Known feature identifiers.
|
|
17115
17483
|
*/
|
|
@@ -17402,6 +17770,21 @@ export type GetCsvWizardUploadedFileInfo = {
|
|
|
17402
17770
|
};
|
|
17403
17771
|
|
|
17404
17772
|
|
|
17773
|
+
export type GetCurrentApiKeyInfoResponse = {
|
|
17774
|
+
/**
|
|
17775
|
+
* Whether the operation succeeded
|
|
17776
|
+
*/
|
|
17777
|
+
success: boolean;
|
|
17778
|
+
/**
|
|
17779
|
+
* Optional error description (set if 'success' was false)
|
|
17780
|
+
*/
|
|
17781
|
+
error?: string;
|
|
17782
|
+
apiKeyId: number;
|
|
17783
|
+
projectId: number;
|
|
17784
|
+
role: ProjectApiKeyRole;
|
|
17785
|
+
};
|
|
17786
|
+
|
|
17787
|
+
|
|
17405
17788
|
export type GetDataExplorerFeaturesResponse = {
|
|
17406
17789
|
/**
|
|
17407
17790
|
* Whether the operation succeeded
|
|
@@ -18183,6 +18566,19 @@ export type GetOrganizationDspBlockResponse = {
|
|
|
18183
18566
|
};
|
|
18184
18567
|
|
|
18185
18568
|
|
|
18569
|
+
export type GetOrganizationExtensionBlockResponse = {
|
|
18570
|
+
/**
|
|
18571
|
+
* Whether the operation succeeded
|
|
18572
|
+
*/
|
|
18573
|
+
success: boolean;
|
|
18574
|
+
/**
|
|
18575
|
+
* Optional error description (set if 'success' was false)
|
|
18576
|
+
*/
|
|
18577
|
+
error?: string;
|
|
18578
|
+
extensionBlock: Extension;
|
|
18579
|
+
};
|
|
18580
|
+
|
|
18581
|
+
|
|
18186
18582
|
export type GetOrganizationPipelinesResponse = {
|
|
18187
18583
|
/**
|
|
18188
18584
|
* Whether the operation succeeded
|
|
@@ -18467,6 +18863,53 @@ export type GetPretrainedModelResponse = {
|
|
|
18467
18863
|
};
|
|
18468
18864
|
|
|
18469
18865
|
|
|
18866
|
+
export type GetProjectActiveExtensionsResponse = {
|
|
18867
|
+
/**
|
|
18868
|
+
* Whether the operation succeeded
|
|
18869
|
+
*/
|
|
18870
|
+
success: boolean;
|
|
18871
|
+
/**
|
|
18872
|
+
* Optional error description (set if 'success' was false)
|
|
18873
|
+
*/
|
|
18874
|
+
error?: string;
|
|
18875
|
+
extensions: ProjectExtension[];
|
|
18876
|
+
};
|
|
18877
|
+
|
|
18878
|
+
|
|
18879
|
+
export type GetPublicDeploymentStatusResponse = {
|
|
18880
|
+
/**
|
|
18881
|
+
* Whether the operation succeeded
|
|
18882
|
+
*/
|
|
18883
|
+
success: boolean;
|
|
18884
|
+
/**
|
|
18885
|
+
* Optional error description (set if 'success' was false)
|
|
18886
|
+
*/
|
|
18887
|
+
error?: string;
|
|
18888
|
+
job: {
|
|
18889
|
+
/**
|
|
18890
|
+
* When the job was created.
|
|
18891
|
+
*/
|
|
18892
|
+
created: Date;
|
|
18893
|
+
/**
|
|
18894
|
+
* When the job was started.
|
|
18895
|
+
*/
|
|
18896
|
+
started?: Date;
|
|
18897
|
+
/**
|
|
18898
|
+
* When the job was finished.
|
|
18899
|
+
*/
|
|
18900
|
+
finished?: Date;
|
|
18901
|
+
/**
|
|
18902
|
+
* Whether the job finished successfully. (Set to null if job is not finished)
|
|
18903
|
+
*/
|
|
18904
|
+
finishedSuccessful?: boolean;
|
|
18905
|
+
};
|
|
18906
|
+
/**
|
|
18907
|
+
* Last 1000 log lines for this job.
|
|
18908
|
+
*/
|
|
18909
|
+
logs: JobLogItem[];
|
|
18910
|
+
};
|
|
18911
|
+
|
|
18912
|
+
|
|
18470
18913
|
export type GetPublicMetricsResponse = {
|
|
18471
18914
|
/**
|
|
18472
18915
|
* Whether the operation succeeded
|
|
@@ -19572,6 +20015,15 @@ export type JobFailureDetails = {
|
|
|
19572
20015
|
};
|
|
19573
20016
|
|
|
19574
20017
|
|
|
20018
|
+
export type JobLogItem = {
|
|
20019
|
+
created: Date;
|
|
20020
|
+
data: string;
|
|
20021
|
+
logLevel?: JobLogItemLogLevelEnum;
|
|
20022
|
+
};
|
|
20023
|
+
export type JobLogItemLogLevelEnum = 'error' | 'warn' | 'info' | 'debug';
|
|
20024
|
+
export const JobLogItemLogLevelEnumValues: string[];
|
|
20025
|
+
|
|
20026
|
+
|
|
19575
20027
|
export type JobLogsResponse = {
|
|
19576
20028
|
/**
|
|
19577
20029
|
* Whether the operation succeeded
|
|
@@ -19581,7 +20033,7 @@ export type JobLogsResponse = {
|
|
|
19581
20033
|
* Optional error description (set if 'success' was false)
|
|
19582
20034
|
*/
|
|
19583
20035
|
error?: string;
|
|
19584
|
-
logs:
|
|
20036
|
+
logs: JobLogItem[];
|
|
19585
20037
|
};
|
|
19586
20038
|
|
|
19587
20039
|
|
|
@@ -20590,6 +21042,19 @@ export type ListOrganizationDspBlocksResponse = {
|
|
|
20590
21042
|
};
|
|
20591
21043
|
|
|
20592
21044
|
|
|
21045
|
+
export type ListOrganizationExtensionBlocksResponse = {
|
|
21046
|
+
/**
|
|
21047
|
+
* Whether the operation succeeded
|
|
21048
|
+
*/
|
|
21049
|
+
success: boolean;
|
|
21050
|
+
/**
|
|
21051
|
+
* Optional error description (set if 'success' was false)
|
|
21052
|
+
*/
|
|
21053
|
+
error?: string;
|
|
21054
|
+
extensionBlocks: Extension[];
|
|
21055
|
+
};
|
|
21056
|
+
|
|
21057
|
+
|
|
20593
21058
|
export type ListOrganizationFilesResponse = {
|
|
20594
21059
|
/**
|
|
20595
21060
|
* Whether the operation succeeded
|
|
@@ -20753,6 +21218,23 @@ export type ListPortalFilesInFolderResponse = {
|
|
|
20753
21218
|
};
|
|
20754
21219
|
|
|
20755
21220
|
|
|
21221
|
+
export type ListProjectAvailableExtensionsResponse = {
|
|
21222
|
+
/**
|
|
21223
|
+
* Whether the operation succeeded
|
|
21224
|
+
*/
|
|
21225
|
+
success: boolean;
|
|
21226
|
+
/**
|
|
21227
|
+
* Optional error description (set if 'success' was false)
|
|
21228
|
+
*/
|
|
21229
|
+
error?: string;
|
|
21230
|
+
/**
|
|
21231
|
+
* This field will be removed once extensions are publicly available
|
|
21232
|
+
*/
|
|
21233
|
+
projectHasAccessToExtensions: boolean;
|
|
21234
|
+
extensions: Extension[];
|
|
21235
|
+
};
|
|
21236
|
+
|
|
21237
|
+
|
|
20756
21238
|
export type ListProjects = {
|
|
20757
21239
|
/**
|
|
20758
21240
|
* Array with projects
|
|
@@ -20989,7 +21471,7 @@ export type LogStdoutResponse = {
|
|
|
20989
21471
|
* Optional error description (set if 'success' was false)
|
|
20990
21472
|
*/
|
|
20991
21473
|
error?: string;
|
|
20992
|
-
stdout:
|
|
21474
|
+
stdout: JobLogItem[];
|
|
20993
21475
|
/**
|
|
20994
21476
|
* Total number of logs (only the last 1000 lines are returned)
|
|
20995
21477
|
*/
|
|
@@ -20997,15 +21479,6 @@ export type LogStdoutResponse = {
|
|
|
20997
21479
|
};
|
|
20998
21480
|
|
|
20999
21481
|
|
|
21000
|
-
export type LogStdoutResponseAllOfStdout = {
|
|
21001
|
-
created: Date;
|
|
21002
|
-
data: string;
|
|
21003
|
-
logLevel?: LogStdoutResponseAllOfStdoutLogLevelEnum;
|
|
21004
|
-
};
|
|
21005
|
-
export type LogStdoutResponseAllOfStdoutLogLevelEnum = 'error' | 'warn' | 'info' | 'debug';
|
|
21006
|
-
export const LogStdoutResponseAllOfStdoutLogLevelEnumValues: string[];
|
|
21007
|
-
|
|
21008
|
-
|
|
21009
21482
|
export type LogWebsitePageviewRequest = {
|
|
21010
21483
|
sessionId: string;
|
|
21011
21484
|
pageUrl: string;
|
|
@@ -23839,6 +24312,7 @@ export type ProjectApiKey = {
|
|
|
23839
24312
|
* OAuth client_id that created this API key through an OAuth-scoped key endpoint.
|
|
23840
24313
|
*/
|
|
23841
24314
|
createdViaOAuthClientId?: string;
|
|
24315
|
+
createdForExtension?: ApiKeyExtension;
|
|
23842
24316
|
};
|
|
23843
24317
|
export type ProjectApiKeyRoleEnum = 'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment' | 'wladmin';
|
|
23844
24318
|
export const ProjectApiKeyRoleEnumValues: string[];
|
|
@@ -23860,6 +24334,10 @@ export type ProjectApiKeyLastUsed = {
|
|
|
23860
24334
|
};
|
|
23861
24335
|
|
|
23862
24336
|
|
|
24337
|
+
export type ProjectApiKeyRole = 'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment';
|
|
24338
|
+
export const ProjectApiKeyRoleValues: string[];
|
|
24339
|
+
|
|
24340
|
+
|
|
23863
24341
|
export type ProjectCollaborator = {
|
|
23864
24342
|
id: number;
|
|
23865
24343
|
username: string;
|
|
@@ -24354,6 +24832,41 @@ export type ProjectDownloadsResponse = {
|
|
|
24354
24832
|
};
|
|
24355
24833
|
|
|
24356
24834
|
|
|
24835
|
+
export type ProjectExtension = {
|
|
24836
|
+
id: number;
|
|
24837
|
+
ownerOrganizationId: number;
|
|
24838
|
+
ownerOrganizationName: string;
|
|
24839
|
+
onlyAvailableInProjectId?: number;
|
|
24840
|
+
name: string;
|
|
24841
|
+
created: Date;
|
|
24842
|
+
createdByUser?: CreatedUpdatedByUser;
|
|
24843
|
+
description: string;
|
|
24844
|
+
visibility: ExtensionVisibility;
|
|
24845
|
+
publicProjectTierAvailability: PublicProjectTierAvailability;
|
|
24846
|
+
url: string;
|
|
24847
|
+
repositoryUrl?: string;
|
|
24848
|
+
navbarLocation: ProjectExtensionNavbarLocationEnum;
|
|
24849
|
+
lastUpdated: Date;
|
|
24850
|
+
lastUpdatedByUser?: CreatedUpdatedByUser;
|
|
24851
|
+
/**
|
|
24852
|
+
* If set, then this block is no longer available; and blockNoLongerAvailableReason will be set.
|
|
24853
|
+
*/
|
|
24854
|
+
indBlockNoLongerAvailable: boolean;
|
|
24855
|
+
/**
|
|
24856
|
+
* In Markdown format. Set if `indBlockNoLongerAvailable` is true, contains migration information for existing users
|
|
24857
|
+
* of this block.
|
|
24858
|
+
*/
|
|
24859
|
+
blockNoLongerAvailableReason?: string;
|
|
24860
|
+
logo?: string;
|
|
24861
|
+
navbarIcon?: string;
|
|
24862
|
+
requiredApiKeyRole: ProjectApiKeyRole;
|
|
24863
|
+
addedToProject: Date;
|
|
24864
|
+
addedToProjectByUser?: CreatedUpdatedByUser;
|
|
24865
|
+
};
|
|
24866
|
+
export type ProjectExtensionNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
|
|
24867
|
+
export const ProjectExtensionNavbarLocationEnumValues: string[];
|
|
24868
|
+
|
|
24869
|
+
|
|
24357
24870
|
export type ProjectHmacKey = {
|
|
24358
24871
|
id: number;
|
|
24359
24872
|
hmacKey: string;
|
|
@@ -24575,6 +25088,10 @@ export type ProjectInfoResponse = {
|
|
|
24575
25088
|
versioningStorageSizeMib?: number;
|
|
24576
25089
|
anomalyLabelsConfig?: AnomalyLabelsConfig;
|
|
24577
25090
|
datasetSplitOptions?: DatasetSplitOptions;
|
|
25091
|
+
/**
|
|
25092
|
+
* Whether this project has a first-class validation dataset alongside training and testing.
|
|
25093
|
+
*/
|
|
25094
|
+
explicitValidationEnabled?: boolean;
|
|
24578
25095
|
};
|
|
24579
25096
|
export type ProjectInfoResponseAllOfAcquisitionSettingsViewTypeEnum = 'list' | 'grid';
|
|
24580
25097
|
export const ProjectInfoResponseAllOfAcquisitionSettingsViewTypeEnumValues: string[];
|
|
@@ -25018,6 +25535,22 @@ export type RemoveMemberRequest = {
|
|
|
25018
25535
|
};
|
|
25019
25536
|
|
|
25020
25537
|
|
|
25538
|
+
export type RemoveProjectActiveExtensionResponse = {
|
|
25539
|
+
/**
|
|
25540
|
+
* Whether the operation succeeded
|
|
25541
|
+
*/
|
|
25542
|
+
success: boolean;
|
|
25543
|
+
/**
|
|
25544
|
+
* Optional error description (set if 'success' was false)
|
|
25545
|
+
*/
|
|
25546
|
+
error?: string;
|
|
25547
|
+
/**
|
|
25548
|
+
* Number of project API keys revoked while removing the extension.
|
|
25549
|
+
*/
|
|
25550
|
+
revokedProjectApiKeyCount: number;
|
|
25551
|
+
};
|
|
25552
|
+
|
|
25553
|
+
|
|
25021
25554
|
export type RenameDeviceRequest = {
|
|
25022
25555
|
/**
|
|
25023
25556
|
* New name for this device
|
|
@@ -25637,6 +26170,11 @@ export type SetKerasParameterRequest = {
|
|
|
25637
26170
|
lastShownModelVariant?: KerasModelVariantEnum;
|
|
25638
26171
|
blockParameters?: BlockParameters;
|
|
25639
26172
|
trainingProcessor?: ExperimentalImpulseSpecificGpuTrainingProcessor;
|
|
26173
|
+
/**
|
|
26174
|
+
* EXPERIMENTAL. When set, max GPU utilization will be checked against this threshold after training. Used for
|
|
26175
|
+
* testing purposes.
|
|
26176
|
+
*/
|
|
26177
|
+
assertGpuUsagePercentage?: number | null;
|
|
25640
26178
|
};
|
|
25641
26179
|
export type SetKerasParameterRequestModeEnum = 'expert' | 'visual';
|
|
25642
26180
|
export const SetKerasParameterRequestModeEnumValues: string[];
|
|
@@ -26079,7 +26617,7 @@ export type StopDeviceDebugStreamRequest = {
|
|
|
26079
26617
|
};
|
|
26080
26618
|
|
|
26081
26619
|
|
|
26082
|
-
export type StorageProvider = 's3' | 'google' | 'azure' | 'other';
|
|
26620
|
+
export type StorageProvider = 's3' | 'google' | 'azure' | 'other' | 'edgeimpulse';
|
|
26083
26621
|
export const StorageProviderValues: string[];
|
|
26084
26622
|
|
|
26085
26623
|
|
|
@@ -26973,6 +27511,62 @@ export type UpdateOrganizationDspBlockRequest = {
|
|
|
26973
27511
|
};
|
|
26974
27512
|
|
|
26975
27513
|
|
|
27514
|
+
export type UpdateOrganizationExtensionBlockRequest = {
|
|
27515
|
+
/**
|
|
27516
|
+
* Extension block name.
|
|
27517
|
+
*/
|
|
27518
|
+
name?: string;
|
|
27519
|
+
/**
|
|
27520
|
+
* Required if "visibility" is "project". If set, this extension is scoped to this specific project.
|
|
27521
|
+
*/
|
|
27522
|
+
onlyAvailableInProjectId?: number | null;
|
|
27523
|
+
/**
|
|
27524
|
+
* Extension block description.
|
|
27525
|
+
*/
|
|
27526
|
+
description?: string;
|
|
27527
|
+
/**
|
|
27528
|
+
* URL loaded by the extension.
|
|
27529
|
+
*/
|
|
27530
|
+
url?: string;
|
|
27531
|
+
/**
|
|
27532
|
+
* Optional source repository URL for the extension.
|
|
27533
|
+
*/
|
|
27534
|
+
repositoryUrl?: string;
|
|
27535
|
+
/**
|
|
27536
|
+
* Optional logo image for the extension.
|
|
27537
|
+
*/
|
|
27538
|
+
logo?: {
|
|
27539
|
+
fieldname: string;
|
|
27540
|
+
originalname: string;
|
|
27541
|
+
encoding: string;
|
|
27542
|
+
mimetype: string;
|
|
27543
|
+
buffer: ArrayBuffer;
|
|
27544
|
+
size: number;
|
|
27545
|
+
}[];
|
|
27546
|
+
/**
|
|
27547
|
+
* Optional Font Awesome icon class for the navigation item.
|
|
27548
|
+
*/
|
|
27549
|
+
navbarIcon?: string;
|
|
27550
|
+
/**
|
|
27551
|
+
* Studio navigation location for the extension.
|
|
27552
|
+
*/
|
|
27553
|
+
navbarLocation?: UpdateOrganizationExtensionBlockRequestNavbarLocationEnum;
|
|
27554
|
+
requiredApiKeyRole?: ProjectApiKeyRole;
|
|
27555
|
+
visibility?: ExtensionVisibility;
|
|
27556
|
+
publicProjectTierAvailability?: PublicProjectTierAvailability;
|
|
27557
|
+
/**
|
|
27558
|
+
* Whether this extension is no longer available.
|
|
27559
|
+
*/
|
|
27560
|
+
indBlockNoLongerAvailable?: boolean;
|
|
27561
|
+
/**
|
|
27562
|
+
* Reason this extension is no longer available.
|
|
27563
|
+
*/
|
|
27564
|
+
blockNoLongerAvailableReason?: string;
|
|
27565
|
+
};
|
|
27566
|
+
export type UpdateOrganizationExtensionBlockRequestNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
|
|
27567
|
+
export const UpdateOrganizationExtensionBlockRequestNavbarLocationEnumValues: string[];
|
|
27568
|
+
|
|
27569
|
+
|
|
26976
27570
|
export type UpdateOrganizationPortalResponse = {
|
|
26977
27571
|
/**
|
|
26978
27572
|
* Whether the operation succeeded
|
|
@@ -27311,6 +27905,10 @@ export type UpdateProjectRequest = {
|
|
|
27311
27905
|
lastShownModelEngine?: ModelEngineShortEnum;
|
|
27312
27906
|
versioningStorageSizeMib?: number;
|
|
27313
27907
|
anomalyLabelsConfig?: AnomalyLabelsConfig;
|
|
27908
|
+
/**
|
|
27909
|
+
* Enables a first-class validation dataset alongside training and testing.
|
|
27910
|
+
*/
|
|
27911
|
+
explicitValidationEnabled?: boolean;
|
|
27314
27912
|
};
|
|
27315
27913
|
export type UpdateProjectRequestSelectedProjectTypeInWizardEnum = 'accelerometer' | 'audio' | 'image_classification' | 'object_detection' | 'something_else';
|
|
27316
27914
|
export const UpdateProjectRequestSelectedProjectTypeInWizardEnumValues: string[];
|