From 2b7d46e83c2998e32022490167e75f5b98f762ed Mon Sep 17 00:00:00 2001
From: Brian Zhang <brianz@openai.com>
Date: Tue, 23 Apr 2024 15:44:43 -0700
Subject: [PATCH] Add stream_options param; add usage in ChatCompletionChunk

---
 openapi.yaml | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/openapi.yaml b/openapi.yaml
index 888df352..0c3b5af5 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -7145,6 +7145,17 @@ components:
           type: boolean
           nullable: true
           default: false
+        stream_options:
+          description: Options for stream response
+          type: object
+          nullable: true
+          default: null
+          properties:
+            include_usage:
+              type: boolean
+              description: |
+                If set, an extra chunk will be returned before the `data: [Done]` message with a `usage` field that shows usage data for all chunks in the streamed request.
+                All other chunks will also include a `usage` field but with a null value. In the case of an error, the extra (usage) chunk might be missing.
         suffix:
           description: |
             The suffix that comes after a completion of inserted text.
@@ -7822,6 +7833,17 @@ components:
           type: boolean
           nullable: true
           default: false
+        stream_options:
+          description: Options for stream response
+          type: object
+          nullable: true
+          default: null
+          properties:
+            include_usage:
+              type: boolean
+              description: |
+                If set, an extra chunk will be returned before the `data: [Done]` message with a `usage` field that shows usage data for all chunks in the streamed request.
+                All other chunks will also include a `usage` field but with a null value. In the case of an error, the extra (usage) chunk might be missing.
         temperature:
           type: number
           minimum: 0
@@ -8122,6 +8144,23 @@ components:
           type: string
           description: The object type, which is always `chat.completion.chunk`.
           enum: [chat.completion.chunk]
+        usage:
+          type: object
+          description: Usage statistics for the streamed completion request. Value is null except for the last chunk.
+          properties:
+            completion_tokens:
+              type: integer
+              description: Number of tokens in the generated completion.
+            prompt_tokens:
+              type: integer
+              description: Number of tokens in the prompt.
+            total_tokens:
+              type: integer
+              description: Total number of tokens used in the request (prompt + completion).
+          required:
+            - prompt_tokens
+            - completion_tokens
+            - total_tokens
       required:
         - choices
         - created