feat: add custom requestHeaders support for custom OAI and Azure models in BYOK
#1231
Conversation
…zhichli/customheaders4byok
…zhichli/customheaders4byok
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for custom HTTP headers in BYOK (Bring Your Own Key) configurations for both Azure and custom OpenAI models. Users can now specify additional request headers that will be sent with API requests to their custom model endpoints.
- Extends the model configuration interfaces to include optional
requestHeadersfield - Implements header sanitization logic to prevent overriding reserved system headers
- Updates the OpenAI endpoint to merge custom headers with default request headers
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/platform/endpoint/common/endpointProvider.ts | Adds requestHeaders field to IChatModelInformation interface |
| src/platform/configuration/common/configurationService.ts | Updates CustomOAIModels type definition to include requestHeaders |
| src/extension/byok/vscode-node/customOAIProvider.ts | Integrates requestHeaders throughout the custom OAI provider implementation |
| src/extension/byok/vscode-node/customOAIModelConfigurator.ts | Adds requestHeaders to the ModelConfig interface |
| src/extension/byok/node/openAIEndpoint.ts | Implements header sanitization and merging logic for custom headers |
| src/extension/byok/common/byokProvider.ts | Updates BYOK interfaces and resolveModelInfo to handle custom headers |
| package.json | Adds schema definitions for the new requestHeaders configuration options |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…ode-copilot-chat into zhichli/customheaders4byok
| } | ||
|
|
||
| private _sanitizeHeaderValue(value: string, key: string): string | undefined { | ||
| private _sanitizeHeaderValue(value: unknown): string | undefined { |
There was a problem hiding this comment.
Are we not sanitzing twice here? Both above and with this function
There was a problem hiding this comment.
So _sanitizeHeaderValue() is a helper function called by _sanitizeCustomHeaders() during initialization, not a separate sanitization step. The headers are sanitized once during object construction and then reused safely throughout the object's lifetime.
The separation is: _sanitizeCustomHeaders() handles the overall header collection logic (limits, reserved headers, key validation) while _sanitizeHeaderValue() focuses specifically on value sanitization (control characters, length limits, etc.)."
No description provided.