OCIGenAIEmbeddings#

class langchain_community.embeddings.oci_generative_ai.OCIGenAIEmbeddings[source]#

基础类：BaseModel, Embeddings

OCI嵌入模型。

要进行身份验证，OCI客户端使用以下方法： https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm

认证方法通过auth_type传递，应为以下之一： API_KEY（默认）、SECURITY_TOKEN、INSTANCE_PRINCIPLE、RESOURCE_PRINCIPLE

确保您拥有访问OCI生成式AI服务所需的策略（配置文件/角色）。如果使用了特定的配置配置文件，您必须通过auth_profile传递配置文件的名称（~/.oci/config）。

要使用，您必须提供 compartment id 以及 endpoint url 和 model id 作为构造函数的命名参数。

示例

from langchain.embeddings import OCIGenAIEmbeddings

embeddings = OCIGenAIEmbeddings(
    model_id="MY_EMBEDDING_MODEL",
    service_endpoint="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com",
    compartment_id="MY_OCID"
)

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

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

param auth_profile: str | None = 'DEFAULT'#: 配置文件在 ~/.oci/config 中的名称如果未指定，将使用 DEFAULT

param auth_type: str | None = 'API_KEY'#

认证类型，可能是

API_KEY, SECURITY_TOKEN, INSTANCE_PRINCIPLE, RESOURCE_PRINCIPLE

如果未指定，将使用API_KEY

param batch_size: int = 96#: OCI GenAI 嵌入请求的批量大小。OCI GenAI 每个请求最多可以处理 96 个文本

param compartment_id: str | None = None#: 部门的OCID

param model_id: str | None = None#: 要调用的模型的ID，例如，cohere.embed-english-light-v2.0

param model_kwargs: Dict | None = None#: 传递给模型的关键字参数

param service_endpoint: str | None = None#: 服务端点URL

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

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

异步嵌入搜索文档。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表。
Return type:: 列表[列表[浮点数]]

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

异步嵌入查询文本。

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

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

调用OCIGenAI的嵌入端点。

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

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

调用OCIGenAI的嵌入端点。

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

classmethod validate_environment(values: Dict) → Dict[来源]#

验证环境中是否存在OCI配置和python包。

Parameters:: 值 (字典)
Return type:: 字典

使用 OCIGenAIEmbeddings 的示例