Oracle Cloud Infrastructure （OCI） GenAI 嵌入

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

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

先决条件

添加存储库和 BOM

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

为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。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-oci-genai-spring-boot-starter</artifactId>
</dependency>

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-oci-genai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 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-芝加哥-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.fingerprint 的spring-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

可选的私钥密码，在进行身份验证时使用simpleauth 和受 passphrase 保护的私钥。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.oci.genai.文件spring-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

违约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.oci.genai.embedding是配置EmbeddingModelOCI GenAI 实施spring-doc.cadn.net.cn

财产 描述 违约

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

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

真spring-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

按需spring-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

开始时，使用OCIEmbeddingOptionsconstructor 设置用于所有嵌入请求的默认选项。 在运行时，您可以通过传递OCIEmbeddingOptions实例替换为EmbeddingRequest请求。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()
            .withModel("my-other-embedding-model")
            .build()
));

示例代码

这将创建一个EmbeddingModel实现，您可以将其注入到您的类中。 下面是一个简单的示例@Controller类使用EmbeddingModel实现。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依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-oci-genai-openai'
}
请参阅 Dependency Management 部分，将 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()
    .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?"));