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.

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

Fix Chat Completion Stream API and Swagger Docs #356

Closed
GirinMan opened this issue Mar 26, 2024 · 0 comments · Fixed by #358
Closed

Fix Chat Completion Stream API and Swagger Docs #356

GirinMan opened this issue Mar 26, 2024 · 0 comments · Fixed by #358
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@GirinMan
Copy link
Contributor

Feature request

  • This issue encompasses two distinct improvements: fixing the Chat Completion Stream API to align with official OpenAI API behavior, and enhancing the Swagger Docs for better usability and clarity.
  • Specifically, the Stream API fix involves ensuring the final chunk in a stream correctly returns as an empty object rather than erroneously containing null "role" and "content".
  • The Swagger Docs improvement focuses on making the OpenAI compatible API visible, better tagging differentiation, and adding missing schemas to eliminate errors.

Motivation

  • The Chat Completion Stream API currently behaves differently from the official OpenAI API in its handling of the final chunk, leading to potential issues for clients expecting OpenAI-compatible behavior.
  • This discrepancy can cause unexpected errors and complicates integration efforts.
  • Additionally, the current state of the Swagger Docs makes it challenging for users to navigate and understand the available API features and capabilities.
  • Enhancing these aspects of the project will improve its compatibility, usability, and overall user experience.

Your contribution

  • I plan to address these issues by submitting a PR that implements the necessary fixes and improvements.
  • This will include code adjustments for the Chat Completion Stream API, as well as updates to the Swagger Docs to address the identified shortcomings.
@tgaddair tgaddair added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants