Spring AI 使用 OpenAI ​内容审核

简介

Spring AI 支持 OpenAI 的内容审核模型，该模型可用于检测文本中潜在的有害或敏感内容。有关 OpenAI 内容审核模型的更多信息，请参阅本指南。

前提条件

1. 创建 OpenAI 账户并获取 API 密钥。你可以在 OpenAI 注册页面注册账户，并在 API 密钥页面生成 API 密钥。

2. 将 spring-ai-openai 依赖添加到项目的构建文件中。更多信息请参阅依赖管理章节。

自动配置

Spring AI 的自动配置、启动器模块的构件名称发生了重大变更。更多详情请参阅升级说明。

Spring AI 为 OpenAI 内容审核模型提供了 Spring Boot 自动配置。如需启用该功能，请将以下依赖添加到项目的 Maven pom.xml 文件中：

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

或添加到你的 Gradle build.gradle 构建文件中：

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

请参阅依赖管理章节，将 Spring AI BOM 添加到你的构建文件中。

内容审核配置属性

连接属性

使用 spring.ai.openai 作为属性前缀，用于配置 OpenAI 的连接信息。

对于归属多个组织的用户（或通过旧版用户 API 密钥访问项目的用户），可按需指定 API 请求使用的组织和项目。此类 API 请求的使用量将计入指定的组织和项目中。

配置属性

现在通过以 spring.ai.model.moderation 为前缀的顶级属性配置启用或禁用嵌入自动配置。

启用方式：spring.ai.model.moderation=openai（默认启用）

禁用方式：spring.ai.model.moderation=none（或任何不等于 openai 的值）

该变更用于支持多模型的配置。

使用 spring.ai.openai.moderation 作为属性前缀，用于配置 OpenAI 内容审核模型。

你可以覆盖通用的 spring.ai.openai.base-url、spring.ai.openai.api-key、spring.ai.openai.organization-id 和 spring.ai.openai.project-id 属性。若设置了 spring.ai.openai.moderation.base-url、spring.ai.openai.moderation.api-key、spring.ai.openai.moderation.organization-id 和 spring.ai.openai.moderation.project-id 属性，其优先级将高于通用属性。如果你希望为不同模型和不同模型端点使用不同的 OpenAI 账户，该配置会非常实用。

所有以 spring.ai.openai.moderation.options 为前缀的属性都可以在运行时覆盖。

运行时选项

OpenAiModerationOptions 类提供了发起内容审核请求时可配置的选项。应用启动时，会使用 spring.ai.openai.moderation 指定的配置，你也可以在运行时覆盖这些配置。

示例：

OpenAiModerationOptions moderationOptions = OpenAiModerationOptions.builder()
    .model("omni-moderation-latest")
    .build();

ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = openAiModerationModel.call(this.moderationPrompt);

// 获取内容审核结果
Moderation moderation = moderationResponse.getResult().getOutput();

// 打印基础信息
System.out.println("审核 ID: " + moderation.getId());
System.out.println("使用的模型: " + moderation.getModel());

// 获取审核结果（通常仅有一个结果，返回类型为列表）
for (ModerationResult result : moderation.getResults()) {
    System.out.println("\n审核结果:");
    System.out.println("是否标记违规: " + result.isFlagged());

    // 获取违规分类
    Categories categories = this.result.getCategories();
    System.out.println("\n违规分类:");
    System.out.println("性暗示: " + categories.isSexual());
    System.out.println("仇恨言论: " + categories.isHate());
    System.out.println("骚扰: " + categories.isHarassment());
    System.out.println("自残: " + categories.isSelfHarm());
    System.out.println("涉及未成年人的性内容: " + categories.isSexualMinors());
    System.out.println("仇恨威胁: " + categories.isHateThreatening());
    System.out.println("暴力血腥: " + categories.isViolenceGraphic());
    System.out.println("自残意图: " + categories.isSelfHarmIntent());
    System.out.println("自残指导: " + categories.isSelfHarmInstructions());
    System.out.println("骚扰威胁: " + categories.isHarassmentThreatening());
    System.out.println("暴力: " + categories.isViolence());

    // 获取分类评分
    CategoryScores scores = this.result.getCategoryScores();
    System.out.println("\n分类评分:");
    System.out.println("性暗示: " + scores.getSexual());
    System.out.println("仇恨言论: " + scores.getHate());
    System.out.println("骚扰: " + scores.getHarassment());
    System.out.println("自残: " + scores.getSelfHarm());
    System.out.println("涉及未成年人的性内容: " + scores.getSexualMinors());
    System.out.println("仇恨威胁: " + scores.getHateThreatening());
    System.out.println("暴力血腥: " + scores.getViolenceGraphic());
    System.out.println("自残意图: " + scores.getSelfHarmIntent());
    System.out.println("自残指导: " + scores.getSelfHarmInstructions());
    System.out.println("骚扰威胁: " + scores.getHarassmentThreatening());
    System.out.println("暴力: " + scores.getViolence());
}

手动配置

将 spring-ai-openai 依赖添加到项目的 Maven pom.xml 文件中：

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

或添加到你的 Gradle build.gradle 构建文件中：

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

请参阅依赖管理章节，将 Spring AI BOM 添加到你的构建文件中。

接下来，创建 OpenAiModerationModel 实例：

OpenAiModerationApi openAiModerationApi = new OpenAiModerationApi(System.getenv("OPENAI_API_KEY"));

OpenAiModerationModel openAiModerationModel = new OpenAiModerationModel(this.openAiModerationApi);

OpenAiModerationOptions moderationOptions = OpenAiModerationOptions.builder()
    .model("omni-moderation-latest")
    .build();

ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);

示例代码

OpenAiModerationModelIT 测试类提供了一些使用该库的通用示例。你可以参考该测试类获取更详细的使用示例。