AttributeFilter

import type { AttributeFilter } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";

Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

```
<OrAllFilters>
```
```
<EqualsTo>
```

If you use more than 2 layers, you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2."

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "AttributeFilter cannot have a length of more than 10".

interface AttributeFilter {

AndAllFilters?: AttributeFilter[] | null;

ContainsAll?: DocumentAttribute | null;

ContainsAny?: DocumentAttribute | null;

EqualsTo?: DocumentAttribute | null;

GreaterThan?: DocumentAttribute | null;

GreaterThanOrEquals?: DocumentAttribute | null;

LessThan?: DocumentAttribute | null;

LessThanOrEquals?: DocumentAttribute | null;

NotFilter?: AttributeFilter | null;

OrAllFilters?: AttributeFilter[] | null;

}

§Properties

AndAllFilters?: AttributeFilter[] | null

[src]

Performs a logical AND operation on all supplied filters.

ContainsAll?: DocumentAttribute | null

[src]

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

ContainsAny?: DocumentAttribute | null

[src]

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

EqualsTo?: DocumentAttribute | null

[src]

Performs an equals operation on two document attributes.

GreaterThan?: DocumentAttribute | null

[src]

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

GreaterThanOrEquals?: DocumentAttribute | null

[src]

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

LessThan?: DocumentAttribute | null

[src]

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

LessThanOrEquals?: DocumentAttribute | null

[src]

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

NotFilter?: AttributeFilter | null

[src]

Performs a logical NOT operation on all supplied filters.

OrAllFilters?: AttributeFilter[] | null

[src]

Performs a logical OR operation on all supplied filters.