Class: Aws::Kendra::Types::AttributeFilter

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::AttributeFilter

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides filtering the query results based on document attributes or metadata fields.

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

<AndAllFilters>

1. <OrAllFilters>

2. <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".

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #and_all_filters ⇒ Array<Types::AttributeFilter>

  Performs a logical AND operation on all supplied filters.

• #contains_all ⇒ Types::DocumentAttribute

  Returns true when a document contains all of the specified document attributes or metadata fields.

• #contains_any ⇒ Types::DocumentAttribute

  Returns true when a document contains any of the specified document attributes or metadata fields.

• #equals_to ⇒ Types::DocumentAttribute

  Performs an equals operation on two document attributes or metadata fields.

• #greater_than ⇒ Types::DocumentAttribute

  Performs a greater than operation on two document attributes or metadata fields.

• #greater_than_or_equals ⇒ Types::DocumentAttribute

  Performs a greater or equals than operation on two document attributes or metadata fields.

• #less_than ⇒ Types::DocumentAttribute

  Performs a less than operation on two document attributes or metadata fields.

• #less_than_or_equals ⇒ Types::DocumentAttribute

  Performs a less than or equals operation on two document attributes or metadata fields.

• #not_filter ⇒ Types::AttributeFilter

  Performs a logical NOT operation on all supplied filters.

• #or_all_filters ⇒ Array<Types::AttributeFilter>

  Performs a logical OR operation on all supplied filters.

Instance Attribute Details

#and_all_filters ⇒ Array<Types::AttributeFilter>

Performs a logical AND operation on all supplied filters.

Returns:

• (Array<Types::AttributeFilter>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#contains_all ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#contains_any ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#equals_to ⇒ Types::DocumentAttribute

Performs an equals operation on two document attributes or metadata fields.

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#greater_than ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#greater_than_or_equals ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#less_than ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#less_than_or_equals ⇒ Types::DocumentAttribute

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

Returns:

• (Types::DocumentAttribute)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#not_filter ⇒ Types::AttributeFilter

Performs a logical NOT operation on all supplied filters.

Returns:

• (Types::AttributeFilter)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end

#or_all_filters ⇒ Array<Types::AttributeFilter>

Performs a logical OR operation on all supplied filters.

Returns:

• (Array<Types::AttributeFilter>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 421

class AttributeFilter < Struct.new(
  :and_all_filters,
  :or_all_filters,
  :not_filter,
  :equals_to,
  :contains_all,
  :contains_any,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals)
  SENSITIVE = []
  include Aws::Structure
end