Skip to content

Change OpenAI API endpoints from Completions to Responses for TypeScript #277

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

Change OpenAI API endpoints from Completions to Responses for TypeScript #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions typescript/src/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export function createLanguageModel(env: Record<string, string | undefined>): Ty
if (env.OPENAI_API_KEY) {
const apiKey = env.OPENAI_API_KEY ?? missingEnvironmentVariable("OPENAI_API_KEY");
const model = env.OPENAI_MODEL ?? missingEnvironmentVariable("OPENAI_MODEL");
const endPoint = env.OPENAI_ENDPOINT ?? "https://api.openai.com/v1/chat/completions";
const endPoint = env.OPENAI_ENDPOINT ?? "https://api.openai.com/v1/responses";
const org = env.OPENAI_ORGANIZATION ?? "";
return createOpenAILanguageModel(apiKey, model, endPoint, org);
}
Expand All @@ -111,11 +111,11 @@ export function createLanguageModel(env: Record<string, string | undefined>): Ty
* Creates a language model encapsulation of an OpenAI REST API endpoint.
* @param apiKey The OpenAI API key.
* @param model The model name.
* @param endPoint The URL of the OpenAI REST API endpoint. Defaults to "https://api.openai.com/v1/chat/completions".
* @param endPoint The URL of the OpenAI REST API endpoint. Defaults to "https://api.openai.com/v1/responses".
* @param org The OpenAI organization id.
* @returns An instance of `TypeChatLanguageModel`.
*/
export function createOpenAILanguageModel(apiKey: string, model: string, endPoint = "https://api.openai.com/v1/chat/completions", org = ""): TypeChatLanguageModel {
export function createOpenAILanguageModel(apiKey: string, model: string, endPoint = "https://api.openai.com/v1/responses", org = ""): TypeChatLanguageModel {
const headers = {
"Authorization": `Bearer ${apiKey}`,
"OpenAI-Organization": org
Expand All @@ -126,7 +126,7 @@ export function createOpenAILanguageModel(apiKey: string, model: string, endPoin
/**
* Creates a language model encapsulation of an Azure OpenAI REST API endpoint.
* @param endPoint The URL of the OpenAI REST API endpoint. The URL must be in the format
* "https://{your-resource-name}.openai.azure.com/openai/deployments/{your-deployment-name}/chat/completions?api-version={API-version}".
* "https://{your-resource-name}.openai.azure.com/openai/deployments/{your-deployment-name}/responses?api-version={API-version}".
* Example deployment names are "gpt-35-turbo" and "gpt-4". An example API versions is "2023-05-15".
* @param apiKey The Azure OpenAI API key.
* @returns An instance of `TypeChatLanguageModel`.
Expand Down