@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/messages/ai.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.cjs","names":["BaseMessage","fields: string | AIMessageFields","kwargs?: Record<string, unknown>","initParams: AIMessageFields","toolCalls","defaultToolCallParser","getTranslator","x: BaseMessage","x: BaseMessageChunk","BaseMessageChunk","fields: string | AIMessageChunkFields","initParams: AIMessageChunkFields","toolCalls: ToolCall[]","invalidToolCalls: InvalidToolCall[]","parsePartialJson","chunk: AIMessageChunk","combinedFields: AIMessageChunkFields","mergeContent","_mergeDicts","_mergeLists","inputTokenDetails: InputTokenDetails","outputTokenDetails: OutputTokenDetails","left: UsageMetadata","right: UsageMetadata","usage_metadata: UsageMetadata"],"sources":["../../src/messages/ai.ts"],"sourcesContent":["import { parsePartialJson } from \"../utils/json.js\";\nimport {\n  BaseMessage,\n  BaseMessageChunk,\n  mergeContent,\n  _mergeDicts,\n  type MessageType,\n  BaseMessageFields,\n  _mergeLists,\n} from \"./base.js\";\nimport { getTranslator } from \"./block_translators/index.js\";\nimport { ContentBlock } from \"./content/index.js\";\nimport {\n  InvalidToolCall,\n  ToolCall,\n  ToolCallChunk,\n  defaultToolCallParser,\n} from \"./tool.js\";\n\nexport type AIMessageFields = BaseMessageFields & {\n  tool_calls?: ToolCall[];\n  invalid_tool_calls?: InvalidToolCall[];\n  usage_metadata?: UsageMetadata;\n};\n\nexport type ModalitiesTokenDetails = {\n  /**\n   * Text tokens.\n   * Does not need to be reported, but some models will do so.\n   */\n  text?: number;\n\n  /**\n   * Image (non-video) tokens.\n   */\n  image?: number;\n\n  /**\n   * Audio tokens.\n   */\n  audio?: number;\n\n  /**\n   * Video tokens.\n   */\n  video?: number;\n\n  /**\n   * Document tokens.\n   * e.g. PDF\n   */\n  document?: number;\n};\n\n/**\n * Breakdown of input token counts.\n *\n * Does not *need* to sum to full input token count. Does *not* need to have all keys.\n */\nexport type InputTokenDetails = ModalitiesTokenDetails & {\n  /**\n   * Input tokens that were cached and there was a cache hit.\n   *\n   * Since there was a cache hit, the tokens were read from the cache.\n   * More precisely, the model state given these tokens was read from the cache.\n   */\n  cache_read?: number;\n\n  /**\n   * Input tokens that were cached and there was a cache miss.\n   *\n   * Since there was a cache miss, the cache was created from these tokens.\n   */\n  cache_creation?: number;\n};\n\n/**\n * Breakdown of output token counts.\n *\n * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n */\nexport type OutputTokenDetails = ModalitiesTokenDetails & {\n  /**\n   * Reasoning output tokens.\n   *\n   * Tokens generated by the model in a chain of thought process (i.e. by\n   * OpenAI's o1 models) that are not returned as part of model output.\n   */\n  reasoning?: number;\n};\n\n/**\n * Usage metadata for a message, such as token counts.\n */\nexport type UsageMetadata = {\n  /**\n   * Count of input (or prompt) tokens. Sum of all input token types.\n   */\n  input_tokens: number;\n  /**\n   * Count of output (or completion) tokens. Sum of all output token types.\n   */\n  output_tokens: number;\n  /**\n   * Total token count. Sum of input_tokens + output_tokens.\n   */\n  total_tokens: number;\n\n  /**\n   * Breakdown of input token counts.\n   *\n   * Does *not* need to sum to full input token count. Does *not* need to have all keys.\n   */\n  input_token_details?: InputTokenDetails;\n\n  /**\n   * Breakdown of output token counts.\n   *\n   * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n   */\n  output_token_details?: OutputTokenDetails;\n};\n\n/**\n * Represents an AI message in a conversation.\n */\nexport class AIMessage extends BaseMessage implements AIMessageFields {\n  // These are typed as optional to avoid breaking changes and allow for casting\n  // from BaseMessage.\n  tool_calls?: ToolCall[] = [];\n\n  invalid_tool_calls?: InvalidToolCall[] = [];\n\n  /**\n   * If provided, token usage information associated with the message.\n   */\n  usage_metadata?: UsageMetadata;\n\n  get lc_aliases(): Record<string, string> {\n    // exclude snake case conversion to pascal case\n    return {\n      ...super.lc_aliases,\n      tool_calls: \"tool_calls\",\n      invalid_tool_calls: \"invalid_tool_calls\",\n    };\n  }\n\n  constructor(\n    fields: string | AIMessageFields,\n    /** @deprecated */\n    kwargs?: Record<string, unknown>\n  ) {\n    let initParams: AIMessageFields;\n    if (typeof fields === \"string\") {\n      initParams = {\n        content: fields,\n        tool_calls: [],\n        invalid_tool_calls: [],\n        additional_kwargs: kwargs ?? {},\n      };\n    } else {\n      initParams = fields;\n      const rawToolCalls = initParams.additional_kwargs?.tool_calls;\n      const toolCalls = initParams.tool_calls;\n      if (\n        !(rawToolCalls == null) &&\n        rawToolCalls.length > 0 &&\n        (toolCalls === undefined || toolCalls.length === 0)\n      ) {\n        console.warn(\n          [\n            \"New LangChain packages are available that more efficiently handle\",\n            \"tool calling.\\n\\nPlease upgrade your packages to versions that set\",\n            \"message tool calls. e.g., `pnpm install @langchain/anthropic`,\",\n            \"pnpm install @langchain/openai`, etc.\",\n          ].join(\" \")\n        );\n      }\n      try {\n        if (!(rawToolCalls == null) && toolCalls === undefined) {\n          const [toolCalls, invalidToolCalls] =\n            defaultToolCallParser(rawToolCalls);\n          initParams.tool_calls = toolCalls ?? [];\n          initParams.invalid_tool_calls = invalidToolCalls ?? [];\n        } else {\n          initParams.tool_calls = initParams.tool_calls ?? [];\n          initParams.invalid_tool_calls = initParams.invalid_tool_calls ?? [];\n        }\n      } catch (e) {\n        // Do nothing if parsing fails\n        initParams.tool_calls = [];\n        initParams.invalid_tool_calls = [];\n      }\n      if (initParams.contentBlocks !== undefined) {\n        // Add constructor tool calls as content blocks\n        initParams.contentBlocks.push(\n          ...initParams.tool_calls.map((toolCall) => ({\n            type: \"tool_call\" as const,\n            id: toolCall.id,\n            name: toolCall.name,\n            args: toolCall.args,\n          }))\n        );\n        // Add content block tool calls that aren't in the constructor tool calls\n        const missingToolCalls = initParams.contentBlocks\n          .filter<ContentBlock.Tools.ToolCall>(\n            (block) => block.type === \"tool_call\"\n          )\n          .filter(\n            (block) =>\n              !initParams.tool_calls?.some(\n                (toolCall) =>\n                  toolCall.id === block.id && toolCall.name === block.name\n              )\n          );\n        if (missingToolCalls.length > 0) {\n          initParams.tool_calls = missingToolCalls.map((block) => ({\n            id: block.id!,\n            name: block.name,\n            args: block.args as Record<string, unknown>,\n          }));\n        }\n      }\n    }\n    // Sadly, TypeScript only allows super() calls at root if the class has\n    // properties with initializers, so we have to check types twice.\n    super(initParams);\n    if (typeof initParams !== \"string\") {\n      this.tool_calls = initParams.tool_calls ?? this.tool_calls;\n      this.invalid_tool_calls =\n        initParams.invalid_tool_calls ?? this.invalid_tool_calls;\n    }\n    this.usage_metadata = initParams.usage_metadata;\n  }\n\n  static lc_name() {\n    return \"AIMessage\";\n  }\n\n  _getType(): MessageType {\n    return \"ai\";\n  }\n\n  get contentBlocks(): Array<ContentBlock.Standard> {\n    if (this.response_metadata?.output_version === \"v1\") {\n      return this.content as Array<ContentBlock.Standard>;\n    }\n\n    const modelProvider = this.response_metadata?.model_provider;\n    if (modelProvider) {\n      const translator = getTranslator(modelProvider);\n      if (translator) {\n        return translator.translateContent(this);\n      }\n    }\n\n    const blocks = super.contentBlocks;\n\n    if (this.tool_calls) {\n      const missingToolCalls = this.tool_calls.filter(\n        (block) =>\n          !blocks.some((b) => b.id === block.id && b.name === block.name)\n      );\n      blocks.push(\n        ...missingToolCalls.map((block) => ({\n          ...block,\n          type: \"tool_call\" as const,\n          id: block.id,\n          name: block.name,\n          args: block.args,\n        }))\n      );\n    }\n\n    return blocks;\n  }\n\n  override get _printableFields(): Record<string, unknown> {\n    return {\n      ...super._printableFields,\n      tool_calls: this.tool_calls,\n      invalid_tool_calls: this.invalid_tool_calls,\n      usage_metadata: this.usage_metadata,\n    };\n  }\n}\n\nexport function isAIMessage(x: BaseMessage): x is AIMessage {\n  return x._getType() === \"ai\";\n}\n\nexport function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk {\n  return x._getType() === \"ai\";\n}\n\nexport type AIMessageChunkFields = AIMessageFields & {\n  tool_call_chunks?: ToolCallChunk[];\n};\n\n/**\n * Represents a chunk of an AI message, which can be concatenated with\n * other AI message chunks.\n */\nexport class AIMessageChunk extends BaseMessageChunk {\n  // Must redeclare tool call fields since there is no multiple inheritance in JS.\n  // These are typed as optional to avoid breaking changes and allow for casting\n  // from BaseMessage.\n  tool_calls?: ToolCall[] = [];\n\n  invalid_tool_calls?: InvalidToolCall[] = [];\n\n  tool_call_chunks?: ToolCallChunk[] = [];\n\n  /**\n   * If provided, token usage information associated with the message.\n   */\n  usage_metadata?: UsageMetadata;\n\n  constructor(fields: string | AIMessageChunkFields) {\n    let initParams: AIMessageChunkFields;\n    if (typeof fields === \"string\") {\n      initParams = {\n        content: fields,\n        tool_calls: [],\n        invalid_tool_calls: [],\n        tool_call_chunks: [],\n      };\n    } else if (fields.tool_call_chunks === undefined) {\n      initParams = {\n        ...fields,\n        tool_calls: fields.tool_calls ?? [],\n        invalid_tool_calls: [],\n        tool_call_chunks: [],\n        usage_metadata:\n          fields.usage_metadata !== undefined\n            ? fields.usage_metadata\n            : undefined,\n      };\n    } else {\n      const groupedToolCallChunk = fields.tool_call_chunks.reduce(\n        (acc, chunk) => {\n          // Assign a fallback ID if the chunk doesn't have one\n          // This can happen with tools that have empty schemas\n          const chunkId = chunk.id || `fallback-${chunk.index || 0}`;\n          acc[chunkId] = acc[chunkId] ?? [];\n          acc[chunkId].push(chunk);\n          return acc;\n        },\n        {} as Record<string, ToolCallChunk[]>\n      );\n\n      const toolCalls: ToolCall[] = [];\n      const invalidToolCalls: InvalidToolCall[] = [];\n      for (const [id, chunks] of Object.entries(groupedToolCallChunk)) {\n        let parsedArgs = {};\n        const name = chunks[0]?.name ?? \"\";\n        const joinedArgs = chunks.map((c) => c.args || \"\").join(\"\");\n        const argsStr = joinedArgs.length ? joinedArgs : \"{}\";\n        // Use the original ID from the first chunk if it exists, otherwise use the grouped ID\n        const originalId = chunks[0]?.id || id;\n        try {\n          parsedArgs = parsePartialJson(argsStr);\n          if (\n            parsedArgs === null ||\n            typeof parsedArgs !== \"object\" ||\n            Array.isArray(parsedArgs)\n          ) {\n            throw new Error(\"Malformed tool call chunk args.\");\n          }\n          toolCalls.push({\n            name,\n            args: parsedArgs,\n            id: originalId,\n            type: \"tool_call\",\n          });\n        } catch (e) {\n          invalidToolCalls.push({\n            name,\n            args: argsStr,\n            id: originalId,\n            error: \"Malformed args.\",\n            type: \"invalid_tool_call\",\n          });\n        }\n      }\n      initParams = {\n        ...fields,\n        tool_calls: toolCalls,\n        invalid_tool_calls: invalidToolCalls,\n        usage_metadata:\n          fields.usage_metadata !== undefined\n            ? fields.usage_metadata\n            : undefined,\n      };\n    }\n    // Sadly, TypeScript only allows super() calls at root if the class has\n    // properties with initializers, so we have to check types twice.\n    super(initParams);\n    this.tool_call_chunks =\n      initParams.tool_call_chunks ?? this.tool_call_chunks;\n    this.tool_calls = initParams.tool_calls ?? this.tool_calls;\n    this.invalid_tool_calls =\n      initParams.invalid_tool_calls ?? this.invalid_tool_calls;\n    this.usage_metadata = initParams.usage_metadata;\n  }\n\n  get lc_aliases(): Record<string, string> {\n    // exclude snake case conversion to pascal case\n    return {\n      ...super.lc_aliases,\n      tool_calls: \"tool_calls\",\n      invalid_tool_calls: \"invalid_tool_calls\",\n      tool_call_chunks: \"tool_call_chunks\",\n    };\n  }\n\n  static lc_name() {\n    return \"AIMessageChunk\";\n  }\n\n  _getType(): MessageType {\n    return \"ai\";\n  }\n\n  get contentBlocks(): Array<ContentBlock.Standard> {\n    if (this.response_metadata?.output_version === \"v1\") {\n      return this.content as Array<ContentBlock.Standard>;\n    }\n\n    const modelProvider = this.response_metadata?.model_provider;\n    if (modelProvider) {\n      const translator = getTranslator(modelProvider);\n      if (translator) {\n        return translator.translateContent(this);\n      }\n    }\n\n    const blocks = super.contentBlocks;\n\n    if (this.tool_calls) {\n      if (typeof this.content !== \"string\") {\n        const contentToolCalls = this.content\n          .filter((block) => block.type === \"tool_call\")\n          .map((block) => block.id);\n        for (const toolCall of this.tool_calls) {\n          if (toolCall.id && !contentToolCalls.includes(toolCall.id)) {\n            blocks.push({\n              ...toolCall,\n              type: \"tool_call\",\n              id: toolCall.id,\n              name: toolCall.name,\n              args: toolCall.args,\n            });\n          }\n        }\n      }\n    }\n\n    return blocks;\n  }\n\n  override get _printableFields(): Record<string, unknown> {\n    return {\n      ...super._printableFields,\n      tool_calls: this.tool_calls,\n      tool_call_chunks: this.tool_call_chunks,\n      invalid_tool_calls: this.invalid_tool_calls,\n      usage_metadata: this.usage_metadata,\n    };\n  }\n\n  concat(chunk: AIMessageChunk) {\n    const combinedFields: AIMessageChunkFields = {\n      content: mergeContent(this.content, chunk.content),\n      additional_kwargs: _mergeDicts(\n        this.additional_kwargs,\n        chunk.additional_kwargs\n      ),\n      response_metadata: _mergeDicts(\n        this.response_metadata,\n        chunk.response_metadata\n      ),\n      tool_call_chunks: [],\n      id: this.id ?? chunk.id,\n    };\n    if (\n      this.tool_call_chunks !== undefined ||\n      chunk.tool_call_chunks !== undefined\n    ) {\n      const rawToolCalls = _mergeLists(\n        this.tool_call_chunks,\n        chunk.tool_call_chunks\n      );\n      if (rawToolCalls !== undefined && rawToolCalls.length > 0) {\n        combinedFields.tool_call_chunks = rawToolCalls;\n      }\n    }\n    if (\n      this.usage_metadata !== undefined ||\n      chunk.usage_metadata !== undefined\n    ) {\n      const inputTokenDetails: InputTokenDetails = {\n        ...((this.usage_metadata?.input_token_details?.audio !== undefined ||\n          chunk.usage_metadata?.input_token_details?.audio !== undefined) && {\n          audio:\n            (this.usage_metadata?.input_token_details?.audio ?? 0) +\n            (chunk.usage_metadata?.input_token_details?.audio ?? 0),\n        }),\n        ...((this.usage_metadata?.input_token_details?.cache_read !==\n          undefined ||\n          chunk.usage_metadata?.input_token_details?.cache_read !==\n            undefined) && {\n          cache_read:\n            (this.usage_metadata?.input_token_details?.cache_read ?? 0) +\n            (chunk.usage_metadata?.input_token_details?.cache_read ?? 0),\n        }),\n        ...((this.usage_metadata?.input_token_details?.cache_creation !==\n          undefined ||\n          chunk.usage_metadata?.input_token_details?.cache_creation !==\n            undefined) && {\n          cache_creation:\n            (this.usage_metadata?.input_token_details?.cache_creation ?? 0) +\n            (chunk.usage_metadata?.input_token_details?.cache_creation ?? 0),\n        }),\n      };\n\n      const outputTokenDetails: OutputTokenDetails = {\n        ...((this.usage_metadata?.output_token_details?.audio !== undefined ||\n          chunk.usage_metadata?.output_token_details?.audio !== undefined) && {\n          audio:\n            (this.usage_metadata?.output_token_details?.audio ?? 0) +\n            (chunk.usage_metadata?.output_token_details?.audio ?? 0),\n        }),\n        ...((this.usage_metadata?.output_token_details?.reasoning !==\n          undefined ||\n          chunk.usage_metadata?.output_token_details?.reasoning !==\n            undefined) && {\n          reasoning:\n            (this.usage_metadata?.output_token_details?.reasoning ?? 0) +\n            (chunk.usage_metadata?.output_token_details?.reasoning ?? 0),\n        }),\n      };\n\n      const left: UsageMetadata = this.usage_metadata ?? {\n        input_tokens: 0,\n        output_tokens: 0,\n        total_tokens: 0,\n      };\n      const right: UsageMetadata = chunk.usage_metadata ?? {\n        input_tokens: 0,\n        output_tokens: 0,\n        total_tokens: 0,\n      };\n      const usage_metadata: UsageMetadata = {\n        input_tokens: left.input_tokens + right.input_tokens,\n        output_tokens: left.output_tokens + right.output_tokens,\n        total_tokens: left.total_tokens + right.total_tokens,\n        // Do not include `input_token_details` / `output_token_details` keys in combined fields\n        // unless their values are defined.\n        ...(Object.keys(inputTokenDetails).length > 0 && {\n          input_token_details: inputTokenDetails,\n        }),\n        ...(Object.keys(outputTokenDetails).length > 0 && {\n          output_token_details: outputTokenDetails,\n        }),\n      };\n      combinedFields.usage_metadata = usage_metadata;\n    }\n    return new AIMessageChunk(combinedFields);\n  }\n}\n"],"mappings":";;;;;;;;;AA8HA,IAAa,YAAb,cAA+BA,yBAAuC;CAGpE,aAA0B,CAAE;CAE5B,qBAAyC,CAAE;;;;CAK3C;CAEA,IAAI,aAAqC;AAEvC,SAAO;GACL,GAAG,MAAM;GACT,YAAY;GACZ,oBAAoB;EACrB;CACF;CAED,YACEC,QAEAC,QACA;EACA,IAAIC;AACJ,MAAI,OAAO,WAAW,UACpB,aAAa;GACX,SAAS;GACT,YAAY,CAAE;GACd,oBAAoB,CAAE;GACtB,mBAAmB,UAAU,CAAE;EAChC;OACI;GACL,aAAa;GACb,MAAM,eAAe,WAAW,mBAAmB;GACnD,MAAM,YAAY,WAAW;AAC7B,OACE,EAAE,gBAAgB,SAClB,aAAa,SAAS,MACrB,cAAc,UAAa,UAAU,WAAW,IAEjD,QAAQ,KACN;IACE;IACA;IACA;IACA;GACD,EAAC,KAAK,IAAI,CACZ;AAEH,OAAI;AACF,QAAI,EAAE,gBAAgB,SAAS,cAAc,QAAW;KACtD,MAAM,CAACC,aAAW,iBAAiB,GACjCC,4CAAsB,aAAa;KACrC,WAAW,aAAaD,eAAa,CAAE;KACvC,WAAW,qBAAqB,oBAAoB,CAAE;IACvD,OAAM;KACL,WAAW,aAAa,WAAW,cAAc,CAAE;KACnD,WAAW,qBAAqB,WAAW,sBAAsB,CAAE;IACpE;GACF,SAAQ,GAAG;IAEV,WAAW,aAAa,CAAE;IAC1B,WAAW,qBAAqB,CAAE;GACnC;AACD,OAAI,WAAW,kBAAkB,QAAW;IAE1C,WAAW,cAAc,KACvB,GAAG,WAAW,WAAW,IAAI,CAAC,cAAc;KAC1C,MAAM;KACN,IAAI,SAAS;KACb,MAAM,SAAS;KACf,MAAM,SAAS;IAChB,GAAE,CACJ;IAED,MAAM,mBAAmB,WAAW,cACjC,OACC,CAAC,UAAU,MAAM,SAAS,YAC3B,CACA,OACC,CAAC,UACC,CAAC,WAAW,YAAY,KACtB,CAAC,aACC,SAAS,OAAO,MAAM,MAAM,SAAS,SAAS,MAAM,KACvD,CACJ;AACH,QAAI,iBAAiB,SAAS,GAC5B,WAAW,aAAa,iBAAiB,IAAI,CAAC,WAAW;KACvD,IAAI,MAAM;KACV,MAAM,MAAM;KACZ,MAAM,MAAM;IACb,GAAE;GAEN;EACF;EAGD,MAAM,WAAW;AACjB,MAAI,OAAO,eAAe,UAAU;GAClC,KAAK,aAAa,WAAW,cAAc,KAAK;GAChD,KAAK,qBACH,WAAW,sBAAsB,KAAK;EACzC;EACD,KAAK,iBAAiB,WAAW;CAClC;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,WAAwB;AACtB,SAAO;CACR;CAED,IAAI,gBAA8C;AAChD,MAAI,KAAK,mBAAmB,mBAAmB,KAC7C,QAAO,KAAK;EAGd,MAAM,gBAAgB,KAAK,mBAAmB;AAC9C,MAAI,eAAe;GACjB,MAAM,aAAaE,4BAAc,cAAc;AAC/C,OAAI,WACF,QAAO,WAAW,iBAAiB,KAAK;EAE3C;EAED,MAAM,SAAS,MAAM;AAErB,MAAI,KAAK,YAAY;GACnB,MAAM,mBAAmB,KAAK,WAAW,OACvC,CAAC,UACC,CAAC,OAAO,KAAK,CAAC,MAAM,EAAE,OAAO,MAAM,MAAM,EAAE,SAAS,MAAM,KAAK,CAClE;GACD,OAAO,KACL,GAAG,iBAAiB,IAAI,CAAC,WAAW;IAClC,GAAG;IACH,MAAM;IACN,IAAI,MAAM;IACV,MAAM,MAAM;IACZ,MAAM,MAAM;GACb,GAAE,CACJ;EACF;AAED,SAAO;CACR;CAED,IAAa,mBAA4C;AACvD,SAAO;GACL,GAAG,MAAM;GACT,YAAY,KAAK;GACjB,oBAAoB,KAAK;GACzB,gBAAgB,KAAK;EACtB;CACF;AACF;AAED,SAAgB,YAAYC,GAAgC;AAC1D,QAAO,EAAE,UAAU,KAAK;AACzB;AAED,SAAgB,iBAAiBC,GAA0C;AACzE,QAAO,EAAE,UAAU,KAAK;AACzB;;;;;AAUD,IAAa,iBAAb,MAAa,uBAAuBC,8BAAiB;CAInD,aAA0B,CAAE;CAE5B,qBAAyC,CAAE;CAE3C,mBAAqC,CAAE;;;;CAKvC;CAEA,YAAYC,QAAuC;EACjD,IAAIC;AACJ,MAAI,OAAO,WAAW,UACpB,aAAa;GACX,SAAS;GACT,YAAY,CAAE;GACd,oBAAoB,CAAE;GACtB,kBAAkB,CAAE;EACrB;WACQ,OAAO,qBAAqB,QACrC,aAAa;GACX,GAAG;GACH,YAAY,OAAO,cAAc,CAAE;GACnC,oBAAoB,CAAE;GACtB,kBAAkB,CAAE;GACpB,gBACE,OAAO,mBAAmB,SACtB,OAAO,iBACP;EACP;OACI;GACL,MAAM,uBAAuB,OAAO,iBAAiB,OACnD,CAAC,KAAK,UAAU;IAGd,MAAM,UAAU,MAAM,MAAM,CAAC,SAAS,EAAE,MAAM,SAAS,GAAG;IAC1D,IAAI,WAAW,IAAI,YAAY,CAAE;IACjC,IAAI,SAAS,KAAK,MAAM;AACxB,WAAO;GACR,GACD,CAAE,EACH;GAED,MAAMC,YAAwB,CAAE;GAChC,MAAMC,mBAAsC,CAAE;AAC9C,QAAK,MAAM,CAAC,IAAI,OAAO,IAAI,OAAO,QAAQ,qBAAqB,EAAE;IAC/D,IAAI,aAAa,CAAE;IACnB,MAAM,OAAO,OAAO,IAAI,QAAQ;IAChC,MAAM,aAAa,OAAO,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,CAAC,KAAK,GAAG;IAC3D,MAAM,UAAU,WAAW,SAAS,aAAa;IAEjD,MAAM,aAAa,OAAO,IAAI,MAAM;AACpC,QAAI;KACF,aAAaC,8BAAiB,QAAQ;AACtC,SACE,eAAe,QACf,OAAO,eAAe,YACtB,MAAM,QAAQ,WAAW,CAEzB,OAAM,IAAI,MAAM;KAElB,UAAU,KAAK;MACb;MACA,MAAM;MACN,IAAI;MACJ,MAAM;KACP,EAAC;IACH,SAAQ,GAAG;KACV,iBAAiB,KAAK;MACpB;MACA,MAAM;MACN,IAAI;MACJ,OAAO;MACP,MAAM;KACP,EAAC;IACH;GACF;GACD,aAAa;IACX,GAAG;IACH,YAAY;IACZ,oBAAoB;IACpB,gBACE,OAAO,mBAAmB,SACtB,OAAO,iBACP;GACP;EACF;EAGD,MAAM,WAAW;EACjB,KAAK,mBACH,WAAW,oBAAoB,KAAK;EACtC,KAAK,aAAa,WAAW,cAAc,KAAK;EAChD,KAAK,qBACH,WAAW,sBAAsB,KAAK;EACxC,KAAK,iBAAiB,WAAW;CAClC;CAED,IAAI,aAAqC;AAEvC,SAAO;GACL,GAAG,MAAM;GACT,YAAY;GACZ,oBAAoB;GACpB,kBAAkB;EACnB;CACF;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,WAAwB;AACtB,SAAO;CACR;CAED,IAAI,gBAA8C;AAChD,MAAI,KAAK,mBAAmB,mBAAmB,KAC7C,QAAO,KAAK;EAGd,MAAM,gBAAgB,KAAK,mBAAmB;AAC9C,MAAI,eAAe;GACjB,MAAM,aAAaR,4BAAc,cAAc;AAC/C,OAAI,WACF,QAAO,WAAW,iBAAiB,KAAK;EAE3C;EAED,MAAM,SAAS,MAAM;AAErB,MAAI,KAAK,YACP;OAAI,OAAO,KAAK,YAAY,UAAU;IACpC,MAAM,mBAAmB,KAAK,QAC3B,OAAO,CAAC,UAAU,MAAM,SAAS,YAAY,CAC7C,IAAI,CAAC,UAAU,MAAM,GAAG;AAC3B,SAAK,MAAM,YAAY,KAAK,WAC1B,KAAI,SAAS,MAAM,CAAC,iBAAiB,SAAS,SAAS,GAAG,EACxD,OAAO,KAAK;KACV,GAAG;KACH,MAAM;KACN,IAAI,SAAS;KACb,MAAM,SAAS;KACf,MAAM,SAAS;IAChB,EAAC;GAGP;;AAGH,SAAO;CACR;CAED,IAAa,mBAA4C;AACvD,SAAO;GACL,GAAG,MAAM;GACT,YAAY,KAAK;GACjB,kBAAkB,KAAK;GACvB,oBAAoB,KAAK;GACzB,gBAAgB,KAAK;EACtB;CACF;CAED,OAAOS,OAAuB;EAC5B,MAAMC,iBAAuC;GAC3C,SAASC,0BAAa,KAAK,SAAS,MAAM,QAAQ;GAClD,mBAAmBC,yBACjB,KAAK,mBACL,MAAM,kBACP;GACD,mBAAmBA,yBACjB,KAAK,mBACL,MAAM,kBACP;GACD,kBAAkB,CAAE;GACpB,IAAI,KAAK,MAAM,MAAM;EACtB;AACD,MACE,KAAK,qBAAqB,UAC1B,MAAM,qBAAqB,QAC3B;GACA,MAAM,eAAeC,yBACnB,KAAK,kBACL,MAAM,iBACP;AACD,OAAI,iBAAiB,UAAa,aAAa,SAAS,GACtD,eAAe,mBAAmB;EAErC;AACD,MACE,KAAK,mBAAmB,UACxB,MAAM,mBAAmB,QACzB;GACA,MAAMC,oBAAuC;IAC3C,IAAK,KAAK,gBAAgB,qBAAqB,UAAU,UACvD,MAAM,gBAAgB,qBAAqB,UAAU,WAAc,EACnE,QACG,KAAK,gBAAgB,qBAAqB,SAAS,MACnD,MAAM,gBAAgB,qBAAqB,SAAS,GACxD;IACD,IAAK,KAAK,gBAAgB,qBAAqB,eAC7C,UACA,MAAM,gBAAgB,qBAAqB,eACzC,WAAc,EAChB,aACG,KAAK,gBAAgB,qBAAqB,cAAc,MACxD,MAAM,gBAAgB,qBAAqB,cAAc,GAC7D;IACD,IAAK,KAAK,gBAAgB,qBAAqB,mBAC7C,UACA,MAAM,gBAAgB,qBAAqB,mBACzC,WAAc,EAChB,iBACG,KAAK,gBAAgB,qBAAqB,kBAAkB,MAC5D,MAAM,gBAAgB,qBAAqB,kBAAkB,GACjE;GACF;GAED,MAAMC,qBAAyC;IAC7C,IAAK,KAAK,gBAAgB,sBAAsB,UAAU,UACxD,MAAM,gBAAgB,sBAAsB,UAAU,WAAc,EACpE,QACG,KAAK,gBAAgB,sBAAsB,SAAS,MACpD,MAAM,gBAAgB,sBAAsB,SAAS,GACzD;IACD,IAAK,KAAK,gBAAgB,sBAAsB,cAC9C,UACA,MAAM,gBAAgB,sBAAsB,cAC1C,WAAc,EAChB,YACG,KAAK,gBAAgB,sBAAsB,aAAa,MACxD,MAAM,gBAAgB,sBAAsB,aAAa,GAC7D;GACF;GAED,MAAMC,OAAsB,KAAK,kBAAkB;IACjD,cAAc;IACd,eAAe;IACf,cAAc;GACf;GACD,MAAMC,QAAuB,MAAM,kBAAkB;IACnD,cAAc;IACd,eAAe;IACf,cAAc;GACf;GACD,MAAMC,iBAAgC;IACpC,cAAc,KAAK,eAAe,MAAM;IACxC,eAAe,KAAK,gBAAgB,MAAM;IAC1C,cAAc,KAAK,eAAe,MAAM;IAGxC,GAAI,OAAO,KAAK,kBAAkB,CAAC,SAAS,KAAK,EAC/C,qBAAqB,kBACtB;IACD,GAAI,OAAO,KAAK,mBAAmB,CAAC,SAAS,KAAK,EAChD,sBAAsB,mBACvB;GACF;GACD,eAAe,iBAAiB;EACjC;AACD,SAAO,IAAI,eAAe;CAC3B;AACF"}

