add support for token provider #1587
Draft
+185
−84
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.
Changes being requested
This PR introduces a new
tokenProvider
option to the OpenAI client, enabling dynamic token retrieval for authentication scenarios where API keys need to be refreshed or obtained at runtime.Additional context & links
Changes
New Feature:
tokenProvider
OptionTokenProvider
type definition:() => Promise<AccessToken>
AccessToken
interface withtoken: string
propertytokenProvider
option toClientOptions
interface_setToken()
methodKey Benefits
Implementation Details
Client Construction:
tokenProvider
andapiKey
are mutually exclusive - only one can be providedtokenProvider
(setsdangerouslyAllowBrowser: true
)Token Management:
_setToken()
method now returns a boolean indicating if a token was successfully retrievedprepareOptions()
Usage Example
Backward Compatibility
This change is fully backward compatible. Existing code using
apiKey
continues to work unchanged. The newtokenProvider
option is purely additive.