mirror of
https://github.com/hwchase17/langchain
synced 2024-11-08 07:10:35 +00:00
181dfef118
1. Adds `.get_ls_params` to BaseChatModel which returns
```python
class LangSmithParams(TypedDict, total=False):
ls_provider: str
ls_model_name: str
ls_model_type: Literal["chat"]
ls_temperature: Optional[float]
ls_max_tokens: Optional[int]
ls_stop: Optional[List[str]]
```
by default it will only return
```python
{ls_model_type="chat", ls_stop=stop}
```
2. Add these params to inheritable metadata in
`CallbackManager.configure`
3. Implement `.get_ls_params` and populate all params for Anthropic +
all subclasses of BaseChatOpenAI
Sample trace:
https://smith.langchain.com/public/d2962673-4c83-47c7-b51e-61d07aaffb1b/r
**OpenAI**:
<img width="984" alt="Screenshot 2024-05-17 at 10 03 35 AM"
src="https://github.com/langchain-ai/langchain/assets/26529506/2ef41f74-a9df-4e0e-905d-da74fa82a910">
**Anthropic**:
<img width="978" alt="Screenshot 2024-05-17 at 10 06 07 AM"
src="https://github.com/langchain-ai/langchain/assets/26529506/39701c9f-7da5-4f1a-ab14-84e9169d63e7">
**Mistral** (and all others for which params are not yet populated):
<img width="977" alt="Screenshot 2024-05-17 at 10 08 43 AM"
src="https://github.com/langchain-ai/langchain/assets/26529506/37d7d894-fec2-4300-986f-49a5f0191b03">
113 lines
3.6 KiB
Python
113 lines
3.6 KiB
Python
"""Wrapper around Together AI's Chat Completions API."""
|
|
|
|
import os
|
|
from typing import (
|
|
Any,
|
|
Dict,
|
|
List,
|
|
Optional,
|
|
)
|
|
|
|
import openai
|
|
from langchain_core.language_models.chat_models import LangSmithParams
|
|
from langchain_core.pydantic_v1 import Field, SecretStr, root_validator
|
|
from langchain_core.utils import (
|
|
convert_to_secret_str,
|
|
get_from_dict_or_env,
|
|
)
|
|
from langchain_openai.chat_models.base import BaseChatOpenAI
|
|
|
|
|
|
class ChatTogether(BaseChatOpenAI):
|
|
"""ChatTogether chat model.
|
|
|
|
To use, you should have the environment variable `TOGETHER_API_KEY`
|
|
set with your API key or pass it as a named parameter to the constructor.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
from langchain_together import ChatTogether
|
|
|
|
|
|
model = ChatTogether()
|
|
"""
|
|
|
|
@property
|
|
def lc_secrets(self) -> Dict[str, str]:
|
|
return {"together_api_key": "TOGETHER_API_KEY"}
|
|
|
|
@classmethod
|
|
def get_lc_namespace(cls) -> List[str]:
|
|
return ["langchain", "chat_models", "together"]
|
|
|
|
@property
|
|
def lc_attributes(self) -> Dict[str, Any]:
|
|
attributes: Dict[str, Any] = {}
|
|
|
|
if self.together_api_base:
|
|
attributes["together_api_base"] = self.together_api_base
|
|
|
|
return attributes
|
|
|
|
@property
|
|
def _llm_type(self) -> str:
|
|
"""Return type of chat model."""
|
|
return "together-chat"
|
|
|
|
def _get_ls_params(
|
|
self, stop: Optional[List[str]] = None, **kwargs: Any
|
|
) -> LangSmithParams:
|
|
"""Get the parameters used to invoke the model."""
|
|
params = super()._get_ls_params(stop=stop, **kwargs)
|
|
params["ls_provider"] = "together"
|
|
return params
|
|
|
|
model_name: str = Field(default="meta-llama/Llama-3-8b-chat-hf", alias="model")
|
|
"""Model name to use."""
|
|
together_api_key: Optional[SecretStr] = Field(default=None, alias="api_key")
|
|
"""Automatically inferred from env are `TOGETHER_API_KEY` if not provided."""
|
|
together_api_base: Optional[str] = Field(
|
|
default="https://api.together.ai/v1/", alias="base_url"
|
|
)
|
|
|
|
@root_validator()
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that api key and python package exists in environment."""
|
|
if values["n"] < 1:
|
|
raise ValueError("n must be at least 1.")
|
|
if values["n"] > 1 and values["streaming"]:
|
|
raise ValueError("n must be 1 when streaming.")
|
|
|
|
values["together_api_key"] = convert_to_secret_str(
|
|
get_from_dict_or_env(values, "together_api_key", "TOGETHER_API_KEY")
|
|
)
|
|
values["together_api_base"] = values["together_api_base"] or os.getenv(
|
|
"TOGETHER_API_BASE"
|
|
)
|
|
|
|
client_params = {
|
|
"api_key": (
|
|
values["together_api_key"].get_secret_value()
|
|
if values["together_api_key"]
|
|
else None
|
|
),
|
|
"base_url": values["together_api_base"],
|
|
"timeout": values["request_timeout"],
|
|
"max_retries": values["max_retries"],
|
|
"default_headers": values["default_headers"],
|
|
"default_query": values["default_query"],
|
|
}
|
|
|
|
if not values.get("client"):
|
|
sync_specific = {"http_client": values["http_client"]}
|
|
values["client"] = openai.OpenAI(
|
|
**client_params, **sync_specific
|
|
).chat.completions
|
|
if not values.get("async_client"):
|
|
async_specific = {"http_client": values["http_async_client"]}
|
|
values["async_client"] = openai.AsyncOpenAI(
|
|
**client_params, **async_specific
|
|
).chat.completions
|
|
return values
|