ZhiPu AI

ZhiPuAI Embeddings

Spring AI 支持 ZhiPuAI 的文本嵌入模型。ZhiPuAI 的文本嵌入用于衡量文本字符串之间的相关性。嵌入是由浮点数组成的向量（列表）。

两个向量之间的距离反映了它们的相关性：距离小表示高度相关，距离大则表示相关性低。

前提条件（Prerequisites）

您需要创建一个与智谱 AI 对接的 API，以便访问智谱 AI 的语言模型。

在 智普AI 注册界面 创建帐户。

并在API 密钥页面 生成令牌。

Spring AI 扩展项目定义了一个名为 spring.ai.zhipuai.api-key 的配置属性，你需要将其设置为从 zhipu.com 获取的api-key值。

您可以在 application.properties 文件中设置此配置属性：

spring.ai.zhipuai.api-key=<your-zhipuai-api-key>

为了在处理诸如 API 密钥等敏感信息时增强安全性，您可以使用 Spring 表达式语言（SpEL）来引用自定义环境变量：

# In application.yml
spring:
  ai:
    zhipuai:
      api-key: ${ZHIPUAI_API_KEY}

# In your environment or .env file
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>

您也可以在应用程序代码中以编程方式设置此配置：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");

添加存储库和 BOM

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

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

自动配置（Auto-configuration）

Spring AI 为 ZhiPuAI 嵌入模型提供 Spring Boot 自动配置。要启用它，请在项目的 Maven pom.xml文件中添加以下依赖项：

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

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}

嵌入属性（Embedding Properties）

Retry 属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，允许您为 Mistral AI 模型配置 retry 机制。

连接属性（Connection Properties）

前缀是 spring.ai.zhipuai 的属性，用于配置 ZhipuAI 的链接。

配置属性（Configuration Properties）

前缀是 spring.ai.zhipuai.embedding 的属性，用于配置 ZhipuAI 的 EmbeddingModel 实现。

运行时选项（Runtime Options ）

ZhiPuAiEmbeddingOptions.java 提供了嵌入请求的配置信息，并提供了一个构建器来创建这些选项。

默认选项也可以通过配置 spring.ai.zhipuai.embedding.options 属性来进行设置。

在启动时，使用 ZhiPuAiEmbeddingModel 构造函数来设置所有嵌入请求默认使用的选项。在运行时，您可以通过在 EmbeddingRequest 中使用 ZhiPuAiEmbeddingOptions 实例来覆盖这些默认选项。

例如，要为特定请求覆盖默认模型名称：

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        ZhiPuAiEmbeddingOptions.builder()
            .model("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器（Sample Controller）

创建一个新的 Spring Boot 项目，并将 spring-ai-zhipuai 添加到 pom (或 gradle) 依赖项中。

在 src/main/resources 目录下添加 application.properties 文件，以启用和配置 MiniMax Embedding 模型：

spring.ai.zhipuai.api-key=YOUR_API_KEY
spring.ai.zhipuai.embedding.options.model=embedding-2

这将创建一个 ZhiPuAiEmbeddingModel 的实现，你可以将其注入到你的类中。下面是一个简单的 @Controller 类的示例，它使用聊天模型进行文本生成。

@RestController
public class EmbeddingController {

    private final ZhiPuAiEmbeddingModel embeddingModel;

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

    @GetMapping("/v1/embedding")
    public Map<String, Object> embedding(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("embeddings", embeddingModel.embed(message));
    }

}

手动配置（Manual Configuration）

ZhiPuAiEmbeddingModel 实现了 EmbeddingModel , 并使用轻量级 ZhiPuAiApi 客户端连接到 ZhipuAI 服务。

要启用它，添加 spring-ai-zhipuai 依赖到你的项目 Maven pom.xml 文件:

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-zhipuai</artifactId>
</dependency>

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}

接下来，创建一个 ZhiPuAiEmbeddingModel 并将其用于文本嵌入：

var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));

var embeddingModel = new ZhiPuAiEmbeddingModel(api, MetadataMode.EMBED,
                ZhiPuAiEmbeddingOptions.builder()
                        .model("embedding-3")
                        .dimensions(1536)
                        .build());

EmbeddingResponse embeddingResponse = this.embeddingModel
    .embedForResponse(List.of("Hello World", "World is big and salvation is near"));

ZhiPuAiEmbeddingOptions 提供了嵌入请求的配置信息，该选项类提供了 builder () 方法以便轻松创建选项。