|
此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！ |
适度
介绍
Spring AI 支持 OpenAI 的审核模型，该模型允许您检测文本中可能有害或敏感的内容。 请按照本指南了解有关 OpenAI 审核模型的更多信息。
先决条件
-
创建 OpenAI 帐户并获取 API 密钥。您可以在 OpenAI 注册页面注册，并在 API 密钥页面上生成 API 密钥。
-
添加
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>或发送到您的 Gradlebuild.gradlebuild 文件：
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
审核属性
连接属性
前缀spring.ai.openai用作允许您连接到 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.openai.moderation 用作配置 OpenAI 审核模型的属性前缀。
财产 |
描述 |
违约 |
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.options.model |
用于审核的模型的 ID。 |
文本审核最新 |
您可以覆盖常见的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());
}手动配置
添加spring-ai-openai依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件：
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参阅 Dependency Management 部分，将 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);