chore: update task input for stream method (#138)

Because

- the stream method support multiple tasks

This commit

- define task input for stream method

Author: phelan

openapiv2/openapiv2.swagger.yaml

@@ -3678,6 +3678,23 @@ definitions:
         type: string
         title: Image type base64
     title: ClassificationInput represents the input of classification task
+  v1alphaClassificationInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: ClassificationInputStream represents the input of classification task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaClassificationOutput:
     type: object
     properties:
@@ -4049,6 +4066,23 @@ definitions:
         type: string
         title: Image type base64
     title: DetectionInput represents the input of detection task
+  v1alphaDetectionInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: DetectionInputStream represents the input of detection task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaDetectionObject:
     type: object
     properties:
@@ -4228,6 +4262,23 @@ definitions:
         type: string
         title: Image type base64
     title: InstanceSegmentationInput represents the input of instance segmentation task
+  v1alphaInstanceSegmentationInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: InstanceSegmentationInputStream represents the input of instance segmentation task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaInstanceSegmentationObject:
     type: object
     properties:
@@ -4290,6 +4341,23 @@ definitions:
         type: string
         title: Image type base64
     title: KeypointInput represents the input of keypoint detection task
+  v1alphaKeypointInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: KeypointInputStream represents the input of keypoint detection task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaKeypointObject:
     type: object
     properties:
@@ -4989,6 +5057,23 @@ definitions:
         type: string
         title: Image type base64
     title: OcrInput represents the input of ocr task
+  v1alphaOcrInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: OcrInputStream represents the input of ocr task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaOcrObject:
     type: object
     properties:
@@ -5264,6 +5349,23 @@ definitions:
         type: string
         title: Image type base64
     title: SemanticSegmentationInput represents the input of semantic segmentation task
+  v1alphaSemanticSegmentationInputStream:
+    type: object
+    properties:
+      file_lengths:
+        type: array
+        items:
+          type: string
+          format: uint64
+        title: The list of file length for each uploaded binary file
+      content:
+        type: string
+        format: byte
+        title: Content of images in bytes
+    title: SemanticSegmentationInputStream represents the input of semantic segmentation task when using stream method
+    required:
+      - file_lengths
+      - content
   v1alphaSemanticSegmentationOutput:
     type: object
     properties:
@@ -5548,6 +5650,37 @@ definitions:
         $ref: '#/definitions/v1alphaUnspecifiedInput'
         title: The unspecified task input
     title: Input represents the input to trigger a model instance
+  v1alphaTaskInputStream:
+    type: object
+    properties:
+      classification:
+        $ref: '#/definitions/v1alphaClassificationInputStream'
+        title: The classification input
+      detection:
+        $ref: '#/definitions/v1alphaDetectionInputStream'
+        title: The detection input
+      keypoint:
+        $ref: '#/definitions/v1alphaKeypointInputStream'
+        title: The keypoint input
+      ocr:
+        $ref: '#/definitions/v1alphaOcrInputStream'
+        title: The ocr input
+      instance_segmentation:
+        $ref: '#/definitions/v1alphaInstanceSegmentationInputStream'
+        title: The instance segmentation input
+      semantic_segmentation:
+        $ref: '#/definitions/v1alphaSemanticSegmentationInputStream'
+        title: The semantic segmentation input
+      text_to_image:
+        $ref: '#/definitions/v1alphaTextToImageInput'
+        title: The text to image input
+      text_generation:
+        $ref: '#/definitions/v1alphaTextGenerationInput'
+        title: The text generation input
+      unspecified:
+        $ref: '#/definitions/v1alphaUnspecifiedInput'
+        title: The unspecified task input
+    title: TaskInputStream represents the input to trigger a model instance with stream method
   v1alphaTestModelInstanceBinaryFileUploadResponse:
     type: object
     properties:

vdp/model/v1alpha/model.proto

@@ -524,6 +524,31 @@ message TaskInput {
   }
 }
 