package/dist/messages/ai.d.cts

@@ -0,0 +1,148 @@
+import { ContentBlock } from "./content/index.cjs";
+import { BaseMessage, BaseMessageChunk, BaseMessageFields, MessageType } from "./base.cjs";
+import { InvalidToolCall, ToolCall, ToolCallChunk } from "./tool.cjs";
+
+//#region src/messages/ai.d.ts
+type AIMessageFields = BaseMessageFields & {
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  usage_metadata?: UsageMetadata;
+};
+type ModalitiesTokenDetails = {
+  /**
+   * Text tokens.
+   * Does not need to be reported, but some models will do so.
+   */
+  text?: number;
+  /**
+   * Image (non-video) tokens.
+   */
+  image?: number;
+  /**
+   * Audio tokens.
+   */
+  audio?: number;
+  /**
+   * Video tokens.
+   */
+  video?: number;
+  /**
+   * Document tokens.
+   * e.g. PDF
+   */
+  document?: number;
+};
+/**
+ * Breakdown of input token counts.
+ *
+ * Does not *need* to sum to full input token count. Does *not* need to have all keys.
+ */
+type InputTokenDetails = ModalitiesTokenDetails & {
+  /**
+   * Input tokens that were cached and there was a cache hit.
+   *
+   * Since there was a cache hit, the tokens were read from the cache.
+   * More precisely, the model state given these tokens was read from the cache.
+   */
+  cache_read?: number;
+  /**
+   * Input tokens that were cached and there was a cache miss.
+   *
+   * Since there was a cache miss, the cache was created from these tokens.
+   */
+  cache_creation?: number;
+};
+/**
+ * Breakdown of output token counts.
+ *
+ * Does *not* need to sum to full output token count. Does *not* need to have all keys.
+ */
+type OutputTokenDetails = ModalitiesTokenDetails & {
+  /**
+   * Reasoning output tokens.
+   *
+   * Tokens generated by the model in a chain of thought process (i.e. by
+   * OpenAI's o1 models) that are not returned as part of model output.
+   */
+  reasoning?: number;
+};
+/**
+ * Usage metadata for a message, such as token counts.
+ */
+type UsageMetadata = {
+  /**
+   * Count of input (or prompt) tokens. Sum of all input token types.
+   */
+  input_tokens: number;
+  /**
+   * Count of output (or completion) tokens. Sum of all output token types.
+   */
+  output_tokens: number;
+  /**
+   * Total token count. Sum of input_tokens + output_tokens.
+   */
+  total_tokens: number;
+  /**
+   * Breakdown of input token counts.
+   *
+   * Does *not* need to sum to full input token count. Does *not* need to have all keys.
+   */
+  input_token_details?: InputTokenDetails;
+  /**
+   * Breakdown of output token counts.
+   *
+   * Does *not* need to sum to full output token count. Does *not* need to have all keys.
+   */
+  output_token_details?: OutputTokenDetails;
+};
+/**
+ * Represents an AI message in a conversation.
+ */
+declare class AIMessage extends BaseMessage implements AIMessageFields {
+  // These are typed as optional to avoid breaking changes and allow for casting
+  // from BaseMessage.
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  /**
+   * If provided, token usage information associated with the message.
+   */
+  usage_metadata?: UsageMetadata;
+  get lc_aliases(): Record<string, string>;
+  constructor(fields: string | AIMessageFields, /** @deprecated */
+  kwargs?: Record<string, unknown>);
+  static lc_name(): string;
+  _getType(): MessageType;
+  get contentBlocks(): Array<ContentBlock.Standard>;
+  get _printableFields(): Record<string, unknown>;
+}
+declare function isAIMessage(x: BaseMessage): x is AIMessage;
+declare function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk;
+type AIMessageChunkFields = AIMessageFields & {
+  tool_call_chunks?: ToolCallChunk[];
+};
+/**
+ * Represents a chunk of an AI message, which can be concatenated with
+ * other AI message chunks.
+ */
+declare class AIMessageChunk extends BaseMessageChunk {
+  // Must redeclare tool call fields since there is no multiple inheritance in JS.
+  // These are typed as optional to avoid breaking changes and allow for casting
+  // from BaseMessage.
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  tool_call_chunks?: ToolCallChunk[];
+  /**
+   * If provided, token usage information associated with the message.
+   */
+  usage_metadata?: UsageMetadata;
+  constructor(fields: string | AIMessageChunkFields);
+  get lc_aliases(): Record<string, string>;
+  static lc_name(): string;
+  _getType(): MessageType;
+  get contentBlocks(): Array<ContentBlock.Standard>;
+  get _printableFields(): Record<string, unknown>;
+  concat(chunk: AIMessageChunk): AIMessageChunk;
+}
+//#endregion
+export { AIMessage, AIMessageChunk, AIMessageChunkFields, AIMessageFields, InputTokenDetails, ModalitiesTokenDetails, OutputTokenDetails, UsageMetadata, isAIMessage, isAIMessageChunk };
+//# sourceMappingURL=ai.d.cts.map

