From 12e0c28a6e7dc860ba7c429d2f9c5b9c2132e336 Mon Sep 17 00:00:00 2001 From: Bagatur <22008038+baskaryan@users.noreply.github.com> Date: Thu, 20 Jun 2024 12:51:10 -0700 Subject: [PATCH] docs: fix chat model methods table (#23233) rst table not md ![Screenshot 2024-06-20 at 12 37 46 PM](https://github.com/langchain-ai/langchain/assets/22008038/7a03b869-c1f4-45d0-8d27-3e16f4c6eb19) --- libs/core/langchain_core/language_models/chat_models.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/libs/core/langchain_core/language_models/chat_models.py b/libs/core/langchain_core/language_models/chat_models.py index 8519e60f36..5b3bf9a48f 100644 --- a/libs/core/langchain_core/language_models/chat_models.py +++ b/libs/core/langchain_core/language_models/chat_models.py @@ -126,14 +126,21 @@ class BaseChatModel(BaseLanguageModel[BaseMessage], ABC): Please reference the table below for information about which methods and properties are required or optional for implementations. + +----------------------------------+--------------------------------------------------------------------+-------------------+ | Method/Property | Description | Required/Optional | - |----------------------------------|--------------------------------------------------------------------|-------------------| + +==================================+====================================================================+===================+ | `_generate` | Use to generate a chat result from a prompt | Required | + +----------------------------------+--------------------------------------------------------------------+-------------------+ | `_llm_type` (property) | Used to uniquely identify the type of the model. Used for logging. | Required | + +----------------------------------+--------------------------------------------------------------------+-------------------+ | `_identifying_params` (property) | Represent model parameterization for tracing purposes. | Optional | + +----------------------------------+--------------------------------------------------------------------+-------------------+ | `_stream` | Use to implement streaming | Optional | + +----------------------------------+--------------------------------------------------------------------+-------------------+ | `_agenerate` | Use to implement a native async method | Optional | + +----------------------------------+--------------------------------------------------------------------+-------------------+ | `_astream` | Use to implement async version of `_stream` | Optional | + +----------------------------------+--------------------------------------------------------------------+-------------------+ """ # noqa: E501 callback_manager: Optional[BaseCallbackManager] = Field(default=None, exclude=True)