Skip to content

feat(models): add metadata #716

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steebchen merged 2 commits into from
Sep 2, 2025
Merged

feat(models): add metadata #716

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7614df6
feat(gateway): add metadata object to chat completions response
steebchen Sep 2, 2025
5dbbf3b
Merge branch 'main' into terragon/implement-feature-issue-714
steebchen Sep 2, 2025
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
85 changes: 80 additions & 5 deletions apps/gateway/src/chat/chat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -828,6 +828,9 @@ function transformToOpenAIFormat(
cachedTokens: number | null,
toolResults: any,
images: ImageObject[],
requestedModel: string,
requestedProvider: string | null,
baseModelName: string,
) {
let transformedResponse = json;

Expand All @@ -838,7 +841,7 @@ function transformToOpenAIFormat(
id: `chatcmpl-${Date.now()}`,
object: "chat.completion",
created: Math.floor(Date.now() / 1000),
model: usedModel,
model: `${usedProvider}/${baseModelName}`,
choices: [
{
index: 0,
Expand Down Expand Up @@ -875,6 +878,13 @@ function transformToOpenAIFormat(
},
}),
},
metadata: {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
},
};
break;
}
Expand All @@ -883,7 +893,7 @@ function transformToOpenAIFormat(
id: `chatcmpl-${Date.now()}`,
object: "chat.completion",
created: Math.floor(Date.now() / 1000),
model: usedModel,
model: `${usedProvider}/${baseModelName}`,
choices: [
{
index: 0,
Expand Down Expand Up @@ -919,6 +929,13 @@ function transformToOpenAIFormat(
},
}),
},
metadata: {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
},
};
break;
}
Expand All @@ -930,7 +947,7 @@ function transformToOpenAIFormat(
id: `chatcmpl-${Date.now()}`,
object: "chat.completion",
created: Math.floor(Date.now() / 1000),
model: usedModel,
model: `${usedProvider}/${baseModelName}`,
choices: [
{
index: 0,
Expand All @@ -955,6 +972,13 @@ function transformToOpenAIFormat(
reasoning_tokens: reasoningTokens,
}),
},
metadata: {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
},
};
} else {
// Always transform reasoning field to reasoning_content even if response already has an id
Expand All @@ -966,6 +990,15 @@ function transformToOpenAIFormat(
delete message.reasoning;
}
}
// Add metadata to existing response
transformedResponse.model = `${usedProvider}/${baseModelName}`;
transformedResponse.metadata = {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
};
}
break;
}
Expand All @@ -977,7 +1010,7 @@ function transformToOpenAIFormat(
id: json.id || `chatcmpl-${Date.now()}`,
object: "chat.completion",
created: json.created_at || Math.floor(Date.now() / 1000),
model: json.model || usedModel,
model: `${usedProvider}/${baseModelName}`,
choices: [
{
index: 0,
Expand Down Expand Up @@ -1008,9 +1041,41 @@ function transformToOpenAIFormat(
},
}),
},
metadata: {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
},
};
} else {
// For standard chat completions format, update model field and add metadata
if (transformedResponse && typeof transformedResponse === "object") {
transformedResponse.model = `${usedProvider}/${baseModelName}`;
transformedResponse.metadata = {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
};
}
}
break;
}
default: {
// For any other provider, add metadata to existing response
if (transformedResponse && typeof transformedResponse === "object") {
transformedResponse.model = `${usedProvider}/${baseModelName}`;
transformedResponse.metadata = {
requested_model: requestedModel,
requested_provider: requestedProvider,
used_model: baseModelName,
used_provider: usedProvider,
underlying_used_model: usedModel,
};
}
// If not responses format, leave as is (standard chat completions format)
break;
}
}
Expand Down Expand Up @@ -1829,6 +1894,13 @@ const completions = createRoute({
})
.optional(),
}),
metadata: z.object({
requested_model: z.string(),
requested_provider: z.string().nullable(),
used_model: z.string(),
used_provider: z.string(),
underlying_used_model: z.string(),
}),
}),
},
"text/event-stream": {
Expand Down Expand Up @@ -4325,6 +4397,9 @@ chat.openapi(completions, async (c) => {
cachedTokens,
toolResults,
images,
modelInput,
requestedProvider || null,
baseModelName,
);

const baseLogEntry = createLogEntry(
Expand Down
Loading