package/dist/messages/ai.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.cts","names":["BaseMessage","BaseMessageChunk","MessageType","BaseMessageFields","ContentBlock","InvalidToolCall","ToolCall","ToolCallChunk","AIMessageFields","UsageMetadata","ModalitiesTokenDetails","InputTokenDetails","OutputTokenDetails","AIMessage","Record","Standard","Array","isAIMessage","isAIMessageChunk","AIMessageChunk","AIMessageChunkFields"],"sources":["../../src/messages/ai.d.ts"],"sourcesContent":["import { BaseMessage, BaseMessageChunk, type MessageType, BaseMessageFields } from \"./base.js\";\nimport { ContentBlock } from \"./content/index.js\";\nimport { InvalidToolCall, ToolCall, ToolCallChunk } from \"./tool.js\";\nexport type AIMessageFields = BaseMessageFields & {\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    usage_metadata?: UsageMetadata;\n};\nexport type ModalitiesTokenDetails = {\n    /**\n     * Text tokens.\n     * Does not need to be reported, but some models will do so.\n     */\n    text?: number;\n    /**\n     * Image (non-video) tokens.\n     */\n    image?: number;\n    /**\n     * Audio tokens.\n     */\n    audio?: number;\n    /**\n     * Video tokens.\n     */\n    video?: number;\n    /**\n     * Document tokens.\n     * e.g. PDF\n     */\n    document?: number;\n};\n/**\n * Breakdown of input token counts.\n *\n * Does not *need* to sum to full input token count. Does *not* need to have all keys.\n */\nexport type InputTokenDetails = ModalitiesTokenDetails & {\n    /**\n     * Input tokens that were cached and there was a cache hit.\n     *\n     * Since there was a cache hit, the tokens were read from the cache.\n     * More precisely, the model state given these tokens was read from the cache.\n     */\n    cache_read?: number;\n    /**\n     * Input tokens that were cached and there was a cache miss.\n     *\n     * Since there was a cache miss, the cache was created from these tokens.\n     */\n    cache_creation?: number;\n};\n/**\n * Breakdown of output token counts.\n *\n * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n */\nexport type OutputTokenDetails = ModalitiesTokenDetails & {\n    /**\n     * Reasoning output tokens.\n     *\n     * Tokens generated by the model in a chain of thought process (i.e. by\n     * OpenAI's o1 models) that are not returned as part of model output.\n     */\n    reasoning?: number;\n};\n/**\n * Usage metadata for a message, such as token counts.\n */\nexport type UsageMetadata = {\n    /**\n     * Count of input (or prompt) tokens. Sum of all input token types.\n     */\n    input_tokens: number;\n    /**\n     * Count of output (or completion) tokens. Sum of all output token types.\n     */\n    output_tokens: number;\n    /**\n     * Total token count. Sum of input_tokens + output_tokens.\n     */\n    total_tokens: number;\n    /**\n     * Breakdown of input token counts.\n     *\n     * Does *not* need to sum to full input token count. Does *not* need to have all keys.\n     */\n    input_token_details?: InputTokenDetails;\n    /**\n     * Breakdown of output token counts.\n     *\n     * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n     */\n    output_token_details?: OutputTokenDetails;\n};\n/**\n * Represents an AI message in a conversation.\n */\nexport declare class AIMessage extends BaseMessage implements AIMessageFields {\n    // These are typed as optional to avoid breaking changes and allow for casting\n    // from BaseMessage.\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    /**\n     * If provided, token usage information associated with the message.\n     */\n    usage_metadata?: UsageMetadata;\n    get lc_aliases(): Record<string, string>;\n    constructor(fields: string | AIMessageFields, \n    /** @deprecated */\n    kwargs?: Record<string, unknown>);\n    static lc_name(): string;\n    _getType(): MessageType;\n    get contentBlocks(): Array<ContentBlock.Standard>;\n    get _printableFields(): Record<string, unknown>;\n}\nexport declare function isAIMessage(x: BaseMessage): x is AIMessage;\nexport declare function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk;\nexport type AIMessageChunkFields = AIMessageFields & {\n    tool_call_chunks?: ToolCallChunk[];\n};\n/**\n * Represents a chunk of an AI message, which can be concatenated with\n * other AI message chunks.\n */\nexport declare class AIMessageChunk extends BaseMessageChunk {\n    // Must redeclare tool call fields since there is no multiple inheritance in JS.\n    // These are typed as optional to avoid breaking changes and allow for casting\n    // from BaseMessage.\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    tool_call_chunks?: ToolCallChunk[];\n    /**\n     * If provided, token usage information associated with the message.\n     */\n    usage_metadata?: UsageMetadata;\n    constructor(fields: string | AIMessageChunkFields);\n    get lc_aliases(): Record<string, string>;\n    static lc_name(): string;\n    _getType(): MessageType;\n    get contentBlocks(): Array<ContentBlock.Standard>;\n    get _printableFields(): Record<string, unknown>;\n    concat(chunk: AIMessageChunk): AIMessageChunk;\n}\n"],"mappings":";;;;;KAGYQ,eAAAA,GAAkBL;eACbG;EADLE,kBAAe,CAAA,EAEFH,eAFE,EAAA;EAAA,cAAA,CAAA,EAGNI,aAHM;CAAA;AACVH,KAILI,sBAAAA,GAJKJ;EAAQ;;AAES;AAElC;EA6BYK,IAAAA,CAAAA,EAAAA,MAAAA;EAoBAC;AAYZ;;EAAyB,KAkBCD,CAAAA,EAAAA,MAAAA;EAAiB;AAME;AAK7C;EAA8B,KAAA,CAAA,EAAA,MAAA;EAAA;;;EAQI,KACZG,CAAAA,EAAAA,MAAAA;EAAM;;;;EAMwB,QAA3BE,CAAAA,EAAAA,MAAAA;CAAK;;;AAf+C;AAkB7E;;AAAuChB,KA/E3BW,iBAAAA,GAAoBD,sBA+EOV,GAAAA;EAAW;AAAiB;AACnE;;;;EAAkF,UAAA,CAAA,EAAA,MAAA;EACtEoB;;;;AACwB;EAMfD,cAAAA,CAAAA,EAAc,MAAA;CAAA;;;;;;AAYbL,KAhFVF,kBAAAA,GAAqBF,sBAgFXI,GAAAA;EAAM;;;;;;EAKqB,SAjBLb,CAAAA,EAAAA,MAAAA;AAAgB,CAAA;;;;KAxDhDQ,aAAAA;;;;;;;;;;;;;;;;;;wBAkBcE;;;;;;yBAMCC;;;;;cAKNC,SAAAA,SAAkBb,WAAAA,YAAuBQ;;;eAG7CF;uBACQD;;;;mBAIJI;oBACCK;+BACWN;WAEpBM;;cAEGZ;uBACSc,MAAMZ,YAAAA,CAAaW;0BAChBD;;iBAEJG,WAAAA,IAAejB,mBAAmBa;iBAClCK,gBAAAA,IAAoBjB,wBAAwBkB;KACxDC,oBAAAA,GAAuBZ;qBACZD;;;;;;cAMFY,cAAAA,SAAuBlB,gBAAAA;;;;eAI3BK;uBACQD;qBACFE;;;;mBAIFE;+BACYW;oBACXN;;cAENZ;uBACSc,MAAMZ,YAAAA,CAAaW;0BAChBD;gBACVK,iBAAiBA"}

