GRPC clients version 12.0.5

Author: clarifai-prod

VERSION

@@ -1 +1 @@
-12.0.4
+12.0.5

package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarifai-nodejs-grpc",
-  "version": "12.0.4",
+  "version": "12.0.5",
   "description": "The official Clarifai Node.js gRPC client",
   "main": "src/index.js",
   "repository": "https://github.com/Clarifai/clarifai-javascript-grpc",

proto/clarifai/api/service.proto

@@ -351,8 +351,8 @@ service V2 {
     option (clarifai.auth.util.cl_depending_scopes) = Models_Get; // to get the model for the worker.
   }
 
-  // Stream video track annotations for a specific input one-by-one.
-  rpc StreamTrackAnnotationsSearches (StreamTrackAnnotationsSearchesRequest) returns (stream SingleStreamTrackAnnotationResponse) {
+  // Stream annotations for a specific input one-by-one.
+  rpc StreamAnnotations (StreamAnnotationsRequest) returns (stream SingleStreamAnnotationResponse) {
     option (google.api.http) = {
       post: "/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/track_annotations/searches/stream"
       body: "*"
@@ -370,6 +370,23 @@ service V2 {
     option (clarifai.auth.util.cl_depending_scopes) = AnnotationTracks_Get;
   }
 
+  // Stream live video annotations as they are being created by the runner.
+  // This endpoint reads from Redis instead of the database for real-time streaming.
+  rpc StreamLivestreamAnnotations (StreamLivestreamAnnotationsRequest) returns (stream SingleStreamAnnotationResponse) {
+    option (google.api.http) = {
+      post: "/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/stream/live"
+      body: "*"
+      additional_bindings {
+        post: "/v2/inputs/{input_id}/annotations/stream/live"
+        body: "*"
+      }
+    };
+    option (clarifai.auth.util.cl_auth_type) = KeyAuth;
+    option (clarifai.auth.util.cl_depending_scopes) = Apps_Get;
+    option (clarifai.auth.util.cl_depending_scopes) = Inputs_Get;
+    option (clarifai.auth.util.cl_depending_scopes) = Annotations_Get;
+  }
+
   // Post annotations.
   rpc PostAnnotations (PostAnnotationsRequest) returns (MultiAnnotationResponse) {
     option (google.api.http) = {
@@ -4780,14 +4797,15 @@ message PostTrackAnnotationsSearchesRequest {
   Worker worker = 9;
 }
 
-// StreamTrackAnnotationsSearchesRequest
-message StreamTrackAnnotationsSearchesRequest {
+// StreamAnnotationsRequest
+message StreamAnnotationsRequest {
   clarifai.api.UserAppIDSet user_app_id = 1;
 
-  // The input ID containing the video track annotations to stream
+  // The input ID containing the annotations to stream
   string input_id = 2;
 
-  // Filter annotations by track_ids
+  // Filter annotations by track_ids (optional - omit to stream all tracks for the input).
+  // This is useful for historical playback where you want to stream all annotations in a time range.
   repeated string track_ids = 3;
 
   // Filter annotations starting from this frame number (inclusive)
@@ -4801,11 +4819,11 @@ message StreamTrackAnnotationsSearchesRequest {
 
   // Maximum number of frames to return. Returns annotations from frames in range [frame_number_start, frame_number_start + max_frames - 1] (inclusive on both ends).
   // For example: frame_number_start=5, max_frames=3 returns frames 5, 6, and 7.
-  // Default and max: 10800 frames (3 minutes at 60 FPS)
+  // Default and max: 216000 frames (60 minutes at 60 FPS)
   uint32 max_frames = 7;
 
   // Maximum duration in milliseconds to return. Returns annotations from time range [frame_time_start, frame_time_start + max_duration - 1] (inclusive on both ends).
-  // Default and max: 180000 ms (3 minutes)
+  // Default and max: 3600000 ms (60 minutes)
   uint32 max_duration = 8;
 
   // Filtering by model version ID within a worker (optional).
@@ -4814,6 +4832,24 @@ message StreamTrackAnnotationsSearchesRequest {
   Worker worker = 9;
 }
 
+// StreamLivestreamAnnotationsRequest
+// Streams live annotations from Redis as they are being created by the runner
+message StreamLivestreamAnnotationsRequest {
+  clarifai.api.UserAppIDSet user_app_id = 1;
+
+  // The input ID containing the video being processed
+  string input_id = 2;
+
+  // (Optional) Filter by specific task ID if known
+  string task_id = 3;
+
+  // (Optional) Filter annotations by track_ids
+  repeated string track_ids = 4;
+
+  // (Optional) Filter by annotation type (e.g., "bounding_box", "point", "mask")
+  AnnotationDataType annotation_type = 5;
+}
+
 // PostAnnotationsRequest
 message PostAnnotationsRequest {
 
@@ -4932,8 +4968,8 @@ message SingleAnnotationResponse {
   Annotation annotation = 2;
 }
 
-// SingleStreamTrackAnnotationResponse similar to SingleAnnotationResponse but with an extra field
-message SingleStreamTrackAnnotationResponse {
+// SingleStreamAnnotationResponse similar to SingleAnnotationResponse but with an extra field
+message SingleStreamAnnotationResponse {
   clarifai.api.status.Status status = 1;
   Annotation annotation = 2;
 
@@ -8685,11 +8721,30 @@ message RunnerItem {
     PostModelOutputsRequest post_model_outputs_request = 4;
     // Agent sync request from control plane.
     SyncStateRequest sync_state_request = 5;
+    // Auto annotation request from a user.
+    AutoAnnotationRequest auto_annotation_request = 6;
     // Workflow request from a user.  // FUTURE
     // training request next, etc.
   }
 }
 
+message AutoAnnotationRequest {
+  // Perform prediction request and call PostAnnotations endpoint using post_annotations_info and prediction results.
+  PostModelOutputsRequest post_model_outputs_request = 1;
+
+  PostAnnotationsInfo post_annotations_info = 2;
+
+  message PostAnnotationsInfo {
+    UserAppIDSet user_app_id = 1;
+
+    // Authorization value to be used when calling PostAnnotations endpoint.
+    string authorization_value = 2;
+
+    // Task ID linked to the annotations being created.
+    string task_id = 3;
+  }
+}
+
 // This contains the response of the user's request once processing is done.
 // The runner should fill in the matching output to the RunnerItem.request
 // oneof field. This is sent to the API within PostRunnerItemOutputsRequest

proto/clarifai/api/service_grpc_pb.d.ts

@@ -36,7 +36,8 @@ interface IV2Service extends grpc.ServiceDefinition<grpc.UntypedServiceImplement
     getAnnotation: IV2Service_IGetAnnotation;
     listAnnotations: IV2Service_IListAnnotations;
     postTrackAnnotationsSearches: IV2Service_IPostTrackAnnotationsSearches;
-    streamTrackAnnotationsSearches: IV2Service_IStreamTrackAnnotationsSearches;
+    streamAnnotations: IV2Service_IStreamAnnotations;
+    streamLivestreamAnnotations: IV2Service_IStreamLivestreamAnnotations;
     postAnnotations: IV2Service_IPostAnnotations;
     patchAnnotations: IV2Service_IPatchAnnotations;
     patchAnnotationsStatus: IV2Service_IPatchAnnotationsStatus;
@@ -480,14 +481,23 @@ interface IV2Service_IPostTrackAnnotationsSearches extends grpc.MethodDefinition
     responseSerialize: grpc.serialize<proto_clarifai_api_service_pb.MultiAnnotationResponse>;
     responseDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.MultiAnnotationResponse>;
 }
-interface IV2Service_IStreamTrackAnnotationsSearches extends grpc.MethodDefinition<proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse> {
-    path: "/clarifai.api.V2/StreamTrackAnnotationsSearches";
+interface IV2Service_IStreamAnnotations extends grpc.MethodDefinition<proto_clarifai_api_service_pb.StreamAnnotationsRequest, proto_clarifai_api_service_pb.SingleStreamAnnotationResponse> {
+    path: "/clarifai.api.V2/StreamAnnotations";
     requestStream: false;
     responseStream: true;
-    requestSerialize: grpc.serialize<proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest>;
-    requestDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest>;
-    responseSerialize: grpc.serialize<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
-    responseDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
+    requestSerialize: grpc.serialize<proto_clarifai_api_service_pb.StreamAnnotationsRequest>;
+    requestDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.StreamAnnotationsRequest>;
+    responseSerialize: grpc.serialize<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    responseDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+}
+interface IV2Service_IStreamLivestreamAnnotations extends grpc.MethodDefinition<proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, proto_clarifai_api_service_pb.SingleStreamAnnotationResponse> {
+    path: "/clarifai.api.V2/StreamLivestreamAnnotations";
+    requestStream: false;
+    responseStream: true;
+    requestSerialize: grpc.serialize<proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest>;
+    requestDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest>;
+    responseSerialize: grpc.serialize<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    responseDeserialize: grpc.deserialize<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
 }
 interface IV2Service_IPostAnnotations extends grpc.MethodDefinition<proto_clarifai_api_service_pb.PostAnnotationsRequest, proto_clarifai_api_service_pb.MultiAnnotationResponse> {
     path: "/clarifai.api.V2/PostAnnotations";
@@ -2942,7 +2952,8 @@ export interface IV2Server {
     getAnnotation: grpc.handleUnaryCall<proto_clarifai_api_service_pb.GetAnnotationRequest, proto_clarifai_api_service_pb.SingleAnnotationResponse>;
     listAnnotations: grpc.handleUnaryCall<proto_clarifai_api_service_pb.ListAnnotationsRequest, proto_clarifai_api_service_pb.MultiAnnotationResponse>;
     postTrackAnnotationsSearches: grpc.handleUnaryCall<proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, proto_clarifai_api_service_pb.MultiAnnotationResponse>;
-    streamTrackAnnotationsSearches: grpc.handleServerStreamingCall<proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
+    streamAnnotations: grpc.handleServerStreamingCall<proto_clarifai_api_service_pb.StreamAnnotationsRequest, proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    streamLivestreamAnnotations: grpc.handleServerStreamingCall<proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
     postAnnotations: grpc.handleUnaryCall<proto_clarifai_api_service_pb.PostAnnotationsRequest, proto_clarifai_api_service_pb.MultiAnnotationResponse>;
     patchAnnotations: grpc.handleUnaryCall<proto_clarifai_api_service_pb.PatchAnnotationsRequest, proto_clarifai_api_service_pb.MultiAnnotationResponse>;
     patchAnnotationsStatus: grpc.handleUnaryCall<proto_clarifai_api_service_pb.PatchAnnotationsStatusRequest, proto_clarifai_api_service_pb.PatchAnnotationsStatusResponse>;
@@ -3273,8 +3284,10 @@ export interface IV2Client {
     postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
-    streamTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
-    streamTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
+    streamAnnotations(request: proto_clarifai_api_service_pb.StreamAnnotationsRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    streamAnnotations(request: proto_clarifai_api_service_pb.StreamAnnotationsRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    streamLivestreamAnnotations(request: proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    streamLivestreamAnnotations(request: proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
     postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
@@ -4144,8 +4157,10 @@ export class V2Client extends grpc.Client implements IV2Client {
     public postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     public postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     public postTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.PostTrackAnnotationsSearchesRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
-    public streamTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
-    public streamTrackAnnotationsSearches(request: proto_clarifai_api_service_pb.StreamTrackAnnotationsSearchesRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamTrackAnnotationResponse>;
+    public streamAnnotations(request: proto_clarifai_api_service_pb.StreamAnnotationsRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    public streamAnnotations(request: proto_clarifai_api_service_pb.StreamAnnotationsRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    public streamLivestreamAnnotations(request: proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
+    public streamLivestreamAnnotations(request: proto_clarifai_api_service_pb.StreamLivestreamAnnotationsRequest, metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientReadableStream<proto_clarifai_api_service_pb.SingleStreamAnnotationResponse>;
     public postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     public postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;
     public postAnnotations(request: proto_clarifai_api_service_pb.PostAnnotationsRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: proto_clarifai_api_service_pb.MultiAnnotationResponse) => void): grpc.ClientUnaryCall;