feat(model): update chat_history schema to align with OpenAI message field

core/mgmt/v1beta/mgmt.proto

@@ -904,7 +904,7 @@ message GetOrganizationSubscriptionRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {child_type: "api.instill.tech/Organization"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization.name"}
+      field_configuration: {path_param_name: "organization.name"}
     }
   ];
 }
@@ -914,6 +914,7 @@ message GetOrganizationSubscriptionResponse {
   // The subscription resource.
   Subscription subscription = 1;
 }
+
 // GetUserSubscriptionAdminRequest
 message GetUserSubscriptionAdminRequest {
   // parent

core/mgmt/v1beta/mgmt_public_service.proto

@@ -8,7 +8,6 @@ import "core/mgmt/v1beta/mgmt.proto";
 import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/visibility.proto";
-
 // OpenAPI definition
 import "protoc-gen-openapiv2/options/annotations.proto";
 
@@ -23,8 +22,8 @@ service MgmtPublicService {
     description: "🔮 Core endpoints to manage user resources. The **base path** for this server is `core/` (e.g. `GET {protocol}://{host}/core/v1beta/users`)";
     external_docs: {
       description: "More about Core";
-      url:"https://github.com/instill-ai/core";
-     };
+      url: "https://github.com/instill-ai/core";
+    };
   };
 
   // Check if the MGMT server is alive

model/model/v1alpha/common.proto

@@ -37,12 +37,31 @@ message PromptImage {
   }
 }
 
-// Content used for chat history in text generation model
-message Content {
+// Image content for Message Content
+message ImageContent {
+  // Image url or base64 code of Message Content
+  PromptImage image_url = 1;
+  // Additinoal information for Image Content
+  optional string detail = 2;
+}
+
+// Content used for chat history message in text generation model
+message MessageContent {
   // Type of Content
   string type = 1;
   // Content of Text Message
-  string content = 2;
-  // Content of Image
-  PromptImage prompt_image = 3;
+  oneof content {
+    // Image Url is the naming convention by openAi but not necessarily a url
+    ImageContent image_url = 2;
+    // Field for text
+    string text = 3;
+  }
+}
+
+// Message used for chat history in text generation model
+message Message {
+  // The Role of a message
+  string role = 1;
+  // The context of the message
+  repeated MessageContent content = 2;
 }

model/model/v1alpha/task_text_generation.proto

@@ -14,7 +14,7 @@ message TextGenerationInput {
   // The prompt images
   repeated PromptImage prompt_images = 2 [(google.api.field_behavior) = OPTIONAL];
   // The chat history
-  repeated Content chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
+  repeated Message chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
   // The system message
   optional string system_message = 4 [(google.api.field_behavior) = OPTIONAL];
   // The maximum number of tokens for model to generate

model/model/v1alpha/task_text_generation_chat.proto

@@ -14,7 +14,7 @@ message TextGenerationChatInput {
   // The prompt images
   repeated PromptImage prompt_images = 2 [(google.api.field_behavior) = OPTIONAL];
   // The chat history
-  repeated Content chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
+  repeated Message chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
   // The system message
   optional string system_message = 4 [(google.api.field_behavior) = OPTIONAL];
   // The maximum number of tokens for model to generate

model/model/v1alpha/task_visual_question_answering.proto

@@ -14,7 +14,7 @@ message VisualQuestionAnsweringInput {
   // The prompt images
   repeated PromptImage prompt_images = 2 [(google.api.field_behavior) = OPTIONAL];
   // The chat history
-  repeated Content chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
+  repeated Message chat_history = 3 [(google.api.field_behavior) = OPTIONAL];
   // The system message
   optional string system_message = 4 [(google.api.field_behavior) = OPTIONAL];
   // The maximum number of tokens for model to generate

openapiv2/openapiv2.swagger.yaml

@@ -5502,19 +5502,6 @@ definitions:
         title: Classification score
         readOnly: true
     title: ClassificationOutput represents the output of classification task
-  v1alphaContent:
-    type: object
-    properties:
-      type:
-        type: string
-        title: Type of Content
-      content:
-        type: string
-        title: Content of Text Message
-      prompt_image:
-        $ref: '#/definitions/v1alphaPromptImage'
-        title: Content of Image
-    title: Content used for chat history in text generation model
   v1alphaCreateUserModelBinaryFileUploadResponse:
     type: object
     properties:
@@ -5635,6 +5622,16 @@ definitions:
         $ref: '#/definitions/v1alphaModel'
         title: The retrieved model
     title: GetUserModelResponse represents a response for a model
+  v1alphaImageContent:
+    type: object
+    properties:
+      image_url:
+        $ref: '#/definitions/v1alphaPromptImage'
+        title: Image url or base64 code of Message Content
+      detail:
+        type: string
+        title: Additinoal information for Image Content
+    title: Image content for Message Content
   v1alphaImageToImageInput:
     type: object
     properties:
@@ -5905,6 +5902,32 @@ definitions:
         $ref: '#/definitions/v1alphaModel'
         title: A model resource
     title: LookUpModelResponse represents a response for a model
+  v1alphaMessage:
+    type: object
+    properties:
+      role:
+        type: string
+        title: The Role of a message
+      content:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/v1alphaMessageContent'
+        title: The context of the message
+    title: Message used for chat history in text generation model
+  v1alphaMessageContent:
+    type: object
+    properties:
+      type:
+        type: string
+        title: Type of Content
+      image_url:
+        $ref: '#/definitions/v1alphaImageContent'
+        title: Image Url is the naming convention by openAi but not necessarily a url
+      text:
+        type: string
+        title: Field for text
+    title: Content used for chat history message in text generation model
   v1alphaModel:
     type: object
     properties:
@@ -6443,7 +6466,7 @@ definitions:
         type: array
         items:
           type: object
-          $ref: '#/definitions/v1alphaContent'
+          $ref: '#/definitions/v1alphaMessage'
         title: The chat history
       system_message:
         type: string
@@ -6494,7 +6517,7 @@ definitions:
         type: array
         items:
           type: object
-          $ref: '#/definitions/v1alphaContent'
+          $ref: '#/definitions/v1alphaMessage'
         title: The chat history
       system_message:
         type: string
@@ -6671,7 +6694,7 @@ definitions:
         type: array
         items:
           type: object
-          $ref: '#/definitions/v1alphaContent'
+          $ref: '#/definitions/v1alphaMessage'
         title: The chat history
       system_message:
         type: string

vdp/pipeline/v1beta/connector.proto

@@ -420,7 +420,7 @@ message CreateOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {child_type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization.name"}
+      field_configuration: {path_param_name: "organization.name"}
     }
   ];
 }
@@ -450,7 +450,7 @@ message ListOrganizationConnectorsRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {child_type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization.name"}
+      field_configuration: {path_param_name: "organization.name"}
     }
   ];
   // Include soft-deleted connectors in the result.
@@ -477,7 +477,7 @@ message GetOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
   // View allows clients to specify the desired resource view in the response.
@@ -518,7 +518,7 @@ message DeleteOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
 }
