审核

简介

Spring AI 支持 OpenAI 的审核模型，该模型允许您检测文本中可能存在的有害或敏感内容。请遵循此 指南 以获取有关 OpenAI 审核模型的更多信息。

先决条件

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

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

自动配置

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

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

或到您的 Gradle build.gradle 构建文件

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 依赖项管理 部分，以将 Spring AI BOM 添加到您的构建文件。

审核属性

连接属性

前缀 spring.ai.openai 用作属性前缀，可让您连接到 OpenAI。

属性

描述

默认值

spring.ai.openai.base-url

要连接到的 URL

api.openai.com

spring.ai.openai.api-key

API 密钥

-

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

要连接到的 URL

api.openai.com

spring.ai.openai.moderation.api-key

API 密钥

-

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()
    .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());
}

手动配置

将 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()
    .withModel("text-moderation-latest")
    .build();

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

示例代码

OpenAiModerationModelIT 测试提供了一些有关如何使用库的常规示例。您可以参考此测试以获取更详细的使用示例。