SanitizationResult

Resultado da sanitização após a aplicação de todos os filtros no conteúdo de entrada.

Representação JSON 
{
  "filterMatchState": enum (FilterMatchState),
  "filterResults": {
    string: {
      object (FilterResult)
    },
    ...
  },
  "invocationResult": enum (InvocationResult),
  "sanitizationMetadata": {
    object (SanitizationMetadata)
  }
}
Campos
filterMatchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência geral do filtro para higienização. O estado pode ter dois valores abaixo.

1) NO_MATCH_FOUND: nenhum filtro na configuração atende aos critérios de correspondência. Em outras palavras, a entrada passou por todos os filtros.

2) MATCH_FOUND: pelo menos um filtro na configuração atende à correspondência. Em outras palavras, a entrada não passou por um ou mais filtros.
filterResults

map (key: string, value: object (FilterResult))

Apenas saída. Resultados de todos os filtros em que a chave é o nome do filtro: "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
invocationResult

enum (InvocationResult)

Apenas saída. Um campo que indica o resultado da invocação, independentemente do status de correspondência. Pode ter os seguintes três valores: SUCCESS: todos os filtros foram executados. PARCIAL: alguns filtros foram ignorados ou não foram executados. FALHA: todos os filtros foram ignorados ou a execução falhou.
sanitizationMetadata

object (SanitizationMetadata)

Apenas saída. Metadados relacionados à limpeza.

FilterMatchState

Opção para especificar o estado de correspondência do filtro.

Enums
FILTER_MATCH_STATE_UNSPECIFIED Não utilizado
NO_MATCH_FOUND Os critérios de correspondência não são atendidos para os filtros.
MATCH_FOUND Os critérios de correspondência foram atendidos para o filtro.

FilterResult

Resultado da filtragem obtido após as operações de sanitização.

Representação JSON 
{

  // Union field filter_result can be only one of the following:
  "raiFilterResult": {
    object (RaiFilterResult)
  },
  "sdpFilterResult": {
    object (SdpFilterResult)
  },
  "piAndJailbreakFilterResult": {
    object (PiAndJailbreakFilterResult)
  },
  "maliciousUriFilterResult": {
    object (MaliciousUriFilterResult)
  },
  "csamFilterFilterResult": {
    object (CsamFilterResult)
  },
  "virusScanFilterResult": {
    object (VirusScanFilterResult)
  }
  // End of list of possible types for union field filter_result.
}
Campos
Campo de união filter_result. Encapsula uma das seguintes opções: IA responsável, proteção de dados sensíveis, injeção de comandos e jailbreak, URI malicioso, CSAM, resultados de filtro relacionados à verificação de vírus. filter_result pode ser apenas de um dos tipos a seguir:
raiFilterResult

object (RaiFilterResult)

Filtrar resultados da IA responsável.
sdpFilterResult

object (SdpFilterResult)

Resultados da Proteção de Dados Sensíveis.
piAndJailbreakFilterResult

object (PiAndJailbreakFilterResult)

Resultados do filtro de injeção de comando e jailbreak.
maliciousUriFilterResult

object (MaliciousUriFilterResult)

Resultados do filtro de URIs maliciosos.
csamFilterFilterResult

object (CsamFilterResult)

Resultados do filtro CSAM.
virusScanFilterResult

object (VirusScanFilterResult)

Resultados da verificação de vírus.

RaiFilterResult

Resultado da IA responsável.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "raiFilterTypeResults": {
    string: {
      object (RaiFilterTypeResult)
    },
    ...
  }
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se o filtro RAI foi executado ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado geral de correspondência do filtro para RAI. O valor é MATCH_FOUND se pelo menos um nível de confiança do filtro RAI for igual ou superior ao nível de confiança definido na configuração.
raiFilterTypeResults

map (key: string, value: object (RaiFilterTypeResult))

O mapa de resultados do filtro RAI em que a chave é o tipo de filtro RAI, como "sexually_explicit", "hate_speech", "harassment" ou "dangerous".

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FilterExecutionState

Enum que informa se um filtro específico foi executado ou não.

Enums
FILTER_EXECUTION_STATE_UNSPECIFIED Não utilizado
EXECUTION_SUCCESS Filtro executado
EXECUTION_SKIPPED A execução do filtro foi ignorada. Isso pode acontecer devido a um erro ou problema de permissão no servidor.

MessageItem

Item de mensagem para informar informações, avisos ou mensagens de erro.

Representação JSON 
{
  "messageType": enum (MessageType),
  "message": string
}
Campos
messageType

enum (MessageType)

Tipo de mensagem.
message

string

O conteúdo da mensagem.

MessageType

Opção para especificar o tipo de mensagem.

Enums
MESSAGE_TYPE_UNSPECIFIED Não utilizado
INFO Mensagem relacionada a informações.
WARNING Mensagem relacionada ao aviso.
ERROR Mensagem de erro.

