稽核
引言
Spring AI 支援 OpenAI 的稽核模型，該模型可用於檢測文字中潛在有害或敏感的內容。請遵循此指南，獲取更多關於 OpenAI 稽核模型的資訊。
前提條件
-
建立 OpenAI 賬戶並獲取 API 金鑰。您可以在OpenAI 註冊頁面註冊，並在API Keys 頁面生成 API 金鑰。
-
將
spring-ai-openai依賴新增到專案的構建檔案中。有關更多資訊，請參閱依賴管理章節。
自動配置
|
Spring AI 自動配置、starter 模組的構件名稱發生了重大變化。請參閱升級注意事項獲取更多資訊。 |
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。
屬性 |
描述 |
預設值 |
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.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.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()
.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 依賴新增到專案的 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("text-moderation-latest")
.build();
ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);
