Oracle云基础设施 (OCI) GenAI嵌入
OCI GenAI服务 提供按需模型或专用AI集群的文本嵌入。
自动配置
Spring AI为OCI GenAI嵌入客户端提供Spring Boot自动配置。要启用它，请将以下依赖项添加到您项目的Maven pom.xml文件中
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-oci-genai-spring-boot-starter</artifactId>
</dependency>或到您的Gradle build.gradle构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-oci-genai-spring-boot-starter'
}| 请参考依赖管理部分，将Spring AI BOM添加到您的构建文件中。 |
嵌入属性
前缀spring.ai.oci.genai是配置与OCI GenAI连接的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.oci.genai.authenticationType |
用于向OCI进行身份验证的身份验证类型。可以是 |
file |
spring.ai.oci.genai.region |
OCI服务区域。 |
us-chicago-1 |
spring.ai.oci.genai.tenantId |
OCI租户OCID，在使用 |
- |
spring.ai.oci.genai.userId |
OCI用户OCID，在使用 |
- |
spring.ai.oci.genai.fingerprint |
私钥指纹，在使用 |
- |
spring.ai.oci.genai.privateKey |
私钥内容，在使用 |
- |
spring.ai.oci.genai.passPhrase |
可选私钥密码，在使用 |
- |
spring.ai.oci.genai.file |
OCI配置文件的路径。在使用 |
<用户主目录>/.oci/config |
spring.ai.oci.genai.profile |
OCI配置文件名称。在使用 |
DEFAULT |
spring.ai.oci.genai.endpoint |
可选OCI GenAI端点。 |
- |
前缀spring.ai.oci.genai.embedding是配置OCI GenAI的EmbeddingModel实现的属性前缀
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.oci.genai.embedding.enabled |
启用OCI GenAI嵌入模型。 |
true |
spring.ai.oci.genai.embedding.compartment |
模型隔间OCID。 |
- |
spring.ai.oci.genai.embedding.servingMode |
要使用的模型服务模式。可以是 |
on-demand |
spring.ai.oci.genai.embedding.truncate |
如果文本超过嵌入上下文，如何截断文本。可以是 |
END |
spring.ai.oci.genai.embedding.model |
用于嵌入的模型或模型端点。 |
- |
所有以spring.ai.oci.genai.embedding.options为前缀的属性都可以在运行时通过向EmbeddingRequest调用添加特定于请求的运行时选项来覆盖。 |
运行时选项
OCIEmbeddingOptions提供嵌入请求的配置信息。OCIEmbeddingOptions提供了一个构建器来创建选项。
在启动时，使用OCIEmbeddingOptions构造函数设置所有嵌入请求使用的默认选项。在运行时，您可以通过将OCIEmbeddingOptions实例与您的EmbeddingRequest请求一起传递来覆盖默认选项。
例如，要覆盖特定请求的默认模型名称
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实现，您可以将其注入到您的类中。这是一个使用EmbeddingModel实现的简单@Controller类的示例。
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文件中
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-oci-genai-openai</artifactId>
</dependency>或到您的Gradle build.gradle构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-oci-genai-openai'
}| 请参考依赖管理部分，将Spring AI BOM添加到您的构建文件中。 |
接下来，创建一个OCIEmbeddingModel实例并使用它来计算两个输入文本之间的相似性
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?"));
