@eyepop.ai/eyepop 3.22.0 → 3.23.0

package/dist/eyepop.index.d.mts

@@ -73,6 +73,15 @@ interface Prediction extends StreamTime {
     details?: Array<Record<string, any>>;
     motions?: Array<PredictedMotion>;
     depth?: Depth;
+    /**
+     * Set on a selected prediction: the results of a `select_crop` or
+     * `select_full` forward for one track. It arrives after later predictions,
+     * carries the `timestamp` of the past frame that was selected, and its
+     * selected object's `trackId` links it to that track's live predictions.
+     * It is not the stream's progress: skip it where frames are drawn or
+     * counted.
+     */
+    selected?: boolean;
 }
 interface PredictedClass {
     id?: number;
@@ -918,7 +927,13 @@ declare function validateCamera(camera: Camera): void;
 
 declare enum PredictionVersion {
     V1 = 1,
-    V2 = 2
+    V2 = 2,
+    /**
+     * Adds selected predictions: a `select_crop` or `select_full` forward
+     * reports each selection on a prediction of its own, `selected` set and
+     * timed by the past frame it selected. Nothing else differs from V2.
+     */
+    V3 = 3
 }
 declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
 interface WorkerSession extends Session {
@@ -981,7 +996,38 @@ declare enum PopComponentType {
 declare enum ForwardOperatorType {
     FULL = "full",
     CROP = "crop",
-    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback"
+    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback",
+    /**
+     * `SELECT_CROP` and `SELECT_FULL` forward one past frame per track, the one
+     * of its most relevant detection, and their targets' results arrive late as
+     * selected predictions. Only a tracking component's forward can select.
+     */
+    SELECT_CROP = "select_crop",
+    SELECT_FULL = "select_full"
+}
+declare enum SelectMode {
+    MOST_RELEVANT = "most_relevant"
+}
+/**
+ * How a `select_crop` or `select_full` forward picks one frame per track.
+ *
+ * `relevancyModel` (by alias) or `relevancyModelUuid` names an ability that
+ * runs on every tracked object of every frame; a detection it finds nothing on
+ * is never selected. Without one, relevance comes from the detection's box
+ * alone.
+ *
+ * A track shorter than `minTrackLengthSeconds` is never selected. With
+ * `intervalSeconds` the first selection comes that long after the track
+ * starts, then at most one per interval and only when a more relevant
+ * detection turned up; the track's end reports a final one if it improved
+ * since. Without it, a track is selected once, when it ends.
+ */
+interface PopSelect {
+    mode?: SelectMode;
+    relevancyModelUuid?: string;
+    relevancyModel?: string;
+    minTrackLengthSeconds?: number;
+    intervalSeconds?: number;
 }
 interface PopCrop {
     maxItems?: number;
@@ -992,7 +1038,9 @@ interface PopForwardOperator {
     type: ForwardOperatorType;
     includeClasses?: string[];
     crop?: PopCrop;
+    select?: PopSelect;
 }
+declare function isSelectOperator(operator: PopForwardOperator | undefined): boolean;
 interface PopForward {
     operator?: PopForwardOperator;
     targets: PopComponent[];
@@ -1157,6 +1205,10 @@ interface Pop {
  * these too, but as a 400 once the Pop is already in flight.
  */
 declare function validatePop(pop: Pop): void;
+/**
+ * Whether any forward of the Pop is a `select_crop` or `select_full`.
+ */
+declare function popSelects(pop: Pop | null | undefined): boolean;
 interface MotionDetectConfig {
     motionDetect: boolean;
     motionSensitivity?: number;
@@ -1431,6 +1483,12 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     session(): Promise<WorkerSession>;
     popName(): string | null;
     pop(): Pop | null;
+    /**
+     * A select forward's results come only at V3. Only a Pop that selects asks
+     * for it, so a worker too old to know V3 - which also rejects that Pop - is
+     * never sent a version it would not accept.
+     */
+    private predictionVersion;
     changePop(pop: Pop): Promise<void>;
     private _authenticationHeaders;
     /**
@@ -1872,14 +1930,14 @@ declare class UploadJob extends AbstractJob {
     private readonly _needsFullDuplex;
     private readonly _videoMode;
     get [Symbol.toStringTag](): string;
-    constructor(stream: UploadBody, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, uploadBodyFactory?: () => Promise<UploadBody>);
+    constructor(stream: UploadBody, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, uploadBodyFactory?: () => Promise<UploadBody>, version?: PredictionVersion);
     private uploadBody;
     protected onEvent(event: StreamEvent): Promise<void>;
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromJob extends AbstractJob {
     private readonly _location;
-    constructor(location: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(location: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
@@ -1890,24 +1948,24 @@ interface UploadSource {
 declare class UploadGroupJob extends AbstractJob {
     private readonly _sources;
     get [Symbol.toStringTag](): string;
-    constructor(sources: UploadSource[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(sources: UploadSource[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromGroupJob extends AbstractJob {
     private readonly _urls;
     get [Symbol.toStringTag](): string;
-    constructor(urls: string[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(urls: string[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromAssetUuidJob extends AbstractJob {
     private readonly _assetUuid;
-    constructor(assetUuid: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(assetUuid: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
 declare class LoadMediaStreamJob extends AbstractJob {
     private readonly _mediaStream;
-    constructor(mediaStream: MediaStream, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(mediaStream: MediaStream, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
@@ -1976,4 +2034,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Camera, type CameraDistortion, type CameraExtrinsics, type CameraIntrinsics, type ChangeEvent, ChangeType, type ClassificationTask, type CloudBounds, type CloudBox, type ComponentFinderComponent, type ComponentParams, ComputeAccountMismatchError, ComputeApiError, 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 Depth, DepthMap, type DepthSemantic, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, PointCloud, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopDepthMap, 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, QUATERNION_TOLERANCE, type QcAiHubExportParams, type Quaternion, type RectangleArea, type ResponseSchema, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, type Source, type SourceDefaults, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, type UrlSource, UserReview, type Vector3, type Vector3d, 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, accessTokenCredential, apiKeyCredential, cloudOfDepth, cloudOfObject, cloudsOfPrediction, decodeDepthMap, decodePointCloud, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth, validateCamera, validatePop };
+export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Camera, type CameraDistortion, type CameraExtrinsics, type CameraIntrinsics, type ChangeEvent, ChangeType, type ClassificationTask, type CloudBounds, type CloudBox, type ComponentFinderComponent, type ComponentParams, ComputeAccountMismatchError, ComputeApiError, 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 Depth, DepthMap, type DepthSemantic, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, PointCloud, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopDepthMap, type PopForward, type PopForwardOperator, type PopSelect, type PredictedClass, type PredictedEmbedding, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, QUATERNION_TOLERANCE, type QcAiHubExportParams, type Quaternion, type RectangleArea, type ResponseSchema, type ResultStream, type Roi, SelectMode, Semaphore, type Session, type SessionAuth, type Source, type SourceDefaults, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, type UrlSource, UserReview, type Vector3, type Vector3d, 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, accessTokenCredential, apiKeyCredential, cloudOfDepth, cloudOfObject, cloudsOfPrediction, decodeDepthMap, decodePointCloud, EyePop as default, encodeMultipartFormData, getBaseUrl, isSelectOperator, popSelects, randomMultipartBoundary, readableStreamFromString, resolveAuth, validateCamera, validatePop };

package/dist/eyepop.index.d.ts

@@ -73,6 +73,15 @@ interface Prediction extends StreamTime {
     details?: Array<Record<string, any>>;
     motions?: Array<PredictedMotion>;
     depth?: Depth;
+    /**
+     * Set on a selected prediction: the results of a `select_crop` or
+     * `select_full` forward for one track. It arrives after later predictions,
+     * carries the `timestamp` of the past frame that was selected, and its
+     * selected object's `trackId` links it to that track's live predictions.
+     * It is not the stream's progress: skip it where frames are drawn or
+     * counted.
+     */
+    selected?: boolean;
 }
 interface PredictedClass {
     id?: number;
@@ -918,7 +927,13 @@ declare function validateCamera(camera: Camera): void;
 
 declare enum PredictionVersion {
     V1 = 1,
-    V2 = 2
+    V2 = 2,
+    /**
+     * Adds selected predictions: a `select_crop` or `select_full` forward
+     * reports each selection on a prediction of its own, `selected` set and
+     * timed by the past frame it selected. Nothing else differs from V2.
+     */
+    V3 = 3
 }
 declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
 interface WorkerSession extends Session {
@@ -981,7 +996,38 @@ declare enum PopComponentType {
 declare enum ForwardOperatorType {
     FULL = "full",
     CROP = "crop",
-    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback"
+    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback",
+    /**
+     * `SELECT_CROP` and `SELECT_FULL` forward one past frame per track, the one
+     * of its most relevant detection, and their targets' results arrive late as
+     * selected predictions. Only a tracking component's forward can select.
+     */
+    SELECT_CROP = "select_crop",
+    SELECT_FULL = "select_full"
+}
+declare enum SelectMode {
+    MOST_RELEVANT = "most_relevant"
+}
+/**
+ * How a `select_crop` or `select_full` forward picks one frame per track.
+ *
+ * `relevancyModel` (by alias) or `relevancyModelUuid` names an ability that
+ * runs on every tracked object of every frame; a detection it finds nothing on
+ * is never selected. Without one, relevance comes from the detection's box
+ * alone.
+ *
+ * A track shorter than `minTrackLengthSeconds` is never selected. With
+ * `intervalSeconds` the first selection comes that long after the track
+ * starts, then at most one per interval and only when a more relevant
+ * detection turned up; the track's end reports a final one if it improved
+ * since. Without it, a track is selected once, when it ends.
+ */
+interface PopSelect {
+    mode?: SelectMode;
+    relevancyModelUuid?: string;
+    relevancyModel?: string;
+    minTrackLengthSeconds?: number;
+    intervalSeconds?: number;
 }
 interface PopCrop {
     maxItems?: number;
@@ -992,7 +1038,9 @@ interface PopForwardOperator {
     type: ForwardOperatorType;
     includeClasses?: string[];
     crop?: PopCrop;
+    select?: PopSelect;
 }
+declare function isSelectOperator(operator: PopForwardOperator | undefined): boolean;
 interface PopForward {
     operator?: PopForwardOperator;
     targets: PopComponent[];
@@ -1157,6 +1205,10 @@ interface Pop {
  * these too, but as a 400 once the Pop is already in flight.
  */
 declare function validatePop(pop: Pop): void;
+/**
+ * Whether any forward of the Pop is a `select_crop` or `select_full`.
+ */
+declare function popSelects(pop: Pop | null | undefined): boolean;
 interface MotionDetectConfig {
     motionDetect: boolean;
     motionSensitivity?: number;
@@ -1431,6 +1483,12 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     session(): Promise<WorkerSession>;
     popName(): string | null;
     pop(): Pop | null;
+    /**
+     * A select forward's results come only at V3. Only a Pop that selects asks
+     * for it, so a worker too old to know V3 - which also rejects that Pop - is
+     * never sent a version it would not accept.
+     */
+    private predictionVersion;
     changePop(pop: Pop): Promise<void>;
     private _authenticationHeaders;
     /**
@@ -1872,14 +1930,14 @@ declare class UploadJob extends AbstractJob {
     private readonly _needsFullDuplex;
     private readonly _videoMode;
     get [Symbol.toStringTag](): string;
-    constructor(stream: UploadBody, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, uploadBodyFactory?: () => Promise<UploadBody>);
+    constructor(stream: UploadBody, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, uploadBodyFactory?: () => Promise<UploadBody>, version?: PredictionVersion);
     private uploadBody;
     protected onEvent(event: StreamEvent): Promise<void>;
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromJob extends AbstractJob {
     private readonly _location;
-    constructor(location: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(location: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
@@ -1890,24 +1948,24 @@ interface UploadSource {
 declare class UploadGroupJob extends AbstractJob {
     private readonly _sources;
     get [Symbol.toStringTag](): string;
-    constructor(sources: UploadSource[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(sources: UploadSource[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromGroupJob extends AbstractJob {
     private readonly _urls;
     get [Symbol.toStringTag](): string;
-    constructor(urls: string[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(urls: string[], params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     protected startJob(): Promise<Response>;
 }
 declare class LoadFromAssetUuidJob extends AbstractJob {
     private readonly _assetUuid;
-    constructor(assetUuid: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(assetUuid: string, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
 declare class LoadMediaStreamJob extends AbstractJob {
     private readonly _mediaStream;
-    constructor(mediaStream: MediaStream, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(mediaStream: MediaStream, params: ProcessParams, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger, version?: PredictionVersion);
     get [Symbol.toStringTag](): string;
     protected startJob(): Promise<Response>;
 }
@@ -1976,4 +2034,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Camera, type CameraDistortion, type CameraExtrinsics, type CameraIntrinsics, type ChangeEvent, ChangeType, type ClassificationTask, type CloudBounds, type CloudBox, type ComponentFinderComponent, type ComponentParams, ComputeAccountMismatchError, ComputeApiError, 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 Depth, DepthMap, type DepthSemantic, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, PointCloud, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopDepthMap, 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, QUATERNION_TOLERANCE, type QcAiHubExportParams, type Quaternion, type RectangleArea, type ResponseSchema, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, type Source, type SourceDefaults, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, type UrlSource, UserReview, type Vector3, type Vector3d, 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, accessTokenCredential, apiKeyCredential, cloudOfDepth, cloudOfObject, cloudsOfPrediction, decodeDepthMap, decodePointCloud, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth, validateCamera, validatePop };
+export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Camera, type CameraDistortion, type CameraExtrinsics, type CameraIntrinsics, type ChangeEvent, ChangeType, type ClassificationTask, type CloudBounds, type CloudBox, type ComponentFinderComponent, type ComponentParams, ComputeAccountMismatchError, ComputeApiError, 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 Depth, DepthMap, type DepthSemantic, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, PointCloud, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopDepthMap, type PopForward, type PopForwardOperator, type PopSelect, type PredictedClass, type PredictedEmbedding, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, QUATERNION_TOLERANCE, type QcAiHubExportParams, type Quaternion, type RectangleArea, type ResponseSchema, type ResultStream, type Roi, SelectMode, Semaphore, type Session, type SessionAuth, type Source, type SourceDefaults, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, type UrlSource, UserReview, type Vector3, type Vector3d, 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, accessTokenCredential, apiKeyCredential, cloudOfDepth, cloudOfObject, cloudsOfPrediction, decodeDepthMap, decodePointCloud, EyePop as default, encodeMultipartFormData, getBaseUrl, isSelectOperator, popSelects, randomMultipartBoundary, readableStreamFromString, resolveAuth, validateCamera, validatePop };

package/dist/eyepop.index.js

@@ -8699,6 +8699,7 @@ __export(index_exports, {
   PopComponentType: () => PopComponentType,
   PredictionVersion: () => PredictionVersion,
   QUATERNION_TOLERANCE: () => QUATERNION_TOLERANCE,
+  SelectMode: () => SelectMode,
   Semaphore: () => Semaphore,
   Stream: () => Stream,
   TaskMode: () => TaskMode,
@@ -8725,6 +8726,8 @@ __export(index_exports, {
   default: () => index_default,
   encodeMultipartFormData: () => encodeMultipartFormData,
   getBaseUrl: () => getBaseUrl,
+  isSelectOperator: () => isSelectOperator,
+  popSelects: () => popSelects,
   randomMultipartBoundary: () => randomMultipartBoundary,
   readableStreamFromString: () => readableStreamFromString,
   resolveAuth: () => resolveAuth,
@@ -9412,6 +9415,7 @@ function validateCamera(camera) {
 var PredictionVersion = /* @__PURE__ */ ((PredictionVersion3) => {
   PredictionVersion3[PredictionVersion3["V1"] = 1] = "V1";
   PredictionVersion3[PredictionVersion3["V2"] = 2] = "V2";
+  PredictionVersion3[PredictionVersion3["V3"] = 3] = "V3";
   return PredictionVersion3;
 })(PredictionVersion || {});
 var DEFAULT_PREDICTION_VERSION = 2 /* V2 */;
@@ -9432,8 +9436,17 @@ var ForwardOperatorType = /* @__PURE__ */ ((ForwardOperatorType2) => {
   ForwardOperatorType2["FULL"] = "full";
   ForwardOperatorType2["CROP"] = "crop";
   ForwardOperatorType2["CROP_WITH_FULL_FALLBACK"] = "crop_with_full_fallback";
+  ForwardOperatorType2["SELECT_CROP"] = "select_crop";
+  ForwardOperatorType2["SELECT_FULL"] = "select_full";
   return ForwardOperatorType2;
 })(ForwardOperatorType || {});
+var SelectMode = /* @__PURE__ */ ((SelectMode2) => {
+  SelectMode2["MOST_RELEVANT"] = "most_relevant";
+  return SelectMode2;
+})(SelectMode || {});
+function isSelectOperator(operator) {
+  return operator?.type === "select_crop" /* SELECT_CROP */ || operator?.type === "select_full" /* SELECT_FULL */;
+}
 var InferenceType = /* @__PURE__ */ ((InferenceType2) => {
   InferenceType2["IMAGE_CLASSIFICATION"] = "image_classification";
   InferenceType2["OBJECT_DETECTION"] = "object_detection";
@@ -9470,6 +9483,52 @@ function validatePop(pop) {
   if (pop.defaults?.camera !== void 0) {
     validateCamera(pop.defaults.camera);
   }
+  validateForwards(pop.components);
+}
+function popSelects(pop) {
+  const selects = (components) => (components ?? []).some((component) => isSelectOperator(component.forward?.operator) || selects(component.forward?.targets));
+  return selects(pop?.components);
+}
+function validateForwards(components) {
+  for (const component of components ?? []) {
+    const operator = component.forward?.operator;
+    if (operator !== void 0) {
+      validateSelectOperator(operator);
+    }
+    validateForwards(component.forward?.targets);
+  }
+}
+function validateSelectOperator(operator) {
+  if (!isSelectOperator(operator)) {
+    if (operator.select !== void 0) {
+      throw new Error("select is only valid with the select_crop or select_full operator");
+    }
+    return;
+  }
+  const select = operator.select;
+  if (select === void 0) {
+    throw new Error(`${operator.type} requires a select block`);
+  }
+  if (select.mode !== void 0 && select.mode !== "most_relevant" /* MOST_RELEVANT */) {
+    throw new Error(`select mode ${select.mode} is not supported, the only mode is ${"most_relevant" /* MOST_RELEVANT */}`);
+  }
+  if (select.relevancyModel !== void 0 && select.relevancyModelUuid !== void 0) {
+    throw new Error("select can only have one of relevancyModelUuid or relevancyModel");
+  }
+  if (select.minTrackLengthSeconds !== void 0 && select.minTrackLengthSeconds < 0) {
+    throw new Error("select minTrackLengthSeconds cannot be negative");
+  }
+  if (select.intervalSeconds !== void 0 && select.intervalSeconds <= 0) {
+    throw new Error("select intervalSeconds must be positive");
+  }
+  if (operator.crop !== void 0) {
+    if (operator.type !== "select_crop" /* SELECT_CROP */) {
+      throw new Error(`crop options are only valid with select_crop, not ${operator.type}`);
+    }
+    if (operator.crop.maxItems !== void 0) {
+      throw new Error("select_crop forwards one detection per selection, maxItems does not apply");
+    }
+  }
 }
 
 // worker/webrtc_whip.ts
@@ -9922,8 +9981,8 @@ var UploadJob = class extends AbstractJob {
   get [Symbol.toStringTag]() {
     return "uploadJob";
   }
-  constructor(stream, mimeType, size, videoMode, params, getSession, client, requestLogger, uploadBodyFactory) {
-    super(params, getSession, client, requestLogger);
+  constructor(stream, mimeType, size, videoMode, params, getSession, client, requestLogger, uploadBodyFactory, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     this._uploadStream = stream;
     this._uploadBodyFactory = uploadBodyFactory;
     this._mimeType = mimeType;
@@ -10116,8 +10175,8 @@ var UploadJob = class extends AbstractJob {
   }
 };
 var LoadFromJob = class extends AbstractJob {
-  constructor(location, params, getSession, client, requestLogger) {
-    super(params, getSession, client, requestLogger);
+  constructor(location, params, getSession, client, requestLogger, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     this._location = location;
   }
   get [Symbol.toStringTag]() {
@@ -10163,8 +10222,8 @@ var UploadGroupJob = class extends AbstractJob {
   get [Symbol.toStringTag]() {
     return "uploadGroupJob";
   }
-  constructor(sources, params, getSession, client, requestLogger) {
-    super(params, getSession, client, requestLogger);
+  constructor(sources, params, getSession, client, requestLogger, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     if (sources.length === 0) {
       throw new Error("upload group requires at least one source");
     }
@@ -10225,8 +10284,8 @@ var LoadFromGroupJob = class extends AbstractJob {
   get [Symbol.toStringTag]() {
     return "loadFromGroupJob";
   }
-  constructor(urls, params, getSession, client, requestLogger) {
-    super(params, getSession, client, requestLogger);
+  constructor(urls, params, getSession, client, requestLogger, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     if (urls.length === 0) {
       throw new Error("load from group requires at least one url");
     }
@@ -10271,8 +10330,8 @@ var LoadFromGroupJob = class extends AbstractJob {
   }
 };
 var LoadFromAssetUuidJob = class extends AbstractJob {
-  constructor(assetUuid, params, getSession, client, requestLogger) {
-    super(params, getSession, client, requestLogger);
+  constructor(assetUuid, params, getSession, client, requestLogger, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     this._assetUuid = assetUuid;
   }
   get [Symbol.toStringTag]() {
@@ -10312,8 +10371,8 @@ var LoadFromAssetUuidJob = class extends AbstractJob {
   }
 };
 var LoadMediaStreamJob = class extends AbstractJob {
-  constructor(mediaStream, params, getSession, client, requestLogger) {
-    super(params, getSession, client, requestLogger);
+  constructor(mediaStream, params, getSession, client, requestLogger, version = DEFAULT_PREDICTION_VERSION) {
+    super(params, getSession, client, requestLogger, version);
     this._mediaStream = mediaStream;
   }
   get [Symbol.toStringTag]() {
@@ -10957,6 +11016,14 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
     }
     return this.options().pop || null;
   }
+  /**
+   * A select forward's results come only at V3. Only a Pop that selects asks
+   * for it, so a worker too old to know V3 - which also rejects that Pop - is
+   * never sent a version it would not accept.
+   */
+  predictionVersion() {
+    return popSelects(this.pop()) ? 3 /* V3 */ : DEFAULT_PREDICTION_VERSION;
+  }
   async changePop(pop) {
     validatePop(pop);
     if (this.options().popId == "transient" /* Transient */) {
@@ -11085,7 +11152,7 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return { stream: streamSource.stream, mimeType: streamSource.mimeType };
         })
       );
-      const job = new UploadGroupJob(sources, params, async () => this.session(), this._client, this._requestLogger);
+      const job = new UploadGroupJob(sources, params, async () => this.session(), this._client, this._requestLogger, this.predictionVersion());
       return job.start(
         () => {
           this.jobDone(job);
@@ -11117,7 +11184,7 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
         stream,
         mimeType: mimeTypes?.[i] ?? null
       }));
-      const job = new UploadGroupJob(sources, params, async () => this.session(), this._client, this._requestLogger);
+      const job = new UploadGroupJob(sources, params, async () => this.session(), this._client, this._requestLogger, this.predictionVersion());
       return job.start(
         () => {
           this.jobDone(job);
@@ -11142,7 +11209,7 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
     await this._limit.acquire();
     try {
       this.updateState();
-      const job = new LoadFromGroupJob(urls, params, async () => this.session(), this._client, this._requestLogger);
+      const job = new LoadFromGroupJob(urls, params, async () => this.session(), this._client, this._requestLogger, this.predictionVersion());
       return job.start(
         () => {
           this.jobDone(job);
@@ -11174,7 +11241,9 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return this.session();
         },
         this._client,
-        this._requestLogger
+        this._requestLogger,
+        void 0,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -11207,7 +11276,9 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return this.session();
         },
         this._client,
-        this._requestLogger
+        this._requestLogger,
+        void 0,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -11256,7 +11327,8 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
         },
         this._client,
         this._requestLogger,
-        uploadBodyFactory
+        uploadBodyFactory,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -11294,7 +11366,8 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return this.session();
         },
         this._client,
-        this._requestLogger
+        this._requestLogger,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -11324,7 +11397,8 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return this.session();
         },
         this._client,
-        this._requestLogger
+        this._requestLogger,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -11354,7 +11428,8 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
           return this.session();
         },
         this._client,
-        this._requestLogger
+        this._requestLogger,
+        this.predictionVersion()
       );
       return job.start(
         () => {
@@ -13512,6 +13587,7 @@ var index_default = EyePop;
   PopComponentType,
   PredictionVersion,
   QUATERNION_TOLERANCE,
+  SelectMode,
   Semaphore,
   Stream,
   TaskMode,
@@ -13537,6 +13613,8 @@ var index_default = EyePop;
   decodePointCloud,
   encodeMultipartFormData,
   getBaseUrl,
+  isSelectOperator,
+  popSelects,
   randomMultipartBoundary,
   readableStreamFromString,
   resolveAuth,