Skip to content

Commit

Permalink
feat (provider/openai-compatible): Allow extending message metadata.
Browse files Browse the repository at this point in the history
  • Loading branch information
@shaper
shaper committed Dec 20, 2024
1 parent 9049c57 commit 745d832
Show file tree
Hide file tree
Showing 3 changed files with 609 additions and 66 deletions.
358 changes: 358 additions & 0 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 @@ -119,3 +119,361 @@ describe('tool calls', () => {
]);
});
});

describe('metadata merging', () => {
it('should merge system message metadata', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'system',
content: 'You are a helpful assistant.',
providerMetadata: {
openaiCompatible: {
cacheControl: { type: 'ephemeral' },
},
},
},
]);

expect(result).toEqual([
{
role: 'system',
content: 'You are a helpful assistant.',
cacheControl: { type: 'ephemeral' },
},
]);
});

it('should merge user message content metadata', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
content: [
{
type: 'text',
text: 'Hello',
providerMetadata: {
openaiCompatible: {
cacheControl: { type: 'ephemeral' },
},
},
},
],
},
]);

expect(result).toEqual([
{
role: 'user',
content: 'Hello',
cacheControl: { type: 'ephemeral' },
},
]);
});

it('should merge metadata at multiple levels', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
providerMetadata: {
openaiCompatible: {
messageLevel: true,
},
},
content: [
{
type: 'text',
text: 'Hello',
providerMetadata: {
openaiCompatible: {
contentLevel: true,
},
},
},
],
},
]);

expect(result).toEqual([
{
role: 'user',
messageLevel: true,
content: 'Hello',
contentLevel: true,
},
]);
});

it('should handle tool calls with metadata', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'assistant',
content: [
{
type: 'tool-call',
toolCallId: 'call1',
toolName: 'calculator',
args: { x: 1, y: 2 },
providerMetadata: {
openaiCompatible: {
cacheControl: { type: 'ephemeral' },
},
},
},
],
},
]);

expect(result).toEqual([
{
role: 'assistant',
content: '',
tool_calls: [
{
id: 'call1',
type: 'function',
function: {
name: 'calculator',
arguments: JSON.stringify({ x: 1, y: 2 }),
},
cacheControl: { type: 'ephemeral' },
},
],
},
]);
});

it('should handle image content with metadata', async () => {
const imageUrl = new URL('https://example.com/image.jpg');
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
content: [
{
type: 'image',
image: imageUrl,
mimeType: 'image/jpeg',
providerMetadata: {
openaiCompatible: {
cacheControl: { type: 'ephemeral' },
},
},
},
],
},
]);

expect(result).toEqual([
{
role: 'user',
content: [
{
type: 'image_url',
image_url: { url: imageUrl.toString() },
cacheControl: { type: 'ephemeral' },
},
],
},
]);
});

it('should preserve non-openaiCompatible metadata', async () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'system',
content: 'Hello',
providerMetadata: {
someOtherProvider: {
shouldBeIgnored: true,
},
},
},
]);

expect(result).toEqual([
{
role: 'system',
content: 'Hello',
providerMetadata: {
someOtherProvider: {
shouldBeIgnored: true,
},
},
},
]);
});
});

describe('complex part-level transformations', () => {
it('should handle a user message with multiple content parts (text + image)', () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
content: [
{
type: 'text',
text: 'Hello from part 1',
providerMetadata: {
openaiCompatible: { sentiment: 'positive' },
leftoverKey: { foo: 'some leftover data' },
},
},
{
type: 'image',
image: new Uint8Array([0, 1, 2, 3]),
mimeType: 'image/png',
providerMetadata: {
openaiCompatible: { alt_text: 'A sample image' },
},
},
],
providerMetadata: {
openaiCompatible: { priority: 'high' },
},
},
]);

expect(result).toEqual([
{
role: 'user',
priority: 'high', // hoisted from message-level providerMetadata
content: [
{
type: 'text',
text: 'Hello from part 1',
sentiment: 'positive', // hoisted from part-level openaiCompatible
providerMetadata: {
leftoverKey: { foo: 'some leftover data' },
},
},
{
type: 'image_url',
image_url: {
url: 'data:image/png;base64,AAECAw==',
},
alt_text: 'A sample image',
},
],
},
]);
});

it('should handle a user message with multiple text parts (flattening disabled)', () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'user',
content: [
{ type: 'text', text: 'Part 1' },
{ type: 'text', text: 'Part 2' },
],
},
]);

// Because there are multiple text parts, the converter won't flatten them
expect(result).toEqual([
{
role: 'user',
content: [
{ type: 'text', text: 'Part 1' },
{ type: 'text', text: 'Part 2' },
],
},
]);
});

it('should handle an assistant message with text plus multiple tool calls', () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'assistant',
content: [
{ type: 'text', text: 'Checking that now...' },
{
type: 'tool-call',
toolCallId: 'call1',
toolName: 'searchTool',
args: { query: 'Weather' },
providerMetadata: {
openaiCompatible: { function_call_reason: 'user request' },
},
},
{ type: 'text', text: 'Almost there...' },
{
type: 'tool-call',
toolCallId: 'call2',
toolName: 'mapsTool',
args: { location: 'Paris' },
},
],
},
]);

expect(result).toEqual([
{
role: 'assistant',
content: 'Checking that now...Almost there...',
tool_calls: [
{
id: 'call1',
type: 'function',
function: {
name: 'searchTool',
arguments: JSON.stringify({ query: 'Weather' }),
},
function_call_reason: 'user request',
},
{
id: 'call2',
type: 'function',
function: {
name: 'mapsTool',
arguments: JSON.stringify({ location: 'Paris' }),
},
},
],
},
]);
});

it('should handle a single tool role message with multiple tool-result parts', () => {
const result = convertToOpenAICompatibleChatMessages([
{
role: 'tool',
providerMetadata: {
openaiCompatible: { responseTier: 'detailed' },
},
content: [
{
type: 'tool-result',
toolCallId: 'call123',
toolName: 'calculator',
result: { stepOne: 'data chunk 1' },
},
{
type: 'tool-result',
toolCallId: 'call123',
toolName: 'calculator',
providerMetadata: {
openaiCompatible: { partial: true },
},
result: { stepTwo: 'data chunk 2' },
},
],
},
]);

expect(result).toEqual([
{
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',
},
]);
});
});
Loading

0 comments on commit 745d832

Please sign in to comment.