此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

Oracle Cloud Infrastructure (OCI) GenAI 嵌入

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

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

前置条件

添加仓库和BOM

Spring AI 构件发布在 Maven 中央仓库和 Spring Snapshot 仓库中。 请参阅 构件仓库 部分，将这些仓库添加到您的构建系统中。spring-doc.cadn.net.cn

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

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 OCI GenAI Embedding Client 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：spring-doc.cadn.net.cn

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

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

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

嵌入属性

The prefix spring.ai.oci.genai 是配置连接到 OCI GenAI 的属性前缀。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

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

当向OCI进行身份验证时要使用的认证类型。可能的值为file、instance-principal、workload-identity或simple。spring-doc.cadn.net.cn

filespring-doc.cadn.net.cn

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

OCI服务区域。spring-doc.cadn.net.cn

us-chicago-1spring-doc.cadn.net.cn

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

当使用simple认证时使用的OC域租户OCID。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

OCI用户OCID，用于使用simple认证进行身份验证。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.oci.genai.fingerprintspring-doc.cadn.net.cn

私钥指纹，在使用simple认证时用于身份验证。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

私钥内容，在使用simple认证时进行身份验证。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

使用simple认证和带密码保护的私钥时，可选的私钥密码短语。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.oci.genai.filespring-doc.cadn.net.cn

OCI配置文件路径。用于使用file认证进行身份验证。spring-doc.cadn.net.cn

<user’s home directory>/.oci/configspring-doc.cadn.net.cn

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

OCI配置文件名称。在使用file身份验证进行认证时使用。spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

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

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

-spring-doc.cadn.net.cn

嵌入自动配置的启用和禁用现在通过前缀为 spring.ai.model.embedding 的顶层属性进行配置。spring-doc.cadn.net.cn

要启用，请设置 spring.ai.model.embedding=oci-genai（默认已启用）spring-doc.cadn.net.cn

要禁用，请设置 spring.ai.model.embedding=none（或任何不匹配 oci-genai 的值）spring-doc.cadn.net.cn

此更改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.oci.genai.embedding 是用于配置 OCI GenAI 的 EmbeddingModel 实现的属性前缀。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

spring.ai.oci.genai.embedding.enabled（已移除且不再生效）spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

spring.ai.model.embeddingspring-doc.cadn.net.cn

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

oci-genaispring-doc.cadn.net.cn

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

模型隔间OCID。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

要使用的模型服务模式。可能为on-demand，或dedicated。spring-doc.cadn.net.cn

on-demandspring-doc.cadn.net.cn

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

如何在文本超出嵌入上下文时进行截断。可以是 START 或 END。spring-doc.cadn.net.cn

结束spring-doc.cadn.net.cn

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

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

-spring-doc.cadn.net.cn
所有以spring.ai.oci.genai.embedding.options开头的属性可以在运行时通过向EmbeddingRequest调用添加请求特定的运行时选项来覆盖。

运行时选项

OCIEmbeddingOptions 提供嵌入请求的配置信息。 OCIEmbeddingOptions 提供用于创建选项的构建器。spring-doc.cadn.net.cn

在启动时，使用 OCIEmbeddingOptions 构造函数来设置所有嵌入请求的默认选项。 在运行时，您可以通过向 EmbeddingRequest 请求传递一个包含您自定义设置的 OCIEmbeddingOptions 实例来覆盖默认选项。spring-doc.cadn.net.cn

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

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

示例代码

这将创建一个您可以注入到类中的 EmbeddingModel 实现。 下面是一个使用 EmbeddingModel 实现的简单 @Controller 类示例。spring-doc.cadn.net.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 自动配置，可以在应用程序中手动配置OCIEmbeddingModel。 为此，请将spring-oci-genai-openai依赖项添加到项目的 Maven pom.xml文件中：spring-doc.cadn.net.cn

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

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

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

接下来，创建一个 OCIEmbeddingModel 实例，并使用它来计算两个输入文本之间的相似度：spring-doc.cadn.net.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()
    .model(this.EMBEDDING_MODEL)
    .compartment(this.COMPARTMENT_ID)
    .servingMode("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?"));