SanitizationResult

对输入内容应用所有过滤器后的清理结果。

JSON 表示法 
{
  "filterMatchState": enum (FilterMatchState),
  "filterResults": {
    string: {
      object (FilterResult)
    },
    ...
  },
  "invocationResult": enum (InvocationResult),
  "sanitizationMetadata": {
    object (SanitizationMetadata)
  }
}
字段
filterMatchState

enum (FilterMatchState)

仅限输出。对齐处理的整体过滤条件匹配状态。该状态可以是以下两个值。

1) NO_MATCH_FOUND：配置中没有任何过滤条件符合匹配条件。换句话说，输入已通过所有过滤条件。

2) MATCH_FOUND：配置中至少有一个过滤条件满足匹配条件。换句话说，输入内容未通过一个或多个过滤条件。
filterResults

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

仅限输出。所有过滤条件的结果，其中键是过滤条件名称，即“csam”“malicious_uris”“rai”“pi_and_jailbreak”“sdp”。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
invocationResult

enum (InvocationResult)

仅限输出。一个字段，用于指示调用的结果（与匹配状态无关）。它可以具有以下三个值：SUCCESS：所有过滤器均已成功执行。部分：系统跳过了某些过滤条件或未能执行某些过滤条件。失败：所有过滤器均已跳过或执行失败。
sanitizationMetadata

object (SanitizationMetadata)

仅限输出。与排错相关的元数据。

FilterMatchState

用于指定过滤器匹配状态的选项。

枚举
FILTER_MATCH_STATE_UNSPECIFIED 未使用
NO_MATCH_FOUND 过滤条件未达到匹配条件。
MATCH_FOUND 过滤条件符合匹配条件。

FilterResult

在执行排错操作后获得的过滤器结果。

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.
}
字段
联合字段 filter_result。封装了 Responsible AI、敏感数据保护、提示注入和越狱、恶意 URI、儿童色情内容、病毒扫描相关的过滤结果之一。filter_result 只能是下列其中一项：
raiFilterResult

object (RaiFilterResult)

Responsible AI 过滤结果。
sdpFilterResult

object (SdpFilterResult)

敏感数据保护结果。
piAndJailbreakFilterResult

object (PiAndJailbreakFilterResult)

提示注入和越狱过滤条件结果。
maliciousUriFilterResult

object (MaliciousUriFilterResult)

恶意 URI 过滤条件结果。
csamFilterFilterResult

object (CsamFilterResult)

CSAM 过滤结果。
virusScanFilterResult

object (VirusScanFilterResult)

病毒扫描结果。

RaiFilterResult

Responsible AI 结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "raiFilterTypeResults": {
    string: {
      object (RaiFilterTypeResult)
    },
    ...
  }
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告 RAI 过滤器是否已成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。RAI 的整体过滤条件匹配状态。如果至少有一个 RAI 过滤条件的置信度水平等于或高于配置中定义的置信度水平，则值为 MATCH_FOUND。
raiFilterTypeResults

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

RAI 过滤结果的映射，其中键是 RAI 过滤条件类型，即“sexually_explicit”“hate_speech”“harassment”“dangerous”。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

FilterExecutionState

用于报告特定过滤器是否成功执行的枚举。

枚举
FILTER_EXECUTION_STATE_UNSPECIFIED 未使用
EXECUTION_SUCCESS 过滤条件已成功执行
EXECUTION_SKIPPED 系统跳过了过滤器执行。这可能是因为服务器端错误或权限问题。

MessageItem

用于报告信息、警告或错误消息的消息项。

JSON 表示法 
{
  "messageType": enum (MessageType),
  "message": string
}
字段
messageType

enum (MessageType)

消息类型。
message

string

消息内容。

MessageType

用于指定消息类型的选项。

枚举
MESSAGE_TYPE_UNSPECIFIED 未使用
INFO 信息相关消息。
WARNING 警告相关消息。
ERROR 错误消息。

RaiFilterTypeResult

每种 Responsible AI 过滤条件类型的详细过滤结果。

JSON 表示法 
{
  "filterType": enum (RaiFilterType),
  "confidenceLevel": enum (DetectionConfidenceLevel),
  "matchState": enum (FilterMatchState)
}
字段
filterType

