MetadataFilter

Chunk または Document レベルのメタデータ値に基づいて取得を制限する、ユーザー指定のフィルタ。例(ジャンル = ドラマ OR ジャンル = アクション): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

JSON 表現
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
フィールド
key

string

必須。フィルタするメタデータのキー。

conditions[]

object (Condition)

必須。このフィルタをトリガーする特定のキーの Condition。複数の Condition は論理 OR で結合されます。

条件

1 つのキーに適用されるフィルタ条件。

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)

必須。条件をトリガーするために指定された Key-Value ペアに適用される演算子。

共用体フィールド value。値の型は、対応するキーのフィールドで定義されている値の型と一致している必要があります。値の型が一致しない場合、結果は空のセットになります。CustomMetadataStringList 型の場合、フィルタリング条件は string_value と INCLUDES/EXCLUDES オペレーションを組み合わせる必要があります。そうでない場合、結果も空のセットになります。value は次のいずれかになります。
stringValue

string

メタデータをフィルタする文字列値。

numericValue

number

メタデータをフィルタする数値。

演算子

Key-Value ペアに適用できる有効な演算子を定義します。

列挙型
OPERATOR_UNSPECIFIED デフォルト値。この値は使用されません。
LESS 数値でサポートされます。
LESS_EQUAL 数値でサポートされます。
EQUAL 数値と文字列でサポートされます。
GREATER_EQUAL 数値でサポートされます。
GREATER 数値でサポートされます。
NOT_EQUAL 数値と文字列でサポートされます。
INCLUDES 指定されたキーの CustomMetadata 値の型に stringListValue がある場合にのみ、文字列でサポートされます。
EXCLUDES 指定されたキーの CustomMetadata 値の型に stringListValue がある場合にのみ、文字列でサポートされます。