@eyepop.ai/eyepop 1.9.1 → 1.10.0

package/README.md

@@ -1,98 +1,121 @@
 # EyePop.ai Node SDK
-The EyePop.ai Node SDK provides convenient access to the EyePop.ai's inference API from applications written in the 
+
+The EyePop.ai Node SDK provides convenient access to the EyePop.ai's inference API from applications written in the
 TypeScript or JavaScript language.
+
 ## Installation
+
 ### Node
+
 ```shell
 npm install --save @eyepop.ai/eyepop
 ```
+
 ### Browser
+
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@eyepop.ai/eyepop/dist/eyepop.min.js"></script>
 ```
+
 ## Configuration
-The EyePop SDK needs to be configured with the __Pop Id__ and your __Authentication Credentials__. Credentials can 
+
+The EyePop SDK needs to be configured with the **Pop Id** and your **Authentication Credentials**. Credentials can
 be provided as:
-1. __Api Key__, server side only because this key must be kept secret
-2. __Session generated from Api Key__, server side generated session transported to client over trusted channel
-3. __Current Browser Session__, for developer running client code in the same browser session loghed into their EyePop Dashboard.
+
+1. **Api Key**, server side only because this key must be kept secret
+2. **Session generated from Api Key**, server side generated session transported to client over trusted channel
+3. **Current Browser Session**, for developer running client code in the same browser session loghed into their EyePop Dashboard.
+
 ### Configuration via Environment (Server Side)
-While you can provide a secret_key keyword argument, we recommend using dotenv to add EYEPOP_SECRET_KEY="My API Key" 
+
+While you can provide a secret_key keyword argument, we recommend using dotenv to add EYEPOP_SECRET_KEY="My API Key"
 to your .env file so that your API Key is not stored in source control. By default, the SDK will read the following environment variables:
-* `EYEPOP_POP_ID`: The Pop Id to use as an endpoint. You can copy and paste this string from your EyePop Dashboard in the Pop -> Settings section.
-* `EYEPOP_SECRET_KEY`: Your Secret Api Key. You can create Api Keys in the profile section of your EyePop dashboard.
-* `EYEPOP_URL`: (Optional) URL of the EyePop API service, if you want to use any other endpoint than production `http://api.eyepop.ai`  
+
+-   `EYEPOP_POP_ID`: The Pop Id to use as an endpoint. You can copy and paste this string from your EyePop Dashboard in the Pop -> Settings section.
+-   `EYEPOP_SECRET_KEY`: Your Secret Api Key. You can create Api Keys in the profile section of your EyePop dashboard.
+-   `EYEPOP_URL`: (Optional) URL of the EyePop API service, if you want to use any other endpoint than production `http://api.eyepop.ai`
+
 ### Authentication with Api Key
+
 Configuration and authorization with explicit defaults:
+
 ```typescript
 import { EyePop } from '@eyepop.ai/eyepop'
-(async() => {
+;async () => {
     const endpoint = EyePop.workerEndpoint({
         // This is the default and can be omitted
         popId: process.env['EYEPOP_POP_ID'],
         // This is the default and can be omitted
-        auth : {secretKey: process.env['EYEPOP_SECRET_KEY']},
+        auth: { secretKey: process.env['EYEPOP_SECRET_KEY'] },
     })
     await endpoint.connect()
     // do work ....
     await endpoint.disconnect()
-})
+}
 ```
+
 Equivalent, but shorter:
+
 ```typescript
 import { EyePop } from '@eyepop.ai/eyepop'
-(async() => {
+;async () => {
     const endpoint = await EyePop.workerEndpoint().connect()
     // do work ....
     await endpoint.disconnect()
-})
+}
 ```
+
 ### Authentication with session generated from Api Key
+
 #### Server Side
 
 ```javascript
-import {EyePop} from '@eyepop.ai/eyepop'
+import { EyePop } from '@eyepop.ai/eyepop'
 
 const getSession = async function (req, res) {
-    const endpoint = await EyePop.workerEndpoint().connect();
-    res.setHeader("Content-Type", "application/json");
-    res.writeHead(200);
-    res.end(JSON.stringify(await endpoint.session()));
-};
-const server = http.createServer(getSession);
-server.listen(8080, '127.0.0.1');
+    const endpoint = await EyePop.workerEndpoint().connect()
+    res.setHeader('Content-Type', 'application/json')
+    res.writeHead(200)
+    res.end(JSON.stringify(await endpoint.session()))
+}
+const server = http.createServer(getSession)
+server.listen(8080, '127.0.0.1')
 ```
