|
此版本仍在开发中，尚未被视为稳定版。为了获取最新的快照版本，请使用Spring AI 1.1.3！ |
审核
简介
Spring AI支持OpenAI的 Moderation模型，该模型可帮助您检测文本中的潜在有害或敏感内容。 请参阅此指南以获取有关OpenAI审核模型的更多信息。
前提条件
-
创建一个OpenAI账户并获取API密钥。您可以在OpenAI注册页面上注册，并在API密钥页面上生成API密钥。
-
将
spring-ai-openai依赖项添加到项目的构建文件中。更多信息，请参阅依赖管理部分。
自动配置
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
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到你的构建文件中。 |
审核属性
连接属性
用于连接到OpenAI的属性前缀为spring.ai.openai。
属性 |
描述 |
默认 |
spring.ai.openai.base-url |
要连接的URL |
|
spring.ai.openai.api-key |
API 密钥 |
- |
spring.ai.openai.organization-id |
您可以选择性地指定用于API请求的组织。 |
- |
spring.ai.openai.project-id |
您可以选择性地指定用于API请求的项目。 |
- |
| 对于属于多个组织（或通过其旧版用户API密钥访问项目）的用户，可选地，您可以指定用于API请求的组织和项目。 来自这些API请求的使用将计为指定组织和项目的使用量。 |
配置属性
|
启用和禁用嵌入式自动配置现在通过带有前缀 要启用，请设置 spring.ai.model.moderation=openai （默认情况下已启用） 要禁用，请设置 spring.ai.model.moderation=none（或任何不匹配openai的值）。 这种修改是为了允许配置多个模型。 |
spring.ai.openai.moderation 前缀用于配置 OpenAI 内容审核模型的属性前缀。
属性 |
描述 |
默认 |
spring.ai.model.moderation |
启用审核模型 |
开源人工智能 |
spring.ai.openai.moderation.base-url |
要连接的URL |
|
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.moderation-path |
用于审核请求的API端点路径。对于具有不同端点结构的OpenAI兼容API非常有用。 |
/v1/moderations |
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);