MetadataFilter

用户提供的过滤条件,用于根据 ChunkDocument 级别元数据值限制检索。示例(类型 = 戏剧 OR 类型 = 操作):键 = "document.custom_metadata.genre" 条件 = [{stringValue = "drama", actions = EQUAL}, {stringValue = "action", actions = EQUAL}]

JSON 表示法
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
字段
key

string

必需。作为过滤条件的元数据的键。

conditions[]

object (Condition)

必需。将触发此过滤器的给定键的 Condition。多个 Condition 通过逻辑 OR 连接。

条件

适用于单个键的过滤条件。

JSON 表示法
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
字段
operation

enum (Operator)

必需。为触发条件的指定键值对应用的运算符。

联合字段 value。值类型必须与在相应键的字段中定义的值类型一致。如果值类型不一致,则结果将为空集。当 CustomMetadata 具有 StringList 值类型时,过滤条件应将 string_value 与包含/排除操作搭配使用,否则结果也将是空集。value 只能是下列其中一项:
stringValue

string

用于过滤元数据的字符串值。

numericValue

number

用于过滤元数据的数值。

运营商

定义可应用于键值对的有效运算符。

枚举
OPERATOR_UNSPECIFIED 默认值。此值未使用。
LESS 由数字支持。
LESS_EQUAL 由数字支持。
EQUAL 支持数字和字符串。
GREATER_EQUAL 由数字支持。
GREATER 由数字支持。
NOT_EQUAL 支持数字和字符串。
INCLUDES 仅当给定键的 CustomMetadata 值类型具有 stringListValue 时,字符串才支持该字符串。
EXCLUDES 仅当给定键的 CustomMetadata 值类型具有 stringListValue 时,字符串才支持该字符串。