@amplitude/ai 0.3.3 → 0.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/AGENTS.md +1 -1
  2. package/README.md +181 -177
  3. package/data/agent_event_catalog.json +18 -3
  4. package/dist/client.d.ts +1 -0
  5. package/dist/client.d.ts.map +1 -1
  6. package/dist/client.js +1 -0
  7. package/dist/client.js.map +1 -1
  8. package/dist/core/constants.d.ts +4 -1
  9. package/dist/core/constants.d.ts.map +1 -1
  10. package/dist/core/constants.js +4 -1
  11. package/dist/core/constants.js.map +1 -1
  12. package/dist/core/privacy.d.ts +7 -1
  13. package/dist/core/privacy.d.ts.map +1 -1
  14. package/dist/core/privacy.js +78 -2
  15. package/dist/core/privacy.js.map +1 -1
  16. package/dist/core/tracking.d.ts +3 -2
  17. package/dist/core/tracking.d.ts.map +1 -1
  18. package/dist/core/tracking.js +4 -2
  19. package/dist/core/tracking.js.map +1 -1
  20. package/dist/index.d.ts +3 -3
  21. package/dist/index.js +3 -3
  22. package/dist/mcp/server.d.ts.map +1 -1
  23. package/dist/patching.d.ts.map +1 -1
  24. package/dist/providers/anthropic.d.ts.map +1 -1
  25. package/dist/providers/anthropic.js +6 -0
  26. package/dist/providers/anthropic.js.map +1 -1
  27. package/dist/providers/bedrock.d.ts.map +1 -1
  28. package/dist/providers/bedrock.js +8 -0
  29. package/dist/providers/bedrock.js.map +1 -1
  30. package/dist/providers/gemini.d.ts.map +1 -1
  31. package/dist/providers/gemini.js +6 -0
  32. package/dist/providers/gemini.js.map +1 -1
  33. package/dist/providers/mistral.d.ts.map +1 -1
  34. package/dist/providers/mistral.js +6 -0
  35. package/dist/providers/mistral.js.map +1 -1
  36. package/dist/providers/openai.d.ts +2 -1
  37. package/dist/providers/openai.d.ts.map +1 -1
  38. package/dist/providers/openai.js +13 -1
  39. package/dist/providers/openai.js.map +1 -1
  40. package/dist/types.d.ts +1 -0
  41. package/dist/types.d.ts.map +1 -1
  42. package/dist/types.js.map +1 -1
  43. package/dist/utils/logger.d.ts.map +1 -1
  44. package/llms-full.txt +1 -1
  45. package/llms.txt +1 -1
  46. package/mcp.schema.json +1 -1
  47. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;AAkBA;;;;;AAeA;AAQA;AAeA;AAQA;AAKA;AA0BA;AAWA;AAciB,UAtGA,cAAA,CAsGsB;EAStB,UAAA,EAAA,MAAU;EAQV,OAAA,CAAA,EAAA,MAAA;EASA,SAAA,CAAA,EAAA,MAAA;EASA,UAAA,CAAA,EAAA,MAAA;EASA,gBAAA,CAAA,EA7II,MA6IJ,CAAA,MAAwB,EAAA,OAG7B,CAAA;EAOK,eAAA,CAAA,EAtJG,MAsJgB,CAAA,MAAA,EAAA,OAAA,CAAA;EAcnB,MAAA,CAAA,EAnKN,MAmKM,CAAA,MAAc,EAAA,OAIpB,CAAA;EAYM,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAe;AAahC;AAUA;AAYA;AAeA;;AAGkB,UAhOD,aAAA,CAgOC;EACH,KAAA,EAAA,CAAA,KAAA,EAhOE,cAgOF,EAAA,GAAA,IAAA;;AAMf;AASA;AASA;AAQA;AAYiB,UArQA,mBAAA,SAA4B,aAqQP,CAAA;EASrB,KAAA,EAAA,GAAA,GAAA,OAAA;EAqBA,QAAA,CAAA,EAAA,GAAA,GAAA,IAAiB;EAYjB,IAAA,CAAA,EAAA,CAAA,MAAA,EAAA,MAAmB,EAAA,GAAA,OAExB;EAOK,aAAA,CAAA,EApTC,MAoTY,CAAA,MAAA,EAAA,OAAA,CAAA;AAQ9B;AAaA;AASA;AAkBA;AAUA;;;;;AA6BoC,UAhYnB,eAAA,CAgYmB;EAAtB,SAAA,SAAA,EA/XQ,mBA+XR;;;;;;KAxXF,aAAA,GAAgB,gBAAgB;;;;iBAK5B,gBAAA,QAAwB,gBAAgB;;;;;UA0BvC,WAAA;;;;eAIF;;;;;;UAOE,oBAAA;;YAEL;;;;;;;;;;;UAYK,sBAAA;;WAEN;UACD;;;;;UAMO,UAAA;;;iBACkC;;;;;;;UAOlC,gBAAA;;;;;;;;UASA,mBAAA;;qBAEI;;;;;;;;;UAOJ,+BAAA;;;;;;;;UASA,wBAAA;;;YAGL;;;;;;UAOK,mBAAA;;;;;;;;;;;;;UAcA,cAAA;;;;WAIN;UACD;;;;;;UAWO,eAAA;;;;;;;;;;;;UAaA,iBAAA;;WAEN;SACF;;;;;;UAOQ,YAAA;;;;;;;;;;;UAYA,mBAAA;;;;;;;;;;UAeA,cAAA;aACJ;;kBAEK;eACH;;;;;UAME,oBAAA;;kBAEC;eACH;;;;;UAME,mBAAA;;;;;;;;UASA,eAAA;;;YAEK;;;;;;UAML,UAAA;;;;UAEsB;;;;;;UAUtB,qBAAA;;;;;;;;UASA,uBAAA;;;gBAGD;;;;;;;;;;;;;;;UAkBC,iBAAA;;;;;;;;;;;UAYA,mBAAA;;YAEL;UACF;;;;;UAMO,aAAA;;;;;;;;;UAQA,iBAAA;;;;;;;;UAaA,aAAA;;;;;;;;UASA,UAAA;;;;;;;;;;;;;;;;;KAkBL,OAAA,UAAiB;;;;;;;;;UAUZ,gBAAA;;;;;;;;;;;;;;YAcL;;WAED;oBACS;;;;;;;;;;;;cAYN,MAAM,gBAAgB"}