+
 #### Client Side
 
 ```javascript
-import {EyePop} from '@eyepop.ai/eyepop'
+import { EyePop } from '@eyepop.ai/eyepop'
 
-(async () => {
-    const session = await (await fetch("http://127.0.0.1:8080")).json();
-    const endpoint = await EyePop.workerEndpoint({auth: {session: session}}).connect();
+;(async () => {
+    const session = await (await fetch('http://127.0.0.1:8080')).json()
+    const endpoint = await EyePop.workerEndpoint({ auth: { session: session } }).connect()
     // do work ....
-    await endpoint.disconnect();
-})();
+    await endpoint.disconnect()
+})()
 ```
+
 ### Authentication with Current Browser Session
 
 ```html
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <script src="https://cdn.jsdelivr.net/npm/@eyepop.ai/eyepop/dist/eyepop.min.js"></script>
-</head>
-<body>
-<script>
-    document.addEventListener("DOMContentLoaded", async (event) => {
-        let endpoint = await EyePop.workerEndpoint({auth: {oAuth2: true}, popId: '< Pop Id>'}).connect();
-        // do work ....
-        await endpoint.disconnect();
-    });
-</script>
-</body>
+    <head>
+        <meta charset="UTF-8" />
+        <script src="https://cdn.jsdelivr.net/npm/@eyepop.ai/eyepop/dist/eyepop.min.js"></script>
+    </head>
+    <body>
+        <script>
+            document.addEventListener('DOMContentLoaded', async event => {
+                let endpoint = await EyePop.workerEndpoint({ auth: { oAuth2: true }, popId: '< Pop Id>' }).connect()
+                // do work ....
+                await endpoint.disconnect()
+            })
+        </script>
+    </body>
+</html>
 ```
+
 To use an alternative environment, e.g. STAGING vs PRODUCTION, pass in the adjusted Auth0 configuration:
 
 ```javascript
@@ -100,72 +123,83 @@ To use an alternative environment, e.g. STAGING vs PRODUCTION, pass in the adjus
 let endpoint = await EyePop.workerEndpoint({
     auth: {
         oAuth2: {
-            audience: "https://dev-app.eyepop.ai",
-            domain: "dev-eyepop.us.auth0.com",
-            clientId: "jktx3YO2UnbkNPvr05PQWf26t1kNTJyg"
-        }
-    }, popId: '< Pop Id>'
-}).connect();
+            audience: 'https://dev-app.eyepop.ai',
+            domain: 'dev-eyepop.us.auth0.com',
+            clientId: 'jktx3YO2UnbkNPvr05PQWf26t1kNTJyg',
+        },
+    },
+    popId: '< Pop Id>',
+}).connect()
 // ...
 ```
+
 ## Usage Examples
+
 ### Uploading and processing one single image
+
 ```typescript
 import { EyePop } from '@eyepop.ai/eyepop'
 
-const example_image_path = 'examples/example.jpg';
+const example_image_path = 'examples/example.jpg'
 
-(async() => {
+;(async () => {
     const endpoint = await EyePop.workerEndpoint().connect()
     try {
-        let results = await endpoint.process({path: example_image_path})
+        let results = await endpoint.process({ path: example_image_path })
         for await (let result of results) {
             console.log(result)
-        }        
+        }
     } finally {
         await endpoint.disconnect()
     }
-})();
+})()
 ```
-1. `EyePop.workerEndpoint()` returns a local endpoint object, that will authenticate with the Api Key found in 
-EYEPOP_SECRET_KEY and load the worker configuration for the Pop identified by EYEPOP_POP_ID.  
+
+1. `EyePop.workerEndpoint()` returns a local endpoint object, that will authenticate with the Api Key found in
+   EYEPOP_SECRET_KEY and load the worker configuration for the Pop identified by EYEPOP_POP_ID.
 2. Call `endpoint.connect()` before any job is submitted and `endpoint.disconnect()` to release all resources.
