Method: documents.moderateText

有害なカテゴリと機密情報のカテゴリについてドキュメントを管理します。

HTTP リクエスト

POST https://language.googleapis.com/v2/documents:moderateText

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "document": {
    object (Document)
  },
  "modelVersion": enum (ModelVersion)
}
フィールド
document

object (Document)

必須。入力ドキュメント。
modelVersion

enum (ModelVersion)

省略可。documents.moderateText に使用するモデル バージョン。

レスポンスの本文

ドキュメントの管理のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageCode": string,
  "languageSupported": boolean
}
フィールド
moderationCategories[]

object (ClassificationCategory)

入力ドキュメントを表す有害なカテゴリと機密情報のカテゴリ。
languageCode

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
languageSupported

boolean

言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート方式です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ModelVersion

documents.moderateText に使用するモデル バージョン。

列挙型
MODEL_VERSION_UNSPECIFIED デフォルトのモデル バージョン。
MODEL_VERSION_1 v1 モデルを使用します。このモデルは、指定されていない場合はデフォルトで使用されます。v1 モデルは、各カテゴリの確率（信頼度）スコアのみを返します。
MODEL_VERSION_2 v2 モデルを使用します。v2 モデルは、各カテゴリの確率（信頼度）スコアのみを返します。カテゴリの一部については、重大度スコアも返します。