Skip to content

Commit

Permalink
docs: fix chat model methods table (#23233)
Browse files Browse the repository at this point in the history
  • Loading branch information
baskaryan committed Jun 20, 2024
1 parent a349fce commit 12e0c28
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion libs/core/langchain_core/language_models/chat_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 12e0c28

Please sign in to comment.