Class: Aws::BedrockAgentRuntime::Types::RetrievalFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Note:

RetrievalFilter is a union - when making an API calls you must set exactly one of the members.

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

See Also:

Defined Under Namespace

Classes: AndAll, Equals, GreaterThan, GreaterThanOrEquals, In, LessThan, LessThanOrEquals, ListContains, NotEquals, NotIn, OrAll, StartsWith, StringContains, Unknown

Constant Summary collapse

SENSITIVE = 
[:and_all, :or_all]

Instance Attribute Summary collapse

Instance Attribute Details

#and_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is cat:

"equals": { "key": "animal", "value": "cat" }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#greater_than ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.

The following example would return data sources with an year attribute whose value is greater than 1989:

"greaterThan": { "key": "year", "value": 1989 }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#greater_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is greater than or equal to 1989:

"greaterThanOrEquals": { "key": "year", "value": 1989 }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#in ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.

The following example would return data sources with an animal attribute that is either cat or dog:

"in": { "key": "animal", "value": ["cat", "dog"] }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#less_than ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.

The following example would return data sources with an year attribute whose value is less than to 1989.

"lessThan": { "key": "year", "value": 1989 }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#less_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is less than or equal to 1989.

"lessThanOrEquals": { "key": "year", "value": 1989 }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#list_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).

"listContains": { "key": "animals", "value": "cat" }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#not_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned when:

  • It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.

  • The key is not present in the document.

The following example would return data sources that don't contain an animal attribute whose value is cat.

"notEquals": { "key": "animal", "value": "cat" }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#not_in ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.

The following example would return data sources whose animal attribute is neither cat nor dog.

"notIn": { "key": "animal", "value": ["cat", "dog"] }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#or_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#starts_with ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).

"startsWith": { "key": "animal", "value": "ca" }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#string_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

  • A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).

    "stringContains": { "key": "animal", "value": "at" }

  • A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).

    "stringContains": { "key": "animals", "value": "at" }

Returns:



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

class RetrievalFilter < Struct.new(
  :and_all,
  :equals,
  :greater_than,
  :greater_than_or_equals,
  :in,
  :less_than,
  :less_than_or_equals,
  :list_contains,
  :not_equals,
  :not_in,
  :or_all,
  :starts_with,
  :string_contains,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < RetrievalFilter; end
  class Equals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



8793
8794
8795
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8793

def unknown
  @unknown
end