package/dist/messages/ai.d.ts

@@ -1,136 +1,148 @@
-import { BaseMessage, BaseMessageChunk, type MessageType, BaseMessageFields } from "./base.js";
+import { ContentBlock } from "./content/index.js";
+import { BaseMessage, BaseMessageChunk, BaseMessageFields, MessageType } from "./base.js";
 import { InvalidToolCall, ToolCall, ToolCallChunk } from "./tool.js";
-export type AIMessageFields = BaseMessageFields & {
-    tool_calls?: ToolCall[];
-    invalid_tool_calls?: InvalidToolCall[];
-    usage_metadata?: UsageMetadata;
+
+//#region src/messages/ai.d.ts
+type AIMessageFields = BaseMessageFields & {
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  usage_metadata?: UsageMetadata;
 };
-export type ModalitiesTokenDetails = {
-    /**
-     * Text tokens.
-     * Does not need to be reported, but some models will do so.
-     */
-    text?: number;
-    /**
-     * Image (non-video) tokens.
-     */
-    image?: number;
-    /**
-     * Audio tokens.
-     */
-    audio?: number;
-    /**
-     * Video tokens.
-     */
-    video?: number;
-    /**
-     * Document tokens.
-     * e.g. PDF
-     */
-    document?: number;
+type ModalitiesTokenDetails = {
+  /**
+   * Text tokens.
+   * Does not need to be reported, but some models will do so.
+   */
+  text?: number;
+  /**
+   * Image (non-video) tokens.
+   */
+  image?: number;
+  /**
+   * Audio tokens.
+   */
+  audio?: number;
+  /**
+   * Video tokens.
+   */
+  video?: number;
+  /**
+   * Document tokens.
+   * e.g. PDF
+   */
+  document?: number;
 };
 /**
  * Breakdown of input token counts.
  *
  * Does not *need* to sum to full input token count. Does *not* need to have all keys.
  */
-export type InputTokenDetails = ModalitiesTokenDetails & {
-    /**
-     * Input tokens that were cached and there was a cache hit.
-     *
-     * Since there was a cache hit, the tokens were read from the cache.
-     * More precisely, the model state given these tokens was read from the cache.
-     */
-    cache_read?: number;
-    /**
-     * Input tokens that were cached and there was a cache miss.
-     *
-     * Since there was a cache miss, the cache was created from these tokens.
-     */
-    cache_creation?: number;
+type InputTokenDetails = ModalitiesTokenDetails & {
+  /**
+   * Input tokens that were cached and there was a cache hit.
+   *
+   * Since there was a cache hit, the tokens were read from the cache.
+   * More precisely, the model state given these tokens was read from the cache.
+   */
+  cache_read?: number;
+  /**
+   * Input tokens that were cached and there was a cache miss.
+   *
+   * Since there was a cache miss, the cache was created from these tokens.
+   */
+  cache_creation?: number;
 };
 /**
  * Breakdown of output token counts.
  *
  * Does *not* need to sum to full output token count. Does *not* need to have all keys.
  */
-export type OutputTokenDetails = ModalitiesTokenDetails & {
-    /**
-     * Reasoning output tokens.
-     *
-     * Tokens generated by the model in a chain of thought process (i.e. by
-     * OpenAI's o1 models) that are not returned as part of model output.
-     */
-    reasoning?: number;
+type OutputTokenDetails = ModalitiesTokenDetails & {
+  /**
+   * Reasoning output tokens.
+   *
+   * Tokens generated by the model in a chain of thought process (i.e. by
+   * OpenAI's o1 models) that are not returned as part of model output.
+   */
+  reasoning?: number;
 };
 /**
  * Usage metadata for a message, such as token counts.
  */
-export type UsageMetadata = {
-    /**
-     * Count of input (or prompt) tokens. Sum of all input token types.
-     */
-    input_tokens: number;
-    /**
-     * Count of output (or completion) tokens. Sum of all output token types.
-     */
-    output_tokens: number;
-    /**
-     * Total token count. Sum of input_tokens + output_tokens.
-     */
-    total_tokens: number;
-    /**
-     * Breakdown of input token counts.
-     *
-     * Does *not* need to sum to full input token count. Does *not* need to have all keys.
-     */
-    input_token_details?: InputTokenDetails;
-    /**
-     * Breakdown of output token counts.
-     *
-     * Does *not* need to sum to full output token count. Does *not* need to have all keys.
-     */
-    output_token_details?: OutputTokenDetails;
+type UsageMetadata = {
+  /**
+   * Count of input (or prompt) tokens. Sum of all input token types.
+   */
+  input_tokens: number;
+  /**
+   * Count of output (or completion) tokens. Sum of all output token types.
+   */
+  output_tokens: number;
+  /**
+   * Total token count. Sum of input_tokens + output_tokens.
+   */
+  total_tokens: number;
+  /**
+   * Breakdown of input token counts.
+   *
+   * Does *not* need to sum to full input token count. Does *not* need to have all keys.
+   */
+  input_token_details?: InputTokenDetails;
+  /**
+   * Breakdown of output token counts.
+   *
+   * Does *not* need to sum to full output token count. Does *not* need to have all keys.
+   */
+  output_token_details?: OutputTokenDetails;
 };
 /**
  * Represents an AI message in a conversation.
  */
-export declare class AIMessage extends BaseMessage {
-    tool_calls?: ToolCall[];
-    invalid_tool_calls?: InvalidToolCall[];
-    /**
-     * If provided, token usage information associated with the message.
-     */
-    usage_metadata?: UsageMetadata;
-    get lc_aliases(): Record<string, string>;
-    constructor(fields: string | AIMessageFields, 
-    /** @deprecated */
-    kwargs?: Record<string, unknown>);
-    static lc_name(): string;
-    _getType(): MessageType;
-    get _printableFields(): Record<string, unknown>;
+declare class AIMessage extends BaseMessage implements AIMessageFields {
+  // These are typed as optional to avoid breaking changes and allow for casting
+  // from BaseMessage.
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  /**
+   * If provided, token usage information associated with the message.
+   */
+  usage_metadata?: UsageMetadata;
+  get lc_aliases(): Record<string, string>;
+  constructor(fields: string | AIMessageFields, /** @deprecated */
+  kwargs?: Record<string, unknown>);
+  static lc_name(): string;
+  _getType(): MessageType;
+  get contentBlocks(): Array<ContentBlock.Standard>;
+  get _printableFields(): Record<string, unknown>;
 }
-export declare function isAIMessage(x: BaseMessage): x is AIMessage;
-export declare function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk;
-export type AIMessageChunkFields = AIMessageFields & {
-    tool_call_chunks?: ToolCallChunk[];
+declare function isAIMessage(x: BaseMessage): x is AIMessage;
+declare function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk;
+type AIMessageChunkFields = AIMessageFields & {
+  tool_call_chunks?: ToolCallChunk[];
 };
 /**
  * Represents a chunk of an AI message, which can be concatenated with
  * other AI message chunks.
  */
-export declare class AIMessageChunk extends BaseMessageChunk {
-    tool_calls?: ToolCall[];
-    invalid_tool_calls?: InvalidToolCall[];
-    tool_call_chunks?: ToolCallChunk[];
-    /**
-     * If provided, token usage information associated with the message.
-     */
-    usage_metadata?: UsageMetadata;
-    constructor(fields: string | AIMessageChunkFields);
-    get lc_aliases(): Record<string, string>;
-    static lc_name(): string;
-    _getType(): MessageType;
-    get _printableFields(): Record<string, unknown>;
-    concat(chunk: AIMessageChunk): AIMessageChunk;
+declare class AIMessageChunk extends BaseMessageChunk {
+  // Must redeclare tool call fields since there is no multiple inheritance in JS.
+  // These are typed as optional to avoid breaking changes and allow for casting
+  // from BaseMessage.
+  tool_calls?: ToolCall[];
+  invalid_tool_calls?: InvalidToolCall[];
+  tool_call_chunks?: ToolCallChunk[];
+  /**
+   * If provided, token usage information associated with the message.
+   */
+  usage_metadata?: UsageMetadata;
+  constructor(fields: string | AIMessageChunkFields);
+  get lc_aliases(): Record<string, string>;
+  static lc_name(): string;
+  _getType(): MessageType;
+  get contentBlocks(): Array<ContentBlock.Standard>;
+  get _printableFields(): Record<string, unknown>;
+  concat(chunk: AIMessageChunk): AIMessageChunk;
 }
+//#endregion
+export { AIMessage, AIMessageChunk, AIMessageChunkFields, AIMessageFields, InputTokenDetails, ModalitiesTokenDetails, OutputTokenDetails, UsageMetadata, isAIMessage, isAIMessageChunk };
+//# sourceMappingURL=ai.d.ts.map

package/dist/messages/ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.ts","names":["BaseMessage","BaseMessageChunk","MessageType","BaseMessageFields","ContentBlock","InvalidToolCall","ToolCall","ToolCallChunk","AIMessageFields","UsageMetadata","ModalitiesTokenDetails","InputTokenDetails","OutputTokenDetails","AIMessage","Record","Standard","Array","isAIMessage","isAIMessageChunk","AIMessageChunk","AIMessageChunkFields"],"sources":["../../src/messages/ai.d.ts"],"sourcesContent":["import { BaseMessage, BaseMessageChunk, type MessageType, BaseMessageFields } from \"./base.js\";\nimport { ContentBlock } from \"./content/index.js\";\nimport { InvalidToolCall, ToolCall, ToolCallChunk } from \"./tool.js\";\nexport type AIMessageFields = BaseMessageFields & {\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    usage_metadata?: UsageMetadata;\n};\nexport type ModalitiesTokenDetails = {\n    /**\n     * Text tokens.\n     * Does not need to be reported, but some models will do so.\n     */\n    text?: number;\n    /**\n     * Image (non-video) tokens.\n     */\n    image?: number;\n    /**\n     * Audio tokens.\n     */\n    audio?: number;\n    /**\n     * Video tokens.\n     */\n    video?: number;\n    /**\n     * Document tokens.\n     * e.g. PDF\n     */\n    document?: number;\n};\n/**\n * Breakdown of input token counts.\n *\n * Does not *need* to sum to full input token count. Does *not* need to have all keys.\n */\nexport type InputTokenDetails = ModalitiesTokenDetails & {\n    /**\n     * Input tokens that were cached and there was a cache hit.\n     *\n     * Since there was a cache hit, the tokens were read from the cache.\n     * More precisely, the model state given these tokens was read from the cache.\n     */\n    cache_read?: number;\n    /**\n     * Input tokens that were cached and there was a cache miss.\n     *\n     * Since there was a cache miss, the cache was created from these tokens.\n     */\n    cache_creation?: number;\n};\n/**\n * Breakdown of output token counts.\n *\n * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n */\nexport type OutputTokenDetails = ModalitiesTokenDetails & {\n    /**\n     * Reasoning output tokens.\n     *\n     * Tokens generated by the model in a chain of thought process (i.e. by\n     * OpenAI's o1 models) that are not returned as part of model output.\n     */\n    reasoning?: number;\n};\n/**\n * Usage metadata for a message, such as token counts.\n */\nexport type UsageMetadata = {\n    /**\n     * Count of input (or prompt) tokens. Sum of all input token types.\n     */\n    input_tokens: number;\n    /**\n     * Count of output (or completion) tokens. Sum of all output token types.\n     */\n    output_tokens: number;\n    /**\n     * Total token count. Sum of input_tokens + output_tokens.\n     */\n    total_tokens: number;\n    /**\n     * Breakdown of input token counts.\n     *\n     * Does *not* need to sum to full input token count. Does *not* need to have all keys.\n     */\n    input_token_details?: InputTokenDetails;\n    /**\n     * Breakdown of output token counts.\n     *\n     * Does *not* need to sum to full output token count. Does *not* need to have all keys.\n     */\n    output_token_details?: OutputTokenDetails;\n};\n/**\n * Represents an AI message in a conversation.\n */\nexport declare class AIMessage extends BaseMessage implements AIMessageFields {\n    // These are typed as optional to avoid breaking changes and allow for casting\n    // from BaseMessage.\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    /**\n     * If provided, token usage information associated with the message.\n     */\n    usage_metadata?: UsageMetadata;\n    get lc_aliases(): Record<string, string>;\n    constructor(fields: string | AIMessageFields, \n    /** @deprecated */\n    kwargs?: Record<string, unknown>);\n    static lc_name(): string;\n    _getType(): MessageType;\n    get contentBlocks(): Array<ContentBlock.Standard>;\n    get _printableFields(): Record<string, unknown>;\n}\nexport declare function isAIMessage(x: BaseMessage): x is AIMessage;\nexport declare function isAIMessageChunk(x: BaseMessageChunk): x is AIMessageChunk;\nexport type AIMessageChunkFields = AIMessageFields & {\n    tool_call_chunks?: ToolCallChunk[];\n};\n/**\n * Represents a chunk of an AI message, which can be concatenated with\n * other AI message chunks.\n */\nexport declare class AIMessageChunk extends BaseMessageChunk {\n    // Must redeclare tool call fields since there is no multiple inheritance in JS.\n    // These are typed as optional to avoid breaking changes and allow for casting\n    // from BaseMessage.\n    tool_calls?: ToolCall[];\n    invalid_tool_calls?: InvalidToolCall[];\n    tool_call_chunks?: ToolCallChunk[];\n    /**\n     * If provided, token usage information associated with the message.\n     */\n    usage_metadata?: UsageMetadata;\n    constructor(fields: string | AIMessageChunkFields);\n    get lc_aliases(): Record<string, string>;\n    static lc_name(): string;\n    _getType(): MessageType;\n    get contentBlocks(): Array<ContentBlock.Standard>;\n    get _printableFields(): Record<string, unknown>;\n    concat(chunk: AIMessageChunk): AIMessageChunk;\n}\n"],"mappings":";;;;;KAGYQ,eAAAA,GAAkBL;eACbG;EADLE,kBAAe,CAAA,EAEFH,eAFE,EAAA;EAAA,cAAA,CAAA,EAGNI,aAHM;CAAA;AACVH,KAILI,sBAAAA,GAJKJ;EAAQ;;AAES;AAElC;EA6BYK,IAAAA,CAAAA,EAAAA,MAAAA;EAoBAC;AAYZ;;EAAyB,KAkBCD,CAAAA,EAAAA,MAAAA;EAAiB;AAME;AAK7C;EAA8B,KAAA,CAAA,EAAA,MAAA;EAAA;;;EAQI,KACZG,CAAAA,EAAAA,MAAAA;EAAM;;;;EAMwB,QAA3BE,CAAAA,EAAAA,MAAAA;CAAK;;;AAf+C;AAkB7E;;AAAuChB,KA/E3BW,iBAAAA,GAAoBD,sBA+EOV,GAAAA;EAAW;AAAiB;AACnE;;;;EAAkF,UAAA,CAAA,EAAA,MAAA;EACtEoB;;;;AACwB;EAMfD,cAAAA,CAAAA,EAAc,MAAA;CAAA;;;;;;AAYbL,KAhFVF,kBAAAA,GAAqBF,sBAgFXI,GAAAA;EAAM;;;;;;EAKqB,SAjBLb,CAAAA,EAAAA,MAAAA;AAAgB,CAAA;;;;KAxDhDQ,aAAAA;;;;;;;;;;;;;;;;;;wBAkBcE;;;;;;yBAMCC;;;;;cAKNC,SAAAA,SAAkBb,WAAAA,YAAuBQ;;;eAG7CF;uBACQD;;;;mBAIJI;oBACCK;+BACWN;WAEpBM;;cAEGZ;uBACSc,MAAMZ,YAAAA,CAAaW;0BAChBD;;iBAEJG,WAAAA,IAAejB,mBAAmBa;iBAClCK,gBAAAA,IAAoBjB,wBAAwBkB;KACxDC,oBAAAA,GAAuBZ;qBACZD;;;;;;cAMFY,cAAAA,SAAuBlB,gBAAAA;;;;eAI3BK;uBACQD;qBACFE;;;;mBAIFE;+BACYW;oBACXN;;cAENZ;uBACSc,MAAMZ,YAAAA,CAAaW;0BAChBD;gBACVK,iBAAiBA"}