1
+ {"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;AAkBA;;;;;AAeA;AAQA;AAeA;AAQA;AAKA;AA0BA;AAWA;AAciB,UAtGA,cAAA,CAsGsB;EAStB,UAAA,EAAA,MAAU;EAQV,OAAA,CAAA,EAAA,MAAA;EASA,SAAA,CAAA,EAAA,MAAA;EASA,UAAA,CAAA,EAAA,MAAA;EASA,gBAAA,CAAA,EA7II,MA6IJ,CAAA,MAAwB,EAAA,OAG7B,CAAA;EAOK,eAAA,CAAA,EAtJG,MAsJgB,CAAA,MAAA,EAAA,OAAA,CAAA;EAcnB,MAAA,CAAA,EAnKN,MAmKM,CAAA,MAAc,EAAA,OAIpB,CAAA;EAYM,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAe;AAahC;AAUA;AAYA;AAeA;;AAGkB,UAhOD,aAAA,CAgOC;EACH,KAAA,EAAA,CAAA,KAAA,EAhOE,cAgOF,EAAA,GAAA,IAAA;;AAMf;AASA;AASA;AAQA;AAYiB,UArQA,mBAAA,SAA4B,aAqQP,CAAA;EASrB,KAAA,EAAA,GAAA,GAAA,OAAA;EAqBA,QAAA,CAAA,EAAA,GAAA,GAAA,IAAiB;EAYjB,IAAA,CAAA,EAAA,CAAA,MAAA,EAAA,MAAmB,EAAA,GAAA,OAAA;EASnB,aAAA,CAAA,EApTC,MAoTY,CAAA,MAAA,EAAA,OAAA,CAAA;AAQ9B;AAaA;AASA;AAkBA;AAUA;;;;;AA6BoC,UAhYnB,eAAA,CAgYmB;EAAtB,SAAA,SAAA,EA/XQ,mBA+XR;;;;;;KAxXF,aAAA,GAAgB,gBAAgB;;;;iBAK5B,gBAAA,QAAwB,gBAAgB;;;;;UA0BvC,WAAA;;;;eAIF;;;;;;UAOE,oBAAA;;YAEL;;;;;;;;;;;UAYK,sBAAA;;WAEN;UACD;;;;;UAMO,UAAA;;;iBACkC;;;;;;;UAOlC,gBAAA;;;;;;;;UASA,mBAAA;;qBAEI;;;;;;;;;UAOJ,+BAAA;;;;;;;;UASA,wBAAA;;;YAGL;;;;;;UAOK,mBAAA;;;;;;;;;;;;;UAcA,cAAA;;;;WAIN;UACD;;;;;;UAWO,eAAA;;;;;;;;;;;;UAaA,iBAAA;;WAEN;SACF;;;;;;UAOQ,YAAA;;;;;;;;;;;UAYA,mBAAA;;;;;;;;;;UAeA,cAAA;aACJ;;kBAEK;eACH;;;;;UAME,oBAAA;;kBAEC;eACH;;;;;UAME,mBAAA;;;;;;;;UASA,eAAA;;;YAEK;;;;;;UAML,UAAA;;;;UAEsB;;;;;;UAUtB,qBAAA;;;;;;;;UASA,uBAAA;;;gBAGD;;;;;;;;;;;;;;;UAkBC,iBAAA;;;;;;;;;;;UAYA,mBAAA;;YAEL;UACF;;;;;UAMO,aAAA;;;;;;;;;UAQA,iBAAA;;;;;;;;UAaA,aAAA;;;;;;;;UASA,UAAA;;;;;;;;;;;;;;;;;KAkBL,OAAA,UAAiB;;;;;;;;;UAUZ,gBAAA;;;;;;;;;;;;;;YAcL;;WAED;oBACS;;;;;;;;;;;;cAYN,MAAM,gBAAgB;;oBAEhB,MAAM"}
package/dist/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * Shared type definitions for the Amplitude AI SDK.\n *\n * Structural interfaces for provider request/response shapes,\n * events, and the core AmplitudeLike contract. These are\n * \"duck-typed\" interfaces — they describe the subset of each\n * provider SDK's shape that we actually use, without importing\n * the real SDK types.\n */\n\n// ---------------------------------------------------------------------------\n// Amplitude client contract\n// ---------------------------------------------------------------------------\n\n/**\n * Event payload shape for Amplitude tracking.\n * Used when passing events to `AmplitudeLike.track()`.\n */\nexport interface AmplitudeEvent {\n event_type: string;\n user_id?: string;\n device_id?: string;\n session_id?: number;\n event_properties?: Record<string, unknown>;\n user_properties?: Record<string, unknown>;\n groups?: Record<string, unknown>;\n [key: string]: unknown;\n}\n\n/**\n * Contract for Amplitude analytics clients.\n * Any object with a `track(event)` method satisfies this interface.\n */\nexport interface AmplitudeLike {\n track: (event: AmplitudeEvent) => void;\n}\n\n/**\n * Extended Amplitude client with flush, shutdown, and optional init.\n * Used by the SDK when it owns or receives an Amplitude instance.\n */\nexport interface AmplitudeClientLike extends AmplitudeLike {\n flush: () => unknown;\n shutdown?: () => void;\n init?: (apiKey: string) => unknown;\n configuration?: Record<string, unknown>;\n}\n\n/**\n * Structural type matching AmplitudeAI instances.\n * Allows providers to accept either an AmplitudeLike (raw analytics client)\n * or an AmplitudeAI instance (which exposes `.amplitude` getter).\n * This avoids circular imports while enabling the convenience pattern:\n * new OpenAI({ amplitude: ai }) // AmplitudeAI\n * new OpenAI({ amplitude: amp }) // raw Amplitude client\n */\nexport interface AmplitudeAILike {\n readonly amplitude: AmplitudeClientLike;\n}\n\n/**\n * Union type accepted by provider constructors.\n * Providers call `resolveAmplitude()` to normalize to `AmplitudeLike`.\n */\nexport type AmplitudeOrAI = AmplitudeLike | AmplitudeAILike;\n\n/**\n * Resolve an `AmplitudeOrAI` value to a plain `AmplitudeLike`.\n */\nexport function resolveAmplitude(input: AmplitudeOrAI): AmplitudeLike {\n if (\n 'amplitude' in input &&\n typeof input.amplitude === 'object' &&\n input.amplitude !== null &&\n 'track' in input.amplitude\n ) {\n return input.amplitude;\n }\n if ('track' in input && typeof input.track === 'function') {\n return input as AmplitudeLike;\n }\n throw new Error(\n 'Expected an AmplitudeLike (with .track()) or AmplitudeAI (with .amplitude) instance. ' +\n 'Pass either your AmplitudeAI instance or ai.amplitude.',\n );\n}\n\n// ---------------------------------------------------------------------------\n// OpenAI-compatible shapes (also used by Azure OpenAI)\n// ---------------------------------------------------------------------------\n\n/**\n * Single message in a chat completion request.\n * Supports role, content, optional name, and tool calls.\n */\nexport interface ChatMessage {\n role: string;\n content?: string | null;\n name?: string;\n tool_calls?: ToolCallShape[];\n}\n\n/**\n * Structural interface for OpenAI-compatible chat completion parameters.\n * Used by the OpenAI and Azure OpenAI provider wrappers.\n */\nexport interface ChatCompletionParams {\n model: string;\n messages: ChatMessage[];\n temperature?: number;\n top_p?: number;\n max_tokens?: number;\n stream?: boolean;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI-compatible chat completion responses.\n * Describes the subset of the OpenAI SDK's response shape that the SDK tracks.\n */\nexport interface ChatCompletionResponse {\n model: string;\n choices: ChatChoice[];\n usage?: OpenAITokenUsage;\n}\n\n/**\n * Single choice in a chat completion response.\n */\nexport interface ChatChoice {\n message: { content?: string | null; tool_calls?: ToolCallShape[] };\n finish_reason?: string;\n}\n\n/**\n * Token usage metadata for OpenAI/Azure OpenAI responses.\n */\nexport interface OpenAITokenUsage {\n prompt_tokens?: number;\n completion_tokens?: number;\n total_tokens?: number;\n}\n\n/**\n * Structural interface for OpenAI Responses API request input items.\n */\nexport interface OpenAIResponseInput {\n role?: string;\n content?: string | Array<{ text?: string; [key: string]: unknown }>;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API output content blocks.\n */\nexport interface OpenAIResponseOutputContentItem {\n type?: string;\n text?: string;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API output items.\n */\nexport interface OpenAIResponseOutputItem {\n type?: string;\n status?: string;\n content?: OpenAIResponseOutputContentItem[];\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API usage metadata.\n */\nexport interface OpenAIResponseUsage {\n input_tokens?: number;\n output_tokens?: number;\n total_tokens?: number;\n output_tokens_details?: {\n reasoning_tokens?: number;\n [key: string]: unknown;\n };\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API responses.\n */\nexport interface OpenAIResponse {\n model?: string;\n status?: string;\n output_text?: string;\n output?: OpenAIResponseOutputItem[];\n usage?: OpenAIResponseUsage;\n [key: string]: unknown;\n}\n\n// ---------------------------------------------------------------------------\n// Anthropic shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Anthropic chat completion request parameters.\n */\nexport interface AnthropicParams {\n model: string;\n system?: string;\n messages: unknown[];\n max_tokens?: number;\n temperature?: number;\n top_p?: number;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for Anthropic chat completion responses.\n */\nexport interface AnthropicResponse {\n model: string;\n content: ContentBlock[];\n usage: AnthropicTokenUsage;\n stop_reason?: string;\n}\n\n/**\n * Content block in an Anthropic response (text, thinking, or tool_use).\n */\nexport interface ContentBlock {\n type: 'text' | 'thinking' | 'tool_use';\n text?: string;\n thinking?: string;\n name?: string;\n input?: unknown;\n id?: string;\n}\n\n/**\n * Token usage metadata for Anthropic responses.\n */\nexport interface AnthropicTokenUsage {\n input_tokens: number;\n output_tokens: number;\n cache_read_input_tokens?: number;\n cache_creation_input_tokens?: number;\n}\n\n// ---------------------------------------------------------------------------\n// Gemini shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Google Gemini API responses.\n * Supports both response object and legacy text/usageMetadata shape.\n */\nexport interface GeminiResponse {\n response?: GeminiResponseObject;\n text?: (() => string) | string;\n usageMetadata?: GeminiUsageMetadata;\n candidates?: GeminiCandidate[];\n}\n\n/**\n * Wrapper object for Gemini response (response.text, usageMetadata, candidates).\n */\nexport interface GeminiResponseObject {\n text?: () => string;\n usageMetadata?: GeminiUsageMetadata;\n candidates?: GeminiCandidate[];\n}\n\n/**\n * Token usage metadata for Gemini responses.\n */\nexport interface GeminiUsageMetadata {\n promptTokenCount?: number;\n candidatesTokenCount?: number;\n totalTokenCount?: number;\n}\n\n/**\n * Single candidate in a Gemini response.\n */\nexport interface GeminiCandidate {\n finishReason?: string;\n content?: { parts?: GeminiPart[] };\n}\n\n/**\n * Part of a Gemini candidate (text or functionCall).\n */\nexport interface GeminiPart {\n text?: string;\n functionCall?: { name: string; args: Record<string, unknown> };\n}\n\n// ---------------------------------------------------------------------------\n// Bedrock shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for AWS Bedrock Converse API request parameters.\n */\nexport interface BedrockConverseParams {\n modelId: string;\n messages?: unknown[];\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for AWS Bedrock Converse API responses.\n */\nexport interface BedrockConverseResponse {\n output?: {\n message?: {\n content?: Array<{ text?: string }>;\n };\n };\n usage?: {\n inputTokens?: number;\n outputTokens?: number;\n totalTokens?: number;\n };\n stopReason?: string;\n}\n\n// ---------------------------------------------------------------------------\n// Mistral shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Mistral chat completion request parameters.\n */\nexport interface MistralChatParams {\n model: string;\n messages: unknown[];\n temperature?: number;\n top_p?: number;\n max_tokens?: number;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for Mistral chat completion responses.\n */\nexport interface MistralChatResponse {\n model?: string;\n choices?: MistralChoice[];\n usage?: MistralTokenUsage;\n}\n\n/**\n * Single choice in a Mistral chat response.\n */\nexport interface MistralChoice {\n message?: { content?: string | unknown[] | null };\n finish_reason?: string;\n}\n\n/**\n * Token usage metadata for Mistral responses.\n */\nexport interface MistralTokenUsage {\n prompt_tokens?: number;\n completion_tokens?: number;\n total_tokens?: number;\n}\n\n// ---------------------------------------------------------------------------\n// Common shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Shape of a tool/function call across provider SDKs.\n */\nexport interface ToolCallShape {\n name: string;\n arguments?: unknown;\n id?: string;\n}\n\n/**\n * File or URL attachment for messages (e.g., image, document).\n */\nexport interface Attachment {\n type: string;\n name?: string;\n content?: string;\n url?: string;\n size_bytes?: number;\n}\n\n/**\n * Callback used by provider wrappers to emit an AI response tracking event.\n *\n * Provider wrappers (OpenAI, Anthropic, etc.) receive a `TrackFn` via\n * `BaseAIProvider.trackFn()` and call it after each completion or stream\n * finishes. The function serializes the options into an Amplitude event\n * and sends it via the underlying Amplitude client.\n *\n * @returns The generated message ID for the tracked event.\n */\nexport type TrackFn = (opts: TrackCallOptions) => string;\n\n/**\n * Options passed to the internal track function for LLM completion events.\n *\n * This is the unified shape used by all provider wrappers to report a\n * single AI completion (streaming or non-streaming). Fields like\n * `reasoningTokens`, `cacheReadInputTokens`, and `totalCostUsd` are\n * optional and populated when the provider returns that data.\n */\nexport interface TrackCallOptions {\n userId: string;\n modelName: string;\n provider: string;\n responseContent: string;\n latencyMs: number;\n sessionId?: string | null;\n traceId?: string | null;\n turnId?: number;\n agentId?: string | null;\n parentAgentId?: string | null;\n customerOrgId?: string | null;\n agentVersion?: string | null;\n description?: string | null;\n context?: Record<string, unknown> | null;\n env?: string | null;\n groups?: Record<string, unknown> | null;\n eventProperties?: Record<string, unknown> | null;\n inputTokens?: number | null;\n outputTokens?: number | null;\n totalTokens?: number | null;\n reasoningTokens?: number | null;\n cacheReadInputTokens?: number | null;\n cacheCreationInputTokens?: number | null;\n totalCostUsd?: number | null;\n providerTtfbMs?: number | null;\n isError?: boolean;\n errorMessage?: string | null;\n finishReason?: string | null;\n toolCalls?: Array<ToolCallShape | Record<string, unknown>> | null;\n reasoningContent?: string | null;\n systemPrompt?: string | null;\n temperature?: number | null;\n maxOutputTokens?: number | null;\n topP?: number | null;\n isStreaming?: boolean;\n}\n"],"mappings":";;;;AAqEA,SAAgB,iBAAiB,OAAqC;AACpE,KACE,eAAe,SACf,OAAO,MAAM,cAAc,YAC3B,MAAM,cAAc,QACpB,WAAW,MAAM,UAEjB,QAAO,MAAM;AAEf,KAAI,WAAW,SAAS,OAAO,MAAM,UAAU,WAC7C,QAAO;AAET,OAAM,IAAI,MACR,8IAED"}
1
+ {"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * Shared type definitions for the Amplitude AI SDK.\n *\n * Structural interfaces for provider request/response shapes,\n * events, and the core AmplitudeLike contract. These are\n * \"duck-typed\" interfaces — they describe the subset of each\n * provider SDK's shape that we actually use, without importing\n * the real SDK types.\n */\n\n// ---------------------------------------------------------------------------\n// Amplitude client contract\n// ---------------------------------------------------------------------------\n\n/**\n * Event payload shape for Amplitude tracking.\n * Used when passing events to `AmplitudeLike.track()`.\n */\nexport interface AmplitudeEvent {\n event_type: string;\n user_id?: string;\n device_id?: string;\n session_id?: number;\n event_properties?: Record<string, unknown>;\n user_properties?: Record<string, unknown>;\n groups?: Record<string, unknown>;\n [key: string]: unknown;\n}\n\n/**\n * Contract for Amplitude analytics clients.\n * Any object with a `track(event)` method satisfies this interface.\n */\nexport interface AmplitudeLike {\n track: (event: AmplitudeEvent) => void;\n}\n\n/**\n * Extended Amplitude client with flush, shutdown, and optional init.\n * Used by the SDK when it owns or receives an Amplitude instance.\n */\nexport interface AmplitudeClientLike extends AmplitudeLike {\n flush: () => unknown;\n shutdown?: () => void;\n init?: (apiKey: string) => unknown;\n configuration?: Record<string, unknown>;\n}\n\n/**\n * Structural type matching AmplitudeAI instances.\n * Allows providers to accept either an AmplitudeLike (raw analytics client)\n * or an AmplitudeAI instance (which exposes `.amplitude` getter).\n * This avoids circular imports while enabling the convenience pattern:\n * new OpenAI({ amplitude: ai }) // AmplitudeAI\n * new OpenAI({ amplitude: amp }) // raw Amplitude client\n */\nexport interface AmplitudeAILike {\n readonly amplitude: AmplitudeClientLike;\n}\n\n/**\n * Union type accepted by provider constructors.\n * Providers call `resolveAmplitude()` to normalize to `AmplitudeLike`.\n */\nexport type AmplitudeOrAI = AmplitudeLike | AmplitudeAILike;\n\n/**\n * Resolve an `AmplitudeOrAI` value to a plain `AmplitudeLike`.\n */\nexport function resolveAmplitude(input: AmplitudeOrAI): AmplitudeLike {\n if (\n 'amplitude' in input &&\n typeof input.amplitude === 'object' &&\n input.amplitude !== null &&\n 'track' in input.amplitude\n ) {\n return input.amplitude;\n }\n if ('track' in input && typeof input.track === 'function') {\n return input as AmplitudeLike;\n }\n throw new Error(\n 'Expected an AmplitudeLike (with .track()) or AmplitudeAI (with .amplitude) instance. ' +\n 'Pass either your AmplitudeAI instance or ai.amplitude.',\n );\n}\n\n// ---------------------------------------------------------------------------\n// OpenAI-compatible shapes (also used by Azure OpenAI)\n// ---------------------------------------------------------------------------\n\n/**\n * Single message in a chat completion request.\n * Supports role, content, optional name, and tool calls.\n */\nexport interface ChatMessage {\n role: string;\n content?: string | null;\n name?: string;\n tool_calls?: ToolCallShape[];\n}\n\n/**\n * Structural interface for OpenAI-compatible chat completion parameters.\n * Used by the OpenAI and Azure OpenAI provider wrappers.\n */\nexport interface ChatCompletionParams {\n model: string;\n messages: ChatMessage[];\n temperature?: number;\n top_p?: number;\n max_tokens?: number;\n stream?: boolean;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI-compatible chat completion responses.\n * Describes the subset of the OpenAI SDK's response shape that the SDK tracks.\n */\nexport interface ChatCompletionResponse {\n model: string;\n choices: ChatChoice[];\n usage?: OpenAITokenUsage;\n}\n\n/**\n * Single choice in a chat completion response.\n */\nexport interface ChatChoice {\n message: { content?: string | null; tool_calls?: ToolCallShape[] };\n finish_reason?: string;\n}\n\n/**\n * Token usage metadata for OpenAI/Azure OpenAI responses.\n */\nexport interface OpenAITokenUsage {\n prompt_tokens?: number;\n completion_tokens?: number;\n total_tokens?: number;\n}\n\n/**\n * Structural interface for OpenAI Responses API request input items.\n */\nexport interface OpenAIResponseInput {\n role?: string;\n content?: string | Array<{ text?: string; [key: string]: unknown }>;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API output content blocks.\n */\nexport interface OpenAIResponseOutputContentItem {\n type?: string;\n text?: string;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API output items.\n */\nexport interface OpenAIResponseOutputItem {\n type?: string;\n status?: string;\n content?: OpenAIResponseOutputContentItem[];\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API usage metadata.\n */\nexport interface OpenAIResponseUsage {\n input_tokens?: number;\n output_tokens?: number;\n total_tokens?: number;\n output_tokens_details?: {\n reasoning_tokens?: number;\n [key: string]: unknown;\n };\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for OpenAI Responses API responses.\n */\nexport interface OpenAIResponse {\n model?: string;\n status?: string;\n output_text?: string;\n output?: OpenAIResponseOutputItem[];\n usage?: OpenAIResponseUsage;\n [key: string]: unknown;\n}\n\n// ---------------------------------------------------------------------------\n// Anthropic shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Anthropic chat completion request parameters.\n */\nexport interface AnthropicParams {\n model: string;\n system?: string;\n messages: unknown[];\n max_tokens?: number;\n temperature?: number;\n top_p?: number;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for Anthropic chat completion responses.\n */\nexport interface AnthropicResponse {\n model: string;\n content: ContentBlock[];\n usage: AnthropicTokenUsage;\n stop_reason?: string;\n}\n\n/**\n * Content block in an Anthropic response (text, thinking, or tool_use).\n */\nexport interface ContentBlock {\n type: 'text' | 'thinking' | 'tool_use';\n text?: string;\n thinking?: string;\n name?: string;\n input?: unknown;\n id?: string;\n}\n\n/**\n * Token usage metadata for Anthropic responses.\n */\nexport interface AnthropicTokenUsage {\n input_tokens: number;\n output_tokens: number;\n cache_read_input_tokens?: number;\n cache_creation_input_tokens?: number;\n}\n\n// ---------------------------------------------------------------------------\n// Gemini shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Google Gemini API responses.\n * Supports both response object and legacy text/usageMetadata shape.\n */\nexport interface GeminiResponse {\n response?: GeminiResponseObject;\n text?: (() => string) | string;\n usageMetadata?: GeminiUsageMetadata;\n candidates?: GeminiCandidate[];\n}\n\n/**\n * Wrapper object for Gemini response (response.text, usageMetadata, candidates).\n */\nexport interface GeminiResponseObject {\n text?: () => string;\n usageMetadata?: GeminiUsageMetadata;\n candidates?: GeminiCandidate[];\n}\n\n/**\n * Token usage metadata for Gemini responses.\n */\nexport interface GeminiUsageMetadata {\n promptTokenCount?: number;\n candidatesTokenCount?: number;\n totalTokenCount?: number;\n}\n\n/**\n * Single candidate in a Gemini response.\n */\nexport interface GeminiCandidate {\n finishReason?: string;\n content?: { parts?: GeminiPart[] };\n}\n\n/**\n * Part of a Gemini candidate (text or functionCall).\n */\nexport interface GeminiPart {\n text?: string;\n functionCall?: { name: string; args: Record<string, unknown> };\n}\n\n// ---------------------------------------------------------------------------\n// Bedrock shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for AWS Bedrock Converse API request parameters.\n */\nexport interface BedrockConverseParams {\n modelId: string;\n messages?: unknown[];\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for AWS Bedrock Converse API responses.\n */\nexport interface BedrockConverseResponse {\n output?: {\n message?: {\n content?: Array<{ text?: string }>;\n };\n };\n usage?: {\n inputTokens?: number;\n outputTokens?: number;\n totalTokens?: number;\n };\n stopReason?: string;\n}\n\n// ---------------------------------------------------------------------------\n// Mistral shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Structural interface for Mistral chat completion request parameters.\n */\nexport interface MistralChatParams {\n model: string;\n messages: unknown[];\n temperature?: number;\n top_p?: number;\n max_tokens?: number;\n [key: string]: unknown;\n}\n\n/**\n * Structural interface for Mistral chat completion responses.\n */\nexport interface MistralChatResponse {\n model?: string;\n choices?: MistralChoice[];\n usage?: MistralTokenUsage;\n}\n\n/**\n * Single choice in a Mistral chat response.\n */\nexport interface MistralChoice {\n message?: { content?: string | unknown[] | null };\n finish_reason?: string;\n}\n\n/**\n * Token usage metadata for Mistral responses.\n */\nexport interface MistralTokenUsage {\n prompt_tokens?: number;\n completion_tokens?: number;\n total_tokens?: number;\n}\n\n// ---------------------------------------------------------------------------\n// Common shapes\n// ---------------------------------------------------------------------------\n\n/**\n * Shape of a tool/function call across provider SDKs.\n */\nexport interface ToolCallShape {\n name: string;\n arguments?: unknown;\n id?: string;\n}\n\n/**\n * File or URL attachment for messages (e.g., image, document).\n */\nexport interface Attachment {\n type: string;\n name?: string;\n content?: string;\n url?: string;\n size_bytes?: number;\n}\n\n/**\n * Callback used by provider wrappers to emit an AI response tracking event.\n *\n * Provider wrappers (OpenAI, Anthropic, etc.) receive a `TrackFn` via\n * `BaseAIProvider.trackFn()` and call it after each completion or stream\n * finishes. The function serializes the options into an Amplitude event\n * and sends it via the underlying Amplitude client.\n *\n * @returns The generated message ID for the tracked event.\n */\nexport type TrackFn = (opts: TrackCallOptions) => string;\n\n/**\n * Options passed to the internal track function for LLM completion events.\n *\n * This is the unified shape used by all provider wrappers to report a\n * single AI completion (streaming or non-streaming). Fields like\n * `reasoningTokens`, `cacheReadInputTokens`, and `totalCostUsd` are\n * optional and populated when the provider returns that data.\n */\nexport interface TrackCallOptions {\n userId: string;\n modelName: string;\n provider: string;\n responseContent: string;\n latencyMs: number;\n sessionId?: string | null;\n traceId?: string | null;\n turnId?: number;\n agentId?: string | null;\n parentAgentId?: string | null;\n customerOrgId?: string | null;\n agentVersion?: string | null;\n description?: string | null;\n context?: Record<string, unknown> | null;\n env?: string | null;\n groups?: Record<string, unknown> | null;\n eventProperties?: Record<string, unknown> | null;\n inputTokens?: number | null;\n outputTokens?: number | null;\n totalTokens?: number | null;\n reasoningTokens?: number | null;\n cacheReadInputTokens?: number | null;\n cacheCreationInputTokens?: number | null;\n totalCostUsd?: number | null;\n providerTtfbMs?: number | null;\n isError?: boolean;\n errorMessage?: string | null;\n finishReason?: string | null;\n toolCalls?: Array<ToolCallShape | Record<string, unknown>> | null;\n reasoningContent?: string | null;\n toolDefinitions?: Array<Record<string, unknown>> | null;\n systemPrompt?: string | null;\n temperature?: number | null;\n maxOutputTokens?: number | null;\n topP?: number | null;\n isStreaming?: boolean;\n}\n"],"mappings":";;;;AAqEA,SAAgB,iBAAiB,OAAqC;AACpE,KACE,eAAe,SACf,OAAO,MAAM,cAAc,YAC3B,MAAM,cAAc,QACpB,WAAW,MAAM,UAEjB,QAAO,MAAM;AAEf,KAAI,WAAW,SAAS,OAAO,MAAM,UAAU,WAC7C,QAAO;AAET,OAAM,IAAI,MACR,8IAED"}
@@ -1 +1 @@
1
- {"version":3,"file":"logger.d.ts","names":[],"sources":["../../src/utils/logger.ts"],"sourcesContent":[],"mappings":";UAAiB,MAAA;EAAA,KAAA,CAAA,OAAM,EAAA,MAAA,CAAA,EAAA,IAAA;EAcP,KAAA,CAAA,OAAS,EAAA,MAAA,CAAA,EAAA,IAAuB;;;;iBAAhC,SAAA,uBAAgC"}
1
+ {"version":3,"file":"logger.d.ts","names":[],"sources":["../../src/utils/logger.ts"],"sourcesContent":[],"mappings":";UAAiB,MAAA;EAAA,KAAA,CAAA,OAAM,EAAA,MAAA,CAAA,EAAA,IAAA;EAcP,KAAA,CAAA,OAAS,EAAA,MAAA,CAAA,EAAuB,IAAA;;;;iBAAhC,SAAA,uBAAgC"}
package/llms-full.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  # llms-full.txt
2
- # @amplitude/ai 0.3.3 — Complete API Reference for AI Coding Agents
2
+ # @amplitude/ai 0.3.5 — Complete API Reference for AI Coding Agents
3
3
  #
4
4
  # This file is the definitive guide for any coding agent instrumenting
5
5
  # a JavaScript/TypeScript AI application with @amplitude/ai.
package/llms.txt CHANGED
@@ -1,7 +1,7 @@
1
1
  <!-- GENERATED FILE: do not edit manually. Update scripts/generate-agent-docs.mjs instead. -->
2
2
  # llms.txt
3
3
  package=@amplitude/ai
4
- version=0.3.3
4
+ version=0.3.5
5
5
 
6
6
  [mcp.tools]
7
7
  get_event_schema
package/mcp.schema.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "generated": true,
3
3
  "package": "@amplitude/ai",
4
- "version": "0.3.3",
4
+ "version": "0.3.5",
5
5
  "prompt": "instrument_app",
6
6
  "tools": [
7
7
  "get_event_schema",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amplitude/ai",
3
- "version": "0.3.3",
3
+ "version": "0.3.5",
4
4
  "private": false,
5
5
  "description": "Amplitude AI SDK - LLM usage tracking for Amplitude Analytics",
6
6
  "keywords": [