@langchain/core/dist/messages/base.d.cts.map

Core LangChain.js abstractions and schemas

{"version":3,"file":"base.d.cts","names":["Serializable","SerializedConstructor","ContentBlock","$InferMessageContent","$InferResponseMetadata","MessageStructure","MessageType","Message","MessageStringFormat","MESSAGE_SYMBOL","StoredMessageData","Record","StoredMessage","StoredGeneration","StoredMessageV1","MessageContent","Array","FunctionCall","BaseMessageFields","TStructure","TRole","Standard","OpenAIToolCall","Partial","mergeContent","_mergeStatus","BaseMessage","NonNullable","Symbol","toStringTag","isOpenAIToolCallArray","_mergeDicts","_mergeLists","Content","_mergeObj","T","BaseMessageChunk","MessageFieldWithRole","_isMessageFieldWithRole","BaseMessageLike","isBaseMessage","isBaseMessageChunk"],"sources":["../../src/messages/base.d.ts"],"sourcesContent":["import { Serializable, SerializedConstructor } from \"../load/serializable.js\";\nimport { ContentBlock } from \"./content/index.js\";\nimport { $InferMessageContent, $InferResponseMetadata, MessageStructure, MessageType, Message } from \"./message.js\";\nimport { type MessageStringFormat } from \"./format.js\";\n/** @internal */\ndeclare const MESSAGE_SYMBOL: unique symbol;\nexport interface StoredMessageData {\n    content: string;\n    role: string | undefined;\n    name: string | undefined;\n    tool_call_id: string | undefined;\n    additional_kwargs?: Record<string, any>;\n    /** Response metadata. For example: response headers, logprobs, token counts, model name. */\n    response_metadata?: Record<string, any>;\n    id?: string;\n}\nexport interface StoredMessage {\n    type: string;\n    data: StoredMessageData;\n}\nexport interface StoredGeneration {\n    text: string;\n    message?: StoredMessage;\n}\nexport interface StoredMessageV1 {\n    type: string;\n    role: string | undefined;\n    text: string;\n}\nexport type MessageContent = string | Array<ContentBlock>;\nexport interface FunctionCall {\n    /**\n     * The arguments to call the function with, as generated by the model in JSON\n     * format. Note that the model does not always generate valid JSON, and may\n     * hallucinate parameters not defined by your function schema. Validate the\n     * arguments in your code before calling your function.\n     */\n    arguments: string;\n    /**\n     * The name of the function to call.\n     */\n    name: string;\n}\nexport type BaseMessageFields<TStructure extends MessageStructure = MessageStructure, TRole extends MessageType = MessageType> = {\n    id?: string;\n    name?: string;\n    content?: $InferMessageContent<TStructure, TRole>;\n    contentBlocks?: Array<ContentBlock.Standard>;\n    /** @deprecated */\n    additional_kwargs?: {\n        /**\n         * @deprecated Use \"tool_calls\" field on AIMessages instead\n         */\n        function_call?: FunctionCall;\n        /**\n         * @deprecated Use \"tool_calls\" field on AIMessages instead\n         */\n        tool_calls?: OpenAIToolCall[];\n        [key: string]: unknown;\n    };\n    response_metadata?: Partial<$InferResponseMetadata<TStructure, TRole>>;\n};\nexport declare function mergeContent(firstContent: MessageContent, secondContent: MessageContent): MessageContent;\n/**\n * 'Merge' two statuses. If either value passed is 'error', it will return 'error'. Else\n * it will return 'success'.\n *\n * @param {\"success\" | \"error\" | undefined} left The existing value to 'merge' with the new value.\n * @param {\"success\" | \"error\" | undefined} right The new value to 'merge' with the existing value\n * @returns {\"success\" | \"error\"} The 'merged' value.\n */\nexport declare function _mergeStatus(left?: \"success\" | \"error\", right?: \"success\" | \"error\"): \"success\" | \"error\" | undefined;\n/**\n * Base class for all types of messages in a conversation. It includes\n * properties like `content`, `name`, and `additional_kwargs`. It also\n * includes methods like `toDict()` and `_getType()`.\n */\nexport declare abstract class BaseMessage<TStructure extends MessageStructure = MessageStructure, TRole extends MessageType = MessageType> extends Serializable implements Message<TStructure, TRole> {\n    lc_namespace: string[];\n    lc_serializable: boolean;\n    get lc_aliases(): Record<string, string>;\n    readonly [MESSAGE_SYMBOL]: true;\n    abstract readonly type: TRole;\n    id?: string;\n    name?: string;\n    content: $InferMessageContent<TStructure, TRole>;\n    additional_kwargs: NonNullable<BaseMessageFields<TStructure, TRole>[\"additional_kwargs\"]>;\n    response_metadata: NonNullable<BaseMessageFields<TStructure, TRole>[\"response_metadata\"]>;\n    /**\n     * @deprecated Use .getType() instead or import the proper typeguard.\n     * For example:\n     *\n     * ```ts\n     * import { isAIMessage } from \"@langchain/core/messages\";\n     *\n     * const message = new AIMessage(\"Hello!\");\n     * isAIMessage(message); // true\n     * ```\n     */\n    _getType(): MessageType;\n    /**\n     * @deprecated Use .type instead\n     * The type of the message.\n     */\n    getType(): MessageType;\n    constructor(arg: $InferMessageContent<TStructure, TRole> | BaseMessageFields<TStructure, TRole>);\n    /** Get text content of the message. */\n    get text(): string;\n    get contentBlocks(): Array<ContentBlock.Standard>;\n    toDict(): StoredMessage;\n    static lc_name(): string;\n    get _printableFields(): Record<string, unknown>;\n    static isInstance(obj: unknown): obj is BaseMessage;\n    _updateId(value: string | undefined): void;\n    get [Symbol.toStringTag](): any;\n    toFormattedString(format?: MessageStringFormat): string;\n}\n/**\n * @deprecated Use \"tool_calls\" field on AIMessages instead\n */\nexport type OpenAIToolCall = {\n    /**\n     * The ID of the tool call.\n     */\n    id: string;\n    /**\n     * The function that the model called.\n     */\n    function: FunctionCall;\n    /**\n     * The type of the tool. Currently, only `function` is supported.\n     */\n    type: \"function\";\n    index?: number;\n};\nexport declare function isOpenAIToolCallArray(value?: unknown): value is OpenAIToolCall[];\nexport declare function _mergeDicts(left?: Record<string, any>, right?: Record<string, any>): Record<string, any>;\nexport declare function _mergeLists<Content extends ContentBlock>(left?: Content[], right?: Content[]): Content[] | undefined;\nexport declare function _mergeObj<T = any>(left: T | undefined, right: T | undefined): T | undefined;\n/**\n * Represents a chunk of a message, which can be concatenated with other\n * message chunks. It includes a method `_merge_kwargs_dict()` for merging\n * additional keyword arguments from another `BaseMessageChunk` into this\n * one. It also overrides the `__add__()` method to support concatenation\n * of `BaseMessageChunk` instances.\n */\nexport declare abstract class BaseMessageChunk<TStructure extends MessageStructure = MessageStructure, TRole extends MessageType = MessageType> extends BaseMessage<TStructure, TRole> {\n    abstract concat(chunk: BaseMessageChunk): BaseMessageChunk<TStructure, TRole>;\n    static isInstance(obj: unknown): obj is BaseMessageChunk;\n}\nexport type MessageFieldWithRole = {\n    role: MessageType;\n    content: MessageContent;\n    name?: string;\n} & Record<string, unknown>;\nexport declare function _isMessageFieldWithRole(x: BaseMessageLike): x is MessageFieldWithRole;\nexport type BaseMessageLike = BaseMessage | MessageFieldWithRole | [MessageType, MessageContent] | string\n/**\n * @deprecated Specifying \"type\" is deprecated and will be removed in 0.4.0.\n */\n | ({\n    type: MessageType | \"user\" | \"assistant\" | \"placeholder\";\n} & BaseMessageFields & Record<string, unknown>) | SerializedConstructor;\n/**\n * @deprecated Use {@link BaseMessage.isInstance} instead\n */\nexport declare function isBaseMessage(messageLike?: unknown): messageLike is BaseMessage;\n/**\n * @deprecated Use {@link BaseMessageChunk.isInstance} instead\n */\nexport declare function isBaseMessageChunk(messageLike?: unknown): messageLike is BaseMessageChunk;\nexport {};\n//# sourceMappingURL=base.d.ts.map"],"mappings":";;;;;;;cAKcS;AAAAA,UACGC,iBAAAA,CAD0B;EAC1BA,OAAAA,EAAAA,MAAAA;EAUAE,IAAAA,EAAAA,MAAAA,GAAAA,SAAa;EAIbC,IAAAA,EAAAA,MAAAA,GAAAA,SAAgB;EAIhBC,YAAAA,EAAAA,MAAe,GAAA,SAAA;EAKpBC,iBAAc,CAAA,EAlBFJ,MAkBE,CAAA,MAAkBT,EAAAA,GAAAA,CAAAA;EAC3Be;EAaLC,iBAAAA,CAAAA,EA9BYP,MA8BK,CAAAQ,MAAAA,EAAAA,GAAAA,CAAAC;EAAoBf,EAAAA,CAAAA,EAAAA,MAAAA;;AAAmDC,UA3BnFM,aAAAA,CA2BmFN;EAAcA,IAAAA,EAAAA,MAAAA;EAG/Ea,IAAAA,EA5BzBT,iBA4ByBS;;AAArBhB,UA1BGU,gBAAAA,CA0BHV;EACYD,IAAAA,EAAAA,MAAamB;EAAnBL,OAAAA,CAAAA,EAzBNJ,aAyBMI;;AAUCM,UAjCJR,eAAAA,CAiCIQ;EAGkCH,IAAAA,EAAAA,MAAAA;EAAYC,IAAAA,EAAAA,MAAAA,GAAAA,SAAAA;EAAnChB,IAAAA,EAAAA,MAAAA;;AAAD,KA/BnBW,cAAAA,GA+BmB,MAAA,GA/BOC,KA+BP,CA/Bad,YA+Bb,CAAA;AAEPsB,UAhCPP,YAAAA,CAgCmB;EAAeF;;;AAA8D;AASjH;AAMA;EAA6DV,SAAAA,EAAAA,MAAAA;EAAmBA;;;EAAmGc,IAAAA,EAAAA,MAAAA;;AAG7JR,KArCVO,iBAqCUP,CAAAA,mBArC2BN,gBAqC3BM,GArC8CN,gBAqC9CM,EAAAA,cArC8EL,WAqC9EK,GArC4FL,WAqC5FK,CAAAA,GAAAA;EACRF,EAAAA,CAAAA,EAAAA,MAAAA;EACcW,IAAAA,CAAAA,EAAAA,MAAAA;EAGMD,OAAAA,CAAAA,EAvCpBhB,oBAuCoBgB,CAvCCA,UAuCDA,EAvCaC,KAuCbD,CAAAA;EAAYC,aAAAA,CAAAA,EAtC1BJ,KAsC0BI,CAtCpBlB,YAAAA,CAAamB,QAsCOD,CAAAA;EAAjCjB;EACwCgB,iBAAAA,CAAAA,EAAAA;IAAYC;;;IACZD,aAAAA,CAAAA,EAlC7BF,YAkC6BE;IAAYC;;;IAYjDd,UAAAA,CAAAA,EA1CKgB,cA0CLhB,EAAAA;IAKDA,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;EAC2Ba,CAAAA;EAAYC,iBAAAA,CAAAA,EA7C9BG,OA6C8BH,CA7CtBhB,sBA6CsBgB,CA7CCD,UA6CDC,EA7CaA,KA6CbA,CAAAA,CAAAA;CAAjCjB;AAA4DgB,iBA3CzDK,YAAAA,CA2CyDL,YAAAA,EA3C9BJ,cA2C8BI,EAAAA,aAAAA,EA3CCJ,cA2CDI,CAAAA,EA3CkBJ,cA2ClBI;;;;;;;;;AAUlDX,iBA5CPiB,YAAAA,CA4COjB,IAAAA,CAAAA,EAAAA,SAAAA,GAAAA,OAAAA,EAAAA,KAAAA,CAAAA,EAAAA,SAAAA,GAAAA,OAAAA,CAAAA,EAAAA,SAAAA,GAAAA,OAAAA,GAAAA,SAAAA;;;AAtCmJ;AA2ClL;AAeA;AACwBuB,uBA3DML,WA2DK,CAAA,mBA3D0BrB,gBA2D1B,GA3D6CA,gBA2D7C,EAAA,cA3D6EC,WA2D7E,GA3D2FA,WA2D3F,CAAA,SA3DgHN,YAAAA,YAAwBO,OA2DxI,CA3DgJY,UA2DhJ,EA3D4JC,KA2D5J,CAAA,CAAA;EAAQT,YAAAA,EAAAA,MAAAA,EAAAA;EAA6BA,eAAAA,EAAAA,OAAAA;EAAsBA,IAAAA,UAAAA,CAAAA,CAAAA,EAxDxEA,MAwDwEA,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;EAAM,UAvDtFF,cAAAA,CAuDsF,EAAA,IAAA;EAC5EuB,kBAAW,IAAAC,EAvDPb,KAuDOa;EAAiB/B,EAAAA,CAAAA,EAAAA,MAAAA;EAAqB+B,IAAAA,CAAAA,EAAAA,MAAAA;EAAmBA,OAAAA,EApD/E9B,oBAoD+E8B,CApD1Dd,UAoD0Dc,EApD9Cb,KAoD8Ca,CAAAA;EAAYA,iBAAAA,EAnDjFN,WAmDiFM,CAnDrEf,iBAmDqEe,CAnDnDd,UAmDmDc,EAnDvCb,KAmDuCa,CAAAA,CAAAA,mBAAAA,CAAAA,CAAAA;EAAO,iBAAA,EAlDxFN,WAkDwF,CAlD5ET,iBAkD4E,CAlD1DC,UAkD0D,EAlD9CC,KAkD8C,CAAA,CAAA,mBAAA,CAAA,CAAA;EACvFc;;;;AAAgE;AAQxF;;;;;;EAAgLd,QAAAA,CAAAA,CAAAA,EA/ChKd,WA+CgKc;EACrJgB;;;;EACiBA,OAAAA,CAAAA,CAAAA,EA5C7B9B,WA4C6B8B;EAF4GV,WAAAA,CAAAA,GAAAA,EAzCnIvB,oBAyCmIuB,CAzC9GP,UAyC8GO,EAzClGN,KAyCkGM,CAAAA,GAzCzFR,iBAyCyFQ,CAzCvEP,UAyCuEO,EAzC3DN,KAyC2DM,CAAAA;EAAW;EAIvJW,IAAAA,IAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EACF/B,IAAAA,aAAAA,CAAAA,CAAAA,EA3CeU,KA2CfV,CA3CqBJ,YAAAA,CAAamB,QA2ClCf,CAAAA;EACGS,MAAAA,CAAAA,CAAAA,EA3CCH,aA2CDG;EAETJ,OAAAA,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAM,IAAA,gBAAA,CAAA,CAAA,EA3CkBA,MA2ClB,CAAA,MAAA,EAAA,OAAA,CAAA;EACc2B,OAAAA,UAAAA,CAAAA,GAAAA,EAAAA,OAAuB,CAAA,EAAA,GAAA,IA3CHZ,WA2COa;EACvCA,SAAAA,CAAAA,KAAAA,EAAAA,MAAe,GAAA,SAAA,CAAA,EAAA,IAAA;EAAGb,KA1CrBE,MAAAA,CAAOC,WAAAA,GA0CcH,EAAAA,GAAAA;EAAcW,iBAAAA,CAAAA,MAAAA,CAAAA,EAzCb7B,mBAyCa6B,CAAAA,EAAAA,MAAAA;;;;;AAMpB1B,KA1CZW,cAAAA,GA0CYX;EAA2BV;AAAqB;AAIxE;EAIwBwC,EAAAA,EAAAA,MAAAA;;;;YA1CVxB;;;;;;;iBAOUa,qBAAAA,4BAAiDR;iBACjDS,WAAAA,QAAmBpB,6BAA6BA,sBAAsBA;iBACtEqB,4BAA4B9B,qBAAqB+B,mBAAmBA,YAAYA;iBAChFC,yBAAyBC,sBAAsBA,gBAAgBA;;;;;;;;uBAQzDC,oCAAoC/B,mBAAmBA,gCAAgCC,cAAcA,qBAAqBoB,YAAYP,YAAYC;yBACrJgB,mBAAmBA,iBAAiBjB,YAAYC;0CAC/BgB;;KAEhCC,oBAAAA;QACF/B;WACGS;;IAETJ;iBACoB2B,uBAAAA,IAA2BC,uBAAuBF;KAC9DE,eAAAA,GAAkBb,cAAcW,wBAAwB/B,aAAaS;;;;QAKvET;IACNY,oBAAoBP,2BAA2BV;;;;iBAI3BuC,aAAAA,wCAAqDd;;;;iBAIrDe,kBAAAA,wCAA0DL"}