9201ef759e
Harness Compat / harness compat (push) Failing after 0s
CI / test on 3.12 (standard) (push) Has been cancelled
CI / test on 3.13 (standard) (push) Has been cancelled
CI / test on 3.14 (standard) (push) Has been cancelled
CI / test on 3.10 (all-extras) (push) Has been cancelled
CI / test on 3.11 (all-extras) (push) Has been cancelled
CI / test on 3.12 (all-extras) (push) Has been cancelled
CI / test on 3.14 (pydantic-ai-slim) (push) Has been cancelled
CI / test on 3.10 (pydantic-evals) (push) Has been cancelled
CI / test on 3.11 (pydantic-evals) (push) Has been cancelled
CI / test on 3.12 (pydantic-evals) (push) Has been cancelled
CI / deploy-docs-preview (push) Has been cancelled
CI / build release artifacts (push) Has been cancelled
CI / publish to PyPI (push) Has been cancelled
CI / Send tweet (push) Has been cancelled
CI / lint (push) Has been cancelled
CI / mypy (push) Has been cancelled
CI / docs (push) Has been cancelled
CI / test on 3.10 (standard) (push) Has been cancelled
CI / test on 3.11 (standard) (push) Has been cancelled
CI / test on 3.13 (all-extras) (push) Has been cancelled
CI / test on 3.14 (all-extras) (push) Has been cancelled
CI / test on 3.10 (pydantic-ai-slim) (push) Has been cancelled
CI / test on 3.11 (pydantic-ai-slim) (push) Has been cancelled
CI / test on 3.12 (pydantic-ai-slim) (push) Has been cancelled
CI / test on 3.13 (pydantic-ai-slim) (push) Has been cancelled
CI / test on 3.13 (pydantic-evals) (push) Has been cancelled
CI / test on 3.14 (pydantic-evals) (push) Has been cancelled
CI / test on 3.10 (lowest-versions) (push) Has been cancelled
CI / test on 3.11 (lowest-versions) (push) Has been cancelled
CI / test on 3.12 (lowest-versions) (push) Has been cancelled
CI / test on 3.13 (lowest-versions) (push) Has been cancelled
CI / test on 3.14 (lowest-versions) (push) Has been cancelled
CI / test examples on 3.11 (push) Has been cancelled
CI / test examples on 3.12 (push) Has been cancelled
CI / test examples on 3.13 (push) Has been cancelled
CI / test examples on 3.14 (push) Has been cancelled
CI / coverage (push) Has been cancelled
CI / check (push) Has been cancelled
CI / deploy-docs (push) Has been cancelled
93 lines
2.2 KiB
Markdown
93 lines
2.2 KiB
Markdown
# Cohere
|
|
|
|
## Install
|
|
|
|
To use `CohereModel`, you need to either install `pydantic-ai`, or install `pydantic-ai-slim` with the `cohere` optional group:
|
|
|
|
```bash
|
|
pip/uv-add "pydantic-ai-slim[cohere]"
|
|
```
|
|
|
|
## Configuration
|
|
|
|
To use [Cohere](https://cohere.com/) through their API, go to [dashboard.cohere.com/api-keys](https://dashboard.cohere.com/api-keys) and follow your nose until you find the place to generate an API key.
|
|
|
|
`CohereModelName` contains a list of the most popular Cohere models.
|
|
|
|
## Environment variable
|
|
|
|
Once you have the API key, you can set it as an environment variable:
|
|
|
|
```bash
|
|
export CO_API_KEY='your-api-key'
|
|
```
|
|
|
|
You can then use `CohereModel` by name:
|
|
|
|
```python
|
|
from pydantic_ai import Agent
|
|
|
|
agent = Agent('cohere:command-r7b-12-2024')
|
|
...
|
|
```
|
|
|
|
Or initialise the model directly with just the model name:
|
|
|
|
```python
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.cohere import CohereModel
|
|
|
|
model = CohereModel('command-r7b-12-2024')
|
|
agent = Agent(model)
|
|
...
|
|
```
|
|
|
|
## `provider` argument
|
|
|
|
You can provide a custom `Provider` via the `provider` argument:
|
|
|
|
```python
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.cohere import CohereModel
|
|
from pydantic_ai.providers.cohere import CohereProvider
|
|
|
|
model = CohereModel('command-r7b-12-2024', provider=CohereProvider(api_key='your-api-key'))
|
|
agent = Agent(model)
|
|
...
|
|
```
|
|
|
|
You can also customize the `CohereProvider` with a custom `http_client`:
|
|
|
|
```python
|
|
from httpx import AsyncClient
|
|
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.cohere import CohereModel
|
|
from pydantic_ai.providers.cohere import CohereProvider
|
|
|
|
custom_http_client = AsyncClient(timeout=30)
|
|
model = CohereModel(
|
|
'command-r7b-12-2024',
|
|
provider=CohereProvider(api_key='your-api-key', http_client=custom_http_client),
|
|
)
|
|
agent = Agent(model)
|
|
...
|
|
```
|
|
|
|
## Model settings
|
|
|
|
You can customize model behavior using [`CohereModelSettings`][pydantic_ai.models.cohere.CohereModelSettings]:
|
|
|
|
```python
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.cohere import CohereModel, CohereModelSettings
|
|
|
|
model = CohereModel('command-r7b-12-2024')
|
|
settings = CohereModelSettings(
|
|
temperature=0.2,
|
|
top_k=40,
|
|
)
|
|
agent = Agent(model, model_settings=settings)
|
|
...
|
|
```
|