From 18e66f29a89acff0cce8cdc093168b49e0f5f51e Mon Sep 17 00:00:00 2001 From: bogdankostic <48713846+bogdankostic@users.noreply.github.com> Date: Mon, 28 Sep 2026 10:43:41 +0000 Subject: [PATCH] Sync Core Integrations API reference (cohere) on Docusaurus --- .../reference/integrations-api/cohere.md | 29 +- .../version-2.18/integrations-api/cohere.md | 29 +- .../version-2.19/integrations-api/cohere.md | 29 +- .../version-2.20/integrations-api/cohere.md | 29 +- .../version-2.21/integrations-api/cohere.md | 29 +- .../version-2.22/integrations-api/cohere.md | 29 +- .../version-2.23/integrations-api/cohere.md | 29 +- .../version-2.24/integrations-api/cohere.md | 29 +- .../version-2.25/integrations-api/cohere.md | 29 +- .../version-2.26/integrations-api/cohere.md | 29 +- .../version-2.27/integrations-api/cohere.md | 29 +- .../version-2.28/integrations-api/cohere.md | 29 +- .../version-2.29/integrations-api/cohere.md | 29 +- .../version-2.30/integrations-api/cohere.md | 29 +- .../version-2.31/integrations-api/cohere.md | 29 +- .../version-3.0/integrations-api/cohere.md | 29 +- .../version-3.1/integrations-api/cohere.md | 29 +- .../integrations-api/cohere.md | 1026 +++++++++++++++++ .../version-3.2/integrations-api/cohere.md | 29 +- 19 files changed, 1440 insertions(+), 108 deletions(-) create mode 100644 docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/cohere.md diff --git a/docs-website/reference/integrations-api/cohere.md b/docs-website/reference/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference/integrations-api/cohere.md +++ b/docs-website/reference/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.18/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.18/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.18/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.18/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.19/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.19/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.19/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.19/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.20/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.20/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.20/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.20/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.21/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.21/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.21/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.21/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.22/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.22/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.22/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.22/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.23/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.23/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.23/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.23/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.24/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.24/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.24/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.24/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.25/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.25/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.25/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.25/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.26/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.26/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.26/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.26/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.27/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.27/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.27/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.27/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.28/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.28/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.28/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.28/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.29/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.29/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.29/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.29/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.30/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.30/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.30/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.30/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-2.31/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-2.31/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-2.31/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-2.31/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-3.0/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-3.0/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-3.0/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-3.0/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-3.1/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-3.1/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-3.1/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-3.1/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up diff --git a/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/cohere.md new file mode 100644 index 00000000000..37889dab3c0 --- /dev/null +++ b/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/cohere.md @@ -0,0 +1,1026 @@ +--- +title: "Cohere" +id: integrations-cohere +description: "Cohere integration for Haystack" +slug: "/integrations-cohere" +--- + + +## haystack_integrations.components.embedders.cohere.document_embedder + +### CohereDocumentEmbedder + +A component for computing Document embeddings using Cohere models. + +The embedding of each Document is stored in the `embedding` field of the Document. + +Usage example: + +```python +from haystack import Document +from haystack_integrations.components.embedders.cohere import CohereDocumentEmbedder + +doc = Document(content="I love pizza!") + +document_embedder = CohereDocumentEmbedder() + +result = document_embedder.run([doc]) +print(result['documents'][0].embedding) + +# [-0.453125, 1.2236328, 2.0058594, ...] +``` + +#### SUPPORTED_MODELS + +```python +SUPPORTED_MODELS: list[str] = [ + "embed-v4.0", + "embed-english-v3.0", + "embed-english-light-v3.0", + "embed-multilingual-v3.0", + "embed-multilingual-light-v3.0", +] + +``` + +A non-exhaustive list of embed models supported by this component. +See https://docs.cohere.com/docs/models#embed for the full list. + +#### __init__ + +```python +__init__( + api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]), + model: str = "embed-v4.0", + input_type: str = "search_document", + api_base_url: str = "https://api.cohere.com", + truncate: str = "END", + timeout: float = 120.0, + batch_size: int = 32, + progress_bar: bool = True, + meta_fields_to_embed: list[str] | None = None, + embedding_separator: str = "\n", + embedding_type: EmbeddingTypes | None = None, +) -> None +``` + +Initialize the CohereDocumentEmbedder. + +**Parameters:** + +- **api_key** (Secret) – the Cohere API key. +- **model** (str) – the name of the model to use. + Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. +- **input_type** (str) – specifies the type of input you're giving to the model. Supported values are + "search_document", "search_query", "classification" and "clustering". +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. +- **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). + Passing "START" will discard the start of the input. "END" will discard the end of the input. In both + cases, input is discarded until the remaining input is exactly the maximum input token length for the model. + If "NONE" is selected, when the input exceeds the maximum input token length an error will be returned. +- **timeout** (float) – request timeout in seconds. +- **batch_size** (int) – number of Documents to encode at once. +- **progress_bar** (bool) – whether to show a progress bar or not. Can be helpful to disable in production deployments + to keep the logs clean. +- **meta_fields_to_embed** (list\[str\] | None) – list of meta fields that should be embedded along with the Document text. +- **embedding_separator** (str) – separator used to concatenate the meta fields to the Document text. +- **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. + Note that int8, uint8, binary, and ubinary are only valid for v3 models. + +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + +#### warm_up + +```python +warm_up() -> None +``` + +Create the synchronous Cohere client. + +#### warm_up_async + +```python +warm_up_async() -> None +``` + +Create the asynchronous Cohere client. + +#### to_dict + +```python +to_dict() -> dict[str, Any] +``` + +Serializes the component to a dictionary. + +**Returns:** + +- dict\[str, Any\] – Dictionary with serialized data. + +#### from_dict + +```python +from_dict(data: dict[str, Any]) -> CohereDocumentEmbedder +``` + +Deserializes the component from a dictionary. + +**Parameters:** + +- **data** (dict\[str, Any\]) – Dictionary to deserialize from. + +**Returns:** + +- CohereDocumentEmbedder – Deserialized component. + +#### run + +```python +run(documents: list[Document]) -> dict[str, list[Document] | dict[str, Any]] +``` + +Embed a list of `Documents`. + +**Parameters:** + +- **documents** (list\[Document\]) – documents to embed. + +**Returns:** + +- dict\[str, list\[Document\] | dict\[str, Any\]\] – A dictionary with the following keys: +- `documents`: documents with the `embedding` field set. +- `meta`: metadata about the embedding process. + +**Raises:** + +- TypeError – if the input is not a list of `Documents`. + +#### run_async + +```python +run_async( + documents: list[Document], +) -> dict[str, list[Document] | dict[str, Any]] +``` + +Embed a list of `Documents` asynchronously. + +**Parameters:** + +- **documents** (list\[Document\]) – documents to embed. + +**Returns:** + +- dict\[str, list\[Document\] | dict\[str, Any\]\] – A dictionary with the following keys: +- `documents`: documents with the `embedding` field set. +- `meta`: metadata about the embedding process. + +**Raises:** + +- TypeError – if the input is not a list of `Documents`. + +## haystack_integrations.components.embedders.cohere.document_image_embedder + +### CohereDocumentImageEmbedder + +A component for computing Document embeddings based on images using Cohere models. + +The embedding of each Document is stored in the `embedding` field of the Document. + +### Usage example + +```python +from haystack import Document +from haystack_integrations.components.embedders.cohere import CohereDocumentImageEmbedder + +embedder = CohereDocumentImageEmbedder(model="embed-v4.0") + +documents = [ + Document(content="A photo of a cat", meta={"file_path": "cat.jpg"}), + Document(content="A photo of a dog", meta={"file_path": "dog.jpg"}), +] + +result = embedder.run(documents=documents) +documents_with_embeddings = result["documents"] +print(documents_with_embeddings) + +# [Document(id=..., +# content='A photo of a cat', +# meta={'file_path': 'cat.jpg', +# 'embedding_source': {'type': 'image', 'file_path_meta_field': 'file_path'}}, +# embedding=vector of size 1536), +# ...] +``` + +#### SUPPORTED_MODELS + +```python +SUPPORTED_MODELS: list[str] = [ + "embed-v4.0", + "embed-english-v3.0", + "embed-english-light-v3.0", + "embed-multilingual-v3.0", + "embed-multilingual-light-v3.0", +] + +``` + +A non-exhaustive list of embed models supported by this component. +See https://docs.cohere.com/docs/models#embed for the full list. + +#### __init__ + +```python +__init__( + *, + file_path_meta_field: str = "file_path", + root_path: str | None = None, + image_size: tuple[int, int] | None = None, + api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]), + model: str = "embed-v4.0", + api_base_url: str = "https://api.cohere.com", + timeout: float = 120.0, + embedding_dimension: int | None = None, + embedding_type: EmbeddingTypes = EmbeddingTypes.FLOAT, + progress_bar: bool = True +) -> None +``` + +Creates a CohereDocumentImageEmbedder component. + +**Parameters:** + +- **file_path_meta_field** (str) – The metadata field in the Document that contains the file path to the image or PDF. +- **root_path** (str | None) – The root directory path where document files are located. If provided, file paths in + document metadata will be resolved relative to this path. If None, file paths are treated as absolute paths. +- **image_size** (tuple\[int, int\] | None) – If provided, resizes the image to fit within the specified dimensions (width, height) while + maintaining aspect ratio. This reduces file size, memory usage, and processing time, which is beneficial + when working with models that have resolution constraints or when transmitting images to remote services. +- **api_key** (Secret) – The Cohere API key. +- **model** (str) – The Cohere model to use for calculating embeddings. + Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. +- **timeout** (float) – Request timeout in seconds. +- **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. + Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and + supported models. +- **embedding_type** (EmbeddingTypes) – The type of embeddings to return. Defaults to float embeddings. + Specifying a type different from float is only supported for Embed v3.0 and newer models. +- **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments + to keep the logs clean. + +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + +#### warm_up + +```python +warm_up() -> None +``` + +Create the synchronous Cohere client. + +#### warm_up_async + +```python +warm_up_async() -> None +``` + +Create the asynchronous Cohere client. + +#### to_dict + +```python +to_dict() -> dict[str, Any] +``` + +Serializes the component to a dictionary. + +**Returns:** + +- dict\[str, Any\] – Dictionary with serialized data. + +#### from_dict + +```python +from_dict(data: dict[str, Any]) -> CohereDocumentImageEmbedder +``` + +Deserializes the component from a dictionary. + +**Parameters:** + +- **data** (dict\[str, Any\]) – Dictionary to deserialize from. + +**Returns:** + +- CohereDocumentImageEmbedder – Deserialized component. + +#### run + +```python +run(documents: list[Document]) -> dict[str, list[Document]] +``` + +Embed a list of image documents. + +**Parameters:** + +- **documents** (list\[Document\]) – Documents to embed. + +**Returns:** + +- dict\[str, list\[Document\]\] – A dictionary with the following keys: +- `documents`: Documents with embeddings. + +#### run_async + +```python +run_async(documents: list[Document]) -> dict[str, list[Document]] +``` + +Asynchronously embed a list of image documents. + +**Parameters:** + +- **documents** (list\[Document\]) – Documents to embed. + +**Returns:** + +- dict\[str, list\[Document\]\] – A dictionary with the following keys: +- `documents`: Documents with embeddings. + +## haystack_integrations.components.embedders.cohere.text_embedder + +### CohereTextEmbedder + +A component for embedding strings using Cohere models. + +Usage example: + +```python +from haystack_integrations.components.embedders.cohere import CohereTextEmbedder + +text_to_embed = "I love pizza!" + +text_embedder = CohereTextEmbedder() + +print(text_embedder.run(text_to_embed)) + +# {'embedding': [-0.453125, 1.2236328, 2.0058594, ...] +# 'meta': {'api_version': {'version': '1'}, 'billed_units': {'input_tokens': 4}}} +``` + +#### SUPPORTED_MODELS + +```python +SUPPORTED_MODELS: list[str] = [ + "embed-v4.0", + "embed-english-v3.0", + "embed-english-light-v3.0", + "embed-multilingual-v3.0", + "embed-multilingual-light-v3.0", +] + +``` + +A non-exhaustive list of embed models supported by this component. +See https://docs.cohere.com/docs/models#embed for the full list. + +#### __init__ + +```python +__init__( + api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]), + model: str = "embed-v4.0", + input_type: str = "search_query", + api_base_url: str = "https://api.cohere.com", + truncate: str = "END", + timeout: float = 120.0, + embedding_type: EmbeddingTypes | None = None, +) -> None +``` + +Initialize the CohereTextEmbedder. + +**Parameters:** + +- **api_key** (Secret) – the Cohere API key. +- **model** (str) – the name of the model to use. + Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. +- **input_type** (str) – specifies the type of input you're giving to the model. Supported values are + "search_document", "search_query", "classification" and "clustering". +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. +- **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). + Passing "START" will discard the start of the input. "END" will discard the end of the input. In both + cases, input is discarded until the remaining input is exactly the maximum input token length for the model. + If "NONE" is selected, when the input exceeds the maximum input token length an error will be returned. +- **timeout** (float) – request timeout in seconds. +- **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. + Note that int8, uint8, binary, and ubinary are only valid for v3 models. + +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + +#### warm_up + +```python +warm_up() -> None +``` + +Create the synchronous Cohere client. + +#### warm_up_async + +```python +warm_up_async() -> None +``` + +Create the asynchronous Cohere client. + +#### to_dict + +```python +to_dict() -> dict[str, Any] +``` + +Serializes the component to a dictionary. + +**Returns:** + +- dict\[str, Any\] – Dictionary with serialized data. + +#### from_dict + +```python +from_dict(data: dict[str, Any]) -> CohereTextEmbedder +``` + +Deserializes the component from a dictionary. + +**Parameters:** + +- **data** (dict\[str, Any\]) – Dictionary to deserialize from. + +**Returns:** + +- CohereTextEmbedder – Deserialized component. + +#### run + +```python +run(text: str) -> dict[str, list[float] | dict[str, Any]] +``` + +Embed text. + +**Parameters:** + +- **text** (str) – the text to embed. + +**Returns:** + +- dict\[str, list\[float\] | dict\[str, Any\]\] – A dictionary with the following keys: + - `embedding`: the embedding of the text. + - `meta`: metadata about the request. + +**Raises:** + +- TypeError – If the input is not a string. + +#### run_async + +```python +run_async(text: str) -> dict[str, list[float] | dict[str, Any]] +``` + +Asynchronously embed text. + +This is the asynchronous version of the `run` method. It has the same parameters and return values +but can be used with `await` in async code. + +:param text: +Text to embed. + +**Returns:** + +- dict\[str, list\[float\] | dict\[str, Any\]\] – A dictionary with the following keys: +- `embedding`: the embedding of the text. +- `meta`: metadata about the request. + +**Raises:** + +- TypeError – If the input is not a string. + +## haystack_integrations.components.embedders.cohere.utils + +### get_async_response + +```python +get_async_response( + cohere_async_client: AsyncClientV2, + texts: list[str], + model_name: str, + input_type: str, + truncate: str, + batch_size: int = 32, + progress_bar: bool = False, + embedding_type: EmbeddingTypes | None = None, +) -> tuple[list[list[float]], dict[str, Any]] +``` + +Embeds a list of texts asynchronously using the Cohere API. + +**Parameters:** + +- **cohere_async_client** (AsyncClientV2) – the Cohere `AsyncClient` +- **texts** (list\[str\]) – the texts to embed +- **model_name** (str) – the name of the model to use +- **input_type** (str) – one of "classification", "clustering", "search_document", "search_query". + The type of input text provided to embed. +- **truncate** (str) – one of "NONE", "START", "END". How the API handles text longer than the maximum token length. +- **batch_size** (int) – the batch size to use. The Cohere embed endpoint caps the number of texts per call, so the + texts are sent in batches just like the synchronous path. +- **progress_bar** (bool) – if `True`, show a progress bar +- **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. + +**Returns:** + +- tuple\[list\[list\[float\]\], dict\[str, Any\]\] – A tuple of the embeddings and metadata. + +**Raises:** + +- ValueError – If an error occurs while querying the Cohere API. + +### get_response + +```python +get_response( + cohere_client: ClientV2, + texts: list[str], + model_name: str, + input_type: str, + truncate: str, + batch_size: int = 32, + progress_bar: bool = False, + embedding_type: EmbeddingTypes | None = None, +) -> tuple[list[list[float]], dict[str, Any]] +``` + +Embeds a list of texts using the Cohere API. + +**Parameters:** + +- **cohere_client** (ClientV2) – the Cohere `Client` +- **texts** (list\[str\]) – the texts to embed +- **model_name** (str) – the name of the model to use +- **input_type** (str) – one of "classification", "clustering", "search_document", "search_query". + The type of input text provided to embed. +- **truncate** (str) – one of "NONE", "START", "END". How the API handles text longer than the maximum token length. +- **batch_size** (int) – the batch size to use +- **progress_bar** (bool) – if `True`, show a progress bar +- **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. + +**Returns:** + +- tuple\[list\[list\[float\]\], dict\[str, Any\]\] – A tuple of the embeddings and metadata. + +**Raises:** + +- ValueError – If an error occurs while querying the Cohere API. + +## haystack_integrations.components.generators.cohere.chat.chat_generator + +### CohereChatGenerator + +Completes chats using Cohere's models using cohere.ClientV2 `chat` endpoint. + +This component supports both text-only and multimodal (text + image) conversations +using Cohere's vision models like Command A Vision. + +Supported image formats: PNG, JPEG, WEBP, GIF (non-animated). +Maximum 20 images per request with 20MB total limit. + +You can customize how the chat response is generated by passing parameters to the +Cohere API through the `**generation_kwargs` parameter. You can do this when +initializing or running the component. Any parameter that works with +`cohere.ClientV2.chat` will work here too. +For details, see [Cohere API](https://docs.cohere.com/reference/chat). + +Below is an example of how to use the component: + +### Simple example + +```python +from haystack.dataclasses import ChatMessage +from haystack.utils import Secret +from haystack_integrations.components.generators.cohere import CohereChatGenerator + +client = CohereChatGenerator(api_key=Secret.from_env_var("COHERE_API_KEY")) +messages = [ChatMessage.from_user("What's Natural Language Processing?")] +client.run(messages) + +# Output: {'replies': [ChatMessage(_role=, +# _content=[TextContent(text='Natural Language Processing (NLP) is an interdisciplinary... +``` + +### Multimodal example + +```python +from haystack.dataclasses import ChatMessage, ImageContent +from haystack.utils import Secret +from haystack_integrations.components.generators.cohere import CohereChatGenerator + +# Create an image from file path or base64 +image_content = ImageContent.from_file_path("path/to/your/image.jpg") + +# Create a multimodal message with both text and image +messages = [ChatMessage.from_user(content_parts=["What's in this image?", image_content])] + +# Use a multimodal model like Command A Vision +client = CohereChatGenerator(model="command-a-vision-07-2025", api_key=Secret.from_env_var("COHERE_API_KEY")) +response = client.run(messages) +print(response) +``` + +### Advanced example + +CohereChatGenerator can be integrated into pipelines and supports Haystack's tooling +architecture, enabling tools to be invoked seamlessly across various generators. + +```python +from haystack import Pipeline +from haystack.dataclasses import ChatMessage +from haystack.components.tools import ToolInvoker +from haystack.tools import Tool +from haystack_integrations.components.generators.cohere import CohereChatGenerator + +# Create a weather tool +def weather(city: str) -> str: + return f"The weather in {city} is sunny and 32°C" + +weather_tool = Tool( + name="weather", + description="useful to determine the weather in a given location", + parameters={ + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "The name of the city to get weather for, e.g. Paris, London", + } + }, + "required": ["city"], + }, + function=weather, +) + +# Create and set up the pipeline +pipeline = Pipeline() +pipeline.add_component("generator", CohereChatGenerator(tools=[weather_tool])) +pipeline.add_component("tool_invoker", ToolInvoker(tools=[weather_tool])) +pipeline.connect("generator", "tool_invoker") + +# Run the pipeline with a weather query +results = pipeline.run( + data={"generator": {"messages": [ChatMessage.from_user("What's the weather like in Paris?")]}} +) + +# The tool result will be available in the pipeline output +print(results["tool_invoker"]["tool_messages"][0].tool_call_result.result) +# Output: "The weather in Paris is sunny and 32°C" +``` + +#### SUPPORTED_MODELS + +```python +SUPPORTED_MODELS: list[str] = [ + "command-a-03-2025", + "command-r7b-12-2024", + "command-a-translate-08-2025", + "command-a-reasoning-08-2025", + "command-a-vision-07-2025", + "command-r-08-2024", + "command-r-plus-08-2024", + "command-r-03-2024", + "command-r-plus-04-2024", + "command-r-plus", + "command-r", + "command-light", + "command", +] + +``` + +A non-exhaustive list of chat models supported by this component. +See https://docs.cohere.com/docs/models#command for the full list. + +#### __init__ + +```python +__init__( + api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]), + model: str = "command-a-03-2025", + streaming_callback: StreamingCallbackT | None = None, + api_base_url: str | None = None, + generation_kwargs: dict[str, Any] | None = None, + tools: ToolsType | None = None, + *, + timeout: float | None = None, + max_retries: int | None = None +) -> None +``` + +Initialize the CohereChatGenerator instance. + +**Parameters:** + +- **api_key** (Secret) – The API key for the Cohere API. +- **model** (str) – The name of the model to use. You can use models from the `command` family. +- **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. + The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) + as an argument. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. +- **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, + see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). + Some of the parameters are: +- 'messages': A list of messages between the user and the model, meant to give the model + conversational context for responding to the user's message. +- 'system_message': When specified, adds a system message at the beginning of the conversation. +- 'citation_quality': Defaults to `accurate`. Dictates the approach taken to generating citations + as part of the RAG flow by allowing the user to specify whether they want + `accurate` results or `fast` results. +- 'temperature': A non-negative float that tunes the degree of randomness in generation. Lower temperatures + mean less random generations. +- **tools** (ToolsType | None) – A list of Tool and/or Toolset objects, or a single Toolset that the model can use. + Each tool should have a unique name. +- **timeout** (float | None) – Timeout for Cohere client calls. If not set, it defaults to the default set by the Cohere client. +- **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by + the Cohere client. + +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + +#### warm_up + +```python +warm_up() -> None +``` + +Create the synchronous Cohere client. + +#### warm_up_async + +```python +warm_up_async() -> None +``` + +Create the asynchronous Cohere client. + +#### to_dict + +```python +to_dict() -> dict[str, Any] +``` + +Serializes the component to a dictionary. + +**Returns:** + +- dict\[str, Any\] – Dictionary with serialized data. + +#### from_dict + +```python +from_dict(data: dict[str, Any]) -> CohereChatGenerator +``` + +Deserializes the component from a dictionary. + +**Parameters:** + +- **data** (dict\[str, Any\]) – Dictionary to deserialize from. + +**Returns:** + +- CohereChatGenerator – Deserialized component. + +#### run + +```python +run( + messages: list[ChatMessage] | str, + generation_kwargs: dict[str, Any] | None = None, + tools: ToolsType | None = None, + streaming_callback: StreamingCallbackT | None = None, +) -> dict[str, list[ChatMessage]] +``` + +Invoke the chat endpoint based on the provided messages and generation parameters. + +**Parameters:** + +- **messages** (list\[ChatMessage\] | str) – list of `ChatMessage` instances representing the input messages. + If a string is provided, it is converted to a list containing a ChatMessage with user role. +- **generation_kwargs** (dict\[str, Any\] | None) – additional keyword arguments for chat generation. These are merged per key + with the `generation_kwargs` passed at initialization: keys provided here take precedence, keys set + only at initialization are kept. + For more details on the parameters supported by the Cohere API, refer to the + Cohere [documentation](https://docs.cohere.com/reference/chat). +- **tools** (ToolsType | None) – A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls. + If set, it will override the `tools` parameter set during component initialization. +- **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. + The callback function accepts StreamingChunk as an argument. + +**Returns:** + +- dict\[str, list\[ChatMessage\]\] – A dictionary with the following keys: +- `replies`: a list of `ChatMessage` instances representing the generated responses. + +#### run_async + +```python +run_async( + messages: list[ChatMessage] | str, + generation_kwargs: dict[str, Any] | None = None, + tools: ToolsType | None = None, + streaming_callback: StreamingCallbackT | None = None, +) -> dict[str, list[ChatMessage]] +``` + +Asynchronously invoke the chat endpoint based on the provided messages and generation parameters. + +**Parameters:** + +- **messages** (list\[ChatMessage\] | str) – list of `ChatMessage` instances representing the input messages. + If a string is provided, it is converted to a list containing a ChatMessage with user role. +- **generation_kwargs** (dict\[str, Any\] | None) – additional keyword arguments for chat generation. These are merged per key + with the `generation_kwargs` passed at initialization: keys provided here take precedence, keys set + only at initialization are kept. + For more details on the parameters supported by the Cohere API, refer to the + Cohere [documentation](https://docs.cohere.com/reference/chat). +- **tools** (ToolsType | None) – A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls. + If set, it will override the `tools` parameter set during component initialization. +- **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. + +**Returns:** + +- dict\[str, list\[ChatMessage\]\] – A dictionary with the following keys: +- `replies`: a list of `ChatMessage` instances representing the generated responses. + +## haystack_integrations.components.rankers.cohere.ranker + +### CohereRanker + +Ranks Documents based on their similarity to the query using [Cohere models](https://docs.cohere.com/reference/rerank-1). + +Documents are indexed from most to least semantically relevant to the query. + +Usage example: + +```python +from haystack import Document +from haystack_integrations.components.rankers.cohere import CohereRanker + +ranker = CohereRanker(model="rerank-v3.5", top_k=2) + +docs = [Document(content="Paris"), Document(content="Berlin")] +query = "What is the capital of germany?" +output = ranker.run(query=query, documents=docs) +docs = output["documents"] +``` + +#### __init__ + +```python +__init__( + model: str = "rerank-v3.5", + top_k: int = 10, + api_key: Secret = Secret.from_env_var(["COHERE_API_KEY", "CO_API_KEY"]), + api_base_url: str = "https://api.cohere.com", + meta_fields_to_embed: list[str] | None = None, + meta_data_separator: str = "\n", + max_tokens_per_doc: int = 4096, +) -> None +``` + +Creates an instance of the 'CohereRanker'. + +**Parameters:** + +- **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). +- **top_k** (int) – The maximum number of documents to return. +- **api_key** (Secret) – Cohere API key. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. +- **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated + with the document content for reranking. +- **meta_data_separator** (str) – Separator used to concatenate the meta fields + to the Document content. +- **max_tokens_per_doc** (int) – The maximum number of tokens to embed for each document defaults to 4096. + +**Raises:** + +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. + +#### warm_up + +```python +warm_up() -> None +``` + +Create the synchronous Cohere client. + +#### warm_up_async + +```python +warm_up_async() -> None +``` + +Create the asynchronous Cohere client. + +#### to_dict + +```python +to_dict() -> dict[str, Any] +``` + +Serializes the component to a dictionary. + +**Returns:** + +- dict\[str, Any\] – Dictionary with serialized data. + +#### from_dict + +```python +from_dict(data: dict[str, Any]) -> CohereRanker +``` + +Deserializes the component from a dictionary. + +**Parameters:** + +- **data** (dict\[str, Any\]) – The dictionary to deserialize from. + +**Returns:** + +- CohereRanker – The deserialized component. + +#### run + +```python +run( + query: str, documents: list[Document], top_k: int | None = None +) -> dict[str, list[Document]] +``` + +Use the Cohere Reranker to re-rank the list of documents based on the query. + +**Parameters:** + +- **query** (str) – Query string. +- **documents** (list\[Document\]) – List of Documents. +- **top_k** (int | None) – The maximum number of Documents you want the Ranker to return. + +**Returns:** + +- dict\[str, list\[Document\]\] – A dictionary with the following keys: +- `documents`: List of Documents most similar to the given query in descending order of similarity. + +**Raises:** + +- ValueError – If `top_k` is not > 0. + +#### run_async + +```python +run_async( + query: str, documents: list[Document], top_k: int | None = None +) -> dict[str, list[Document]] +``` + +Asynchronously re-rank the list of documents based on the query. + +This is the asynchronous version of the `run` method. It has the same parameters and return values +but can be used with `await` in async code. + +**Parameters:** + +- **query** (str) – Query string. +- **documents** (list\[Document\]) – List of Documents. +- **top_k** (int | None) – The maximum number of Documents you want the Ranker to return. + +**Returns:** + +- dict\[str, list\[Document\]\] – A dictionary with the following keys: +- `documents`: List of Documents most similar to the given query in descending order of similarity. + +**Raises:** + +- ValueError – If `top_k` is not > 0. diff --git a/docs-website/reference_versioned_docs/version-3.2/integrations-api/cohere.md b/docs-website/reference_versioned_docs/version-3.2/integrations-api/cohere.md index 4dbf5b7f009..37889dab3c0 100644 --- a/docs-website/reference_versioned_docs/version-3.2/integrations-api/cohere.md +++ b/docs-website/reference_versioned_docs/version-3.2/integrations-api/cohere.md @@ -73,7 +73,7 @@ Initialize the CohereDocumentEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -87,6 +87,10 @@ Initialize the CohereDocumentEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -257,7 +261,7 @@ Creates a CohereDocumentImageEmbedder component. - **api_key** (Secret) – The Cohere API key. - **model** (str) – The Cohere model to use for calculating embeddings. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. -- **api_base_url** (str) – The Cohere API base URL. +- **api_base_url** (str) – The Cohere API base URL. The Cohere client appends the endpoint path to it. - **timeout** (float) – Request timeout in seconds. - **embedding_dimension** (int | None) – The dimension of the embeddings to return. Only valid for v4 and newer models. Read [Cohere API reference](https://docs.cohere.com/reference/embed) for a list possible values and @@ -267,6 +271,10 @@ Creates a CohereDocumentImageEmbedder component. - **progress_bar** (bool) – Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep the logs clean. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -405,7 +413,7 @@ Initialize the CohereTextEmbedder. Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models. - **input_type** (str) – specifies the type of input you're giving to the model. Supported values are "search_document", "search_query", "classification" and "clustering". -- **api_base_url** (str) – the Cohere API Base url. +- **api_base_url** (str) – the Cohere API Base url. The Cohere client appends the endpoint path to it. - **truncate** (str) – truncate embeddings that are too long from start or end, ("NONE"|"START"|"END"). Passing "START" will discard the start of the input. "END" will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. @@ -414,6 +422,10 @@ Initialize the CohereTextEmbedder. - **embedding_type** (EmbeddingTypes | None) – the type of embeddings to return. Defaults to float embeddings. Note that int8, uint8, binary, and ubinary are only valid for v3 models. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -732,7 +744,7 @@ Initialize the CohereChatGenerator instance. - **streaming_callback** (StreamingCallbackT | None) – A callback function that is called when a new token is received from the stream. The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk) as an argument. -- **api_base_url** (str | None) – The base URL of the Cohere API. +- **api_base_url** (str | None) – The base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **generation_kwargs** (dict\[str, Any\] | None) – Other parameters to use for the model during generation. For a list of parameters, see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat). Some of the parameters are: @@ -750,6 +762,10 @@ Initialize the CohereChatGenerator instance. - **max_retries** (int | None) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by the Cohere client. +**Raises:** + +- ValueError – If `api_base_url` is a full endpoint URL rather than a base URL. + #### warm_up ```python @@ -900,7 +916,7 @@ Creates an instance of the 'CohereRanker'. - **model** (str) – Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models). - **top_k** (int) – The maximum number of documents to return. - **api_key** (Secret) – Cohere API key. -- **api_base_url** (str) – the base URL of the Cohere API. +- **api_base_url** (str) – the base URL of the Cohere API. The Cohere client appends the endpoint path to it. - **meta_fields_to_embed** (list\[str\] | None) – List of meta fields that should be concatenated with the document content for reranking. - **meta_data_separator** (str) – Separator used to concatenate the meta fields @@ -909,7 +925,8 @@ Creates an instance of the 'CohereRanker'. **Raises:** -- ValueError – If `top_k` is not > 0. +- ValueError – If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a + base URL. #### warm_up