|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
审核
< Introduction >
Spring AI 支持 OpenAI 的审核模型，该模型可帮助您检测文本中潜在有害或敏感的内容。 请遵循此 指南 以获取更多关于 OpenAI 审核模型的信息。
前置条件
-
创建一个 OpenAI 账户并获取 API 密钥。您可以在 OpenAI 注册页面 进行注册，并在 API 密钥页面 生成 API 密钥。
-
将
spring-ai-openai依赖项添加到项目的构建文件中。更多信息，请参阅 依赖管理 部分。
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
Spring AI 为 OpenAI 审核模型提供了 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。
<property> </property> |
<description> </description> |
默认 |
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 审核模型的属性前缀。
<property> </property> |
<description> </description> |
默认 |
spring.ai.model.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.moderation-path |
用于审核请求的 API 端点路径。适用于具有不同端点结构的 OpenAI 兼容 API。 |
/v1/审核 |
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);