add chat completion stream types to spec (64bit#92)

Author: oslfmt

async-openai/src/types/types.rs

@@ -871,26 +871,26 @@ pub type ChatCompletionResponseStream =
 // For reason (not documented by OpenAI) the response from stream is different
 
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
-pub struct ChatCompletionResponseStreamMessage {
-    pub content: Option<String>,
+pub struct ChatCompletionStreamResponseDelta {
     pub role: Option<Role>,
+    pub content: Option<String>,
+    pub function_call: Option<FunctionCall>,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
-pub struct ChatChoiceDelta {
+pub struct ChatCompletionResponseStreamMessage {
     pub index: u32,
-    pub delta: ChatCompletionResponseStreamMessage,
+    pub delta: ChatCompletionStreamResponseDelta,
     pub finish_reason: Option<String>,
 }
 
 #[derive(Debug, Deserialize, Clone, PartialEq, Serialize)]
 pub struct CreateChatCompletionStreamResponse {
-    pub id: Option<String>,
+    pub id: String,
     pub object: String,
     pub created: u32,
     pub model: String,
-    pub choices: Vec<ChatChoiceDelta>,
-    pub usage: Option<Usage>,
+    pub choices: Vec<ChatCompletionResponseStreamMessage>,
 }
 
 #[derive(Debug, Default, Clone, PartialEq)]

openapi.yaml

@@ -2369,6 +2369,28 @@ components:
       required:
         - role
 
+    ChatCompletionStreamResponseDelta:
+      type: object
+      properties:
+        role:
+          type: string
+          enum: ["system", "user", "assistant", "function"]
+          description: The role of the author of this message.
+        content:
+          type: string
+          description: The contents of the chunk message.
+          nullable: true
+        function_call:
+          type: object
+          description: The name and arguments of a function that should be called, as generated by the model.
+          properties:
+            name:
+              type: string
+              description: The name of the function to call.
+            arguments:
+              type: string
+              description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
+
     CreateChatCompletionRequest:
       type: object
       properties:
@@ -2519,6 +2541,36 @@ components:
         - model
         - choices
 
+    CreateChatCompletionStreamResponse:
+      type: object
+      properties:
+        id:
+          type: string
+        object:
+          type: string
+        created:
+          type: integer
+        model:
+          type: string
+        choices:
+          type: array
+          items:
+            type: object
+            properties:
+              index:
+                type: integer
+              delta:
+                $ref: '#/components/schemas/ChatCompletionStreamResponseDelta'
+              finish_reason:
+                type: string
+                enum: ["stop", "length", "function_call"]
+      required: 
+        - id
+        - object
+        - created
+        - model
+        - choices
+
     CreateEditRequest:
       type: object
       properties: