@eyepop.ai/eyepop 3.15.0 → 3.16.0
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/README.md +9 -7
- package/dist/eyepop.index.d.mts +73 -22
- package/dist/eyepop.index.d.ts +73 -22
- package/dist/eyepop.index.js +269 -58
- package/dist/eyepop.index.js.map +1 -1
- package/dist/eyepop.index.mjs +269 -58
- package/dist/eyepop.index.mjs.map +1 -1
- package/dist/eyepop.min.js +1 -1
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -56,18 +56,18 @@ For provisioned persistent worker sessions, also set `EYEPOP_SESSION_UUID`.
|
|
|
56
56
|
import { EyePop } from '@eyepop.ai/eyepop'
|
|
57
57
|
|
|
58
58
|
;(async () => {
|
|
59
|
-
const endpoint = await EyePop.workerEndpoint(
|
|
60
|
-
|
|
61
|
-
await endpoint.changePop({
|
|
59
|
+
const endpoint = await EyePop.workerEndpoint({
|
|
60
|
+
pop: {
|
|
62
61
|
components: [
|
|
63
62
|
{
|
|
64
63
|
type: 'inference',
|
|
65
|
-
|
|
64
|
+
ability: 'eyepop.person:latest',
|
|
66
65
|
categoryName: 'person',
|
|
67
66
|
},
|
|
68
67
|
],
|
|
69
|
-
}
|
|
70
|
-
|
|
68
|
+
},
|
|
69
|
+
}).connect()
|
|
70
|
+
try {
|
|
71
71
|
const results = await endpoint.process({ source: { path: 'examples/example.jpg' } })
|
|
72
72
|
for await (const result of results) {
|
|
73
73
|
console.log(result)
|
|
@@ -78,6 +78,8 @@ import { EyePop } from '@eyepop.ai/eyepop'
|
|
|
78
78
|
})()
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
+
For transient sessions, pass `pop` when creating the endpoint whenever possible. Use `endpoint.changePop(pop)` only when an already connected transient worker needs to switch Pops.
|
|
82
|
+
|
|
81
83
|
You can also pass the key explicitly from server-side configuration:
|
|
82
84
|
|
|
83
85
|
```typescript
|
|
@@ -133,7 +135,7 @@ Dashboard users can run local browser demos with the current browser session:
|
|
|
133
135
|
components: [
|
|
134
136
|
{
|
|
135
137
|
type: 'inference',
|
|
136
|
-
|
|
138
|
+
ability: 'eyepop.person:latest',
|
|
137
139
|
categoryName: 'person',
|
|
138
140
|
},
|
|
139
141
|
],
|
package/dist/eyepop.index.d.mts
CHANGED
|
@@ -60,24 +60,35 @@ interface Prediction extends StreamTime {
|
|
|
60
60
|
*/
|
|
61
61
|
source_height: number;
|
|
62
62
|
source_id?: string;
|
|
63
|
+
source_url?: string;
|
|
64
|
+
source_type?: string;
|
|
65
|
+
system_timestamp?: number;
|
|
63
66
|
objects?: Array<PredictedObject>;
|
|
64
67
|
classes?: Array<PredictedClass>;
|
|
65
68
|
texts?: Array<PredictedText>;
|
|
66
69
|
meshs?: Array<PredictedMesh>;
|
|
67
70
|
keyPoints?: Array<PredictedKeyPoints>;
|
|
71
|
+
embeddings?: Array<PredictedEmbedding>;
|
|
72
|
+
motions?: Array<PredictedMotion>;
|
|
68
73
|
}
|
|
69
74
|
interface PredictedClass {
|
|
70
75
|
id?: number;
|
|
71
|
-
confidence
|
|
76
|
+
confidence?: number;
|
|
72
77
|
classLabel: string;
|
|
73
78
|
category?: string;
|
|
74
79
|
}
|
|
75
80
|
interface PredictedText {
|
|
76
81
|
id?: number;
|
|
77
|
-
confidence
|
|
82
|
+
confidence?: number;
|
|
78
83
|
text: string;
|
|
79
84
|
category?: string;
|
|
80
85
|
}
|
|
86
|
+
interface PredictedEmbedding {
|
|
87
|
+
x?: number;
|
|
88
|
+
y?: number;
|
|
89
|
+
embedding: Array<number>;
|
|
90
|
+
category?: string;
|
|
91
|
+
}
|
|
81
92
|
interface Contour {
|
|
82
93
|
points: Array<Point2d>;
|
|
83
94
|
cutouts: Array<Array<Point2d>>;
|
|
@@ -89,41 +100,45 @@ interface Mask {
|
|
|
89
100
|
stride: number;
|
|
90
101
|
}
|
|
91
102
|
interface PredictedObject extends PredictedClass {
|
|
92
|
-
trackId
|
|
103
|
+
trackId?: number;
|
|
93
104
|
x: number;
|
|
94
105
|
y: number;
|
|
95
106
|
width: number;
|
|
96
107
|
height: number;
|
|
97
108
|
orientation?: number;
|
|
98
|
-
outline
|
|
99
|
-
contours
|
|
100
|
-
mask
|
|
101
|
-
objects
|
|
102
|
-
classes
|
|
103
|
-
texts
|
|
104
|
-
meshs
|
|
105
|
-
keyPoints
|
|
109
|
+
outline?: Array<Point2d>;
|
|
110
|
+
contours?: Array<Contour>;
|
|
111
|
+
mask?: Mask;
|
|
112
|
+
objects?: Array<PredictedObject>;
|
|
113
|
+
classes?: Array<PredictedClass>;
|
|
114
|
+
texts?: Array<PredictedText>;
|
|
115
|
+
meshs?: Array<PredictedMesh>;
|
|
116
|
+
keyPoints?: Array<PredictedKeyPoints>;
|
|
106
117
|
}
|
|
107
118
|
interface Point2d {
|
|
108
119
|
x: number;
|
|
109
120
|
y: number;
|
|
110
121
|
}
|
|
111
122
|
interface PredictedMesh {
|
|
112
|
-
category
|
|
113
|
-
id
|
|
114
|
-
confidence
|
|
123
|
+
category?: string;
|
|
124
|
+
id?: number;
|
|
125
|
+
confidence?: number;
|
|
115
126
|
points: Array<Point3d>;
|
|
116
127
|
}
|
|
117
128
|
interface Point3d extends Point2d {
|
|
118
|
-
z
|
|
129
|
+
z?: number;
|
|
119
130
|
}
|
|
120
131
|
interface PredictedKeyPoints {
|
|
121
|
-
category
|
|
122
|
-
type
|
|
132
|
+
category?: string;
|
|
133
|
+
type?: string;
|
|
123
134
|
points: Array<PredictedKeyPoint>;
|
|
124
135
|
}
|
|
125
|
-
interface PredictedKeyPoint extends Point3d
|
|
126
|
-
|
|
136
|
+
interface PredictedKeyPoint extends Point3d {
|
|
137
|
+
id?: number;
|
|
138
|
+
confidence?: number;
|
|
139
|
+
classLabel?: string;
|
|
140
|
+
category?: string;
|
|
141
|
+
visible?: boolean;
|
|
127
142
|
}
|
|
128
143
|
interface PredictedMotion {
|
|
129
144
|
begin_timestamp: number;
|
|
@@ -720,8 +735,15 @@ declare enum PredictionVersion {
|
|
|
720
735
|
}
|
|
721
736
|
declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
|
|
722
737
|
interface WorkerSession extends Session {
|
|
738
|
+
/**
|
|
739
|
+
* @deprecated Pop ids are only retained for backwards compatibility.
|
|
740
|
+
* Configure transient sessions with `WorkerOptions.pop`.
|
|
741
|
+
*/
|
|
723
742
|
readonly popId: string;
|
|
724
743
|
readonly baseUrl: string | undefined;
|
|
744
|
+
/**
|
|
745
|
+
* Transient sessions may not have a pipeline until the first source is processed.
|
|
746
|
+
*/
|
|
725
747
|
readonly pipelineId: string | undefined;
|
|
726
748
|
authenticationHeaders(): any;
|
|
727
749
|
}
|
|
@@ -1053,15 +1075,25 @@ declare class Endpoint<T extends Endpoint<T>> {
|
|
|
1053
1075
|
private currentAccessToken;
|
|
1054
1076
|
}
|
|
1055
1077
|
|
|
1078
|
+
/**
|
|
1079
|
+
* @deprecated Configure transient sessions with `WorkerOptions.pop`.
|
|
1080
|
+
* Support for pop id will be removed in 3.16.
|
|
1081
|
+
*/
|
|
1056
1082
|
declare enum TransientPopId {
|
|
1057
1083
|
Transient = "transient"
|
|
1058
1084
|
}
|
|
1059
1085
|
interface WorkerOptions extends Options {
|
|
1060
1086
|
/**
|
|
1061
|
-
*
|
|
1087
|
+
* @deprecated Pass `pop` for transient sessions or `sessionUuid` for persistent sessions.
|
|
1088
|
+
* Support for pop id will be removed in 3.16.
|
|
1062
1089
|
*/
|
|
1063
1090
|
popId?: string | TransientPopId | undefined;
|
|
1064
1091
|
sessionUuid?: string | undefined;
|
|
1092
|
+
sessionName?: string | undefined;
|
|
1093
|
+
pipelineImage?: string | undefined;
|
|
1094
|
+
pipelineVersion?: string | undefined;
|
|
1095
|
+
pop?: Pop | undefined;
|
|
1096
|
+
sessionReadyTimeoutSeconds?: number | undefined;
|
|
1065
1097
|
autoStart?: boolean;
|
|
1066
1098
|
stopJobs?: boolean;
|
|
1067
1099
|
isLocalMode?: boolean;
|
|
@@ -1077,13 +1109,17 @@ declare enum SessionStatus {
|
|
|
1077
1109
|
PIPELINE_CREATING = "pipeline_creating",
|
|
1078
1110
|
PIPELINE_OK = "pipeline_ok",
|
|
1079
1111
|
PIPELINE_CHECKING = "pipeline_checking",
|
|
1080
|
-
PIPELINE_ERROR = "pipeline_error"
|
|
1112
|
+
PIPELINE_ERROR = "pipeline_error",
|
|
1113
|
+
UPGRADING = "upgrading"
|
|
1081
1114
|
}
|
|
1082
1115
|
declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
1083
1116
|
private _baseUrl;
|
|
1084
1117
|
private _pipelineId;
|
|
1085
1118
|
private _popName;
|
|
1119
|
+
private _sessionAccessToken;
|
|
1120
|
+
private _sessionAccessTokenValidUntil;
|
|
1086
1121
|
private _pipeline;
|
|
1122
|
+
private _pipelineCreatePromise;
|
|
1087
1123
|
constructor(options: WorkerOptions);
|
|
1088
1124
|
private options;
|
|
1089
1125
|
disconnect(wait?: boolean): Promise<void>;
|
|
@@ -1093,6 +1129,10 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
|
1093
1129
|
pop(): Pop | null;
|
|
1094
1130
|
changePop(pop: Pop): Promise<void>;
|
|
1095
1131
|
private _authenticationHeaders;
|
|
1132
|
+
/**
|
|
1133
|
+
* @deprecated Pop ids are only retained for backwards compatibility.
|
|
1134
|
+
* Configure transient sessions with `WorkerOptions.pop`.
|
|
1135
|
+
*/
|
|
1096
1136
|
popId(): string | null;
|
|
1097
1137
|
/**
|
|
1098
1138
|
* V1 call to process media as a source with optional component params
|
|
@@ -1126,10 +1166,21 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
|
1126
1166
|
private static SESSION_DEAD;
|
|
1127
1167
|
private static WAIT_FOR_IS_READY;
|
|
1128
1168
|
private static CHECK_FOR_IS_READY_INTERVAL;
|
|
1169
|
+
private sessionReadyTimeoutMs;
|
|
1170
|
+
private sessionHealthReady;
|
|
1129
1171
|
private getComputeSession;
|
|
1130
1172
|
private getOnDemandComputeSession;
|
|
1131
1173
|
private getPermanentComputeSession;
|
|
1132
1174
|
private startTransientPipeline;
|
|
1175
|
+
private ensureTransientPipelineStarted;
|
|
1176
|
+
private changeTransientPop;
|
|
1177
|
+
private deleteTransientPipeline;
|
|
1178
|
+
private pipelineIdFromSession;
|
|
1179
|
+
protected authorizationHeader(): Promise<string>;
|
|
1180
|
+
private computeAuthorizationHeader;
|
|
1181
|
+
private setComputeSessionAccessToken;
|
|
1182
|
+
private setTransientPipelinePop;
|
|
1183
|
+
private sessionCreateBody;
|
|
1133
1184
|
}
|
|
1134
1185
|
|
|
1135
1186
|
interface DataOptions extends Options {
|
|
@@ -1403,4 +1454,4 @@ declare namespace EyePop {
|
|
|
1403
1454
|
function dataEndpoint(opts?: DataOptions): DataEndpoint;
|
|
1404
1455
|
}
|
|
1405
1456
|
|
|
1406
|
-
export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };
|
|
1457
|
+
export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedEmbedding, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };
|
package/dist/eyepop.index.d.ts
CHANGED
|
@@ -60,24 +60,35 @@ interface Prediction extends StreamTime {
|
|
|
60
60
|
*/
|
|
61
61
|
source_height: number;
|
|
62
62
|
source_id?: string;
|
|
63
|
+
source_url?: string;
|
|
64
|
+
source_type?: string;
|
|
65
|
+
system_timestamp?: number;
|
|
63
66
|
objects?: Array<PredictedObject>;
|
|
64
67
|
classes?: Array<PredictedClass>;
|
|
65
68
|
texts?: Array<PredictedText>;
|
|
66
69
|
meshs?: Array<PredictedMesh>;
|
|
67
70
|
keyPoints?: Array<PredictedKeyPoints>;
|
|
71
|
+
embeddings?: Array<PredictedEmbedding>;
|
|
72
|
+
motions?: Array<PredictedMotion>;
|
|
68
73
|
}
|
|
69
74
|
interface PredictedClass {
|
|
70
75
|
id?: number;
|
|
71
|
-
confidence
|
|
76
|
+
confidence?: number;
|
|
72
77
|
classLabel: string;
|
|
73
78
|
category?: string;
|
|
74
79
|
}
|
|
75
80
|
interface PredictedText {
|
|
76
81
|
id?: number;
|
|
77
|
-
confidence
|
|
82
|
+
confidence?: number;
|
|
78
83
|
text: string;
|
|
79
84
|
category?: string;
|
|
80
85
|
}
|
|
86
|
+
interface PredictedEmbedding {
|
|
87
|
+
x?: number;
|
|
88
|
+
y?: number;
|
|
89
|
+
embedding: Array<number>;
|
|
90
|
+
category?: string;
|
|
91
|
+
}
|
|
81
92
|
interface Contour {
|
|
82
93
|
points: Array<Point2d>;
|
|
83
94
|
cutouts: Array<Array<Point2d>>;
|
|
@@ -89,41 +100,45 @@ interface Mask {
|
|
|
89
100
|
stride: number;
|
|
90
101
|
}
|
|
91
102
|
interface PredictedObject extends PredictedClass {
|
|
92
|
-
trackId
|
|
103
|
+
trackId?: number;
|
|
93
104
|
x: number;
|
|
94
105
|
y: number;
|
|
95
106
|
width: number;
|
|
96
107
|
height: number;
|
|
97
108
|
orientation?: number;
|
|
98
|
-
outline
|
|
99
|
-
contours
|
|
100
|
-
mask
|
|
101
|
-
objects
|
|
102
|
-
classes
|
|
103
|
-
texts
|
|
104
|
-
meshs
|
|
105
|
-
keyPoints
|
|
109
|
+
outline?: Array<Point2d>;
|
|
110
|
+
contours?: Array<Contour>;
|
|
111
|
+
mask?: Mask;
|
|
112
|
+
objects?: Array<PredictedObject>;
|
|
113
|
+
classes?: Array<PredictedClass>;
|
|
114
|
+
texts?: Array<PredictedText>;
|
|
115
|
+
meshs?: Array<PredictedMesh>;
|
|
116
|
+
keyPoints?: Array<PredictedKeyPoints>;
|
|
106
117
|
}
|
|
107
118
|
interface Point2d {
|
|
108
119
|
x: number;
|
|
109
120
|
y: number;
|
|
110
121
|
}
|
|
111
122
|
interface PredictedMesh {
|
|
112
|
-
category
|
|
113
|
-
id
|
|
114
|
-
confidence
|
|
123
|
+
category?: string;
|
|
124
|
+
id?: number;
|
|
125
|
+
confidence?: number;
|
|
115
126
|
points: Array<Point3d>;
|
|
116
127
|
}
|
|
117
128
|
interface Point3d extends Point2d {
|
|
118
|
-
z
|
|
129
|
+
z?: number;
|
|
119
130
|
}
|
|
120
131
|
interface PredictedKeyPoints {
|
|
121
|
-
category
|
|
122
|
-
type
|
|
132
|
+
category?: string;
|
|
133
|
+
type?: string;
|
|
123
134
|
points: Array<PredictedKeyPoint>;
|
|
124
135
|
}
|
|
125
|
-
interface PredictedKeyPoint extends Point3d
|
|
126
|
-
|
|
136
|
+
interface PredictedKeyPoint extends Point3d {
|
|
137
|
+
id?: number;
|
|
138
|
+
confidence?: number;
|
|
139
|
+
classLabel?: string;
|
|
140
|
+
category?: string;
|
|
141
|
+
visible?: boolean;
|
|
127
142
|
}
|
|
128
143
|
interface PredictedMotion {
|
|
129
144
|
begin_timestamp: number;
|
|
@@ -720,8 +735,15 @@ declare enum PredictionVersion {
|
|
|
720
735
|
}
|
|
721
736
|
declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
|
|
722
737
|
interface WorkerSession extends Session {
|
|
738
|
+
/**
|
|
739
|
+
* @deprecated Pop ids are only retained for backwards compatibility.
|
|
740
|
+
* Configure transient sessions with `WorkerOptions.pop`.
|
|
741
|
+
*/
|
|
723
742
|
readonly popId: string;
|
|
724
743
|
readonly baseUrl: string | undefined;
|
|
744
|
+
/**
|
|
745
|
+
* Transient sessions may not have a pipeline until the first source is processed.
|
|
746
|
+
*/
|
|
725
747
|
readonly pipelineId: string | undefined;
|
|
726
748
|
authenticationHeaders(): any;
|
|
727
749
|
}
|
|
@@ -1053,15 +1075,25 @@ declare class Endpoint<T extends Endpoint<T>> {
|
|
|
1053
1075
|
private currentAccessToken;
|
|
1054
1076
|
}
|
|
1055
1077
|
|
|
1078
|
+
/**
|
|
1079
|
+
* @deprecated Configure transient sessions with `WorkerOptions.pop`.
|
|
1080
|
+
* Support for pop id will be removed in 3.16.
|
|
1081
|
+
*/
|
|
1056
1082
|
declare enum TransientPopId {
|
|
1057
1083
|
Transient = "transient"
|
|
1058
1084
|
}
|
|
1059
1085
|
interface WorkerOptions extends Options {
|
|
1060
1086
|
/**
|
|
1061
|
-
*
|
|
1087
|
+
* @deprecated Pass `pop` for transient sessions or `sessionUuid` for persistent sessions.
|
|
1088
|
+
* Support for pop id will be removed in 3.16.
|
|
1062
1089
|
*/
|
|
1063
1090
|
popId?: string | TransientPopId | undefined;
|
|
1064
1091
|
sessionUuid?: string | undefined;
|
|
1092
|
+
sessionName?: string | undefined;
|
|
1093
|
+
pipelineImage?: string | undefined;
|
|
1094
|
+
pipelineVersion?: string | undefined;
|
|
1095
|
+
pop?: Pop | undefined;
|
|
1096
|
+
sessionReadyTimeoutSeconds?: number | undefined;
|
|
1065
1097
|
autoStart?: boolean;
|
|
1066
1098
|
stopJobs?: boolean;
|
|
1067
1099
|
isLocalMode?: boolean;
|
|
@@ -1077,13 +1109,17 @@ declare enum SessionStatus {
|
|
|
1077
1109
|
PIPELINE_CREATING = "pipeline_creating",
|
|
1078
1110
|
PIPELINE_OK = "pipeline_ok",
|
|
1079
1111
|
PIPELINE_CHECKING = "pipeline_checking",
|
|
1080
|
-
PIPELINE_ERROR = "pipeline_error"
|
|
1112
|
+
PIPELINE_ERROR = "pipeline_error",
|
|
1113
|
+
UPGRADING = "upgrading"
|
|
1081
1114
|
}
|
|
1082
1115
|
declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
1083
1116
|
private _baseUrl;
|
|
1084
1117
|
private _pipelineId;
|
|
1085
1118
|
private _popName;
|
|
1119
|
+
private _sessionAccessToken;
|
|
1120
|
+
private _sessionAccessTokenValidUntil;
|
|
1086
1121
|
private _pipeline;
|
|
1122
|
+
private _pipelineCreatePromise;
|
|
1087
1123
|
constructor(options: WorkerOptions);
|
|
1088
1124
|
private options;
|
|
1089
1125
|
disconnect(wait?: boolean): Promise<void>;
|
|
@@ -1093,6 +1129,10 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
|
1093
1129
|
pop(): Pop | null;
|
|
1094
1130
|
changePop(pop: Pop): Promise<void>;
|
|
1095
1131
|
private _authenticationHeaders;
|
|
1132
|
+
/**
|
|
1133
|
+
* @deprecated Pop ids are only retained for backwards compatibility.
|
|
1134
|
+
* Configure transient sessions with `WorkerOptions.pop`.
|
|
1135
|
+
*/
|
|
1096
1136
|
popId(): string | null;
|
|
1097
1137
|
/**
|
|
1098
1138
|
* V1 call to process media as a source with optional component params
|
|
@@ -1126,10 +1166,21 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
|
|
|
1126
1166
|
private static SESSION_DEAD;
|
|
1127
1167
|
private static WAIT_FOR_IS_READY;
|
|
1128
1168
|
private static CHECK_FOR_IS_READY_INTERVAL;
|
|
1169
|
+
private sessionReadyTimeoutMs;
|
|
1170
|
+
private sessionHealthReady;
|
|
1129
1171
|
private getComputeSession;
|
|
1130
1172
|
private getOnDemandComputeSession;
|
|
1131
1173
|
private getPermanentComputeSession;
|
|
1132
1174
|
private startTransientPipeline;
|
|
1175
|
+
private ensureTransientPipelineStarted;
|
|
1176
|
+
private changeTransientPop;
|
|
1177
|
+
private deleteTransientPipeline;
|
|
1178
|
+
private pipelineIdFromSession;
|
|
1179
|
+
protected authorizationHeader(): Promise<string>;
|
|
1180
|
+
private computeAuthorizationHeader;
|
|
1181
|
+
private setComputeSessionAccessToken;
|
|
1182
|
+
private setTransientPipelinePop;
|
|
1183
|
+
private sessionCreateBody;
|
|
1133
1184
|
}
|
|
1134
1185
|
|
|
1135
1186
|
interface DataOptions extends Options {
|
|
@@ -1403,4 +1454,4 @@ declare namespace EyePop {
|
|
|
1403
1454
|
function dataEndpoint(opts?: DataOptions): DataEndpoint;
|
|
1404
1455
|
}
|
|
1405
1456
|
|
|
1406
|
-
export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };
|
|
1457
|
+
export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedEmbedding, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };
|