@@ -536,7 +536,7 @@ message ConnectOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
 }
@@ -557,7 +557,7 @@ message DisconnectOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
 }
@@ -578,7 +578,7 @@ message RenameOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
   // The new resource ID. This will transform the resource name into
@@ -602,7 +602,7 @@ message ExecuteOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
   // Connector input parameters.
@@ -627,7 +627,7 @@ message TestOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
 }
@@ -648,7 +648,7 @@ message WatchOrganizationConnectorRequest {
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {type: "api.instill.tech/Connector"},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-field_configuration: {path_param_name: "organization_connector.name"}
+      field_configuration: {path_param_name: "organization_connector.name"}
     }
   ];
 }
@@ -659,7 +659,6 @@ message WatchOrganizationConnectorResponse {
   Connector.State state = 1;
 }
 
-
 // ========== Private endpoints
 
 // ListConnectorsAdminRequest represents a request by an admin to list all

vdp/pipeline/v1beta/pipeline_private_service.proto

@@ -2,18 +2,16 @@ syntax = "proto3";
 
 package vdp.pipeline.v1beta;
 
-import "vdp/pipeline/v1beta/connector.proto";
-import "vdp/pipeline/v1beta/connector_definition.proto";
-import "vdp/pipeline/v1beta/operator_definition.proto";
-import "vdp/pipeline/v1beta/pipeline.proto";
-
 // Google API
 import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/visibility.proto";
-
 // OpenAPI definition
 import "protoc-gen-openapiv2/options/annotations.proto";
+import "vdp/pipeline/v1beta/connector.proto";
+import "vdp/pipeline/v1beta/connector_definition.proto";
+import "vdp/pipeline/v1beta/operator_definition.proto";
+import "vdp/pipeline/v1beta/pipeline.proto";
 
 // PipelinePrivateService defines private methods to interact with Pipeline
 // resources.

vdp/pipeline/v1beta/pipeline_public_service.proto

@@ -6,14 +6,13 @@ package vdp.pipeline.v1beta;
 import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/visibility.proto";
+// OpenAPI definition
+import "protoc-gen-openapiv2/options/annotations.proto";
 import "vdp/pipeline/v1beta/connector.proto";
 import "vdp/pipeline/v1beta/connector_definition.proto";
 import "vdp/pipeline/v1beta/operator_definition.proto";
 import "vdp/pipeline/v1beta/pipeline.proto";
 
-// OpenAPI definition
-import "protoc-gen-openapiv2/options/annotations.proto";
-
 // VDP
 //
 // PipelinePublicService exposes the public VDP endpoints that allow clients to
@@ -25,7 +24,7 @@ service PipelinePublicService {
     description: "💧 VDP endpoints to manage pipeline resources. The **base path** for this server is `vdp/` (e.g. `GET {protocol}://{host}/vdp/v1beta/pipelines`)";
     external_docs: {
       description: "More about VDP";
-      url:"https://github.com/instill-ai/vdp";
+      url: "https://github.com/instill-ai/vdp";
     };
   };
 
@@ -674,7 +673,7 @@ service PipelinePublicService {
   rpc UpdateUserConnector(UpdateUserConnectorRequest) returns (UpdateUserConnectorResponse) {
     option (google.api.http) = {
       patch: "/v1beta/{connector.name=users/*/connectors/*}"
-       body: "connector"
+      body: "connector"
     };
     option (google.api.method_signature) = "connector,update_mask";
   }
@@ -797,7 +796,7 @@ service PipelinePublicService {
   rpc UpdateOrganizationConnector(UpdateOrganizationConnectorRequest) returns (UpdateOrganizationConnectorResponse) {
     option (google.api.http) = {
       patch: "/v1beta/{connector.name=organizations/*/connectors/*}"
-       body: "connector"
+      body: "connector"
     };
     option (google.api.method_signature) = "connector,update_mask";
   }