enum (RaiFilterType)

Responsible AI 过滤条件的类型。
confidenceLevel

enum (DetectionConfidenceLevel)

为此 RAI 过滤条件确定的置信度水平。
matchState

enum (FilterMatchState)

仅限输出。此 RAI 过滤条件的匹配状态。

SdpFilterResult

敏感数据保护过滤结果。

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.
}
字段
联合字段 result。敏感数据保护检查结果或去标识化结果。result 只能是下列其中一项：
inspectResult

object (SdpInspectResult)

敏感数据保护检查结果（如果执行了检查）。
deidentifyResult

object (SdpDeidentifyResult)

执行去标识化操作后的敏感数据保护去标识化结果。

SdpInspectResult

敏感数据保护检查结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "findings": [
    {
      object (SdpFinding)
    }
  ],
  "findingsTruncated": boolean
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告 Sensitive Data Protection 检查是否已成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。SDP 检查的匹配状态。如果发现至少 1 项敏感数据保护问题，则值为 MATCH_FOUND。
findings[]

object (SdpFinding)

敏感数据保护发现结果列表。
findingsTruncated

boolean

如果为 true，则可能存在更多发现结果，并且返回的发现结果是所有发现结果的一部分。发现结果列表可能会被截断，原因可能是输入项过大，或者服务器达到了单次 API 调用允许的资源量上限。

SdpFinding

与敏感数据保护过滤条件对应的发现结果。

JSON 表示法 
{
  "infoType": string,
  "likelihood": enum (SdpFindingLikelihood),
  "location": {
    object (SdpFindingLocation)
  }
}
字段
infoType

string

此发现结果对应的敏感数据保护信息类型的名称。
likelihood

enum (SdpFindingLikelihood)

为 infoType 确定的可靠度概率。
location

object (SdpFindingLocation)

此发现结果的位置。

SdpFindingLikelihood

如需详细了解敏感数据保护的每个可能性级别，请参阅 https://cloud.google.com/sensitive-data-protection/docs/likelihood。

枚举
SDP_FINDING_LIKELIHOOD_UNSPECIFIED 默认值；和 POSSIBLE 相同。
VERY_UNLIKELY 误报可能性最高。
UNLIKELY 误报的可能性很高。
POSSIBLE 一些匹配的信号。默认值。
LIKELY 误报几率较低。
VERY_LIKELY 置信度较高。误报几率最低。

SdpFindingLocation

此敏感数据保护发现结果在输入内容中的位置。

JSON 表示法 
{
  "byteRange": {
    object (RangeInfo)
  },
  "codepointRange": {
    object (RangeInfo)
  }
}
字段
byteRange

object (RangeInfo)

用于限定发现结果的字节偏移量（从零开始）。这些值相对于发现结果的包含元素。请注意，如果内容不是文本，则此属性引用内容的 UTF-8 编码文本表示法。
codepointRange

object (RangeInfo)

用于限定发现结果的 Unicode 字符偏移量。这些值相对于发现结果的包含元素。当内容为文本时提供。

RangeInfo

半开区间 [start, end)

JSON 表示法 
{
  "start": string,
  "end": string
}
字段
start

string (int64 format)

对于 proto3，除非字段是可选的，否则不能将值设置为 0。参考：https://protobuf.dev/programming-guides/proto3/#default 第一个字符的索引（包括该字符）。
end

string (int64 format)

最后一个字符的索引（不含）。

SdpDeidentifyResult

Sensitive Data Protection 去标识化结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "data": {
    object (DataItem)
  },
  "transformedBytes": string,
  "infoTypes": [
    string
  ]
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告 Sensitive Data Protection 去标识化操作是否成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。Sensitive Data Protection 去标识化功能的匹配状态。如果内容已去标识化，则值为 MATCH_FOUND。
data

object (DataItem)

去标识化数据。
transformedBytes

string (int64 format)

去标识化期间转换的总大小（以字节为单位）。
infoTypes[]

string

已去标识化的敏感数据保护 info-type 列表。

PiAndJailbreakFilterResult

