Skip to content

Commit ad347dd

Browse files
Sync Core Integrations API reference (cohere) on Docusaurus (#10880)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent b79081f commit ad347dd

10 files changed

Lines changed: 1010 additions & 50 deletions

File tree

docs-website/reference/integrations-api/cohere.md

Lines changed: 101 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ print(result['documents'][0].embedding)
3030
# [-0.453125, 1.2236328, 2.0058594, ...]
3131
```
3232

33+
#### SUPPORTED_MODELS
34+
35+
```python
36+
SUPPORTED_MODELS: list[str] = [
37+
"embed-v4.0",
38+
"embed-english-v3.0",
39+
"embed-english-light-v3.0",
40+
"embed-multilingual-v3.0",
41+
"embed-multilingual-light-v3.0",
42+
]
43+
44+
```
45+
46+
A non-exhaustive list of embed models supported by this component.
47+
See https://docs.cohere.com/docs/models#embed for the full list.
48+
3349
#### __init__
3450

3551
```python
@@ -45,7 +61,7 @@ __init__(
4561
meta_fields_to_embed: list[str] | None = None,
4662
embedding_separator: str = "\n",
4763
embedding_type: EmbeddingTypes | None = None,
48-
)
64+
) -> None
4965
```
5066

5167
**Parameters:**
@@ -181,6 +197,22 @@ print(documents_with_embeddings)
181197
# ...]
182198
```
183199

200+
#### SUPPORTED_MODELS
201+
202+
```python
203+
SUPPORTED_MODELS: list[str] = [
204+
"embed-v4.0",
205+
"embed-english-v3.0",
206+
"embed-english-light-v3.0",
207+
"embed-multilingual-v3.0",
208+
"embed-multilingual-light-v3.0",
209+
]
210+
211+
```
212+
213+
A non-exhaustive list of embed models supported by this component.
214+
See https://docs.cohere.com/docs/models#embed for the full list.
215+
184216
#### __init__
185217

186218
```python
@@ -305,6 +337,22 @@ print(text_embedder.run(text_to_embed))
305337
# 'meta': {'api_version': {'version': '1'}, 'billed_units': {'input_tokens': 4}}}
306338
```
307339

340+
#### SUPPORTED_MODELS
341+
342+
```python
343+
SUPPORTED_MODELS: list[str] = [
344+
"embed-v4.0",
345+
"embed-english-v3.0",
346+
"embed-english-light-v3.0",
347+
"embed-multilingual-v3.0",
348+
"embed-multilingual-light-v3.0",
349+
]
350+
351+
```
352+
353+
A non-exhaustive list of embed models supported by this component.
354+
See https://docs.cohere.com/docs/models#embed for the full list.
355+
308356
#### __init__
309357

310358
```python
@@ -316,7 +364,7 @@ __init__(
316364
truncate: str = "END",
317365
timeout: float = 120.0,
318366
embedding_type: EmbeddingTypes | None = None,
319-
)
367+
) -> None
320368
```
321369

322370
**Parameters:**
@@ -588,6 +636,30 @@ print(results["tool_invoker"]["tool_messages"][0].tool_call_result.result)
588636
# Output: "The weather in Paris is sunny and 32°C"
589637
```
590638

639+
#### SUPPORTED_MODELS
640+
641+
```python
642+
SUPPORTED_MODELS: list[str] = [
643+
"command-a-03-2025",
644+
"command-r7b-12-2024",
645+
"command-a-translate-08-2025",
646+
"command-a-reasoning-08-2025",
647+
"command-a-vision-07-2025",
648+
"command-r-08-2024",
649+
"command-r-plus-08-2024",
650+
"command-r-03-2024",
651+
"command-r-plus-04-2024",
652+
"command-r-plus",
653+
"command-r",
654+
"command-light",
655+
"command",
656+
]
657+
658+
```
659+
660+
A non-exhaustive list of chat models supported by this component.
661+
See https://docs.cohere.com/docs/models#command for the full list.
662+
591663
#### __init__
592664

593665
```python
@@ -601,7 +673,7 @@ __init__(
601673
*,
602674
timeout: float | None = None,
603675
max_retries: int | None = None
604-
)
676+
) -> None
605677
```
606678

607679
Initialize the CohereChatGenerator instance.
@@ -738,6 +810,30 @@ generator = CohereGenerator(api_key="test-api-key")
738810
generator.run(prompt="What's the capital of France?")
739811
```
740812

813+
#### SUPPORTED_MODELS
814+
815+
```python
816+
SUPPORTED_MODELS: list[str] = [
817+
"command-a-03-2025",
818+
"command-r7b-12-2024",
819+
"command-a-translate-08-2025",
820+
"command-a-reasoning-08-2025",
821+
"command-a-vision-07-2025",
822+
"command-r-08-2024",
823+
"command-r-plus-08-2024",
824+
"command-r-03-2024",
825+
"command-r-plus-04-2024",
826+
"command-r-plus",
827+
"command-r",
828+
"command-light",
829+
"command",
830+
]
831+
832+
```
833+
834+
A non-exhaustive list of chat models supported by this component.
835+
See https://docs.cohere.com/docs/models#command for the full list.
836+
741837
#### __init__
742838

743839
```python
@@ -747,7 +843,7 @@ __init__(
747843
streaming_callback: Callable | None = None,
748844
api_base_url: str | None = None,
749845
**kwargs: Any
750-
)
846+
) -> None
751847
```
752848

