🪙 feat: Add messageId to Transactions (#11987)

* feat: Add messageId to transactions

* chore: field order

* feat: Enhance token usage tracking by adding messageId parameter

- Updated `recordTokenUsage` method in BaseClient to accept a new `messageId` parameter for improved tracking.
- Propagated `messageId` in the AgentClient when recording usage.
- Added tests to ensure `messageId` is correctly passed and handled in various scenarios, including propagation across multiple usage entries.

* chore: Correct field order in createGeminiImageTool function

- Moved the conversationId field to the correct position in the object being passed to the recordTokenUsage method, ensuring proper parameter alignment for improved functionality.

* refactor: Update OpenAIChatCompletionController and createResponse to use responseId instead of requestId

- Replaced instances of requestId with responseId in the OpenAIChatCompletionController for improved clarity in logging and tracking.
- Updated createResponse to include responseId in the requestBody, ensuring consistency across the handling of message identifiers.

* test: Add messageId to agent client tests

- Included messageId in the agent client tests to ensure proper handling and propagation of message identifiers during transaction recording.
- This update enhances the test coverage for scenarios involving messageId, aligning with recent changes in the tracking of message identifiers.

* fix: Update OpenAIChatCompletionController to use requestId for context

- Changed the context object in OpenAIChatCompletionController to use `requestId` instead of `responseId` for improved clarity and consistency in handling request identifiers.

* chore: field order

packages/api/src/agents/usage.ts

@@ -23,6 +23,7 @@ interface TxMetadata {
   user: string;
   model?: string;
   context: string;
+  messageId?: string;
   conversationId: string;
   balance?: Partial<TCustomConfig['balance']> | null;
   transactions?: Partial<TTransactionsConfig>;
@@ -46,6 +47,7 @@ export interface RecordUsageParams {
   collectedUsage: UsageMetadata[];
   model?: string;
   context?: string;
+  messageId?: string;
   balance?: Partial<TCustomConfig['balance']> | null;
   transactions?: Partial<TTransactionsConfig>;
   endpointTokenConfig?: EndpointTokenConfig;
@@ -68,6 +70,7 @@ export async function recordCollectedUsage(
     user,
     model,
     balance,
+    messageId,
     transactions,
     conversationId,
     collectedUsage,
@@ -108,11 +111,12 @@ export async function recordCollectedUsage(
     total_output_tokens += Number(usage.output_tokens) || 0;
 
     const txMetadata: TxMetadata = {
+      user,
       context,
       balance,
+      messageId,
       transactions,
       conversationId,
-      user,
       endpointTokenConfig,
       model: usage.model ?? model,
     };