-3. `endpoint.process({path:'examples/example.jpg'})` initiates the upload to the local file to the worker service. 
-The image will be queued and processed immediately when the worker becomes available.
-The result of endpoint.upload() implements `AsyncIterable<Prediction>` which can be iterated with 'for await' as 
-shown in the example above. Predictions will become available when the submitted file becomes processed by the worker 
-and results are efficiently streamed back to the calling client. If the uploaded file is a video
-e.g. 'video/mp4' or image container format e.g. 'image/gif', the client will receive one prediction per image frame 
-until the entire file has been processed.
+3. `endpoint.process({path:'examples/example.jpg'})` initiates the upload to the local file to the worker service.
+   The image will be queued and processed immediately when the worker becomes available.
+   The result of endpoint.upload() implements `AsyncIterable<Prediction>` which can be iterated with 'for await' as
+   shown in the example above. Predictions will become available when the submitted file becomes processed by the worker
+   and results are efficiently streamed back to the calling client. If the uploaded file is a video
+   e.g. 'video/mp4' or image container format e.g. 'image/gif', the client will receive one prediction per image frame
+   until the entire file has been processed.
 
 4. Alternatively to `path` process() also accepts a readable stream with a mandatory mime-type:
+
 ```typescript
-    // ... 
-    let stream = fs.createReadStream(example_image_path)    
-    endpoint.upload({stream: readableStream, mimeType: 'image/jpeg'})
-    // ...
+// ...
+let stream = fs.createReadStream(example_image_path)
+endpoint.upload({ stream: readableStream, mimeType: 'image/jpeg' })
+// ...
 ```
 
-Note: since v0.21.0 `EyePop.workerEndpoint()` was introduced and replaces `EyePop.endpoint()` which is now deprecated. 
+Note: since v0.21.0 `EyePop.workerEndpoint()` was introduced and replaces `EyePop.endpoint()` which is now deprecated.
 Support for `EyePop.endpoint()` will be removed in v1.0.0.
 
 ### Visualizing Results
+
 Visualization components are provided as separate modules. Please refer to the module's documentation for usage examples.
-* [EyePop Render 2d](https://www.npmjs.com/package/@eyepop.ai/eyepop-render-2d)
+
+-   [EyePop Render 2d](https://www.npmjs.com/package/@eyepop.ai/eyepop-render-2d)
+
 ### Asynchronous uploading and processing of images
-The above _synchronous_ way, process() then iterate all results, is great for individual images or reasonable 
-sized batches. For larger batch sizes, or continuous stream of images, don't `await` the results but instead 
+
+The above _synchronous_ way, process() then iterate all results, is great for individual images or reasonable
+sized batches. For larger batch sizes, or continuous stream of images, don't `await` the results but instead
 use `then()` on the returned promise.
+
 ```typescript
-import { EyePop } from '@eyepop.ai/eyepop';
+import { EyePop } from '@eyepop.ai/eyepop'
 
-const example_image_path = 'examples/example.jpg';
+const example_image_path = 'examples/example.jpg'
 
-(async() => {
+;(async () => {
     const endpoint = await EyePop.workerEndpoint().connect()
     try {
         for (let i = 0; i < 100; i++) {
-            endpoint.process({path: example_image_path}).then(async (results) => {
+            endpoint.process({ path: example_image_path }).then(async results => {
                 for await (let result of results) {
                     console.log(`result for #${i}`, result)
                 }
@@ -174,93 +208,105 @@ const example_image_path = 'examples/example.jpg';
     } finally {
         await endpoint.disconnect()
     }
-})();
+})()
 ```
-This will result in a most efficient processing, i.e. uploads will be processed in parallel (up to five HTTP 
-connections per endpoint) and results will be processed by your code as soon as they are available.     
+
+This will result in a most efficient processing, i.e. uploads will be processed in parallel (up to five HTTP
+connections per endpoint) and results will be processed by your code as soon as they are available.
+
 ### Loading images from URLs
+
 Alternatively to uploading files, you can also submit a publicly accessible URL for processing. Supported protocols are:
-* HTTP(s) URLs with response Content-Type image/* or video/*   
-* RTSP (live-streaming)
-* RTMP (live-streaming)
+
+-   HTTP(s) URLs with response Content-Type image/_ or video/_
+-   RTSP (live-streaming)
+-   RTMP (live-streaming)
+
 ```typescript
