版本：2.0.1

本站内所有文档均为中英对照文档，点击中文可以显示英文。此提醒连续关闭5次后，将不再显示。

文档内容来源于 spring.io，由 springdoc.tech 翻译，版权归属于 SPRING.IO (Broadcom. Inc)。可供个人学习、研究，未经许可，不得进行转载或用于商业行为。

内容审核

QWen 3.8 中英对照 OpenAI Moderation

介绍

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

备注

从版本 2.0.0-M5 开始，Spring AI 在所有 OpenAI 模型的底层均使用官方的 openai-java SDK。该迁移过程预计是无缝的，并且对于现有 OpenAI API 属性和构建器的用户没有任何破坏性变更。如果您发现任何问题，请通过 Spring AI GitHub Issues 向我们报告。

前置条件

创建 OpenAI 账户并获取 API 密钥。您可以在 OpenAI 注册页面注册，并在 API 密钥页面生成 API 密钥。
将 spring-ai-openai 依赖项添加到项目的构建文件中。更多信息，请参阅 Dependency Management 部分。

自动配置

备注

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

Spring AI 为 OpenAI Moderation Model 提供了 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	连接的 URL	api.openai.com
spring.ai.openai.api-key	API Key	-
spring.ai.openai.organization-id	可选地，您可以指定用于 API 请求的组织。	-
spring.ai.openai.project-id	可选地，您可以指定用于 API 请求的项目。	-
spring.ai.openai.timeout	OpenAI 客户端的请求超时时间。	60 秒
spring.ai.openai.max-retries	OpenAI 客户端的最大重试次数。	3
spring.ai.openai.proxy	OpenAI 客户端的代理设置。	-
spring.ai.openai.custom-headers	添加到 OpenAI 客户端请求中的自定义 HTTP 头。	空
spring.ai.openai.connection-pool-metrics-enabled	是否为底层 OkHttp 客户端启用连接池指标。	false

提示

对于属于多个组织（或通过其遗留用户 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	要连接的 URL	api.openai.com
spring.ai.openai.moderation.api-key	API Key	-
spring.ai.openai.moderation.organization-id	可选指定用于 API 请求的组织。	-
spring.ai.openai.moderation.project-id	可选指定用于 API 请求的项目。	-
spring.ai.openai.moderation.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 为前缀的属性均可在运行时进行覆盖。

运行时选项

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);

自定义 HTTP 客户端

Spring AI 底层使用官方的 openai-java SDK，并通过由 SpringAiOpenAiHttpClient.Builder 构建的自定义 OkHttp 客户端来配置其 HTTP 传输层。你可以通过暴露一个或多个 OpenAiHttpClientBuilderCustomizer Bean 来在底层 OkHttpClient 创建之前拦截该 Builder。每个 customizer 都会接收所有 OpenAI 模型（chat、embedding、image、audio、moderation）所使用的同一个 Builder，因此自定义操作会统一生效。

@FunctionalInterface
public interface OpenAiHttpClientBuilderCustomizer {
    void customize(SpringAiOpenAiHttpClient.Builder builder);
}

典型的使用场景包括：

注册 OkHttp Interceptor 实例（如：身份验证、传播头、自定义日志）；
更换调度器（dispatcher）的 ExecutorService（例如，将异步 I/O 路由到虚拟线程）；
通过 Builder 配置代理、SSL、主机名验证或连接池大小。

当存在多个 customizer 时，它们在 Spring AI 自身的默认配置之后，按照 @Order / Ordered 的顺序应用，从而确保用户代码优先生效。

通过 OpenAi*Model.Builder 手动配置模型时，也可以使用相同的钩子：

var chatModel = OpenAiChatModel.builder()
    .options(OpenAiChatOptions.builder().model("gpt-4o").build())
    .httpClientBuilderCustomizer(myCustomizer)
    .build();

示例代码

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

介绍​

前置条件​

自动配置​

审核属性​

连接属性​

配置属性​

运行时选项​

手动配置​

自定义 HTTP 客户端​

示例代码​

介绍