753849
Instantiates a `CohereGenerator` component.
@@ -832,7 +928,7 @@ __init__(
832928
meta_fields_to_embed: list[str] | None = None,
833929
meta_data_separator: str = "\n",
834930
max_tokens_per_doc: int = 4096,
835-
)
931+
) -> None
836932
```
837933

838934
Creates an instance of the 'CohereRanker'.

docs-website/reference_versioned_docs/version-2.18/integrations-api/cohere.md

Lines changed: 101 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ print(result['documents'][0].embedding)
3030
# [-0.453125, 1.2236328, 2.0058594, ...]
3131
```
3232

33+
#### SUPPORTED_MODELS
34+
35+
```python
36+
SUPPORTED_MODELS: list[str] = [
37+
"embed-v4.0",
38+
"embed-english-v3.0",
39+
"embed-english-light-v3.0",
40+
"embed-multilingual-v3.0",
41+
"embed-multilingual-light-v3.0",
42+
]
43+
44+
```
45+
46+
A non-exhaustive list of embed models supported by this component.
47+
See https://docs.cohere.com/docs/models#embed for the full list.
48+
3349
#### __init__
3450

3551
```python
@@ -45,7 +61,7 @@ __init__(
4561
meta_fields_to_embed: list[str] | None = None,
4662
embedding_separator: str = "\n",
4763
embedding_type: EmbeddingTypes | None = None,
48-
)
64+
) -> None
4965
```
5066

5167
**Parameters:**
@@ -181,6 +197,22 @@ print(documents_with_embeddings)
181197
# ...]
182198
```
183199

200+
#### SUPPORTED_MODELS
201+
202+
```python
203+
SUPPORTED_MODELS: list[str] = [
204+
"embed-v4.0",
205+
"embed-english-v3.0",
206+
"embed-english-light-v3.0",
207+
"embed-multilingual-v3.0",
208+
"embed-multilingual-light-v3.0",
209+
]
210+
211+
```
212+
213+
A non-exhaustive list of embed models supported by this component.
214+
See https://docs.cohere.com/docs/models#embed for the full list.
215+
184216
#### __init__
185217

186218
```python
@@ -305,6 +337,22 @@ print(text_embedder.run(text_to_embed))
305337
# 'meta': {'api_version': {'version': '1'}, 'billed_units': {'input_tokens': 4}}}
306338
```
307339

340+
#### SUPPORTED_MODELS
341+
342+
```python
343+
SUPPORTED_MODELS: list[str] = [
344+
"embed-v4.0",
345+
"embed-english-v3.0",
346+
"embed-english-light-v3.0",
347+
"embed-multilingual-v3.0",
348+
"embed-multilingual-light-v3.0",
349+
]
350+
351+
```
352+
353+
A non-exhaustive list of embed models supported by this component.
354+
See https://docs.cohere.com/docs/models#embed for the full list.
355+
308356
#### __init__
309357

310358
```python
@@ -316,7 +364,7 @@ __init__(
316364
truncate: str = "END",
317365
timeout: float = 120.0,
318366
embedding_type: EmbeddingTypes | None = None,
319-
)
367+
) -> None
320368
```
321369

322370
**Parameters:**
@@ -588,6 +636,30 @@ print(results["tool_invoker"]["tool_messages"][0].tool_call_result.result)
588636
# Output: "The weather in Paris is sunny and 32°C"
589637
```
590638

639+
#### SUPPORTED_MODELS
640+
641+
```python
642+
SUPPORTED_MODELS: list[str] = [
643+
"command-a-03-2025",
644+
"command-r7b-12-2024",
645+
"command-a-translate-08-2025",
646+
"command-a-reasoning-08-2025",
647+
"command-a-vision-07-2025",
648+
"command-r-08-2024",
649+
"command-r-plus-08-2024",
650+
"command-r-03-2024",
651+
"command-r-plus-04-2024",
652+
"command-r-plus",
653+
"command-r",
654+
"command-light",
655+
"command",
656+
]
657+
658+
```
659+
660+
A non-exhaustive list of chat models supported by this component.
661+
See https://docs.cohere.com/docs/models#command for the full list.
662+
591663
#### __init__
592664

593665
```python
@@ -601,7 +673,7 @@ __init__(
601673
*,
602674
timeout: float | None = None,
603675
max_retries: int | None = None
604-
)
676+
) -> None
605677
```
606678

607679
Initialize the CohereChatGenerator instance.
@@ -738,6 +810,30 @@ generator = CohereGenerator(api_key="test-api-key")
738810
generator.run(prompt="What's the capital of France?")
739811
```
740812

813+
#### SUPPORTED_MODELS
814+
815+
```python
816+
SUPPORTED_MODELS: list[str] = [
817+
"command-a-03-2025",
818+
"command-r7b-12-2024",
819+
"command-a-translate-08-2025",
820+
"command-a-reasoning-08-2025",
821+
"command-a-vision-07-2025",
822+
"command-r-08-2024",
823+
"command-r-plus-08-2024",
824+
"command-r-03-2024",
825+
"command-r-plus-04-2024",
826+
"command-r-plus",
827+
"command-r",
828+
"command-light",
829+
"command",
830+
]
831+
832+
```
833+
834+
A non-exhaustive list of chat models supported by this component.
835+
See https://docs.cohere.com/docs/models#command for the full list.
836+
741837
#### __init__
742838

743839
```python
@@ -747,7 +843,7 @@ __init__(
747843
streaming_callback: Callable | None = None,
748844
api_base_url: str | None = None,
749845
**kwargs: Any
750-
)
846+
) -> None
751847
```
752848

753849
Instantiates a `CohereGenerator` component.
@@ -832,7 +928,7 @@ __init__(
832928
meta_fields_to_embed: list[str] | None = None,
833929
meta_data_separator: str = "\n",
834930
max_tokens_per_doc: int = 4096,
835-
)
931+
) -> None
836932
```
837933

838934
Creates an instance of the 'CohereRanker'.

0 commit comments

Comments
 (0)