RaiFilterTypeResult

Resultado detalhado do filtro para cada um dos tipos de filtro de IA responsável.

Representação JSON 
{
  "filterType": enum (RaiFilterType),
  "confidenceLevel": enum (DetectionConfidenceLevel),
  "matchState": enum (FilterMatchState)
}
Campos
filterType

enum (RaiFilterType)

Tipo de filtro da IA responsável.
confidenceLevel

enum (DetectionConfidenceLevel)

Nível de confiança identificado para este filtro RAI.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para este filtro RAI.

SdpFilterResult

Resultado do filtro da Proteção de dados sensíveis.

Representação JSON 
{

  // Union field result can be only one of the following:
  "inspectResult": {
    object (SdpInspectResult)
  },
  "deidentifyResult": {
    object (SdpDeidentifyResult)
  }
  // End of list of possible types for union field result.
}
Campos
Campo de união result. Um dos resultados de inspeção ou desidentificação da Proteção de dados sensíveis. result pode ser apenas de um dos tipos a seguir:
inspectResult

object (SdpInspectResult)

Resultado da inspeção de proteção de dados sensíveis, se ela for realizada.
deidentifyResult

object (SdpDeidentifyResult)

Resultado da desidentificação da Proteção de dados sensíveis, se ela for realizada.

SdpInspectResult

Resultado da inspeção de proteção de dados sensíveis.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "findings": [
    {
      object (SdpFinding)
    }
  ],
  "findingsTruncated": boolean
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se a inspeção de proteção de dados sensíveis foi executada ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para a inspeção do SDP. O valor é MATCH_FOUND se pelo menos uma descoberta de Proteção de Dados Sensíveis for identificada.
findings[]

object (SdpFinding)

Lista de descobertas da proteção de dados sensíveis.
findingsTruncated

boolean

Se for verdadeiro, é possível que mais descobertas tenham sido identificadas e que as descobertas retornadas sejam um subconjunto de todas as descobertas. A lista de descobertas pode ser truncada porque os itens de entrada são muito grandes ou porque o servidor atingiu a quantidade máxima de recursos permitidos para uma única chamada de API.

SdpFinding

Encontrar o filtro correspondente à proteção de dados sensíveis.

Representação JSON 
{
  "infoType": string,
  "likelihood": enum (SdpFindingLikelihood),
  "location": {
    object (SdpFindingLocation)
  }
}
Campos
infoType

string

Nome do tipo de informação da Proteção de dados sensíveis para essa descoberta.
likelihood

enum (SdpFindingLikelihood)

Probabilidade de confiança identificada para infoType.
location

object (SdpFindingLocation)

Local da descoberta.

SdpFindingLikelihood

Para mais informações sobre cada nível de probabilidade da Proteção de Dados Sensíveis, consulte https://cloud.google.com/sensitive-data-protection/docs/likelihood.

Enums
SDP_FINDING_LIKELIHOOD_UNSPECIFIED Valor padrão, o mesmo que POSSIBLE.
VERY_UNLIKELY Maior chance de um falso positivo.
UNLIKELY Alta probabilidade de falso positivo.
POSSIBLE Alguns indicadores correspondentes. O valor padrão.
LIKELY Baixa probabilidade de um falso positivo.
VERY_LIKELY O nível de confiança é alto. Menor chance de falso positivo.

SdpFindingLocation

Localização desta descoberta de proteção de dados sensíveis no conteúdo de entrada.

Representação JSON 
{
  "byteRange": {
    object (RangeInfo)
  },
  "codepointRange": {
    object (RangeInfo)
  }
}
Campos
byteRange

object (RangeInfo)

Deslocamentos de byte com base em zero que delimitam a descoberta. Elas são relativas ao elemento que contém a descoberta. Quando o conteúdo não é textual, ele faz referência à representação textual codificada em UTF-8 do conteúdo.
codepointRange

object (RangeInfo)

Deslocamentos de caracteres Unicode que delimitam a descoberta. Elas são relativas ao elemento que contém a descoberta. Fornecido quando o conteúdo é texto.

RangeInfo

Intervalo de intervalo semiaberto [início, fim]

Representação JSON 
{
  "start": string,
  "end": string
}
Campos
start

string (int64 format)

Para proto3, o valor não pode ser definido como 0, a menos que o campo seja opcional. Ref: https://protobuf.dev/programming-guides/proto3/#default Índice do primeiro caractere (inclusive).
end

string (int64 format)

Índice do último caractere (exclusivo).

SdpDeidentifyResult

Resultado da desidentificação da proteção de dados sensíveis.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "data": {
    object (DataItem)
  },
  "transformedBytes": string,
  "infoTypes": [
    string
  ]
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se a desidentificação da Proteção de dados sensíveis foi executada ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para a desidentificação de proteção de dados sensíveis. O valor é MATCH_FOUND se o conteúdo for desidentificado.
data

