mirror of
https://github.com/hwchase17/langchain.git
synced 2026-06-09 10:17:00 +00:00
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:
@@ -632,7 +632,7 @@ class ChatFireworks(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,
|
||||
``'auto'`` to automatically determine which function to call
|
||||
@@ -640,7 +640,7 @@ class ChatFireworks(BaseChatModel):
|
||||
function is called, or a dict of the form:
|
||||
``{"type": "function", "function": {"name": <<tool_name>>}}``.
|
||||
**kwargs: Any additional parameters to pass to
|
||||
:meth:`~langchain_fireworks.chat_models.ChatFireworks.bind`
|
||||
`langchain_fireworks.chat_models.ChatFireworks.bind`
|
||||
|
||||
"""
|
||||
formatted_tools = [convert_to_openai_tool(tool) for tool in tools]
|
||||
@@ -688,13 +688,12 @@ class ChatFireworks(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.7
|
||||
|
||||
Added support for TypedDict class.
|
||||
!!! warning "Behavior changed in 0.1.7"
|
||||
Added support for TypedDict class.
|
||||
|
||||
method: The method for steering model generation, one of:
|
||||
|
||||
@@ -705,8 +704,7 @@ class ChatFireworks(BaseChatModel):
|
||||
- ``'json_mode'``:
|
||||
Uses Fireworks's `JSON mode feature <https://docs.fireworks.ai/structured-responses/structured-response-formatting>`_.
|
||||
|
||||
.. versionchanged:: 0.2.8
|
||||
|
||||
!!! warning "Behavior changed in 0.2.8"
|
||||
Added support for ``'json_schema'``.
|
||||
|
||||
include_raw:
|
||||
@@ -719,10 +717,10 @@ class ChatFireworks(BaseChatModel):
|
||||
|
||||
kwargs:
|
||||
Any additional parameters to pass to the
|
||||
:class:`~langchain.runnable.Runnable` constructor.
|
||||
`langchain.runnable.Runnable` constructor.
|
||||
|
||||
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).
|
||||
|
||||
Reference in New Issue
Block a user