提示注入和越狱过滤条件结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告提示注入和越狱过滤条件是否已成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。提示注入和越狱的匹配状态。
confidenceLevel

enum (DetectionConfidenceLevel)

为提示注入和越狱识别的置信度水平。

MaliciousUriFilterResult

恶意 URI 过滤条件结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "maliciousUriMatchedItems": [
    {
      object (MaliciousUriMatchedItem)
    }
  ]
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告恶意 URI 过滤条件是否已成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。此恶意 URI 的匹配状态。如果找到至少一个恶意 URI，则值为 MATCH_FOUND。
maliciousUriMatchedItems[]

object (MaliciousUriMatchedItem)

数据中发现的恶意 URI 列表。

MaliciousUriMatchedItem

与恶意 URI 及其在输入内容中的位置相关的信息。

JSON 表示法 
{
  "uri": string,
  "locations": [
    {
      object (RangeInfo)
    }
  ]
}
字段
uri

string

恶意 URI。
locations[]

object (RangeInfo)

识别到恶意 URI 的位置列表。只有纯文本内容（即 ByteItemType.PLAINTEXT_UTF8）支持 locations 字段

CsamFilterResult

CSAM（儿童安全虐待内容）过滤结果

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState)
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告 CSAM 过滤器是否成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果跳过了执行状态，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。CSAM 的匹配状态。

VirusScanFilterResult

病毒扫描结果。

JSON 表示法 
{
  "executionState": enum (FilterExecutionState),
  "messageItems": [
    {
      object (MessageItem)
    }
  ],
  "matchState": enum (FilterMatchState),
  "scannedContentType": enum (ScannedContentType),
  "virusDetails": [
    {
      object (VirusDetail)
    }
  ],
  "scannedSize": string
}
字段
executionState

enum (FilterExecutionState)

仅限输出。报告病毒扫描是否成功执行。
messageItems[]

object (MessageItem)

与结果对应的可选消息。消息可以提供警告或错误详情。例如，如果执行状态为“跳过”，则此字段会提供相关原因/说明。
matchState

enum (FilterMatchState)

仅限输出。病毒的匹配状态。如果数据已感染病毒，则值为 MATCH_FOUND。
scannedContentType

enum (ScannedContentType)

扫描的内容类型。
virusDetails[]

object (VirusDetail)

已识别出的病毒列表。如果未检测到病毒，此字段将为空。
scannedSize

string (int64 format)

扫描内容的大小（以字节为单位）。

ScannedContentType

扫描的内容类型。

枚举
SCANNED_CONTENT_TYPE_UNSPECIFIED 未使用
UNKNOWN 未知内容
PLAINTEXT 明文
PDF 仅支持对 PDF 文件进行 PDF 扫描。

VirusDetail

已识别出的病毒的详细信息

JSON 表示法 
{
  "vendor": string,
  "names": [
    string
  ],
  "threatType": enum (ThreatType)
}
字段
vendor

string

生成此病毒识别结果的供应商的名称。
names[]

string

此病毒的名称。
threatType

enum (ThreatType)

已识别病毒的威胁类型

ThreatType

定义病毒的所有威胁类型

枚举
THREAT_TYPE_UNSPECIFIED 未使用
UNKNOWN 无法对威胁进行分类
VIRUS_OR_WORM 病毒或蠕虫威胁。
MALICIOUS_PROGRAM 恶意程序。例如间谍软件、木马。
POTENTIALLY_HARMFUL_CONTENT 可能有害的内容。例如，注入的代码、宏
POTENTIALLY_UNWANTED_CONTENT 可能包含不受欢迎的内容。例如广告软件。

InvocationResult

一个字段，用于指示调用的结果（与匹配状态无关）。

枚举
INVOCATION_RESULT_UNSPECIFIED 未使用。默认值。
SUCCESS 所有过滤器均已成功调用。
PARTIAL 部分过滤条件已被跳过或未能过滤。
FAILURE 所有过滤条件均已跳过或失败。

SanitizationMetadata

用于说明“Sanitization”元数据的消息。

JSON 表示法 
{
  "errorCode": string,
  "errorMessage": string
}
字段
errorCode

string (int64 format)

错误代码（如果有）。
errorMessage

string

错误消息（如果有）。