+// TaskInputStream represents the input to trigger a model instance with stream method
+message TaskInputStream {
+  // Input type
+  oneof input {
+    // The classification input
+    ClassificationInputStream classification = 1;
+    // The detection input
+    DetectionInputStream detection = 2;
+    // The keypoint input
+    KeypointInputStream keypoint = 3;
+    // The ocr input
+    OcrInputStream ocr = 4;
+    // The instance segmentation input
+    InstanceSegmentationInputStream instance_segmentation = 5;
+    // The semantic segmentation input
+    SemanticSegmentationInputStream semantic_segmentation = 6;
+    // The text to image input
+    TextToImageInput text_to_image = 7;
+    // The text generation input
+    TextGenerationInput text_generation = 8;
+    // The unspecified task input
+    UnspecifiedInput unspecified = 9;
+  }
+}
+
 // TaskOutput represents the output of a CV Task result from a model instance
 message TaskOutput {
   // The inference task output
@@ -585,10 +610,8 @@ message TriggerModelInstanceBinaryFileUploadRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference).type = "api.instill.tech/ModelInstance"
   ];
-  // The list of file length for each uploaded binary file
-  repeated uint64 file_lengths = 2 [ (google.api.field_behavior) = REQUIRED ];
-  // Content of images in bytes
-  bytes content = 3 [ (google.api.field_behavior) = REQUIRED ];
+  // Input to trigger the model instance
+  TaskInputStream task_input = 2 [ (google.api.field_behavior) = REQUIRED ];
 }
 
 // TriggerModelInstanceBinaryFileUploadResponse represents a response for the
@@ -632,10 +655,8 @@ message TestModelInstanceBinaryFileUploadRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference).type = "api.instill.tech/ModelInstance"
   ];
-  // The list of file length for each uploaded binary file
-  repeated uint64 file_lengths = 2 [ (google.api.field_behavior) = REQUIRED ];
-  // Content of images in bytes
-  bytes content = 3 [ (google.api.field_behavior) = REQUIRED ];
+  // Input to trigger the model instance
+  TaskInputStream task_input = 2 [ (google.api.field_behavior) = REQUIRED ];
 }
 
 // TestModelInstanceBinaryFileUploadResponse represents a response for the

vdp/model/v1alpha/task_classification.proto

@@ -16,6 +16,14 @@ message ClassificationInput {
   }
 }
 
+// ClassificationInputStream represents the input of classification task when using stream method
+message ClassificationInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // ClassificationOutput represents the output of classification task
 message ClassificationOutput {
   // Classification category

vdp/model/v1alpha/task_detection.proto

@@ -28,6 +28,14 @@ message DetectionInput {
   }
 }
 
+// DetectionInputStream represents the input of detection task when using stream method
+message DetectionInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // DetectionOutput represents the output of detection task
 message DetectionOutput {
   // A list of detection objects

vdp/model/v1alpha/task_instance_segmentation.proto

@@ -30,6 +30,14 @@ message InstanceSegmentationInput {
   }
 }
 
+// InstanceSegmentationInputStream represents the input of instance segmentation task when using stream method
+message InstanceSegmentationInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // InstanceSegmentationOutput represents the output of instance segmentation
 // task
 message InstanceSegmentationOutput {

vdp/model/v1alpha/task_keypoint.proto

@@ -38,6 +38,14 @@ message KeypointInput {
   }
 }
 
+// KeypointInputStream represents the input of keypoint detection task when using stream method
+message KeypointInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // KeypointOutput represents the output of keypoint detection task
 message KeypointOutput {
   // A list of keypoint objects

vdp/model/v1alpha/task_ocr.proto

@@ -28,6 +28,14 @@ message OcrInput {
   }
 }
 
+// OcrInputStream represents the input of ocr task when using stream method
+message OcrInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // OcrOutput represents the output of ocr task
 message OcrOutput {
   // A list of OCR objects

vdp/model/v1alpha/task_semantic_segmentation.proto

@@ -24,6 +24,14 @@ message SemanticSegmentationInput {
   }
 }
 
+// SemanticSegmentationInputStream represents the input of semantic segmentation task when using stream method
+message SemanticSegmentationInputStream {
+  // The list of file length for each uploaded binary file
+  repeated uint64 file_lengths = 1 [ (google.api.field_behavior) = REQUIRED ];
+  // Content of images in bytes
+  bytes content = 2 [ (google.api.field_behavior) = REQUIRED ];
+}
+
 // SemanticSegmentationOutput represents the output of semantic segmentation
 // task
 message SemanticSegmentationOutput {