Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] Update Rest API 2024-08-01-preview for stream options #30810

Open
mirkus90 opened this issue Oct 1, 2024 · 1 comment
Open

[BUG] Update Rest API 2024-08-01-preview for stream options #30810

mirkus90 opened this issue Oct 1, 2024 · 1 comment
Assignees
@yuanzhuangyuanzhuang
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@mirkus90
Copy link

mirkus90 commented Oct 1, 2024

API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.yaml

API Spec version

2024-08-01-preview

Describe the bug

The "chatCompletionStreamOptions" has been added to the schema for returing the token usage into the streaming, but it is never used into the YAML. The "stream_options" parameter is missing, compared to the OpenAI specs
https://platform.openai.com/docs/api-reference/chat

Expected behavior

"stream_options" parameter should be exposed into the request body as optional parameter

Actual behavior

"stream_options" is not available and I had to have a look at the OpenAI specs to understand how to use the "include_usage" parameter.

Reproduction Steps

Create a request with Postman to the ChatCompletion.
Pass "stream" : true
Do not know which parameter name to pass for the streaming options.

Environment

No response
@mirkus90 mirkus90 added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Oct 1, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added question The issue doesn't require a change to the product in order to be resolved. Most issues start as that customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Oct 1, 2024
@v-jiaodi
Copy link
Member

v-jiaodi commented Oct 8, 2024

@yuanzhuangyuanzhuang Please help take a look, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yuanzhuangyuanzhuang yuanzhuangyuanzhuang

Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mirkus90 @yuanzhuangyuanzhuang @v-jiaodi