Skip to content

Commit c5f5181

Browse files
Sync Core Integrations API reference (cohere) on Docusaurus (#11049)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent 940e9c7 commit c5f5181

11 files changed

Lines changed: 132 additions & 198 deletions

File tree

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
5151
```python
5252
__init__(
5353
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
54-
model: str = "embed-english-v2.0",
54+
model: str = "embed-v4.0",
5555
input_type: str = "search_document",
5656
api_base_url: str = "https://api.cohere.com",
5757
truncate: str = "END",
@@ -64,18 +64,15 @@ __init__(
6464
) -> None
6565
```
6666

67+
Initialize the CohereDocumentEmbedder.
68+
6769
**Parameters:**
6870

6971
- **api_key** (<code>Secret</code>) – the Cohere API key.
70-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
71-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
72-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
73-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
74-
[model documentation](https://docs.cohere.com/docs/models#representation).
72+
- **model** (<code>str</code>) – the name of the model to use.
73+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
7574
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
76-
"search_document", "search_query", "classification" and "clustering". Not
77-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
78-
more recent versions (meaning anything bigger than v2).
75+
"search_document", "search_query", "classification" and "clustering".
7976
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
8077
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
8178
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
@@ -358,7 +355,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
358355
```python
359356
__init__(
360357
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
361-
model: str = "embed-english-v2.0",
358+
model: str = "embed-v4.0",
362359
input_type: str = "search_query",
363360
api_base_url: str = "https://api.cohere.com",
364361
truncate: str = "END",
@@ -367,18 +364,15 @@ __init__(
367364
) -> None
368365
```
369366

367+
Initialize the CohereTextEmbedder.
368+
370369
**Parameters:**
371370

372371
- **api_key** (<code>Secret</code>) – the Cohere API key.
373-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
374-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
375-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
376-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
377-
[model documentation](https://docs.cohere.com/docs/models#representation).
372+
- **model** (<code>str</code>) – the name of the model to use.
373+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
378374
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
379-
"search_document", "search_query", "classification" and "clustering". Not
380-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
381-
more recent versions (meaning anything bigger than v2).
375+
"search_document", "search_query", "classification" and "clustering".
382376
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
383377
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
384378
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
5151
```python
5252
__init__(
5353
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
54-
model: str = "embed-english-v2.0",
54+
model: str = "embed-v4.0",
5555
input_type: str = "search_document",
5656
api_base_url: str = "https://api.cohere.com",
5757
truncate: str = "END",
@@ -64,18 +64,15 @@ __init__(
6464
) -> None
6565
```
6666

67+
Initialize the CohereDocumentEmbedder.
68+
6769
**Parameters:**
6870

6971
- **api_key** (<code>Secret</code>) – the Cohere API key.
70-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
71-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
72-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
73-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
74-
[model documentation](https://docs.cohere.com/docs/models#representation).
72+
- **model** (<code>str</code>) – the name of the model to use.
73+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
7574
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
76-
"search_document", "search_query", "classification" and "clustering". Not
77-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
78-
more recent versions (meaning anything bigger than v2).
75+
"search_document", "search_query", "classification" and "clustering".
7976
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
8077
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
8178
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
@@ -358,7 +355,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
358355
```python
359356
__init__(
360357
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
361-
model: str = "embed-english-v2.0",
358+
model: str = "embed-v4.0",
362359
input_type: str = "search_query",
363360
api_base_url: str = "https://api.cohere.com",
364361
truncate: str = "END",
@@ -367,18 +364,15 @@ __init__(
367364
) -> None
368365
```
369366

367+
Initialize the CohereTextEmbedder.
368+
370369
**Parameters:**
371370

372371
- **api_key** (<code>Secret</code>) – the Cohere API key.
373-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
374-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
375-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
376-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
377-
[model documentation](https://docs.cohere.com/docs/models#representation).
372+
- **model** (<code>str</code>) – the name of the model to use.
373+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
378374
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
379-
"search_document", "search_query", "classification" and "clustering". Not
380-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
381-
more recent versions (meaning anything bigger than v2).
375+
"search_document", "search_query", "classification" and "clustering".
382376
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
383377
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
384378
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
5151
```python
5252
__init__(
5353
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
54-
model: str = "embed-english-v2.0",
54+
model: str = "embed-v4.0",
5555
input_type: str = "search_document",
5656
api_base_url: str = "https://api.cohere.com",
5757
truncate: str = "END",
@@ -64,18 +64,15 @@ __init__(
6464
) -> None
6565
```
6666

67+
Initialize the CohereDocumentEmbedder.
68+
6769
**Parameters:**
6870

6971
- **api_key** (<code>Secret</code>) – the Cohere API key.
70-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
71-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
72-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
73-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
74-
[model documentation](https://docs.cohere.com/docs/models#representation).
72+
- **model** (<code>str</code>) – the name of the model to use.
73+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
7574
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
76-
"search_document", "search_query", "classification" and "clustering". Not
77-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
78-
more recent versions (meaning anything bigger than v2).
75+
"search_document", "search_query", "classification" and "clustering".
7976
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
8077
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
8178
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
@@ -358,7 +355,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
358355
```python
359356
__init__(
360357
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
361-
model: str = "embed-english-v2.0",
358+
model: str = "embed-v4.0",
362359
input_type: str = "search_query",
363360
api_base_url: str = "https://api.cohere.com",
364361
truncate: str = "END",
@@ -367,18 +364,15 @@ __init__(
367364
) -> None
368365
```
369366

367+
Initialize the CohereTextEmbedder.
368+
370369
**Parameters:**
371370

372371
- **api_key** (<code>Secret</code>) – the Cohere API key.
373-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
374-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
375-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
376-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
377-
[model documentation](https://docs.cohere.com/docs/models#representation).
372+
- **model** (<code>str</code>) – the name of the model to use.
373+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
378374
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
379-
"search_document", "search_query", "classification" and "clustering". Not
380-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
381-
more recent versions (meaning anything bigger than v2).
375+
"search_document", "search_query", "classification" and "clustering".
382376
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
383377
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
384378
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
5151
```python
5252
__init__(
5353
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
54-
model: str = "embed-english-v2.0",
54+
model: str = "embed-v4.0",
5555
input_type: str = "search_document",
5656
api_base_url: str = "https://api.cohere.com",
5757
truncate: str = "END",
@@ -64,18 +64,15 @@ __init__(
6464
) -> None
6565
```
6666

67+
Initialize the CohereDocumentEmbedder.
68+
6769
**Parameters:**
6870

6971
- **api_key** (<code>Secret</code>) – the Cohere API key.
70-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
71-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
72-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
73-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
74-
[model documentation](https://docs.cohere.com/docs/models#representation).
72+
- **model** (<code>str</code>) – the name of the model to use.
73+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
7574
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
76-
"search_document", "search_query", "classification" and "clustering". Not
77-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
78-
more recent versions (meaning anything bigger than v2).
75+
"search_document", "search_query", "classification" and "clustering".
7976
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
8077
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
8178
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
@@ -358,7 +355,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
358355
```python
359356
__init__(
360357
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
361-
model: str = "embed-english-v2.0",
358+
model: str = "embed-v4.0",
362359
input_type: str = "search_query",
363360
api_base_url: str = "https://api.cohere.com",
364361
truncate: str = "END",
@@ -367,18 +364,15 @@ __init__(
367364
) -> None
368365
```
369366

367+
Initialize the CohereTextEmbedder.
368+
370369
**Parameters:**
371370

372371
- **api_key** (<code>Secret</code>) – the Cohere API key.
373-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
374-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
375-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
376-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
377-
[model documentation](https://docs.cohere.com/docs/models#representation).
372+
- **model** (<code>str</code>) – the name of the model to use.
373+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
378374
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
379-
"search_document", "search_query", "classification" and "clustering". Not
380-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
381-
more recent versions (meaning anything bigger than v2).
375+
"search_document", "search_query", "classification" and "clustering".
382376
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
383377
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
384378
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
5151
```python
5252
__init__(
5353
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
54-
model: str = "embed-english-v2.0",
54+
model: str = "embed-v4.0",
5555
input_type: str = "search_document",
5656
api_base_url: str = "https://api.cohere.com",
5757
truncate: str = "END",
@@ -64,18 +64,15 @@ __init__(
6464
) -> None
6565
```
6666

67+
Initialize the CohereDocumentEmbedder.
68+
6769
**Parameters:**
6870

6971
- **api_key** (<code>Secret</code>) – the Cohere API key.
70-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
71-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
72-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
73-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
74-
[model documentation](https://docs.cohere.com/docs/models#representation).
72+
- **model** (<code>str</code>) – the name of the model to use.
73+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
7574
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
76-
"search_document", "search_query", "classification" and "clustering". Not
77-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
78-
more recent versions (meaning anything bigger than v2).
75+
"search_document", "search_query", "classification" and "clustering".
7976
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
8077
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
8178
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
@@ -358,7 +355,7 @@ See https://docs.cohere.com/docs/models#embed for the full list.
358355
```python
359356
__init__(
360357
api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]),
361-
model: str = "embed-english-v2.0",
358+
model: str = "embed-v4.0",
362359
input_type: str = "search_query",
363360
api_base_url: str = "https://api.cohere.com",
364361
truncate: str = "END",
@@ -367,18 +364,15 @@ __init__(
367364
) -> None
368365
```
369366

367+
Initialize the CohereTextEmbedder.
368+
370369
**Parameters:**
371370

372371
- **api_key** (<code>Secret</code>) – the Cohere API key.
373-
- **model** (<code>str</code>) – the name of the model to use. Supported Models are:
374-
`"embed-english-v3.0"`, `"embed-english-light-v3.0"`, `"embed-multilingual-v3.0"`,
375-
`"embed-multilingual-light-v3.0"`, `"embed-english-v2.0"`, `"embed-english-light-v2.0"`,
376-
`"embed-multilingual-v2.0"`. This list of all supported models can be found in the
377-
[model documentation](https://docs.cohere.com/docs/models#representation).
372+
- **model** (<code>str</code>) – the name of the model to use.
373+
Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
378374
- **input_type** (<code>str</code>) – specifies the type of input you're giving to the model. Supported values are
379-
"search_document", "search_query", "classification" and "clustering". Not
380-
required for older versions of the embedding models (meaning anything lower than v3), but is required for
381-
more recent versions (meaning anything bigger than v2).
375+
"search_document", "search_query", "classification" and "clustering".
382376
- **api_base_url** (<code>str</code>) – the Cohere API Base url.
383377
- **truncate** (<code>str</code>) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
384378
Passing "START" will discard the start of the input. "END" will discard the end of the input. In both

0 commit comments

Comments
 (0)