Skip to content

Commit

Permalink
Remove stream options as the feature is not ready yet (#30087)
Browse files Browse the repository at this point in the history
Co-authored-by: Yuan Zhuang <yuzhua@microsoft.com>
  • Loading branch information
yuanzhuangyuanzhuang and Yuan Zhuang authored Aug 5, 2024
1 parent da1e3d2 commit 3f3d26f
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3681,9 +3681,6 @@
"tool_choice": {
"$ref": "#/components/schemas/chatCompletionToolChoiceOption"
},
"stream_options": {
"$ref": "#/components/schemas/chatCompletionStreamOptions"
},
"functions": {
"description": "Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.",
"type": "array",
Expand Down Expand Up @@ -5571,18 +5568,6 @@
],
"description": "The role of the author of the response message."
},
"chatCompletionStreamOptions": {
"type": "object",
"nullable": true,
"default": null,
"properties": {
"include_usage": {
"type": "boolean",
"description": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value."
}
},
"description": "Options for streaming response. Only set this when you set `stream: true`."
},
"chatCompletionToolChoiceOption": {
"description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.",
"oneOf": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2304,8 +2304,6 @@ components:
type: boolean
nullable: true
default: false
stream_options:
$ref: '#/components/schemas/chatCompletionStreamOptions'
stop:
description: Up to 4 sequences where the API will stop generating further tokens.
oneOf:
Expand Down Expand Up @@ -3674,17 +3672,6 @@ components:
enum:
- assistant
description: The role of the author of the response message.
chatCompletionStreamOptions:
description: |
Options for streaming response. Only set this when you set `stream: true`.
type: object
nullable: true
default: null
properties:
include_usage:
type: boolean
description: |
If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.
chatCompletionToolChoiceOption:
description: |
Controls which (if any) tool is called by the model.
Expand Down

0 comments on commit 3f3d26f

Please sign in to comment.