Skip to content

AttributeFilterDict

Dictionary Type

AttributeFilterDict

Bases: TypedDict

Dictionary form of AttributeFilter.

Attributes

and_all_filters instance-attribute
and_all_filters: Sequence[AttributeFilter | AttributeFilterDict] | None

Performs a logical AND operation on all supplied filters.

contains_all instance-attribute

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

contains_any instance-attribute

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

equals_to instance-attribute

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

greater_than instance-attribute

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

greater_than_or_equals instance-attribute
greater_than_or_equals: DocumentAttribute | DocumentAttributeDict | None

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

less_than instance-attribute

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

less_than_or_equals instance-attribute
less_than_or_equals: DocumentAttribute | DocumentAttributeDict | None

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

not_filter instance-attribute
not_filter: AttributeFilter | AttributeFilterDict | None

Performs a logical NOT operation on all supplied filters.

or_all_filters instance-attribute
or_all_filters: Sequence[AttributeFilter | AttributeFilterDict] | None

Performs a logical OR operation on all supplied filters.