langchain/libs/partners/together/README.md
Hassan El Mghari d6ef5fe86a
together: add chat models, use openai base (#21337)
**Description:** Adding chat completions to the Together AI package,
which is our most popular API. Also staying backwards compatible with
the old API so folks can continue to use the completions API as well.
Also moved the embedding API to use the OpenAI library to standardize it
further.

**Twitter handle:** @nutlope

- [x] **Add tests and docs**: If you're adding a new integration, please
include
- [x] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, hwchase17.

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
2024-05-06 17:47:06 -07:00

29 lines
905 B
Markdown

# langchain-together
This package contains the LangChain integrations for [Together AI](https://www.together.ai/) through their [APIs](https://docs.together.ai/).
## Installation and Setup
- Install the LangChain partner package
```bash
pip install -U langchain-together
```
- Get your Together AI api key from the [Together Dashboard](https://api.together.ai/settings/api-keys) and set it as an environment variable (`TOGETHER_API_KEY`)
## Chat Completions
This package contains the `ChatTogether` class, which is the recommended way to interface with Together AI chat models.
ADD USAGE EXAMPLE HERE.
Can we add this in the langchain docs?
NEED to add image endpoint + completions endpoint as well
## Embeddings
See a [usage example](https://python.langchain.com/docs/integrations/text_embedding/together/)
Use `togethercomputer/m2-bert-80M-8k-retrieval` as the default model for embeddings.