Method: documents.moderateText

Modera un documento en busca de categorías dañinas y sensibles.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "document": {
    object (Document)
  },
  "modelVersion": enum (ModelVersion)
}
Campos
document

object (Document)

Obligatorio. Ingresa el documento.

modelVersion

enum (ModelVersion)

Opcional. Es la versión del modelo que se usará para documents.moderateText.

Cuerpo de la respuesta

El mensaje de respuesta de moderación de documentos.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageCode": string,
  "languageSupported": boolean
}
Campos
moderationCategories[]

object (ClassificationCategory)

Categorías dañinas y sensibles que representan el documento de entrada

languageCode

string

Es el idioma del texto, que será el mismo que el idioma especificado en la solicitud o, si no se especifica, el idioma detectado automáticamente. Consulta el campo [Document.language][] para obtener más detalles.

languageSupported

boolean

Indica si el idioma es compatible oficialmente. Es posible que la API devuelva una respuesta cuando el idioma no sea compatible, pero se hará según el criterio del mejor esfuerzo.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

ModelVersion

Es la versión del modelo que se usará para documents.moderateText.

Enums
MODEL_VERSION_UNSPECIFIED Es la versión predeterminada del modelo.
MODEL_VERSION_1 Usa el modelo v1, que se usa de forma predeterminada cuando no se proporciona. El modelo v1 solo muestra una puntuación de probabilidad (confianza) para cada categoría.
MODEL_VERSION_2 Usa el modelo v2. El modelo v2 solo muestra una puntuación de probabilidad (confianza) para cada categoría y una puntuación de gravedad para un subconjunto de las categorías.