跳到主要内容

内容审核

DeepSeek V3 中英对照 OpenAI Moderation

简介​

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

前提条件​

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

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

自动配置​

Spring AI 为 OpenAI 的 Text-to-Speech 客户端提供了 Spring Boot 自动配置。要启用此功能，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
groovy
提示

请参考 依赖管理 部分，将 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.openai.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。text-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("text-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());
}
java

手动配置​

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

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

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

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

请参考依赖管理部分，将 Spring AI BOM 添加到你的构建文件中。

接下来，创建一个 OpenAiModerationModel：

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

OpenAiModerationModel openAiModerationModel = new OpenAiModerationModel(this.openAiModerationApi);

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

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

示例代码​

OpenAiModerationModelIT 测试提供了一些关于如何使用该库的通用示例。你可以参考这个测试以获取更详细的使用示例。