docs: correct client rate-limit guidance - #896
Open
sylvesterkaczmarek wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Correct the
OpenAIClientandOpenAIClientAsyncclass-level documentation so it no longer claims that each client proactively handles API rate limiting.Fixes #644.
Problem
Both client interfaces currently say:
That implies client-wide proactive rate-limit coordination. The SDK does not implement that behavior. It can retry individual requests after retryable responses, including rate-limit responses, but it does not coordinate a shared rate budget across requests or across client instances.
The existing wording can therefore lead users to believe that reusing one client is required for correct API rate-limit accounting.
Fix
Update the shared guidance in both synchronous and asynchronous client interfaces to state that:
Scope
OpenAIClient.kt: 3 additions / 3 deletionsOpenAIClientAsync.kt: 3 additions / 3 deletionsValidation
The branch is based on current upstream
mainat81134d727946fb84cc48db98e6c8c53c8a8d22aband is 0 commits behind upstream.Risk
Minimal. Documentation only, with sync and async client guidance kept consistent.