OpenAI

适度
介绍
Spring AI 支持 OpenAI 的审核模型，该模型可让您检测文本中潜在的有害或敏感内容。请参阅本指南，了解有关 OpenAI 审核模型的更多信息。

先决条件
创建 OpenAI 帐户并获取 API 密钥。您可以在OpenAI 注册页面注册，并在API 密钥页面生成 API 密钥。

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

自动配置
Spring AI 自动配置和启动模块的构件名称发生了重大变化。请参阅升级说明了解更多信息。

Spring AI 为 OpenAI Moderation 模型提供了 Spring Boot 自动配置功能。要启用此功能，请将以下依赖项添加到项目的 Mavenpom.xml文件中：

dependencies {
implementation ‘org.springframework.ai:spring-ai-starter-model-openai’
}
请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
适度属性
连接属性
前缀 spring.ai.openai 用作允许您连接到 OpenAI 的属性前缀。

财产

描述

默认

spring.ai.openai.base-url

要连接的 URL

api.openai.com

spring.ai.openai.api密钥

API 密钥

-

spring.ai.openai.organization-id

您可以选择指定用于 API 请求的组织。

-

spring.ai.openai.项目编号

您可以选择指定用于 API 请求的项目。

-

对于属于多个组织（或通过其旧版用户 API 密钥访问其项目）的用户，您可以选择指定 API 请求所针对的组织和项目。这些 API 请求的使用量将计入指定组织和项目的使用量。
配置属性
现在可以通过带有前缀的顶级属性来配置嵌入自动配置的启用和禁用spring.ai.model.moderation。

要启用，spring.ai.model.moderation=openai（默认启用）

要禁用，spring.ai.model.moderation=none（或任何与 openai 不匹配的值）

进行此更改是为了允许配置多个模型。

前缀 spring.ai.openai.moderation 用作配置 OpenAI 调节模型的属性前缀。

财产

描述

默认

spring.ai.model.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.项目 ID

您可以选择指定用于 API 请求的项目。

-

spring.ai.openai.moderation.options.model

用于审核的模型的 ID。

文本审核最新

您可以覆盖通用的spring.ai.openai.base-url、spring.ai.openai.api-key和属性。spring.ai.openai.organization-id如果设置了、和属性，则它们优先于通用属性。如果您想为不同的模型和不同的模型端点使用不同的 OpenAI 帐户，这将非常有用。 spring.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 指定的选项，但您可以在运行时覆盖这些选项。

例如：

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文件：

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(“text-moderation-latest”)
.build();

ModerationPrompt moderationPrompt = new ModerationPrompt(“Text to be moderated”, this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);
示例代码
该OpenAiModerationModelIT测试提供了一些如何使用该库的常规示例。您可以参考此测试以获取更详细的使用示例。