-
Notifications
You must be signed in to change notification settings - Fork 798
fix(providers): support Azure OpenAI chat completions #404
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
Open
Yong-yuan-X
wants to merge
2
commits into
rohitg00:main
Choose a base branch
from
Yong-yuan-X:fix/374-azure-openai
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| import type { MemoryProvider } from "../types.js"; | ||
| import { getEnvVar } from "../config.js"; | ||
|
|
||
| const DEFAULT_BASE_URL = "https://api.openai.com"; | ||
| const DEFAULT_AZURE_API_VERSION = "2024-10-21"; | ||
|
|
||
| export class OpenAIProvider implements MemoryProvider { | ||
| name = "openai"; | ||
| private apiKey: string; | ||
| private model: string; | ||
| private maxTokens: number; | ||
| private baseUrl: string; | ||
|
|
||
| constructor( | ||
| apiKey: string, | ||
| model: string, | ||
| maxTokens: number, | ||
| baseUrl?: string, | ||
| ) { | ||
| this.apiKey = apiKey; | ||
| this.model = model; | ||
| this.maxTokens = maxTokens; | ||
| this.baseUrl = baseUrl || getEnvVar("OPENAI_BASE_URL") || DEFAULT_BASE_URL; | ||
| } | ||
|
|
||
| async compress(systemPrompt: string, userPrompt: string): Promise<string> { | ||
| return this.call(systemPrompt, userPrompt); | ||
| } | ||
|
|
||
| async summarize(systemPrompt: string, userPrompt: string): Promise<string> { | ||
| return this.call(systemPrompt, userPrompt); | ||
| } | ||
|
|
||
| private isAzure(): boolean { | ||
| const url = this.baseUrl.toLowerCase(); | ||
| return url.includes("openai.azure.com") || url.includes("/openai/deployments/"); | ||
| } | ||
|
|
||
| private buildRequestUrl(): string { | ||
| const url = new URL(this.baseUrl); | ||
| const pathname = url.pathname.replace(/\/+$/, ""); | ||
|
|
||
| if (this.isAzure()) { | ||
| if (!pathname.endsWith("/chat/completions")) { | ||
| url.pathname = `${pathname}/chat/completions`; | ||
| } | ||
|
|
||
| const apiVersion = | ||
| getEnvVar("AZURE_OPENAI_API_VERSION") || | ||
| url.searchParams.get("api-version") || | ||
| DEFAULT_AZURE_API_VERSION; | ||
| url.searchParams.set("api-version", apiVersion); | ||
|
|
||
| return url.toString(); | ||
| } | ||
|
|
||
| if (pathname.endsWith("/chat/completions")) { | ||
| url.pathname = pathname; | ||
| } else if (pathname.endsWith("/v1")) { | ||
| url.pathname = `${pathname}/chat/completions`; | ||
| } else { | ||
| url.pathname = `${pathname}/v1/chat/completions`; | ||
| } | ||
|
|
||
| return url.toString(); | ||
| } | ||
|
|
||
| private buildHeaders(): HeadersInit { | ||
| if (this.isAzure()) { | ||
| return { | ||
| "Content-Type": "application/json", | ||
| "api-key": this.apiKey, | ||
| }; | ||
| } | ||
|
|
||
| return { | ||
| "Content-Type": "application/json", | ||
| Authorization: `Bearer ${this.apiKey}`, | ||
| }; | ||
| } | ||
|
|
||
| private buildBody(systemPrompt: string, userPrompt: string): string { | ||
| return JSON.stringify({ | ||
| ...(this.isAzure() ? {} : { model: this.model }), | ||
| max_tokens: this.maxTokens, | ||
| messages: [ | ||
| { role: "system", content: systemPrompt }, | ||
| { role: "user", content: userPrompt }, | ||
| ], | ||
| }); | ||
| } | ||
|
|
||
| private async call( | ||
| systemPrompt: string, | ||
| userPrompt: string, | ||
| ): Promise<string> { | ||
| const response = await fetch(this.buildRequestUrl(), { | ||
| method: "POST", | ||
| headers: this.buildHeaders(), | ||
| body: this.buildBody(systemPrompt, userPrompt), | ||
| }); | ||
|
|
||
| if (!response.ok) { | ||
| const text = await response.text(); | ||
| throw new Error(`OpenAI API error (${response.status}): ${text}`); | ||
| } | ||
|
|
||
| const data = (await response.json()) as Record<string, unknown>; | ||
| const choices = data.choices as | ||
| | Array<{ message: { content: string } }> | ||
| | undefined; | ||
| const content = choices?.[0]?.message?.content; | ||
| if (!content) { | ||
| throw new Error( | ||
| `OpenAI returned unexpected response: ${JSON.stringify(data).slice(0, 200)}`, | ||
| ); | ||
| } | ||
| return content; | ||
| } | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; | ||
| import { OpenAIProvider } from "../src/providers/openai.js"; | ||
|
|
||
| describe("OpenAIProvider", () => { | ||
| const originalEnv = { ...process.env }; | ||
|
|
||
| beforeEach(() => { | ||
| process.env = { ...originalEnv }; | ||
| delete process.env["AZURE_OPENAI_API_VERSION"]; | ||
| delete process.env["OPENAI_BASE_URL"]; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| process.env = originalEnv; | ||
| }); | ||
|
|
||
| it("uses OpenAI-compatible chat completions with bearer auth by default", async () => { | ||
| const provider = new OpenAIProvider( | ||
| "test-key", | ||
| "gpt-4o-mini", | ||
| 123, | ||
| "https://api.example.com", | ||
| ); | ||
| const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue( | ||
| new Response( | ||
| JSON.stringify({ choices: [{ message: { content: "ok" } }] }), | ||
| { status: 200 }, | ||
| ), | ||
| ); | ||
|
|
||
| await expect(provider.summarize("sys", "user")).resolves.toBe("ok"); | ||
|
|
||
| expect(fetchSpy).toHaveBeenCalledWith( | ||
| "https://api.example.com/v1/chat/completions", | ||
| expect.objectContaining({ | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/json", | ||
| Authorization: "Bearer test-key", | ||
| }, | ||
| }), | ||
| ); | ||
| const body = JSON.parse( | ||
| (fetchSpy.mock.calls[0][1] as RequestInit).body as string, | ||
| ) as Record<string, unknown>; | ||
| expect(body).toMatchObject({ | ||
| model: "gpt-4o-mini", | ||
| max_tokens: 123, | ||
| }); | ||
| }); | ||
|
|
||
| it("uses Azure deployment URLs with api-version and api-key auth", async () => { | ||
| process.env["AZURE_OPENAI_API_VERSION"] = "2024-10-21"; | ||
| const provider = new OpenAIProvider( | ||
| "azure-key", | ||
| "ignored-deployment-model", | ||
| 456, | ||
| "https://resource.openai.azure.com/openai/deployments/my-deployment", | ||
| ); | ||
| const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue( | ||
| new Response( | ||
| JSON.stringify({ choices: [{ message: { content: "azure ok" } }] }), | ||
| { status: 200 }, | ||
| ), | ||
| ); | ||
|
|
||
| await expect(provider.compress("sys", "user")).resolves.toBe("azure ok"); | ||
|
|
||
| expect(fetchSpy).toHaveBeenCalledWith( | ||
| "https://resource.openai.azure.com/openai/deployments/my-deployment/chat/completions?api-version=2024-10-21", | ||
| expect.objectContaining({ | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/json", | ||
| "api-key": "azure-key", | ||
| }, | ||
| }), | ||
| ); | ||
| const body = JSON.parse( | ||
| (fetchSpy.mock.calls[0][1] as RequestInit).body as string, | ||
| ) as Record<string, unknown>; | ||
| expect(body).not.toHaveProperty("model"); | ||
| expect(body.max_tokens).toBe(456); | ||
| }); | ||
|
|
||
| it("does not duplicate /v1 for non-Azure base URLs", async () => { | ||
| const provider = new OpenAIProvider( | ||
| "test-key", | ||
| "gpt-4o-mini", | ||
| 123, | ||
| "https://api.example.com/v1", | ||
| ); | ||
| const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue( | ||
| new Response( | ||
| JSON.stringify({ choices: [{ message: { content: "ok" } }] }), | ||
| { status: 200 }, | ||
| ), | ||
| ); | ||
|
|
||
| await provider.summarize("sys", "user"); | ||
|
|
||
| expect(fetchSpy.mock.calls[0][0]).toBe( | ||
| "https://api.example.com/v1/chat/completions", | ||
| ); | ||
| }); | ||
|
|
||
| it("does not duplicate /chat/completions for full non-Azure endpoints", async () => { | ||
| const provider = new OpenAIProvider( | ||
| "test-key", | ||
| "gpt-4o-mini", | ||
| 123, | ||
| "https://api.example.com/v1/chat/completions", | ||
| ); | ||
| const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue( | ||
| new Response( | ||
| JSON.stringify({ choices: [{ message: { content: "ok" } }] }), | ||
| { status: 200 }, | ||
| ), | ||
| ); | ||
|
|
||
| await provider.summarize("sys", "user"); | ||
|
|
||
| expect(fetchSpy.mock.calls[0][0]).toBe( | ||
| "https://api.example.com/v1/chat/completions", | ||
| ); | ||
| }); | ||
|
|
||
| it("defaults Azure api-version to the latest GA data-plane version", async () => { | ||
| const provider = new OpenAIProvider( | ||
| "azure-key", | ||
| "deployment", | ||
| 456, | ||
| "https://gateway.example.com/openai/deployments/deployment", | ||
| ); | ||
| const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue( | ||
| new Response( | ||
| JSON.stringify({ choices: [{ message: { content: "azure ok" } }] }), | ||
| { status: 200 }, | ||
| ), | ||
| ); | ||
|
|
||
| await provider.summarize("sys", "user"); | ||
|
|
||
| expect(fetchSpy.mock.calls[0][0]).toBe( | ||
| "https://gateway.example.com/openai/deployments/deployment/chat/completions?api-version=2024-10-21", | ||
| ); | ||
| }); | ||
| }); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a timeout to outbound OpenAI requests.
fetchat Line 97 has no timeout, so stalled upstream/network connections can block summarize/compress indefinitely. Add an abort timeout and clear it infinally.Suggested fix
private async call( systemPrompt: string, userPrompt: string, ): Promise<string> { - const response = await fetch(this.buildRequestUrl(), { - method: "POST", - headers: this.buildHeaders(), - body: this.buildBody(systemPrompt, userPrompt), - }); + const controller = new AbortController(); + const timeout = setTimeout(() => controller.abort(), 30_000); + let response: Response; + try { + response = await fetch(this.buildRequestUrl(), { + method: "POST", + headers: this.buildHeaders(), + body: this.buildBody(systemPrompt, userPrompt), + signal: controller.signal, + }); + } finally { + clearTimeout(timeout); + }🤖 Prompt for AI Agents