-import { EyePop } from '@eyepop.ai/eyepop';
+import { EyePop } from '@eyepop.ai/eyepop'
 
-const example_image_url = 'https://farm2.staticflickr.com/1080/1301049949_532835a8b5_z.jpg';
+const example_image_url = 'https://farm2.staticflickr.com/1080/1301049949_532835a8b5_z.jpg'
 
-(async() => {
+;(async () => {
     const endpoint = await EyePop.workerEndpoint().connect()
     try {
-        let results = await endpoint.process({url: example_image_url})
+        let results = await endpoint.process({ url: example_image_url })
         for await (let result of results) {
             console.log(result)
-        }        
+        }
     } finally {
         await endpoint.disconnect()
     }
-})();
+})()
 ```
-### Processing Videos 
-You can process videos via upload or public URLs. This example shows how to process all video frames of a file 
+
+### Processing Videos
+
+You can process videos via upload or public URLs. This example shows how to process all video frames of a file
 retrieved from a public URL.
 
 ```typescript
 import { EyePop } from '@eyepop.ai/eyepop'
 
-const example_video_url = 'https://demo-eyepop-videos.s3.amazonaws.com/test1_vlog.mp4';
+const example_video_url = 'https://demo-eyepop-videos.s3.amazonaws.com/test1_vlog.mp4'
 
-(async() => {
+;(async () => {
     const endpoint = await EyePop.workerEndpoint().connect()
     try {
-        let results = await endpoint.process({url: example_video_url})
+        let results = await endpoint.process({ url: example_video_url })
         for await (let result of results) {
             console.log(result)
-        }        
+        }
     } finally {
         await endpoint.disconnect()
     }
-})();
+})()
 ```
+
 ### Canceling Jobs
+
 Any job that has been queued or is in-progress can be cancelled. E.g. stop the video processing after
 predictions have been processed for 10 seconds duration of the video.
+
 ```typescript
 import { EyePop } from '@eyepop.ai/eyepop'
 
-const example_video_url = 'https://demo-eyepop-videos.s3.amazonaws.com/test1_vlog.mp4';
+const example_video_url = 'https://demo-eyepop-videos.s3.amazonaws.com/test1_vlog.mp4'
 
