Skip to content

feat(graphql-conversation-transformer): add metrics and usage fields to conversation messages #3448

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pjkroker wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat(graphql-conversation-transformer): add metrics and usage fields to conversation messages #3448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0427652
feat(graphql-conversation-transformer): add usage and metrics fields …
pjkroker Mar 25, 2026
18ef668
feat(graphql-conversation-transformer): add usage and metrics to stre…
pjkroker Mar 25, 2026
0f09a2c
feat(graphql-conversation-transformer): add AmplifyAIMetrics and Ampl…
pjkroker Mar 26, 2026
032bb22
fix(graphql-conversation-transformer): conditionally persist metrics …
pjkroker Mar 30, 2026
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
84 changes: 72 additions & 12 deletions ...sformer/src/__tests__/__snapshots__/amplify-graphql-conversation-transformer.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ export function request(ctx) {
associatedUserMessageId,
accumulatedTurnContent,
errors,
metrics,
usage,
} = ctx.args.input;

const { owner } = ctx.args;
Expand All @@ -230,7 +232,7 @@ export function request(ctx) {
const { createdAt, updatedAt } = ctx.stash.defaultValues;

const assistantResponseId = \`\${associatedUserMessageId}#response\`;
const expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';
let expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';

const expressionValues = util.dynamodb.toMapValues({
':typename': 'ConversationMessagePirateChat',
Expand All @@ -255,6 +257,18 @@ export function request(ctx) {
'#updatedAt': 'updatedAt',
};

if (metrics) {
expression += ', #metrics = :metrics';
expressionValues[':metrics'] = metrics;
expressionNames['#metrics'] = 'metrics';
}

if (usage) {
expression += ', #usage = :usage';
expressionValues[':usage'] = usage;
expressionNames['#usage'] = 'usage';
}

return {
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ id: assistantResponseId }),
Expand Down Expand Up @@ -300,7 +314,8 @@ function generateRandomPadding() {
const base = 'abcdefghijklmnopqrstuvwxyz0123456789';
const rand = Math.floor(Math.random() * 36);
return base.slice(0, rand);
}"
}
"
`;

exports[`ConversationTransformer valid schemas should transform conversation route with inference configuration: AssistantResponseStreamMutation init slot function code 1`] = `
Expand Down Expand Up @@ -676,7 +691,7 @@ export function request(ctx) {
const { graphqlApiEndpoint } = ctx.stash;
const userAgent = createUserAgent(request);

const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p';
const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p metrics { latencyMs } usage { inputTokens outputTokens totalTokens }';

const streamingResponseMutation = {
name: 'createAssistantResponseStreamPirateChat',
Expand Down Expand Up @@ -1078,6 +1093,8 @@ export function request(ctx) {
associatedUserMessageId,
accumulatedTurnContent,
errors,
metrics,
usage,
} = ctx.args.input;

const { owner } = ctx.args;
Expand All @@ -1094,7 +1111,7 @@ export function request(ctx) {
const { createdAt, updatedAt } = ctx.stash.defaultValues;

const assistantResponseId = \`\${associatedUserMessageId}#response\`;
const expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';
let expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';

const expressionValues = util.dynamodb.toMapValues({
':typename': 'ConversationMessagePirateChat',
Expand All @@ -1119,6 +1136,18 @@ export function request(ctx) {
'#updatedAt': 'updatedAt',
};

if (metrics) {
expression += ', #metrics = :metrics';
expressionValues[':metrics'] = metrics;
expressionNames['#metrics'] = 'metrics';
}

if (usage) {
expression += ', #usage = :usage';
expressionValues[':usage'] = usage;
expressionNames['#usage'] = 'usage';
}

return {
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ id: assistantResponseId }),
Expand Down Expand Up @@ -1164,7 +1193,8 @@ function generateRandomPadding() {
const base = 'abcdefghijklmnopqrstuvwxyz0123456789';
const rand = Math.floor(Math.random() * 36);
return base.slice(0, rand);
}"
}
"
`;

exports[`ConversationTransformer valid schemas should transform conversation route with model query tool including relationships: AssistantResponseStreamMutation init slot function code 1`] = `
Expand Down Expand Up @@ -1540,7 +1570,7 @@ export function request(ctx) {
const { graphqlApiEndpoint } = ctx.stash;
const userAgent = createUserAgent(request);

const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p';
const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p metrics { latencyMs } usage { inputTokens outputTokens totalTokens }';

const streamingResponseMutation = {
name: 'createAssistantResponseStreamPirateChat',
Expand Down Expand Up @@ -1942,6 +1972,8 @@ export function request(ctx) {
associatedUserMessageId,
accumulatedTurnContent,
errors,
metrics,
usage,
} = ctx.args.input;

const { owner } = ctx.args;
Expand All @@ -1958,7 +1990,7 @@ export function request(ctx) {
const { createdAt, updatedAt } = ctx.stash.defaultValues;

const assistantResponseId = \`\${associatedUserMessageId}#response\`;
const expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';
let expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';

const expressionValues = util.dynamodb.toMapValues({
':typename': 'ConversationMessagePirateChat',
Expand All @@ -1983,6 +2015,18 @@ export function request(ctx) {
'#updatedAt': 'updatedAt',
};

if (metrics) {
expression += ', #metrics = :metrics';
expressionValues[':metrics'] = metrics;
expressionNames['#metrics'] = 'metrics';
}

if (usage) {
expression += ', #usage = :usage';
expressionValues[':usage'] = usage;
expressionNames['#usage'] = 'usage';
}

return {
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ id: assistantResponseId }),
Expand Down Expand Up @@ -2028,7 +2072,8 @@ function generateRandomPadding() {
const base = 'abcdefghijklmnopqrstuvwxyz0123456789';
const rand = Math.floor(Math.random() * 36);
return base.slice(0, rand);
}"
}
"
`;

exports[`ConversationTransformer valid schemas should transform conversation route with model query tool: AssistantResponseStreamMutation init slot function code 1`] = `
Expand Down Expand Up @@ -2404,7 +2449,7 @@ export function request(ctx) {
const { graphqlApiEndpoint } = ctx.stash;
const userAgent = createUserAgent(request);

const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p';
const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p metrics { latencyMs } usage { inputTokens outputTokens totalTokens }';

const streamingResponseMutation = {
name: 'createAssistantResponseStreamPirateChat',
Expand Down Expand Up @@ -2806,6 +2851,8 @@ export function request(ctx) {
associatedUserMessageId,
accumulatedTurnContent,
errors,
metrics,
usage,
} = ctx.args.input;

const { owner } = ctx.args;
Expand All @@ -2822,7 +2869,7 @@ export function request(ctx) {
const { createdAt, updatedAt } = ctx.stash.defaultValues;

const assistantResponseId = \`\${associatedUserMessageId}#response\`;
const expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';
let expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';

const expressionValues = util.dynamodb.toMapValues({
':typename': 'ConversationMessagePirateChat',
Expand All @@ -2847,6 +2894,18 @@ export function request(ctx) {
'#updatedAt': 'updatedAt',
};

if (metrics) {
expression += ', #metrics = :metrics';
expressionValues[':metrics'] = metrics;
expressionNames['#metrics'] = 'metrics';
}

if (usage) {
expression += ', #usage = :usage';
expressionValues[':usage'] = usage;
expressionNames['#usage'] = 'usage';
}

return {
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ id: assistantResponseId }),
Expand Down Expand Up @@ -2892,7 +2951,8 @@ function generateRandomPadding() {
const base = 'abcdefghijklmnopqrstuvwxyz0123456789';
const rand = Math.floor(Math.random() * 36);
return base.slice(0, rand);
}"
}
"
`;

exports[`ConversationTransformer valid schemas should transform conversation route with query tools: AssistantResponseStreamMutation init slot function code 1`] = `
Expand Down Expand Up @@ -3268,7 +3328,7 @@ export function request(ctx) {
const { graphqlApiEndpoint } = ctx.stash;
const userAgent = createUserAgent(request);

const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p';
const selectionSet = 'associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p metrics { latencyMs } usage { inputTokens outputTokens totalTokens }';

const streamingResponseMutation = {
name: 'createAssistantResponseStreamPirateChat',
Expand Down
26 changes: 25 additions & 1 deletion packages/amplify-graphql-conversation-transformer/src/graphql-types/message-model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ export const createAssistantResponseStreamingMutationInput = (messageModelName:
makeInputValueDefinition('accumulatedTurnContent', makeListType(makeNamedType('AmplifyAIContentBlockInput'))),
makeInputValueDefinition('errors', makeListType(makeNamedType('AmplifyAIConversationTurnErrorInput'))),
makeInputValueDefinition('p', makeNamedType('String')),
makeInputValueDefinition('metrics', makeNamedType('AWSJSON')),
makeInputValueDefinition('usage', makeNamedType('AWSJSON')),
],
};
};
Expand All @@ -156,6 +158,24 @@ export const createConversationTurnErrorInput = (): InputObjectTypeDefinitionNod
};
};

export const constructMetricsType = (): ObjectTypeDefinitionNode => ({
kind: 'ObjectTypeDefinition',
name: { kind: 'Name', value: 'AmplifyAIMetrics' },
fields: [makeField('latencyMs', [], makeNamedType('Int'))],
directives: [],
});

export const constructUsageType = (): ObjectTypeDefinitionNode => ({
kind: 'ObjectTypeDefinition',
name: { kind: 'Name', value: 'AmplifyAIUsage' },
fields: [
makeField('inputTokens', [], makeNamedType('Int')),
makeField('outputTokens', [], makeNamedType('Int')),
makeField('totalTokens', [], makeNamedType('Int')),
],
directives: [],
});

export const createAssistantStreamingMutationField = (fieldName: string, inputTypeName: string): FieldDefinitionNode => {
const args = [makeInputValueDefinition('input', makeNonNullType(makeNamedType(inputTypeName)))];
const cognitoAuthDirective = makeDirective('aws_cognito_user_pools', []);
Expand Down Expand Up @@ -282,11 +302,13 @@ const constructConversationMessageModel = (
const context = makeField('aiContext', [], makeNamedType('AWSJSON'));
const uiComponents = makeField('toolConfiguration', [], makeNamedType('AmplifyAIToolConfiguration'));
const associatedUserMessageId = makeField('associatedUserMessageId', [], makeNamedType('ID'));
const metrics = makeField('metrics', [], makeNamedType('AmplifyAIMetrics'));
const usage = makeField('usage', [], makeNamedType('AmplifyAIUsage'));

const object = {
...blankObject(modelName),
interfaces: [conversationMessageInterface],
fields: [id, conversationId, conversationField, role, content, context, uiComponents, associatedUserMessageId],
fields: [id, conversationId, conversationField, role, content, context, uiComponents, associatedUserMessageId, metrics, usage],
directives: typeDirectives,
};

Expand Down Expand Up @@ -315,6 +337,8 @@ export const constructStreamResponseType = (): ObjectTypeDefinitionNode => {
makeField('contentBlockDoneAtIndex', [], makeNamedType('Int')),

makeField('stopReason', [], makeNamedType('String')),
makeField('metrics', [], makeNamedType('AmplifyAIMetrics')),
makeField('usage', [], makeNamedType('AmplifyAIUsage')),
],
};
};
2 changes: 1 addition & 1 deletion ...mplify-graphql-conversation-transformer/src/resolvers/send-message-pipeline-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ function templateGenerator(slotName: string) {
return createS3AssetMappingTemplateGenerator('Mutation', slotName, fieldName);
}

const streamingSelectionSet = `associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p`;
const streamingSelectionSet = `associatedUserMessageId contentBlockDeltaIndex contentBlockDoneAtIndex contentBlockIndex contentBlockText contentBlockToolUse { toolUseId name input } conversationId id stopReason owner errors { errorType message } p metrics { latencyMs } usage { inputTokens outputTokens totalTokens }`;
18 changes: 16 additions & 2 deletions ...-transformer/src/resolvers/templates/assistant-streaming-mutation-resolver-fn.template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ export function request(ctx) {
associatedUserMessageId,
accumulatedTurnContent,
errors,
metrics,
usage,
} = ctx.args.input;

const { owner } = ctx.args;
Expand All @@ -28,7 +30,7 @@ export function request(ctx) {
const { createdAt, updatedAt } = ctx.stash.defaultValues;

const assistantResponseId = `${associatedUserMessageId}#response`;
const expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';
let expression = 'SET #typename = :typename, #conversationId = :conversationId, #associatedUserMessageId = :associatedUserMessageId, #role = :role, #content = :content, #owner = :owner, #createdAt = if_not_exists(#createdAt, :createdAt), #updatedAt = :updatedAt';

const expressionValues = util.dynamodb.toMapValues({
':typename': '[[CONVERSATION_MESSAGE_TYPE_NAME]]',
Expand All @@ -53,6 +55,18 @@ export function request(ctx) {
'#updatedAt': 'updatedAt',
};

if (metrics) {
expression += ', #metrics = :metrics';
expressionValues[':metrics'] = metrics;
expressionNames['#metrics'] = 'metrics';
}

if (usage) {
expression += ', #usage = :usage';
expressionValues[':usage'] = usage;
expressionNames['#usage'] = 'usage';
}

return {
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ id: assistantResponseId }),
Expand Down Expand Up @@ -98,4 +112,4 @@ function generateRandomPadding() {
const base = 'abcdefghijklmnopqrstuvwxyz0123456789';
const rand = Math.floor(Math.random() * 36);
return base.slice(0, rand);
}
}
9 changes: 8 additions & 1 deletion ...fy-graphql-conversation-transformer/src/transformer-steps/conversation-prepare-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@ import { ModelTransformer } from '@aws-amplify/graphql-model-transformer';
import { BelongsToTransformer, HasManyTransformer } from '@aws-amplify/graphql-relational-transformer';
import { DDB_AMPLIFY_MANAGED_DATASOURCE_STRATEGY, InvalidTransformerError } from '@aws-amplify/graphql-transformer-core';
import { ConversationDirectiveConfiguration } from '../conversation-directive-configuration';
import { constructStreamResponseType, createConversationTurnErrorInput } from '../graphql-types/message-model';
import {
constructStreamResponseType,
createConversationTurnErrorInput,
constructMetricsType,
constructUsageType,
} from '../graphql-types/message-model';
import { TransformerAuthProvider, TransformerPrepareStepContextProvider } from '@aws-amplify/graphql-transformer-interfaces';

/**
Expand Down Expand Up @@ -50,6 +55,8 @@ export class ConversationPrepareHandler {
// add once per schema
const conversationTurnErrorInput = createConversationTurnErrorInput();
ctx.output.addInput(conversationTurnErrorInput);
ctx.output.addObject(constructMetricsType());
ctx.output.addObject(constructUsageType());

for (const directive of directives) {
this.prepareResourcesForDirective(directive, ctx);
Expand Down
Loading