object (DataItem)

Dados desidentificados.
transformedBytes

string (int64 format)

Tamanho total em bytes que foram transformados durante a desidentificação.
infoTypes[]

string

Lista de infoTypes de proteção de dados sensíveis que foram desidentificados.

PiAndJailbreakFilterResult

Injeção de comando e resultado do filtro de jailbreak.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se a injeção de comando e o filtro de jailbreak foram executados ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para injeção de comando e Jailbreak.
confidenceLevel

enum (DetectionConfidenceLevel)

Nível de confiança identificado para injeção de comando e jailbreak.

MaliciousUriFilterResult

Resultado do filtro de URI malicioso.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "maliciousUriMatchedItems": [
    {
      object (MaliciousUriMatchedItem)
    }
  ]
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se o filtro de URI malicioso foi executado ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para este URI malicioso. O valor é MATCH_FOUND se pelo menos um URI malicioso for encontrado.
maliciousUriMatchedItems[]

object (MaliciousUriMatchedItem)

Lista de URIs maliciosos encontrados nos dados.

MaliciousUriMatchedItem

Informações sobre o URI malicioso e a localização dele no conteúdo de entrada.

Representação JSON 
{
  "uri": string,
  "locations": [
    {
      object (RangeInfo)
    }
  ]
}
Campos
uri

string

URI malicioso.
locations[]

object (RangeInfo)

Lista de locais em que o URI malicioso foi identificado. O campo locations tem suporte apenas para conteúdo de texto simples, ou seja, ByteItemType.PLAINTEXT_UTF8.

CsamFilterResult

Resultado do filtro de material de abuso sexual infantil (CSAM)

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState)
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se o filtro CSAM foi executado ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o estado de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Estado de correspondência para CSAM.

VirusScanFilterResult

Resultados da verificação de vírus.

Representação JSON 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "scannedContentType": enum (ScannedContentType),
  "virusDetails": [
    {
      object (VirusDetail)
    }
  ],
  "scannedSize": string
}
Campos
executionState

enum (FilterExecutionState)

Apenas saída. Informa se a verificação de vírus foi executada ou não.
messageItems[]

object (MessageItem)

Mensagens opcionais correspondentes ao resultado. Uma mensagem pode fornecer avisos ou detalhes de erros. Por exemplo, se o status de execução for ignorado, esse campo vai mostrar o motivo/explicação relacionado.
matchState

enum (FilterMatchState)

Apenas saída. Status de correspondência para "Virus". O valor é MATCH_FOUND se os dados estiverem infectados por um vírus.
scannedContentType

enum (ScannedContentType)

Tipo de conteúdo verificado.
virusDetails[]

object (VirusDetail)

Lista de vírus identificados. Este campo vai ficar vazio se nenhum vírus for detectado.
scannedSize

string (int64 format)

Tamanho do conteúdo digitalizado em bytes.

ScannedContentType

Tipo de conteúdo verificado.

Enums
SCANNED_CONTENT_TYPE_UNSPECIFIED Não utilizado
UNKNOWN Conteúdo desconhecido
PLAINTEXT Texto simples
PDF A digitalização de PDFs é compatível apenas com PDFs.

VirusDetail

Detalhes de um vírus identificado

Representação JSON 
{
  "vendor": string,
  "names": [
    string
  ],
  "threatType": enum (ThreatType)
}
Campos
vendor

string

Nome do fornecedor que produziu a identificação do vírus.
names[]

string

Nomes desse vírus.
threatType

enum (ThreatType)

Tipo de ameaça do vírus identificado

ThreatType

Define todos os tipos de ameaças de um vírus

Enums
THREAT_TYPE_UNSPECIFIED Não utilizado
UNKNOWN Não foi possível categorizar a ameaça
VIRUS_OR_WORM Ameaça de vírus ou worm.
MALICIOUS_PROGRAM Programa malicioso. Por exemplo, spyware e cavalos de troia.
POTENTIALLY_HARMFUL_CONTENT Conteúdo potencialmente nocivo. Por exemplo, código injetado, macro
POTENTIALLY_UNWANTED_CONTENT Conteúdo possivelmente indesejado. Por exemplo, adware.

InvocationResult

Um campo que indica o resultado da invocação, independentemente do status de correspondência.

Enums
INVOCATION_RESULT_UNSPECIFIED Não utilizado. Valor padrão.
SUCCESS Todos os filtros foram invocados.
PARTIAL Alguns filtros foram ignorados ou falharam.
FAILURE Todos os filtros foram ignorados ou falharam.

SanitizationMetadata

Mensagem que descreve os metadados de limpeza.

Representação JSON 
{
  "errorCode": string,
  "errorMessage": string
}
Campos
errorCode

string (int64 format)

Código de erro, se houver.
errorMessage

string

Mensagem de erro, se houver.