feat: support new openai routes as unified endpoints

src/handlers/chatCompletionsHandler.ts

@@ -1,4 +1,5 @@
 import { RouterError } from '../errors/RouterError';
+import { endpointStrings } from '../providers/types';
 import {
   constructConfigFromRequestHeaders,
   tryTargetsRecursively,
@@ -13,43 +14,48 @@ import { Context } from 'hono';
  * @throws Will throw an error if no provider options can be determined or if the request to the provider(s) fails.
  * @throws Will throw an 500 error if the handler fails due to some reasons
  */
-export async function chatCompletionsHandler(c: Context): Promise<Response> {
-  try {
-    let request = await c.req.json();
-    let requestHeaders = Object.fromEntries(c.req.raw.headers);
-    const camelCaseConfig = constructConfigFromRequestHeaders(requestHeaders);
-    const tryTargetsResponse = await tryTargetsRecursively(
-      c,
-      camelCaseConfig ?? {},
-      request,
-      requestHeaders,
-      'chatComplete',
-      'POST',
-      'config'
-    );
 
-    return tryTargetsResponse;
-  } catch (err: any) {
-    console.log('chatCompletion error', err.message);
-    let statusCode = 500;
-    let errorMessage = 'Something went wrong';
+export function chatCompletionsHandler(endpoint: endpointStrings) {
+  async function handler(c: Context): Promise<Response> {
+    try {
+      const method = c.req.method;
+      let request = method === 'POST' ? await c.req.json() : {};
+      let requestHeaders = Object.fromEntries(c.req.raw.headers);
+      const camelCaseConfig = constructConfigFromRequestHeaders(requestHeaders);
+      const tryTargetsResponse = await tryTargetsRecursively(
+        c,
+        camelCaseConfig ?? {},
+        request,
+        requestHeaders,
+        endpoint,
+        method,
+        'config'
+      );
 
-    if (err instanceof RouterError) {
-      statusCode = 400;
-      errorMessage = err.message;
-    }
+      return tryTargetsResponse;
+    } catch (err: any) {
+      console.log(`${endpoint} error: ${err.message}`);
+      let statusCode = 500;
+      let errorMessage = 'Something went wrong';
 
-    return new Response(
-      JSON.stringify({
-        status: 'failure',
-        message: errorMessage,
-      }),
-      {
-        status: statusCode,
-        headers: {
-          'content-type': 'application/json',
-        },
+      if (err instanceof RouterError) {
+        statusCode = 400;
+        errorMessage = err.message;
       }
-    );
+
+      return new Response(
+        JSON.stringify({
+          status: 'failure',
+          message: errorMessage,
+        }),
+        {
+          status: statusCode,
+          headers: {
+            'content-type': 'application/json',
+          },
+        }
+      );
+    }
   }
+  return handler;
 }

src/index.ts

@@ -119,7 +119,36 @@ app.onError((err, c) => {
  * POST route for '/v1/chat/completions'.
  * Handles requests by passing them to the chatCompletionsHandler.
  */
-app.post('/v1/chat/completions', requestValidator, chatCompletionsHandler);
+app.post(
+  '/v1/chat/completions',
+  requestValidator,
+  chatCompletionsHandler('chatComplete')
+);
+app.get(
+  '/v1/chat/completions',
+  requestValidator,
+  chatCompletionsHandler('listChatCompletions')
+);
+app.get(
+  '/v1/chat/completions/:completionId',
+  requestValidator,
+  chatCompletionsHandler('getChatCompletion')
+);
+app.get(
+  '/v1/chat/completions/:completionId/messages',
+  requestValidator,
+  chatCompletionsHandler('getChatCompletionMessages')
+);
+app.post(
+  '/v1/chat/completions/:completionId',
+  requestValidator,
+  chatCompletionsHandler('updateChatCompletion')
+);
+app.delete(
+  '/v1/chat/completions/:completionId',
+  requestValidator,
+  chatCompletionsHandler('deleteChatCompletion')
+);
 
 /**
  * POST route for '/v1/completions'.
@@ -211,7 +240,7 @@ app.all(
  */
 app.post('/v1/prompts/*', requestValidator, (c) => {
   if (c.req.url.endsWith('/v1/chat/completions')) {
-    return chatCompletionsHandler(c);
+    return chatCompletionsHandler('chatComplete')(c);
   } else if (c.req.url.endsWith('/v1/completions')) {
     return completionsHandler(c);
   }

src/providers/azure-openai/api.ts

@@ -54,7 +54,7 @@ const AzureOpenAIAPIConfig: ProviderAPIConfig = {
     }
     return headersObj;
   },
-  getEndpoint: ({ providerOptions, fn, gatewayRequestURL }) => {
+  getEndpoint: ({ providerOptions, fn, gatewayRequestURL, c }) => {
     const { apiVersion, urlToFetch, deploymentId } = providerOptions;
     let mappedFn = fn;
 
@@ -77,6 +77,9 @@ const AzureOpenAIAPIConfig: ProviderAPIConfig = {
     }
 
     const path = gatewayRequestURL.split('/v1')?.[1];
+    const apiVersionQueryParam = path.includes('?')
+      ? `&api-version=${apiVersion}`
+      : `?api-version=${apiVersion}`;
 
     switch (mappedFn) {
       case 'complete': {
@@ -129,6 +132,16 @@ const AzureOpenAIAPIConfig: ProviderAPIConfig = {
         return `${path}?api-version=${apiVersion}`;
       case 'listBatches':
         return `${path}?api-version=${apiVersion}`;
+      case 'listChatCompletions':
+        return `/deployments/${deploymentId}/${path}` + apiVersionQueryParam;
+      case 'getChatCompletion':
+        return `/deployments/${deploymentId}/${path}` + apiVersionQueryParam;
+      case 'getChatCompletionMessages':
+        return `/deployments/${deploymentId}/${path}` + apiVersionQueryParam;
+      case 'updateChatCompletion':
+        return `/deployments/${deploymentId}/${path}` + apiVersionQueryParam;
+      case 'deleteChatCompletion':
+        return `/deployments/${deploymentId}/${path}` + apiVersionQueryParam;
       default:
         return '';
     }

src/providers/azure-openai/index.ts

@@ -22,6 +22,7 @@ import {
 } from './createSpeech';
 import { AzureOpenAICreateTranscriptionResponseTransform } from './createTranscription';
 import { AzureOpenAICreateTranslationResponseTransform } from './createTranslation';
+import { AzureOpenAIUpdateChatCompletionConfig } from './updateChatCompletion';
 import { OpenAICreateFinetuneConfig } from '../openai/createFinetune';
 import { AzureTransformFinetuneBody } from './createFinetune';
 import { OpenAIFileUploadRequestTransform } from '../openai/uploadFile';
@@ -40,6 +41,7 @@ const AzureOpenAIConfig: ProviderConfigs = {
   createTranscription: {},
   createTranslation: {},
   realtime: {},
+  updateChatCompletion: AzureOpenAIUpdateChatCompletionConfig,
   cancelFinetune: {},
   cancelBatch: {},
   createBatch: AzureOpenAICreateBatchConfig,
@@ -60,6 +62,11 @@ const AzureOpenAIConfig: ProviderConfigs = {
     retrieveFile: AzureOpenAIResponseTransform,
     deleteFile: AzureOpenAIResponseTransform,
     retrieveFileContent: AzureOpenAIResponseTransform,
+    listChatCompletions: AzureOpenAIResponseTransform,
+    getChatCompletion: AzureOpenAIResponseTransform,
+    getChatCompletionMessages: AzureOpenAIResponseTransform,
+    updateChatCompletion: AzureOpenAIResponseTransform,
+    deleteChatCompletion: AzureOpenAIResponseTransform,
     createFinetune: AzureOpenAIResponseTransform,
     retrieveFinetune: AzureOpenAIFinetuneResponseTransform,
     createBatch: AzureOpenAIResponseTransform,

src/providers/azure-openai/updateChatCompletion.ts

@@ -0,0 +1,8 @@
+import { ProviderConfig } from '../types';
+
+export const AzureOpenAIUpdateChatCompletionConfig: ProviderConfig = {
+  metadata: {
+    param: 'metadata',
+    required: true,
+  },
+};

src/providers/openai/api.ts

@@ -72,6 +72,16 @@ const OpenAIAPIConfig: ProviderAPIConfig = {
         return basePath;
       case 'listBatches':
         return basePath;
+      case 'listChatCompletions':
+        return basePath;
+      case 'getChatCompletion':
+        return basePath;
+      case 'getChatCompletionMessages':
+        return basePath;
+      case 'updateChatCompletion':
+        return basePath;
+      case 'deleteChatCompletion':
+        return basePath;
       default:
         return '';
     }

src/providers/openai/deleteChatCompletions.ts

@@ -0,0 +1,17 @@
+import { OPEN_AI } from '../../globals';
+import { ErrorResponse, DeleteChatCompletionResponse } from '../types';
+import { OpenAIErrorResponseTransform } from './utils';
+
+export const OpenAIDeleteChatCompletionResponseTransform: (
+  response: DeleteChatCompletionResponse | ErrorResponse,
+  responseStatus: number
+) => DeleteChatCompletionResponse | ErrorResponse = (
+  response,
+  responseStatus
+) => {
+  if (responseStatus !== 200 && 'error' in response) {
+    return OpenAIErrorResponseTransform(response, OPEN_AI);
+  }
+
+  return response;
+};

src/providers/openai/getChatCompletion.ts

@@ -0,0 +1,18 @@
+import { OPEN_AI } from '../../globals';
+import { ErrorResponse } from '../types';
+import { OpenAIChatCompleteResponse } from './chatComplete';
+import { OpenAIErrorResponseTransform } from './utils';
+
+export const OpenAIGetChatCompletionResponseTransform: (
+  response: OpenAIChatCompleteResponse | ErrorResponse,
+  responseStatus: number
+) => OpenAIChatCompleteResponse | ErrorResponse = (
+  response,
+  responseStatus
+) => {
+  if (responseStatus !== 200 && 'error' in response) {
+    return OpenAIErrorResponseTransform(response, OPEN_AI);
+  }
+
+  return response;
+};

src/providers/openai/getChatMessages.ts

@@ -0,0 +1,14 @@
+import { OPEN_AI } from '../../globals';
+import { ErrorResponse, GetChatMessagesResponse } from '../types';
+import { OpenAIErrorResponseTransform } from './utils';
+
+export const OpenAIGetChatMessagesResponseTransform: (
+  response: GetChatMessagesResponse | ErrorResponse,
+  responseStatus: number
+) => GetChatMessagesResponse | ErrorResponse = (response, responseStatus) => {
+  if (responseStatus !== 200 && 'error' in response) {
+    return OpenAIErrorResponseTransform(response, OPEN_AI);
+  }
+
+  return response;
+};

src/providers/openai/index.ts

@@ -34,6 +34,14 @@ import { OpenAIRetrieveBatchResponseTransform } from './retrieveBatch';
 import { OpenAICancelBatchResponseTransform } from './cancelBatch';
 import { OpenAIListBatchesResponseTransform } from './listBatches';
 import { OpenAIGetBatchOutputRequestHandler } from './getBatchOutput';
+import { OpenAIListChatCompletionsResponseTransform } from './listChatCompletions';
+import { OpenAIGetChatMessagesResponseTransform } from './getChatMessages';
+import { OpenAIDeleteChatCompletionResponseTransform } from './deleteChatCompletions';
+import { OpenAIGetChatCompletionResponseTransform } from './getChatCompletion';
+import {
+  OpenAIUpdateChatCompletionResponseTransform,
+  OpenAIUpdateChatCompletionConfig,
+} from './updateChatCompletions';
 import {
   OpenAICreateFinetuneConfig,
   OpenAIFinetuneResponseTransform,
@@ -52,6 +60,7 @@ const OpenAIConfig: ProviderConfigs = {
   createBatch: OpenAICreateBatchConfig,
   createFinetune: OpenAICreateFinetuneConfig,
   cancelBatch: {},
+  updateChatCompletion: OpenAIUpdateChatCompletionConfig,
   cancelFinetune: {},
   requestHandlers: {
     getBatchOutput: OpenAIGetBatchOutputRequestHandler,
@@ -79,6 +88,11 @@ const OpenAIConfig: ProviderConfigs = {
     retrieveBatch: OpenAIRetrieveBatchResponseTransform,
     cancelBatch: OpenAICancelBatchResponseTransform,
     listBatches: OpenAIListBatchesResponseTransform,
+    listChatCompletions: OpenAIListChatCompletionsResponseTransform,
+    getChatCompletion: OpenAIGetChatCompletionResponseTransform,
+    getChatCompletionMessages: OpenAIGetChatMessagesResponseTransform,
+    updateChatCompletion: OpenAIUpdateChatCompletionResponseTransform,
+    deleteChatCompletion: OpenAIDeleteChatCompletionResponseTransform,
     createFinetune: OpenAIFinetuneResponseTransform,
     retrieveFinetune: OpenAIFinetuneResponseTransform,
   },

src/providers/openai/listChatCompletions.ts

@@ -0,0 +1,18 @@
+import { OPEN_AI } from '../../globals';
+import { ErrorResponse } from '../types';
+import { OpenAIChatCompleteResponse } from './chatComplete';
+import { OpenAIErrorResponseTransform } from './utils';
+
+export const OpenAIListChatCompletionsResponseTransform: (
+  response: OpenAIChatCompleteResponse[] | ErrorResponse,
+  responseStatus: number
+) => OpenAIChatCompleteResponse[] | ErrorResponse = (
+  response,
+  responseStatus
+) => {
+  if (responseStatus !== 200 && 'error' in response) {
+    return OpenAIErrorResponseTransform(response, OPEN_AI);
+  }
+
+  return response;
+};

src/providers/openai/updateChatCompletions.ts

@@ -0,0 +1,25 @@
+import { OPEN_AI } from '../../globals';
+import { ErrorResponse, ProviderConfig } from '../types';
+import { OpenAIChatCompleteResponse } from './chatComplete';
+import { OpenAIErrorResponseTransform } from './utils';
+
+export const OpenAIUpdateChatCompletionConfig: ProviderConfig = {
+  metadata: {
+    param: 'metadata',
+    required: true,
+  },
+};
+
+export const OpenAIUpdateChatCompletionResponseTransform: (
+  response: OpenAIChatCompleteResponse | ErrorResponse,
+  responseStatus: number
+) => OpenAIChatCompleteResponse | ErrorResponse = (
+  response,
+  responseStatus
+) => {
+  if (responseStatus !== 200 && 'error' in response) {
+    return OpenAIErrorResponseTransform(response, OPEN_AI);
+  }
+
+  return response;
+};

src/providers/types.ts

@@ -93,6 +93,11 @@ export type endpointStrings =
   | 'cancelBatch'
   | 'listBatches'
   | 'getBatchOutput'
+  | 'listChatCompletions'
+  | 'getChatCompletion'
+  | 'getChatCompletionMessages'
+  | 'deleteChatCompletion'
+  | 'updateChatCompletion'
   | 'listFinetunes'
   | 'createFinetune'
   | 'retrieveFinetune'
@@ -320,6 +325,20 @@ export interface ListBatchesResponse {
   data: Batch[];
 }
 
+export interface DeleteChatCompletionResponse {
+  object: string;
+  deleted: boolean;
+  id: string;
+}
+
+export interface GetChatMessagesResponse {
+  object: string;
+  data: Message[];
+  first_id: string;
+  last_id: string;
+  has_more: boolean;
+}
+
 interface FinetuneProviderOptions {
   model: string;
   training_type: 'chat' | 'text';