Skip to content

support responses endpoints as part of unified routes #1021

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

Merged
merged 10 commits into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ export default tseslint.config({
rules: {
// '@typescript-eslint/no-unused-vars': 'error',
'no-duplicate-imports': 'error',
'@typescript-eslint/no-namespace': 'off',
},
});
47 changes: 47 additions & 0 deletions src/handlers/modelResponsesHandler.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { Context } from 'hono';
import {
constructConfigFromRequestHeaders,
tryTargetsRecursively,
} from './handlerUtils';
import { endpointStrings } from '../providers/types';

function modelResponsesHandler(
endpoint: endpointStrings,
method: 'POST' | 'GET' | 'DELETE'
) {
async function handler(c: Context): Promise<Response> {
try {
let requestHeaders = Object.fromEntries(c.req.raw.headers);
let request = method === 'POST' ? await c.req.json() : {};
const camelCaseConfig = constructConfigFromRequestHeaders(requestHeaders);
const tryTargetsResponse = await tryTargetsRecursively(
c,
camelCaseConfig ?? {},
request,
requestHeaders,
endpoint,
method,
'config'
);

return tryTargetsResponse;
} catch (err: any) {
console.error({ message: `${endpoint} error ${err.message}` });
return new Response(
JSON.stringify({
status: 'failure',
message: 'Something went wrong',
}),
{
status: 500,
headers: {
'content-type': 'application/json',
},
}
);
}
}
return handler;
}

export default modelResponsesHandler;
18 changes: 14 additions & 4 deletions src/handlers/responseHandlers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
} from './streamHandler';
import { HookSpan } from '../middlewares/hooks';
import { env } from 'hono/adapter';
import { OpenAIModelResponseJSONToStreamGenerator } from '../providers/open-ai-base/createModelResponse';

