docs: v1 docs updates (#33173)

Co-authored-by: Mohammad Mohtashim <45242107+keenborder786@users.noreply.github.com>
Co-authored-by: Caspar Broekhuizen <caspar@langchain.dev>
Co-authored-by: ccurme <chester.curme@gmail.com>
Co-authored-by: Christophe Bornet <cbornet@hotmail.com>
Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com>
Co-authored-by: Sadra Barikbin <sadraqazvin1@yahoo.com>
Co-authored-by: Vadym Barda <vadim.barda@gmail.com>
This commit is contained in:
Mason Daugherty
2025-10-02 18:46:26 -04:00
committed by GitHub
parent d07cb63c75
commit ae5b105d11
2466 changed files with 2304 additions and 464437 deletions

View File

@@ -707,7 +707,7 @@ class ChatMistralAI(BaseChatModel):
Args:
tools: A list of tool definitions to bind to this chat model.
Supports any tool definition handled by
:meth:`langchain_core.utils.function_calling.convert_to_openai_tool`.
`langchain_core.utils.function_calling.convert_to_openai_tool`.
tool_choice: Which tool to require the model to call.
Must be the name of the single provided function or
``'auto'`` to automatically determine which function to call
@@ -759,13 +759,12 @@ class ChatMistralAI(BaseChatModel):
If ``schema`` is a Pydantic class then the model output will be a
Pydantic instance of that class, and the model-generated fields will be
validated by the Pydantic class. Otherwise the model output will be a
dict and will not be validated. See :meth:`langchain_core.utils.function_calling.convert_to_openai_tool`
dict and will not be validated. See `langchain_core.utils.function_calling.convert_to_openai_tool`
for more on how to properly specify types and descriptions of
schema fields when specifying a Pydantic or TypedDict class.
.. versionchanged:: 0.1.12
Added support for TypedDict class.
!!! warning "Behavior changed in 0.1.12"
Added support for TypedDict class.
method: The method for steering model generation, one of:
@@ -782,9 +781,8 @@ class ChatMistralAI(BaseChatModel):
must include instructions for formatting the output into the
desired schema into the model call.
.. versionchanged:: 0.2.5
Added method="json_schema"
!!! warning "Behavior changed in 0.2.5"
Added method="json_schema"
include_raw:
If False then only the parsed structured output is returned. If
@@ -801,7 +799,7 @@ class ChatMistralAI(BaseChatModel):
``stop`` to control when the model should stop generating output.
Returns:
A Runnable that takes same inputs as a :class:`langchain_core.language_models.chat.BaseChatModel`.
A Runnable that takes same inputs as a `langchain_core.language_models.chat.BaseChatModel`.
If ``include_raw`` is False and ``schema`` is a Pydantic class, Runnable outputs
an instance of ``schema`` (i.e., a Pydantic object).