获取最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

Oracle Cloud Infrastructure (OCI) 生成式AI嵌入

OCI 生成式AI服务 提供了按需模型的文本嵌入，或专用AI集群。spring-doc.cadn.net.cn

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

前提条件

添加仓库和BOM

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

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

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 OCI GenAI 嵌入式客户端提供了 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 构建脚本文件中。spring-doc.cadn.net.cn

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

嵌入属性

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

属性 描述 默认

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

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

文件spring-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

OCI租户OCID，用于与simple认证方式一起验证时。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

用户主目录下的/.oci/configspring-doc.cadn.net.cn

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

OCI配置文件名。用于与file认证方式一起进行身份验证时使用。spring-doc.cadn.net.cn

DEFAULTspring-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

属性 描述 默认

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

ENDspring-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 构建脚本文件中。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?"));