Oracle Cloud Infrastructure （OCI） GenAI 嵌入

OCI GenAI 服务提供带有按需模型或专用 AI 集群的文本嵌入。spring-doc.cn

OCI 嵌入模型页和 OCI 文本嵌入页提供了有关在 OCI 上使用和托管嵌入模型的详细信息。spring-doc.cn

先决条件

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。spring-doc.cn

为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。spring-doc.cn

自动配置

Spring AI 为 OCI GenAI 嵌入客户端提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-oci-genai-spring-boot-starter</artifactId>
</dependency>

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-oci-genai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

前缀是用于配置与 OCI GenAI 的连接的属性前缀。spring.ai.oci.genaispring-doc.cn

财产 描述 违约

spring.ai.oci.genai.authenticationTypespring-doc.cn

验证到 OCI 时要使用的验证类型。可能是 、 、 或 。fileinstance-principalworkload-identitysimplespring-doc.cn

文件spring-doc.cn

spring.ai.oci.genai.regionspring-doc.cn

OCI 服务区域。spring-doc.cn

US-芝加哥-1spring-doc.cn

spring.ai.oci.genai.tenantIdspring-doc.cn

OCI 租户 OCID，使用验证进行验证时使用。simplespring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.userIdspring-doc.cn

OCI 用户 OCID，使用验证进行验证时使用。simplespring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.fingerprint 的spring-doc.cn

私钥指纹，使用身份验证进行身份验证时使用。simplespring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.privateKeyspring-doc.cn

私钥内容，使用身份验证进行身份验证时使用。simplespring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.passPhrasespring-doc.cn

可选的私钥密码，在使用 auth 进行身份验证时使用，并使用受密码保护的私钥。simplespring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.文件spring-doc.cn

OCI 配置文件的路径。使用 auth 进行身份验证时使用。filespring-doc.cn

<用户的主目录>/.oci/configspring-doc.cn

spring.ai.oci.genai.profilespring-doc.cn

OCI 概要文件名称。使用 auth 进行身份验证时使用。filespring-doc.cn

违约spring-doc.cn

spring.ai.oci.genai.endpointspring-doc.cn

可选的 OCI GenAI 端点。spring-doc.cn

-spring-doc.cn

前缀是为 OCI GenAI 配置实施的属性前缀spring.ai.oci.genai.embeddingEmbeddingModelspring-doc.cn

财产 描述 违约

spring.ai.oci.genai.embedding.enabledspring-doc.cn

启用 OCI GenAI 嵌入模型。spring-doc.cn

真spring-doc.cn

spring.ai.oci.genai.embedding.compartmentspring-doc.cn

模型区间 OCID。spring-doc.cn

-spring-doc.cn

spring.ai.oci.genai.embedding.servingModespring-doc.cn

要使用的模型服务模式。可能是 ， 或 .on-demanddedicatedspring-doc.cn

按需spring-doc.cn

spring.ai.oci.genai.embedding.truncatespring-doc.cn

如果文本超过嵌入上下文，如何截断文本。可能是 ， 或 .STARTENDspring-doc.cn

结束spring-doc.cn

spring.ai.oci.genai.embedding.modelspring-doc.cn

用于嵌入的模型或模型终端节点。spring-doc.cn

-spring-doc.cn
通过向调用添加特定于请求的运行时选项，可以在运行时覆盖所有前缀为 的属性。spring.ai.oci.genai.embedding.optionsEmbeddingRequest

运行时选项

这提供了嵌入请求的配置信息。 这提供了一个构建器来创建选项。OCIEmbeddingOptionsOCIEmbeddingOptionsspring-doc.cn

在开始时，使用构造函数设置用于所有嵌入请求的默认选项。 在运行时，您可以通过将实例与 your 传递给请求来覆盖默认选项。OCIEmbeddingOptionsOCIEmbeddingOptionsEmbeddingRequestspring-doc.cn

例如，要覆盖特定请求的默认模型名称：spring-doc.cn

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OCIEmbeddingOptions.builder()
            .withModel("my-other-embedding-model")
            .build()
));

示例代码

这将创建一个可以注入到类中的实现。 下面是一个使用该实现的简单类的示例。EmbeddingModel@ControllerEmbeddingModelspring-doc.cn

spring.ai.oci.genai.embedding.model=<your model>
spring.ai.oci.genai.embedding.compartment=<your model compartment>
@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您不想使用 Spring Boot 自动配置，则可以在应用程序中手动配置。 为此，请将依赖项添加到项目的 Maven 文件中：OCIEmbeddingModelspring-oci-genai-openaipom.xmlspring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-oci-genai-openai</artifactId>
</dependency>

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-oci-genai-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个实例并使用它来计算两个输入文本之间的相似性：OCIEmbeddingModelspring-doc.cn

final String EMBEDDING_MODEL = "cohere.embed-english-light-v2.0";
final String CONFIG_FILE = Paths.get(System.getProperty("user.home"), ".oci", "config").toString();
final String PROFILE = "DEFAULT";
final String REGION = "us-chicago-1";
final String COMPARTMENT_ID = System.getenv("OCI_COMPARTMENT_ID");

var authProvider = new ConfigFileAuthenticationDetailsProvider(
		this.CONFIG_FILE, this.PROFILE);
var aiClient = GenerativeAiInferenceClient.builder()
    .region(Region.valueOf(this.REGION))
    .build(this.authProvider);
var options = OCIEmbeddingOptions.builder()
    .withModel(this.EMBEDDING_MODEL)
    .withCompartment(this.COMPARTMENT_ID)
    .withServingMode("on-demand")
    .build();
var embeddingModel = new OCIEmbeddingModel(this.aiClient, this.options);
List<Double> embedding = this.embeddingModel.embed(new Document("How many provinces are in Canada?"));