CohereEmbeddings#
- class langchain_community.embeddings.cohere.CohereEmbeddings[source]#
Bases:
BaseModel
,Embeddings
Deprecated since version 0.0.30: Use
langchain_cohere.CohereEmbeddings
instead.Cohere embedding models.
To use, you should have the
cohere
python package installed, and the environment variableCOHERE_API_KEY
set with your API key or pass it as a named parameter to the constructor.Example
from langchain_community.embeddings import CohereEmbeddings cohere = CohereEmbeddings( model="embed-english-light-v3.0", cohere_api_key="my-api-key" )
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- param async_client: Any = None#
Cohere async client.
- param client: Any = None#
Cohere client.
- param cohere_api_key: str | None = None#
- param max_retries: int = 3#
Maximum number of retries to make when generating.
- param model: str = 'embed-english-v2.0'#
Model name to use.
- param request_timeout: float | None = None#
Timeout in seconds for the Cohere API request.
- param truncate: str | None = None#
Truncate embeddings that are too long from start or end (βNONEβ|βSTARTβ|βENDβ)
- param user_agent: str = 'langchain'#
Identifier for the application making the request.
- async aembed(texts: List[str], *, input_type: str | None = None) List[List[float]] [source]#
- Parameters:
texts (List[str]) β
input_type (str | None) β
- Return type:
List[List[float]]
- async aembed_documents(texts: List[str]) List[List[float]] [source]#
Async call out to Cohereβs embedding endpoint.
- Parameters:
texts (List[str]) β The list of texts to embed.
- Returns:
List of embeddings, one for each text.
- Return type:
List[List[float]]
- async aembed_query(text: str) List[float] [source]#
Async call out to Cohereβs embedding endpoint.
- Parameters:
text (str) β The text to embed.
- Returns:
Embeddings for the text.
- Return type:
List[float]
- aembed_with_retry(**kwargs: Any) Any [source]#
Use tenacity to retry the embed call.
- Parameters:
kwargs (Any) β
- Return type:
Any
- embed(texts: List[str], *, input_type: str | None = None) List[List[float]] [source]#
- Parameters:
texts (List[str]) β
input_type (str | None) β
- Return type:
List[List[float]]
- embed_documents(texts: List[str]) List[List[float]] [source]#
Embed a list of document texts.
- Parameters:
texts (List[str]) β The list of texts to embed.
- Returns:
List of embeddings, one for each text.
- Return type:
List[List[float]]
Examples using CohereEmbeddings