langchain_cohere.embeddings.CohereEmbeddings

class langchain_cohere.embeddings.CohereEmbeddings

继承自: BaseModel 和 Embeddings

实现了Embeddings接口，使用Cohere的文字表示语言模型。

更多关于我们的信息请访问 https://cohere.com 和 https://hugging-face.cn/CohereForAI

此实现使用了Embed API - 请参阅 https://docs.cohere.com/reference/embed

要使用此功能，您需要Cohere API密钥 - 可以将其传递给cohere_api_key参数或设置COHERE_API_KEY环境变量。

API密钥可在 https://cohere.com 获取 - 注册是免费的，并且试用API密钥可以与此实现一起使用。

基本示例

cohere_embeddings = CohereEmbeddings(model="embed-english-light-v3.0")
text = "This is a test document."

query_result = cohere_embeddings.embed_query(text)
print(query_result)

doc_result = cohere_embeddings.embed_documents([text])
print(doc_result)

通过解析和验证关键字参数中的输入数据来创建一个新的模型。

如果无法解析输入数据以形成有效的模型，则引发ValidationError。

参数 async_client : Any = None

Cohere异步客户端。

参数 base_url : Optional[str] = None

覆盖默认的Cohere API URL。

参数 client : Any = None

Cohere客户端。

参数 cohere_api_key : Optional[str] = None

参数 embedding_types : Optional[Sequence[str]] = [\'float\']

指定希望获取的嵌入类型

参数 max_retries: int = 3

生成时最大重试次数。

参数 model: 可选[str] = None

要使用的模型名称。必须指定模型名称。

参数 request_timeout: 可选[float] = None

Cohere API请求的秒数超时。

参数 truncate: 可选[str] = None

从开始或结尾截断太长的嵌入（“NONE”|“START”|“END”）

参数 user_agent : str = 'langchain:partner'

发出请求的应用程序的标识符。

async aembed(texts: List[str], *, input_type: Optional[Union['search_document', 'search_query', 'classification', 'clustering'], Any]] = None) → List[List[float]]

参数

• texts (List[str]) –

• input_type (Optional[Union[Literal['search_document', 'search_query', 'classification', 'clustering'], ~typing.Any]]) –

返回类型

List[List[float]]

async aembed_documents(texts: List[str]) → List[List[float]]

异步调用 Cohere 的嵌入端点。

参数

texts (List[str]) – 要嵌入的文本列表。

返回

嵌入列表，每个文本一个。

返回类型

List[List[float]]

async aembed_query(text: str) → List[float]

异步调用 Cohere 的嵌入端点。

参数

text (str) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

List[float]

aembed_with_retry(**kwargs: Any) → Any

使用tenacity重试嵌入调用。

参数

kwargs (Any) -

返回类型

任何

embed(texts: List[str], *, input_type: Optional[Union[Literal['search_document', 'search_query', 'classification', 'clustering'], Any]] = None) → List[List[float]]

参数

• texts (List[str]) –

• input_type (Optional[Union[Literal['search_document', 'search_query', 'classification', 'clustering'], ~typing.Any]]) –

返回类型

List[List[float]]

embed_documents(texts: List[str]) → List[List[float]]

嵌入文档文本列表。

参数

texts (List[str]) – 要嵌入的文本列表。

返回

嵌入列表，每个文本一个。

返回类型

List[List[float]]

embed_query(text: str) → List[float]

调用Cohere的嵌入端点。

参数

text (str) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

List[float]

embed_with_retry(**kwargs: Any) → Any

使用tenacity重试嵌入调用。

参数

kwargs (Any) -

返回类型

任何

使用CohereEmbeddings的示例

• Cohere重排器