CohereEmbeddings#

class langchain_cohere.embeddings.CohereEmbeddings[source]#

基础类：BaseModel, Embeddings

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

了解更多关于我们的信息，请访问 https://cohere.com 和 https://huggingface.co/CohereForAI

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

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

API密钥可在https://cohere.com上获取 - 注册是免费的，试用API密钥与此实现兼容。

Basic Example:

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][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param async_client: Any [Required]#: Cohere 异步客户端。

param base_url: str | None = None#: 覆盖默认的Cohere API URL。

param client: Any [Required]#: Cohere 客户端。

param cohere_api_key: SecretStr | None [Optional]#

param embedding_types: Sequence[str] = ['float']#: 指定您想要获取的嵌入类型

param max_retries: int = 3#: 生成时的最大重试次数。

param model: str | None = None#: 使用的模型名称。必须指定模型名称。

param request_timeout: float | None = None#: Cohere API请求的超时时间（以秒为单位）。

param truncate: str | None = None#: 从开始或结束处截断过长的嵌入（“NONE”|“START”|“END”）

param user_agent: str = 'langchain:partner'#: 发出请求的应用程序的标识符。

async aembed(texts: List[str], *, input_type: Literal['search_document', 'search_query', 'classification', 'clustering', 'image'] | Any | None = None) → List[List[float]][source]#

Parameters:

文本 (列表[字符串])
input_type (Literal['search_document', 'search_query', 'classification', 'clustering', 'image'] | ~typing.Any | None)

Return type:

列表[列表[float]]

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

异步调用Cohere的嵌入端点。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表，每个文本对应一个。
Return type:: 列表[列表[float]]

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

异步调用Cohere的嵌入端点。

Parameters:: 文本 (str) – 要嵌入的文本。
Returns:: 文本的嵌入。
Return type:: 列表[float]

aembed_with_retry(**kwargs: Any) → Any[source]#

使用tenacity重试嵌入调用。

Parameters:: kwargs (任意)
Return type:: 任何

embed(texts: List[str], *, input_type: Literal['search_document', 'search_query', 'classification', 'clustering', 'image'] | Any | None = None) → List[List[float]][来源]#

Parameters:

文本 (列表[字符串])
input_type (Literal['search_document', 'search_query', 'classification', 'clustering', 'image'] | ~typing.Any | None)

Return type:

列表[列表[float]]

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

嵌入文档文本列表。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表，每个文本对应一个。
Return type:: 列表[列表[float]]

embed_query(text: str) → List[float][来源]#

调用Cohere的嵌入端点。

Parameters:: 文本 (str) – 要嵌入的文本。
Returns:: 文本的嵌入。
Return type:: 列表[float]

embed_with_retry(**kwargs: Any) → Any[source]#

使用tenacity重试嵌入调用。

Parameters:: kwargs (任意)
Return type:: 任何

使用 CohereEmbeddings 的示例

Cohere reranker