f3fidZddlmZmZmZmZddlmZmZddl m Z GddeZ GddeZ e e zZ Gd d eZGd d eZGd deZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGdd eZGd!d"eZGd#d$eZeezezezezZ eezezezezZeezezezezezZ hd%Z d&e e!d'ffd(Z"d)e#d&e$fd*Z%d+d+d+d,d-e!d.e!d+zd/e&e d+zd0e'e!zd+zd1ed&ef d2Z(d+d+d+d+d+d+d3d4e!d+zd5e!d+zd6e!d+zd7e!d+zd.e!d+zd0e'e!zd+zd1ed&efd8Z)d+d+d+d+d+d+d3d4e!d+zd5e!d+zd6e!d+zd7e!d+zd.e!d+zd0e'e!zd+zd1ed&efd9Z*d+d+d+d+d+d+d3d4e!d+zd5e!d+zd6e!d+zd7e!d+zd.e!d+zd0e'e!zd+zd1ed&efd:Z+d+d+d+d+d+d+d3d4e!d+zd5e!d+zd6e!d+zd7e!d+zd.e!d+zd0e'e!zd+zd1ed&efd;Z, dLd-e!d+zd4e!d+zd5e!d+zd6e!d+zdZ-d+d+d?d@e!dAe#e!efd.e!d+zd0e'e!zd+zd1ed&ef dBZ. dMdCe!d+zd.e!d+zd0e'e!zd+zd1ed&ef dDZ/d+d+d+d+d+d+dEd4e!d+zd,rr"ceZdZUdZeded< eeed< eed< eee ed< ee ezed< ee ee fed<y) TextContentBlockaText output from a LLM. This typically represents the main text content of a message, such as the response from a language model or the text of a user message. !!! note "Factory function" `create_text_block` may also be used as a factory to create a `TextContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time textr r annotationsindexrN) rrrrrrrrlist Annotationrrrrrr r&r&sk  &/=C IT*-.., sSy !!F S#X ''%rr&ceZdZUdZeded< edzed< eed< eeefed< e e ezed< e eeefed <y) ToolCallaRepresents an AI's request to call a tool. Example: ```python {"name": "foo", "args": {"a": 1}, "id": "123"} ``` This represents a request to call the tool named "foo" with arguments {"a": 1} and an identifier of "123". !!! note "Factory function" `create_tool_call` may also be used as a factory to create a `ToolCall`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time tool_callr Nrnameargsr)r rrrrrrrrrrrrrr r-r-sh& + " d N I, sCx.) sSy !!F S#X ''%rr-ceZdZUdZeded< edzed< edzed< edzed< eeezed< ee ee fed <y) ToolCallChunkaA chunk of a tool call (yielded when streaming). When merging `ToolCallChunks` (e.g., via `AIMessageChunk.__add__`), all string attributes are concatenated. Chunks are only merged if their values of `index` are equal and not `None`. Example: ```python left_chunks = [ToolCallChunk(name="foo", args='{"a":', index=0)] right_chunks = [ToolCallChunk(name=None, args="1}", index=0)] ( AIMessageChunk(content="", tool_call_chunks=left_chunks) + AIMessageChunk(content="", tool_call_chunks=right_chunks) ).tool_call_chunks == [ToolCallChunk(name="foo", args='{"a":1}', index=0)] ``` tool_call_chunkr Nrr/r0r)r rrrrrrrrrrrrrr r3r3#sj( # $$! d N *, *) sSy !!3 S#X ''%rr3ceZdZUdZeded< edzed< edzed< edzed< edzed< eeezed < ee ee fed <y) InvalidToolCallzAllowance for errors made by LLM. Here we add an `error` key to surface errors made during generation (e.g., invalid JSON arguments.) invalid_tool_callr Nrr/r0errorr)rr5rrr r7r7Psw % &&" d N *, *) :9 sSy !!F S#X ''%rr7ceZdZUdZeded< eed< eed< eeefed< e e ezed< e eeefed<y ) ServerToolCallz_Tool call that is executed server-side. For example: code execution, web search, etc. server_tool_callr rr/r0r)rNr1rrr r;r;tsa $ %%" G6 I, sCx.) sSy !!F S#X ''%rr;ceZdZUdZeded< eeed< eeed< eeed< eeezed< ee ee fed<y ) ServerToolCallChunkzr>sjF * ++" c , c ;C sSy !!F S#X ''%rr>ceZdZUdZeded< eeed< eed< eded< eeed< ee ezed < ee eefed <y ) ServerToolResultz"Result of a server-side tool call.server_tool_resultr r tool_call_id)successr9statusoutputr)rN) rrrrrrrrrrrrrr rArAst, & ''"C3 & ''3  & sSy !!F S#X ''%rrAczeZdZUdZeded< eeed< eeed< eeezed< ee ee fed<y)ReasoningContentBlocka9Reasoning output from a LLM. !!! note "Factory function" `create_reasoning_block` may also be used as a factory to create a `ReasoningContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time reasoningr rr)rNrrrr rHrHsc  + =C3 sSy !!F S#X ''%rrHceZdZUdZeded< eeed< eeed< eeed< eeezed< eeed< eeed < ee ee fed <y ) ImageContentBlocka!Image data. !!! note "Factory function" `create_image_block` may also be used as a factory to create an `ImageContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time imager rfile_id mime_typer)rbase64rNrrrr rKrK  ' =C  3 sSy !!F S   " S#X ''WrrKceZdZUdZeded< eeed< eeed< eeed< eeezed< eeed< eeed < ee ee fed <y ) VideoContentBlocka Video data. !!! note "Factory function" `create_video_block` may also be used as a factory to create a `VideoContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time videor rrMrNr)rrOrNrrrr rRrR$rPrrRceZdZUdZeded< eeed< eeed< eeed< eeezed< eeed< eeed < ee ee fed <y ) AudioContentBlocka!Audio data. !!! note "Factory function" `create_audio_block` may also be used as a factory to create an `AudioContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time audior rrMrNr)rrOrNrrrr rUrUWrPrrUceZdZUdZeded< eeed< eeed< eded< eeezed< eeed < eeed < eeed < eeed < eeed < ee ee fed<y)PlainTextContentBlocka~Plaintext data (e.g., from a `.txt` or `.md` document). !!! note A `PlainTextContentBlock` existed in `langchain-core<1.0.0`. Although the name has carried over, the structure has changed significantly. The only shared keys between the old and new versions are `type` and `text`, though the `type` value has changed from `'text'` to `'text-plain'`. !!! note Title and context are optional fields that may be passed to the model. See Anthropic [example](https://platform.claude.com/docs/en/build-with-claude/citations#citable-vs-non-citable-content). !!! note "Factory function" `create_plaintext_block` may also be used as a factory to create a `PlainTextContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time text-plainr rrM text/plainrNr)rrOr'rcontextrNrrrr rXrXs. , =C  |$$ sSy !!F S   " c P s @  U S#X ''QrrXceZdZUdZeded< eeed< eeed< eeed< eeezed< eeed< eeed < ee ee fed <y ) FileContentBlockaFile data that doesn't fit into other multimodal block types. This block is intended for files that are not images, audio, or plaintext. For example, it can be used for PDFs, Word documents, etc. If the file is an image, audio, or plaintext, you should use the corresponding content block type (e.g., `ImageContentBlock`, `AudioContentBlock`, `PlainTextContentBlock`). !!! note "Factory function" `create_file_block` may also be used as a factory to create a `FileContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time filer rrMrNr)rrOrNrrrr r]r]s$ &/=C   3 sSy !!F S   " S#X ''Vrr]cbeZdZUdZeded< eeed< eee fed< ee ezed<y)NonStandardContentBlockaProvider-specific content data. This block contains data for which there is not yet a standard type. The purpose of this block should be to simply hold a provider-specific payload. If a provider's non-standard output includes reasoning and tool calls, it should be the adapter's job to parse that payload and emit the corresponding standard `ReasoningContentBlock` and `ToolCalls`. Has no `extras` field, as provider-specific data should be included in the `value` field. !!! note "Factory function" `create_non_standard_block` may also be used as a factory to create a `NonStandardContentBlock`. Benefits include: * Automatic ID generation (when not provided) * Required arguments strictly validated at creation time non_standardr rr$r)N) rrrrrrrrrrrrrr r`r`sL* . !!=C S>) sSy !!Frr`>r^r'rVrLrSrIr.rar4r<r8rBr?rYreturn.cg}ttD]D}t|}d|vs|d}t|ds%|jd}|j |Ft |S)a`Get type literals from DataContentBlock union members dynamically. Example: ("image", "video", "audio", "text-plain", "file") Note that old style multimodal blocks type literals with new style blocks. Specifically, "image", "audio", and "file". See the docstring of `_normalize_messages` in `language_models._utils` for details. r __args__r)rDataContentBlockrhasattrrdappendtuple)data_block_types block_typehintstype_annotation literal_values r _get_data_content_block_typesrnsso/07 z* U?#FmO 3 / 8 8 ;  '' 67 ! ""rblockcjdtvrytfddDrddk(rdvryydvr+d}|dk(rdvs |d k(rd vry|d k(rd vs |dk(rdvryy) a*Check if the provided content block is a data content block. Returns True for both v0 (old-style) and v1 (new-style) multimodal data blocks. Args: block: The content block to check. Returns: `True` if the content block is a data content block, `False` otherwise. r Fc3&K|]}|v yw)Nr).0keyros r z(is_data_content_block..s HC3%< Hs)rrOrMr'r' source_typeTrrOdatar)getrnany)rorus` r is_data_content_blockrys yy = ?? H#G HH =F "}E'AM* 5 Ue^ 8 #% 4 DEM 6 !eun rN)rr(r)r'rr(r)kwargsc td|t|}|||d<|||d<|jDcic] \}}| || }}}|r||d<|Scc}}w)a=Create a `TextContentBlock`. Args: text: The text content of the block. id: Content block identifier. Generated automatically if not provided. annotations: `Citation`s and other annotations for the text. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `TextContentBlock`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. r')r r'rr(r)r)r&r items) r'rr(r)rzrokvrs r create_text_blockrsx8    R= E *m g%||~ ?tq!ad ?F ?  h L @s AA)rrOrMrNrr)rrOrMrNc t|||gs d}t|tdt|}|||d<|||d<|||d<|||d<|||d<|j D cic] \} } |  | |  } } } | r| |d <|Scc} } w) a$Create an `ImageContentBlock`. Args: url: URL of the image. base64: Base64-encoded image data. file_id: ID of the image file from a file storage system. mime_type: MIME type of the image. Required for base64 data. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `ImageContentBlock`. Raises: ValueError: If no image source is provided or if `base64` is used without `mime_type`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. ,Must provide one of: url, base64, or file_idrLr rrrOrMrNr)r)rx ValueErrorrKr r| rrOrMrNrr)rzmsgror}r~rs r create_image_blockrsL VW% &<o 7y} =E e   h"i&k g%||~ ?tq!ad ?F ?  h L @s ( B3Bc 6t|||gs d}t||r|s d}t|tdt|}|||d<|||d<|||d<|||d<|||d <|j D cic] \} } |  | |  } } } | r| |d <|Scc} } w) a#Create a `VideoContentBlock`. Args: url: URL of the video. base64: Base64-encoded video data. file_id: ID of the video file from a file storage system. mime_type: MIME type of the video. Required for base64 data. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `VideoContentBlock`. Raises: ValueError: If no video source is provided or if `base64` is used without `mime_type`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. r,mime_type is required when using base64 datarSrrrOrMrNr)r)rxrrRr r|rs r create_video_blockr L VW% &<o i<o 7y} =E e   h"i&k g%||~ ?tq!ad ?F ?  h L @ 9 BBc 6t|||gs d}t||r|s d}t|tdt|}|||d<|||d<|||d<|||d<|||d <|j D cic] \} } |  | |  } } } | r| |d <|Scc} } w) a$Create an `AudioContentBlock`. Args: url: URL of the audio. base64: Base64-encoded audio data. file_id: ID of the audio file from a file storage system. mime_type: MIME type of the audio. Required for base64 data. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `AudioContentBlock`. Raises: ValueError: If no audio source is provided or if `base64` is used without `mime_type`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. rrrVrrrOrMrNr)r)rxrrUr r|rs r create_audio_blockrbrrc 6t|||gs d}t||r|s d}t|tdt|}|||d<|||d<|||d<|||d<|||d <|j D cic] \} } |  | |  } } } | r| |d <|Scc} } w) aCreate a `FileContentBlock`. Args: url: URL of the file. base64: Base64-encoded file data. file_id: ID of the file from a file storage system. mime_type: MIME type of the file. Required for base64 data. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `FileContentBlock`. Raises: ValueError: If no file source is provided or if `base64` is used without `mime_type`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. rrr^rrrOrMrNr)r)rxrr]r r|rs r create_file_blockrsL VW% &<o i<o &Yr] ;E e   h"i&k g%||~ ?tq!ad ?F ?  h L @rrr[c tddt|} ||| d<||| d<||| d<||| d<||| d<||| d <||| d <|jD cic] \} } |  | |  } } } | r| | d <| Scc} } w) aCreate a `PlainTextContentBlock`. Args: text: The plaintext content. url: URL of the plaintext file. base64: Base64-encoded plaintext data. file_id: ID of the plaintext file from a file storage system. title: Title of the text data. context: Context or description of the text content. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `PlainTextContentBlock`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. rYrZ)r rNrr'rrOrMrr[r)r)rXr r|) r'rrOrMrr[rr)rzror}r~rs r create_plaintext_blockrsF "  R= E  f  e   h"i g"i g%||~ ?tq!ad ?F ?  h L @s  A8'A8)rr)r/r0c td||t|}|||d<|jDcic] \}}| || }}}|r||d<|Scc}}w)a!Create a `ToolCall`. Args: name: The name of the tool to be called. args: The arguments to the tool call. id: An identifier for the tool call. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `ToolCall`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. r.)r r/r0rr)r)r-r r|) r/r0rr)rzror}r~rs r create_tool_callr%sk8     R=  E g%||~ ?tq!ad ?F ?  h L @s AArIc td|xsdt|}|||d<|jDcic] \}}| || }}}|r||d<|Scc}}w)aCreate a `ReasoningContentBlock`. Args: reasoning: The reasoning text or thought summary. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `ReasoningContentBlock`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. rI)r rIrr)r)rHr r|)rIrr)rzror}r~rs r create_reasoning_blockrRsl2 " /r R= E  g%||~ ?tq!ad ?F ?  h L @s AA)rrrrrrrrrc tdt|}|||d<|||d<|||d<|||d<|||d<|jD cic] \}} |  ||  } }} | r| |d<|Scc} }w) aCreate a `Citation`. Args: url: URL of the document source. title: Source document title. start_index: Start index in the response text where citation applies. end_index: End index in the response text where citation applies. cited_text: Excerpt of source text being cited. id: Content block identifier. Generated automatically if not provided. Returns: A properly formatted `Citation`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. r rrrrrrr)r r r|) rrrrrrrzror}r~rs r create_citationr{s< *2 7E e  g*m&k(l%||~ ?tq!ad ?F ?  h L @s A)A)r$cBtd|t|}|||d<|S)aCreate a `NonStandardContentBlock`. Args: value: Provider-specific content data. id: Content block identifier. Generated automatically if not provided. index: Index of block in aggregate response. Used during streaming. Returns: A properly formatted `NonStandardContentBlock`. !!! note The `id` is generated automatically if not provided, using a UUID4 format prefixed with `'lc_'` to indicate it is a LangChain-generated ID. ra)r r$rr))r`r )r$rr)ros r create_non_standard_blockrs12 $  R= E  g Lr)NNNNNNNN)NNN)2rtypingrrrrtyping_extensionsrrlangchain_core.utils.utilsr r r"r+r&r-r3r7r;r>rArHrKrRrUrXr]r`reToolContentBlock ContentBlockKNOWN_BLOCK_TYPESrhrrnrboolryr*rrrrrrrrrrrrrr rsXtl:9407&y7&t-I-&- - 0%&y%&P)&y)&X*&I*&Z!&i!&H&Y&2&)&8&y&>#&I#&R0X 0Xf0X 0Xf0X 0XfCRICRL=Wy=WJ&Gi&GV C }~-0CCFVV     ?, #uS#X#0''$'Z+/" * * d *j!D( * 9t  *  **^ "; t; $J;4Z ; Tz ; d ; 9t ;;;@ "? t? $J?4Z ? Tz ? d ? 9t ???H "? t? $J?4Z ? Tz ? d ? 9t ???H "? t? $J?4Z ? Tz ? d ? 9t ???F"< *< t< $J<4Z < : < 4Z < d < 9t <<<F" * * sCx.* d * 9t  *  **\!"&Tz& d & 9t & &  &V" !/ t/ :/t / Tz / d / d ///j" " S>" d " 9t  "  "r