Method: documents.moderateText

Modera um documento em categorias nocivas e sensíveis.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "document": {
    object (Document)
  },
  "modelVersion": enum (ModelVersion)
}
Campos
document

object (Document)

Obrigatório. Documento de entrada.
modelVersion

enum (ModelVersion)

Opcional. A versão do modelo a ser usada para documents.moderateText.

Corpo da resposta

A mensagem de resposta da moderação de documentos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageCode": string,
  "languageSupported": boolean
}
Campos
moderationCategories[]

object (ClassificationCategory)

Categorias nocivas e sensíveis que representam o documento de entrada.
languageCode

string

O idioma do texto, que será o mesmo especificado na solicitação ou, se não especificado, detectado automaticamente. Consulte o campo [Document.language][] para mais detalhes.
languageSupported

boolean

Se o idioma tem suporte oficial. A API ainda pode retornar uma resposta quando o idioma não tiver suporte, mas isso vai depender da disponibilidade.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ModelVersion

A versão do modelo a ser usada para documents.moderateText.

Enums
MODEL_VERSION_UNSPECIFIED A versão padrão do modelo.
MODEL_VERSION_1 Use o modelo v1, que é usado por padrão quando não é fornecido. O modelo v1 só retorna a pontuação de probabilidade (confiança) para cada categoria.
MODEL_VERSION_2 Use o modelo v2. O modelo v2 só retorna a pontuação de probabilidade (confiança) para cada categoria e a pontuação de gravidade para um subconjunto das categorias.