Interface CfnDataSource.DocumentAttributeConditionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.DocumentAttributeConditionProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
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 Q Business can't 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 Q Business then will map your newly created metadata field to your index field.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.qbusiness.*; DocumentAttributeConditionProperty documentAttributeConditionProperty = DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.DocumentAttributeConditionProperty
static final class
An implementation forCfnDataSource.DocumentAttributeConditionProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getKey
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 Q Business currently doesn't support
_document_body
as an attribute key used for the condition.- See Also:
-
getOperator
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 Q Business currently does not support
_document_body
as an attribute key used for the condition.- See Also:
-
getValue
The value of a document attribute.You can only provide one value for a document attribute.
- See Also:
-
builder
-