-(async() => {
+;(async () => {
     const endpoint = EyePop.workerEndpoint().connect()
     try {
-        let results = await endpoint.process({url: example_video_url})
+        let results = await endpoint.process({ url: example_video_url })
         for await (let result of results) {
             console.log(result)
             if (result['seconds'] >= 10.0) {
                 results.cancel()
             }
-        }        
+        }
     } finally {
         await endpoint.disconnect()
     }
-})();
+})()
 ```
+
 ## Other Usage Options
+
 #### Auto start workers
-By default, `EyePop.workerEndpoint().connect()` will start a worker if none is running yet. To disable this behavior 
+
+By default, `EyePop.workerEndpoint().connect()` will start a worker if none is running yet. To disable this behavior
 create an endpoint with `EyePop.endpoint({autoStart: false})`.
+
 #### Stop pending jobs
-By default, `EyePop.workerEndpoint().connect()` will cancel all currently running or queued jobs on the worker. 
-It is assumed that the caller _takes full control_ of that worker. To disable this behavior create an endpoint with 
+
+By default, `EyePop.workerEndpoint().connect()` will cancel all currently running or queued jobs on the worker.
+It is assumed that the caller _takes full control_ of that worker. To disable this behavior create an endpoint with
 `EyePop.endpoint({stopJobs: false})`.
 
 ## Data endpoint (PREVIEW)
+
 To support managing your own datasets and control model optimization v0.21.0 introduces `EyePop.dataEndpoint()`,
 an experimental pre-release which is subject to change. An officially supported version will be released with v2.0.0
 
 ## Composable Pops (PREVIEW)
-See [Composable Pops](composable-pops.md) for a preview of client side composability of pops, introduced in v1.0.0.
-
-
-
-
 
+See [Composable Pops](composable-pops.md) for a preview of client side composability of pops, introduced in v1.0.0.

package/dist/eyepop.index.d.mts

@@ -125,7 +125,13 @@ interface OAuth2Auth {
      */
     oAuth2: true | Auth0Options;
 }
-type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
+interface LocalAuth {
+    /**
+     * Implicit auth w/o credentials to a local endpoint.
+     */
+    isLocal: true;
+}
+type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth | LocalAuth;
 interface Options {
     auth?: Authentication | undefined;
     /**
@@ -259,6 +265,7 @@ interface WorkerOptions extends Options {
     isSandbox?: boolean;
     autoStart?: boolean;
     stopJobs?: boolean;
+    isLocalMode?: boolean;
 }
 
 interface WorkerSession extends Session {
@@ -266,6 +273,7 @@ interface WorkerSession extends Session {
     readonly baseUrl: string | undefined;
     readonly pipelineId: string | undefined;
     readonly sandboxId: string | undefined;
+    authenticationHeaders(): any;
 }
 interface LiveMedia {
     ingressId(): string;
@@ -274,7 +282,7 @@ interface LiveMedia {
 }
 interface IngressEvent {
     readonly ingressId: string;
-    readonly event: "stream-ready" | "stream-ready";
+    readonly event: 'stream-ready' | 'stream-ready';
 }
 interface FileSource {
     readonly file: File;
@@ -393,6 +401,7 @@ declare enum ContourType {
 }
 interface ContourFinderComponent extends BaseComponent {
     contourType: ContourType;
+    areaThreshold?: number;
 }
 interface ComponentFinderComponent extends BaseComponent {
     dilate?: number;
@@ -426,6 +435,7 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     popName(): string | null;
     pop(): Pop | null;
     changePop(pop: Pop): Promise<void>;
+    private _authenticationHeaders;
     /**
      * @deprecated use pop() instead
      */
@@ -622,6 +632,7 @@ interface ModelExport {
     exported_by: ExportedBy;
     export_params?: QcAiHubExportParams;
     status: ModelExportStatus;
+    status_message?: string;
 }
 interface Model {
     uuid: string;
@@ -883,4 +894,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };

package/dist/eyepop.index.d.ts

@@ -125,7 +125,13 @@ interface OAuth2Auth {
      */
     oAuth2: true | Auth0Options;
 }
-type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
+interface LocalAuth {
+    /**
+     * Implicit auth w/o credentials to a local endpoint.
+     */
+    isLocal: true;
+}
+type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth | LocalAuth;
 interface Options {
     auth?: Authentication | undefined;
     /**
@@ -259,6 +265,7 @@ interface WorkerOptions extends Options {
     isSandbox?: boolean;
     autoStart?: boolean;
     stopJobs?: boolean;
+    isLocalMode?: boolean;
 }
 
 interface WorkerSession extends Session {
@@ -266,6 +273,7 @@ interface WorkerSession extends Session {
     readonly baseUrl: string | undefined;
     readonly pipelineId: string | undefined;
     readonly sandboxId: string | undefined;
+    authenticationHeaders(): any;
 }
 interface LiveMedia {
     ingressId(): string;
@@ -274,7 +282,7 @@ interface LiveMedia {
 }
 interface IngressEvent {
     readonly ingressId: string;
-    readonly event: "stream-ready" | "stream-ready";
+    readonly event: 'stream-ready' | 'stream-ready';
 }
 interface FileSource {
     readonly file: File;
@@ -393,6 +401,7 @@ declare enum ContourType {
 }
 interface ContourFinderComponent extends BaseComponent {
     contourType: ContourType;
+    areaThreshold?: number;
 }
 interface ComponentFinderComponent extends BaseComponent {
     dilate?: number;
@@ -426,6 +435,7 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     popName(): string | null;
     pop(): Pop | null;
     changePop(pop: Pop): Promise<void>;
+    private _authenticationHeaders;
     /**
      * @deprecated use pop() instead
      */
@@ -622,6 +632,7 @@ interface ModelExport {
     exported_by: ExportedBy;
     export_params?: QcAiHubExportParams;
     status: ModelExportStatus;
+    status_message?: string;
 }
 interface Model {
     uuid: string;
@@ -883,4 +894,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };