審核

簡介

Spring AI 支援 OpenAI 的審核模型，讓您可以偵測文字中潛在的有害或敏感內容。請參閱此指南以取得關於 OpenAI 審核模型的更多資訊。

先決條件

  1. 建立一個 OpenAI 帳戶並取得 API 金鑰。您可以在 OpenAI 註冊頁面 註冊，並在 API 金鑰頁面 產生 API 金鑰。

  2. 將 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>

或您的 Gradle build.gradle 建置檔案

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
請參閱 依賴管理 章節，將 Spring AI BOM 新增至您的建置檔案。

審核屬性

連線屬性

前綴 spring.ai.openai 用作屬性前綴，讓您可以連線到 OpenAI。

屬性

描述

預設值

spring.ai.openai.base-url

要連線的 URL

api.openai.com

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

api.openai.com

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

ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);

範例程式碼

OpenAiModerationModelIT 測試提供了一些關於如何使用此程式庫的通用範例。您可以參考此測試以取得更詳細的使用範例。