/**
* Handles various types of responses based on the specified parameters
Expand Down Expand Up @@ -74,10 +75,19 @@ export async function responseHandler(
// JSON to text/event-stream conversion is only allowed for unified routes: chat completions and completions.
// Set the transformer to OpenAI json to stream convertor function in that case.
if (responseTransformer && streamingMode && isCacheHit) {
responseTransformerFunction =
responseTransformer === 'chatComplete'
? OpenAIChatCompleteJSONToStreamResponseTransform
: OpenAICompleteJSONToStreamResponseTransform;
switch (responseTransformer) {
case 'chatComplete':
responseTransformerFunction =
OpenAIChatCompleteJSONToStreamResponseTransform;
break;
case 'createModelResponse':
responseTransformerFunction = OpenAIModelResponseJSONToStreamGenerator;
break;
default:
responseTransformerFunction =
OpenAICompleteJSONToStreamResponseTransform;
break;
}
} else if (responseTransformer && !streamingMode && isCacheHit) {
responseTransformerFunction = undefined;
}
Expand Down
34 changes: 27 additions & 7 deletions src/handlers/streamHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -361,14 +361,34 @@ export async function handleJSONToStreamResponse(
const encoder = new TextEncoder();
const responseJSON: OpenAIChatCompleteResponse | OpenAICompleteResponse =
await response.clone().json();
const streamChunkArray = responseTransformerFunction(responseJSON, provider);

(async () => {
for (const chunk of streamChunkArray) {
await writer.write(encoder.encode(chunk));
}
writer.close();
})();
if (
Object.prototype.toString.call(responseTransformerFunction) ===
'[object GeneratorFunction]'
) {
const generator = responseTransformerFunction(responseJSON, provider);
(async () => {
while (true) {
const chunk = generator.next();
if (chunk.done) {
break;
}
await writer.write(encoder.encode(chunk.value));
}
writer.close();
})();
} else {
const streamChunkArray = responseTransformerFunction(
responseJSON,
provider
);
(async () => {
for (const chunk of streamChunkArray) {
await writer.write(encoder.encode(chunk));
}
writer.close();
})();
}

return new Response(readable, {
headers: new Headers({
Expand Down
23 changes: 23 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import finetuneHandler from './handlers/finetuneHandler';

// Config
import conf from '../conf.json';
import modelResponsesHandler from './handlers/modelResponsesHandler';

// Create a new Hono server instance
const app = new Hono();
Expand Down Expand Up @@ -199,6 +200,28 @@ app.post(
);
app.get('/v1/batches', requestValidator, batchesHandler('listBatches', 'GET'));

// responses
app.post(
'/v1/responses',
requestValidator,
modelResponsesHandler('createModelResponse', 'POST')
);
app.get(
'/v1/responses/:id',
requestValidator,
modelResponsesHandler('getModelResponse', 'GET')
);
app.delete(
'/v1/responses/:id',
requestValidator,
modelResponsesHandler('deleteModelResponse', 'DELETE')
);
app.get(
'/v1/responses/:id/input_items',
requestValidator,
modelResponsesHandler('listResponseInputItems', 'GET')
);

app.all(
'/v1/fine_tuning/jobs/:jobId?/:cancel?',
requestValidator,
Expand Down
18 changes: 18 additions & 0 deletions src/providers/azure-openai/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@ const AzureOpenAIAPIConfig: ProviderAPIConfig = {
}

const path = gatewayRequestURL.split('/v1')?.[1];
const urlObj = new URL(gatewayRequestURL);
const pathname = urlObj.pathname;
const searchParams = urlObj.searchParams;
if (apiVersion) {
searchParams.set('api-version', apiVersion);
}

switch (mappedFn) {
case 'complete': {
Expand All @@ -103,6 +109,18 @@ const AzureOpenAIAPIConfig: ProviderAPIConfig = {
case 'realtime': {
return `/realtime?api-version=${apiVersion}&deployment=${deploymentId}`;
}
case 'createModelResponse': {
return `/responses?${searchParams.toString()}`;
}
case 'getModelResponse': {
return `${pathname}?${searchParams.toString()}`;
}
case 'deleteModelResponse': {
return `${pathname}?${searchParams.toString()}`;
}
case 'listResponseInputItems': {
return `${pathname}?${searchParams.toString()}`;
}
case 'uploadFile':
return `${path}?api-version=${apiVersion}`;
case 'retrieveFile':
Expand Down
16 changes: 16 additions & 0 deletions src/providers/azure-openai/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ import { OpenAIFileUploadRequestTransform } from '../openai/uploadFile';
import { AzureOpenAIFinetuneResponseTransform } from './utils';
import { AzureOpenAICreateBatchConfig } from './createBatch';
import { AzureOpenAIGetBatchOutputRequestHandler } from './getBatchOutput';
import {
createModelResponseParams,
OpenAICreateModelResponseTransformer,
OpenAIDeleteModelResponseTransformer,
OpenAIGetModelResponseTransformer,
OpenAIListInputItemsResponseTransformer,
} from '../open-ai-base';
import { AZURE_OPEN_AI } from '../../globals';

const AzureOpenAIConfig: ProviderConfigs = {
complete: AzureOpenAICompleteConfig,
Expand All @@ -43,6 +51,10 @@ const AzureOpenAIConfig: ProviderConfigs = {
cancelFinetune: {},
cancelBatch: {},
createBatch: AzureOpenAICreateBatchConfig,
createModelResponse: createModelResponseParams([]),
getModelResponse: {},
deleteModelResponse: {},
listModelsResponse: {},
requestHandlers: {
getBatchOutput: AzureOpenAIGetBatchOutputRequestHandler,
},
Expand All @@ -66,6 +78,10 @@ const AzureOpenAIConfig: ProviderConfigs = {
retrieveBatch: AzureOpenAIResponseTransform,
cancelBatch: AzureOpenAIResponseTransform,
listBatches: AzureOpenAIResponseTransform,
createModelResponse: OpenAICreateModelResponseTransformer(AZURE_OPEN_AI),
getModelResponse: OpenAIGetModelResponseTransformer(AZURE_OPEN_AI),
deleteModelResponse: OpenAIDeleteModelResponseTransformer(AZURE_OPEN_AI),
listModelsResponse: OpenAIListInputItemsResponseTransformer(AZURE_OPEN_AI),
},
requestTransforms: {
createFinetune: AzureTransformFinetuneBody,
Expand Down
Loading