此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！spring-doc.cn

适度

介绍

Spring AI 支持 OpenAI 的审核模型，该模型允许您检测文本中可能有害或敏感的内容。 请按照本指南了解有关 OpenAI 审核模型的更多信息。spring-doc.cn

先决条件

  1. 创建 OpenAI 帐户并获取 API 密钥。您可以在 OpenAI 注册页面注册并在 API 密钥页面上生成 API 密钥。spring-doc.cn

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

自动配置

Spring AI 为 OpenAI 文本转语音客户端提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

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

或发送到您的 Gradle 构建文件：build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

审核属性

连接属性

前缀spring.ai.openai用作允许您连接到 OpenAI 的属性前缀。spring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.openai.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

api.openai.comspring-doc.cn

spring.ai.openai.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.openai.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

-spring-doc.cn
对于属于多个组织（或通过其旧版用户 API 密钥访问其项目）的用户，您可以选择指定用于 API 请求的组织和项目。 这些 API 请求的使用量将计为指定组织和项目的使用量。

配置属性

前缀 spring.ai.openai.moderation 用作配置 OpenAI 审核模型的属性前缀。spring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.openai.moderation.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

api.openai.comspring-doc.cn

spring.ai.openai.moderation.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.openai.moderation.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.moderation.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

-spring-doc.cn

spring.ai.openai.moderation.options.modelspring-doc.cn

用于审核的模型的 ID。spring-doc.cn

文本审核最新spring-doc.cn
您可以覆盖通用的 、 和 属性。 、 和 属性（如果已设置）优先于公共属性。 如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。spring.ai.openai.base-urlspring.ai.openai.api-keyspring.ai.openai.organization-idspring.ai.openai.project-idspring.ai.openai.moderation.base-urlspring.ai.openai.moderation.api-keyspring.ai.openai.moderation.organization-idspring.ai.openai.moderation.project-id
所有前缀为 的属性都可以在运行时覆盖。spring.ai.openai.moderation.options

运行时选项

OpenAiModerationOptions 类提供了在发出审核请求时要使用的选项。 在启动时，将使用 spring.ai.openai.moderation 指定的选项，但您可以在运行时覆盖这些选项。spring-doc.cn

例如：spring-doc.cn

OpenAiModerationOptions moderationOptions = OpenAiModerationOptions.builder()
    .withModel("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());
}

手动配置

将依赖项添加到项目的 Maven 文件中：spring-ai-openaipom.xmlspring-doc.cn

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

或发送到您的 Gradle 构建文件：build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个 OpenAiModerationModel：spring-doc.cn

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

OpenAiModerationModel openAiModerationModel = new OpenAiModerationModel(this.openAiModerationApi);

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

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

示例代码

该测试提供了一些有关如何使用该库的一般示例。您可以参考此测试以获取更详细的使用示例。OpenAiModerationModelITspring-doc.cn