CohereEmbeddingFunction

CohereEmbeddingFunction 是 pymilvus 中的一个类，使用 Cohere 嵌入模型将文本编码为嵌入，以支持在 Milvus 中进行嵌入检索。

python

pymilvus.model.dense.CohereEmbeddingFunction

构造函数

构造一个适用于常见用例的 CohereEmbeddingFunction。

python

CohereEmbeddingFunction(
    model_name: str = "embed-english-light-v3.0",
    api_key: Optional[str] = None,
    input_type: str = "search_document",
    embedding_types: Optional[List[str]] = None,
    truncate: Optional[str] = None,
    **kwargs
)

参数：

• model_name (string)

  用于编码的 Cohere 嵌入模型名称。您可以指定任何可用的 Cohere 嵌入模型名称，例如 embed-english-v3.0、embed-multilingual-v3.0 等。如果您未指定此参数，将使用 embed-english-light-v3.0。有关可用模型的列表，请参见 Embed。

• api_key (string)

  用于访问 Cohere API 的 API 密钥。

• input_type (string)

  传递给模型的输入类型。嵌入模型 v3 及更高版本需要此参数。

  • "search_document"：用于存储在向量 Database 中、面向搜索用例的嵌入。

  • "search_query"：用于对向量 DB 执行搜索查询时的嵌入，以查找相关文档。

  • "classification"：用于传递给文本分类器的嵌入。

  • "clustering"：用于经过聚类算法处理的嵌入。

• embedding_types (List[str])

  您希望返回的嵌入类型。此参数非必需，默认值为 None，此时返回 Embed Floats 响应类型。目前，您只能为此参数指定单个值。可选值如下：

  • "float"：当您希望返回默认的浮点嵌入时使用此值。对所有模型均有效。

  • "binary"：当您希望返回有符号二进制嵌入时使用此值。仅对 v3 模型有效。

  • "ubinary"：当您希望返回无符号二进制嵌入时使用此值。仅对 v3 模型有效。

• truncate (string)

  可选值为 NONE|START|END，用于指定 API 如何处理超过最大 token 长度的输入。

  传入 START 将丢弃输入的开头部分。END 将丢弃输入的末尾部分。在这两种情况下，都会持续丢弃输入内容，直到剩余输入恰好等于该模型的最大输入 token 长度。

  如果选择 NONE，当输入超过最大输入 token 长度时，将返回错误。

  默认值：END

• kwargs

  允许在模型初始化时传递其他关键字参数。更多信息，请参见 Embed。

示例

python

from pymilvus.model.dense import CohereEmbeddingFunction

cohere_ef = CohereEmbeddingFunction(
    model_name="embed-english-light-v3.0",
    api_key="YOUR_COHERE_API_KEY",
    input_type="search_document",
    embedding_types=["float"]
)