Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.DocumentAttributeCondition

Description

Documentation

data DocumentAttributeCondition Source #

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

See: newDocumentAttributeCondition smart constructor.

Constructors

DocumentAttributeCondition'

Fields

conditionOnValue :: Maybe DocumentAttributeValue
The value used by the operator.
For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.
conditionDocumentAttributeKey :: Text
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support _document_body as an attribute key used for the condition.
operator :: ConditionOperator
The condition operator.
For example, you can use 'Contains' to partially match a string.

Instances

Instances details

FromJSON DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods parseJSON :: Value -> Parser DocumentAttributeCondition # parseJSONList :: Value -> Parser [DocumentAttributeCondition] #
ToJSON DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods toJSON :: DocumentAttributeCondition -> Value # toEncoding :: DocumentAttributeCondition -> Encoding # toJSONList :: [DocumentAttributeCondition] -> Value # toEncodingList :: [DocumentAttributeCondition] -> Encoding #
Generic DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Associated Types type Rep DocumentAttributeCondition :: Type -> Type # Methods from :: DocumentAttributeCondition -> Rep DocumentAttributeCondition x # to :: Rep DocumentAttributeCondition x -> DocumentAttributeCondition #
Read DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods readsPrec :: Int -> ReadS DocumentAttributeCondition # readList :: ReadS [DocumentAttributeCondition] # readPrec :: ReadPrec DocumentAttributeCondition # readListPrec :: ReadPrec [DocumentAttributeCondition] #
Show DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods showsPrec :: Int -> DocumentAttributeCondition -> ShowS # show :: DocumentAttributeCondition -> String # showList :: [DocumentAttributeCondition] -> ShowS #
NFData DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods rnf :: DocumentAttributeCondition -> () #
Eq DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods (==) :: DocumentAttributeCondition -> DocumentAttributeCondition -> Bool # (/=) :: DocumentAttributeCondition -> DocumentAttributeCondition -> Bool #
Hashable DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods hashWithSalt :: Int -> DocumentAttributeCondition -> Int # hash :: DocumentAttributeCondition -> Int #
type Rep DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition type Rep DocumentAttributeCondition = D1 ('MetaData "DocumentAttributeCondition" "Amazonka.Kendra.Types.DocumentAttributeCondition" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditionOnValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :: (S1 ('MetaSel ('Just "conditionDocumentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConditionOperator))))

newDocumentAttributeCondition Source #

Arguments

:: Text	`$sel:conditionDocumentAttributeKey:DocumentAttributeCondition'`
-> ConditionOperator	`$sel:operator:DocumentAttributeCondition'`
-> DocumentAttributeCondition

Create a value of DocumentAttributeCondition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:conditionOnValue:DocumentAttributeCondition', documentAttributeCondition_conditionOnValue - The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

$sel:conditionDocumentAttributeKey:DocumentAttributeCondition', documentAttributeCondition_conditionDocumentAttributeKey - The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

$sel:operator:DocumentAttributeCondition', documentAttributeCondition_operator - The condition operator.

For example, you can use 'Contains' to partially match a string.

documentAttributeCondition_conditionOnValue :: Lens' DocumentAttributeCondition (Maybe DocumentAttributeValue) Source #

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

documentAttributeCondition_conditionDocumentAttributeKey :: Lens' DocumentAttributeCondition Text Source #

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

documentAttributeCondition_operator :: Lens' DocumentAttributeCondition ConditionOperator Source #

The condition operator.

For example, you can use 'Contains' to partially match a string.