跳到主要内容

内容审核

Deepseek 3.2 中英对照 OpenAI Moderation

引言​

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

前提条件​

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

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

自动配置​

备注

Spring AI 的自动配置和 starter 模块的 artifact 名称发生了重大变化。更多信息请参阅 升级说明。

Spring AI为OpenAI Moderation模型提供了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。

属性描述默认值
spring.ai.openai.base-url连接的 URLapi.openai.com
spring.ai.openai.api-keyAPI 密钥-
spring.ai.openai.organization-id可选配置，用于指定 API 请求所使用的组织。-
spring.ai.openai.project-id可选配置，用于指定 API 请求所使用的项目。-

:::提示
对于属于多个组织（或通过其旧版用户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.model.moderation启用 Moderation 模型openai
spring.ai.openai.moderation.base-url连接的目标 URLapi.openai.com
spring.ai.openai.moderation.api-keyAPI 密钥-
spring.ai.openai.moderation.organization-id可选，可以指定用于 API 请求的组织。-
spring.ai.openai.moderation.project-id可选，可以指定用于 API 请求的项目。-
spring.ai.openai.moderation.options.model用于内容审核的模型 ID。omni-moderation-latest
备注

你可以覆盖通用的 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);

// Access the moderation results
Moderation moderation = moderationResponse.getResult().getOutput();

// Print general information
System.out.println("Moderation ID: " + moderation.getId());
System.out.println("Model used: " + moderation.getModel());

// Access the moderation results (there's usually only one, but it's a list)
for (ModerationResult result : moderation.getResults()) {
    System.out.println("\nModeration Result:");
    System.out.println("Flagged: " + result.isFlagged());

    // Access categories
    Categories categories = this.result.getCategories();
    System.out.println("\nCategories:");
    System.out.println("Sexual: " + categories.isSexual());
    System.out.println("Hate: " + categories.isHate());
    System.out.println("Harassment: " + categories.isHarassment());
    System.out.println("Self-Harm: " + categories.isSelfHarm());
    System.out.println("Sexual/Minors: " + categories.isSexualMinors());
    System.out.println("Hate/Threatening: " + categories.isHateThreatening());
    System.out.println("Violence/Graphic: " + categories.isViolenceGraphic());
    System.out.println("Self-Harm/Intent: " + categories.isSelfHarmIntent());
    System.out.println("Self-Harm/Instructions: " + categories.isSelfHarmInstructions());
    System.out.println("Harassment/Threatening: " + categories.isHarassmentThreatening());
    System.out.println("Violence: " + categories.isViolence());

    // Access category scores
    CategoryScores scores = this.result.getCategoryScores();
    System.out.println("\nCategory Scores:");
    System.out.println("Sexual: " + scores.getSexual());
    System.out.println("Hate: " + scores.getHate());
    System.out.println("Harassment: " + scores.getHarassment());
    System.out.println("Self-Harm: " + scores.getSelfHarm());
    System.out.println("Sexual/Minors: " + scores.getSexualMinors());
    System.out.println("Hate/Threatening: " + scores.getHateThreatening());
    System.out.println("Violence/Graphic: " + scores.getViolenceGraphic());
    System.out.println("Self-Harm/Intent: " + scores.getSelfHarmIntent());
    System.out.println("Self-Harm/Instructions: " + scores.getSelfHarmInstructions());
    System.out.println("Harassment/Threatening: " + scores.getHarassmentThreatening());
    System.out.println("Violence: " + 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 测试提供了一些关于如何使用该库的通用示例。你可以参考这个测试来获取更详细的使用示例。