Method: documents.moderateText

Ein Dokument wird auf schädliche und sensible Inhalte überprüft.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "document": {
    object (Document)
  },
  "modelVersion": enum (ModelVersion)
}
Felder
document

object (Document)

Pflichtangabe. Das Eingabedokument.
modelVersion

enum (ModelVersion)

Optional. Die Modellversion, die für „documents.moderateText“ verwendet werden soll.

Antworttext

Die Antwortnachricht für die Dokumentmoderation.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageCode": string,
  "languageSupported": boolean
}
Felder
moderationCategories[]

object (ClassificationCategory)

Schädliche und sensible Kategorien, die das Eingabedokument repräsentieren.
languageCode

string

Die Sprache des Textes, die entweder mit der in der Anfrage angegebenen Sprache identisch ist oder automatisch erkannt wird, falls in der Anfrage keine Sprache angegeben ist. Weitere Informationen finden Sie im Feld [Document.language][].
languageSupported

boolean

Ob die Sprache offiziell unterstützt wird. Die API kann auch dann eine Antwort zurückgeben, wenn die Sprache nicht unterstützt wird. Dies geschieht jedoch nur auf Best-Effort-Basis.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ModelVersion

Die Modellversion, die für „documents.moderateText“ verwendet werden soll.

Enums
MODEL_VERSION_UNSPECIFIED Die Standardversion des Modells.
MODEL_VERSION_1 Verwenden Sie das Modell „v1“. Dieses Modell wird standardmäßig verwendet, wenn keine Angabe gemacht wird. Das Modell der Version 1 gibt nur einen Wahrscheinlichkeitswert (Konfidenz) für jede Kategorie zurück.
MODEL_VERSION_2 Verwenden Sie das V2-Modell. Das Modell der Version 2 gibt nur einen Wahrscheinlichkeitswert (Konfidenz) für jede Kategorie und einen Schweregrad für einen Teil der Kategorien zurück.