Skip to content

Commit

Permalink
rework: simplify use cases and collapse only within specific context
Browse files Browse the repository at this point in the history
  • Loading branch information
@shaper
shaper committed Dec 22, 2024
1 parent 0209269 commit 8cf8485
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 82 deletions.
23 changes: 3 additions & 20 deletions packages/openai-compatible/src/convert-to-openai-compatible-chat-messages.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ describe('metadata merging', () => {
]);
});

it('should merge metadata at multiple levels', async () => {
it('should prioritize content-level metadata when merging', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
Expand All @@ -196,7 +196,6 @@ describe('metadata merging', () => {
expect(result).toEqual([
{
role: 'user',
messageLevel: true,
content: 'Hello',
contentLevel: true,
},
Expand Down Expand Up @@ -276,7 +275,7 @@ describe('metadata merging', () => {
]);
});

it('should preserve non-openaiCompatible metadata', async () => {
it('should omit non-openaiCompatible metadata', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'system',
Expand All @@ -293,11 +292,6 @@ describe('metadata merging', () => {
{
role: 'system',
content: 'Hello',
providerMetadata: {
someOtherProvider: {
shouldBeIgnored: true,
},
},
},
]);
});
Expand Down Expand Up @@ -341,9 +335,6 @@ describe('complex part-level transformations', () => {
type: 'text',
text: 'Hello from part 1',
sentiment: 'positive', // hoisted from part-level openaiCompatible
providerMetadata: {
leftoverKey: { foo: 'some leftover data' },
},
},
{
type: 'image_url',
Expand Down Expand Up @@ -437,7 +428,7 @@ describe('complex part-level transformations', () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'tool',
providerMetadata: {
providerMetadata: { // this just gets omitted as we prioritize content-level metadata
openaiCompatible: { responseTier: 'detailed' },
},
content: [
Expand Down Expand Up @@ -465,14 +456,12 @@ describe('complex part-level transformations', () => {
role: 'tool',
tool_call_id: 'call123',
content: JSON.stringify({ stepOne: 'data chunk 1' }),
responseTier: 'detailed',
},
{
role: 'tool',
tool_call_id: 'call123',
content: JSON.stringify({ stepTwo: 'data chunk 2' }),
partial: true,
responseTier: 'detailed',
},
]);
});
Expand Down Expand Up @@ -517,9 +506,6 @@ describe('additional permutations tests', () => {
type: 'text',
text: 'Part A',
textPartLevel: 'localized',
providerMetadata: {
leftoverForText: { info: 'text leftover' },
},
},
{
type: 'image_url',
Expand All @@ -529,9 +515,6 @@ describe('additional permutations tests', () => {
imagePartLevel: 'image-data',
},
],
providerMetadata: {
leftoverForMessage: { x: 123 },
},
},
]);
});
Expand Down
84 changes: 22 additions & 62 deletions packages/openai-compatible/src/convert-to-openai-compatible-chat-messages.ts
View file
Original file line number Diff line number Diff line change
@@ -1,84 +1,44 @@
import {
LanguageModelV1Message,
LanguageModelV1Prompt,
LanguageModelV1ProviderMetadata,
UnsupportedFunctionalityError,
} from '@ai-sdk/provider';
import { convertUint8ArrayToBase64 } from '@ai-sdk/provider-utils';
import { OpenAICompatibleChatPrompt } from './openai-compatible-api-types';

function findAndHoistMetadata(obj: LanguageModelV1Message) {
if (obj?.providerMetadata?.openaiCompatible) {
Object.assign(obj, obj.providerMetadata.openaiCompatible);
delete obj.providerMetadata.openaiCompatible;
if (Object.keys(obj.providerMetadata).length === 0) {
delete obj.providerMetadata;
}
}

if (Array.isArray(obj)) {
obj.forEach(item => findAndHoistMetadata(item));
} else if (obj && typeof obj === 'object') {
Object.values(obj).forEach(value => findAndHoistMetadata(value));
}
}

function deepCloneMessage(obj: any): any {
if (obj === null || typeof obj !== 'object') {
return obj;
}

if (obj instanceof URL) {
return new URL(obj.toString());
}

if (obj instanceof Uint8Array) {
return new Uint8Array(obj);
}

if (Array.isArray(obj)) {
return obj.map(item => deepCloneMessage(item));
}

const clone: any = {};
for (const key in obj) {
if (Object.prototype.hasOwnProperty.call(obj, key)) {
clone[key] = deepCloneMessage(obj[key]);
}
}
return clone;
function getOpenAIMetadata(message: { providerMetadata?: LanguageModelV1ProviderMetadata }) {
return message?.providerMetadata?.openaiCompatible ?? {};
}

export function convertToOpenAICompatibleChatMessages(
prompt: LanguageModelV1Prompt,
): OpenAICompatibleChatPrompt {
const messages: OpenAICompatibleChatPrompt = [];
// We can't use JSON.parse/stringify or structuredClone here as it doesn't
// gracefully handle all of the data types in the prompt.
const promptCopy = deepCloneMessage(prompt) as LanguageModelV1Prompt;
promptCopy.map(message => findAndHoistMetadata(message));
for (const { role, content, ...rest } of promptCopy) {
for (const message of prompt) {
const metadata = getOpenAIMetadata(message);
const { role, content } = message;
switch (role) {
case 'system': {
messages.push({ role: 'system', content, ...rest });
messages.push({ role: 'system', content, ...metadata });
break;
}

case 'user': {
if (content.length === 1 && content[0].type === 'text') {
const { text, type, ...contentRest } = content[0];
messages.push({ role: 'user', content: text, ...rest, ...contentRest });
messages.push({ role: 'user', content: content[0].text, ...getOpenAIMetadata(content[0]) });
break;
}

messages.push({
role: 'user',
content: content.map(part => {
const partMetadata = getOpenAIMetadata(part);
switch (part.type) {
case 'text': {
return { ...part };
return { type: 'text', text: part.text, ...partMetadata };
}
case 'image': {
const { type, image, mimeType, ...imageRest } = part;
const { image, mimeType } = part;
return {
type: 'image_url',
image_url: {
Expand All @@ -88,7 +48,7 @@ export function convertToOpenAICompatibleChatMessages(
: `data:${mimeType ?? 'image/jpeg'
};base64,${convertUint8ArrayToBase64(image)}`,
},
...imageRest,
...partMetadata,
};
}
case 'file': {
Expand All @@ -98,7 +58,7 @@ export function convertToOpenAICompatibleChatMessages(
}
}
}),
...rest,
...metadata,
});

break;
Expand All @@ -113,25 +73,25 @@ export function convertToOpenAICompatibleChatMessages(
}> = [];

for (const part of content) {
const partMetadata = getOpenAIMetadata(part);
switch (part.type) {
case 'text': {
// We could be throwing away additional data here as we only
// incorporate `part.text`. However, it's not clear there are use
// cases requiring this, nor how we'd resolve/merge across
// potentially multiple text parts.
// incorporate `part.text`. However, use cases aren't clear, nor
// how we'd resolve/merge across potentially multiple parts.
text += part.text;
break;
}
case 'tool-call': {
const { type, toolCallId, toolName, args, ...toolCallRest } = part;
const { toolCallId, toolName, args } = part;
toolCalls.push({
id: toolCallId,
type: 'function',
function: {
name: toolName,
arguments: JSON.stringify(args),
},
...toolCallRest,
...partMetadata,
});
break;
}
Expand All @@ -146,21 +106,21 @@ export function convertToOpenAICompatibleChatMessages(
role: 'assistant',
content: text,
tool_calls: toolCalls.length > 0 ? toolCalls : undefined,
...rest,
...metadata,
});

break;
}

case 'tool': {
for (const toolResponse of content) {
const { type, content, toolCallId, toolName, result, ...toolResponseRest } = toolResponse;
const { toolCallId, result } = toolResponse;
const toolResponseMetadata = getOpenAIMetadata(toolResponse);
messages.push({
role: 'tool',
tool_call_id: toolCallId,
content: JSON.stringify(result),
...toolResponseRest,
...rest,
...toolResponseMetadata,
});
}
break;
Expand Down

0 comments on commit 8cf8485

Please sign in to comment.