Struct aws_sdk_qbusiness::types::DocumentAttributeCondition

#[non_exhaustive]
pub struct DocumentAttributeCondition {
    pub key: String,
    pub operator: DocumentEnrichmentConditionOperator,
    pub value: Option<DocumentAttributeValue>,
}

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. 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 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 then will map your newly created metadata field to your index field.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: String

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 currently doesn't support _document_body as an attribute key used for the condition.

operator: DocumentEnrichmentConditionOperator

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.

value: Option<DocumentAttributeValue>

The value of a document attribute. You can only provide one value for a document attribute.

Implementations

impl DocumentAttributeCondition

pub fn key(&self) -> &str

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 currently doesn't support _document_body as an attribute key used for the condition.

pub fn operator(&self) -> &DocumentEnrichmentConditionOperator

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.

pub fn value(&self) -> Option<&DocumentAttributeValue>

The value of a document attribute. You can only provide one value for a document attribute.

impl DocumentAttributeCondition

pub fn builder() -> DocumentAttributeConditionBuilder

Creates a new builder-style object to manufacture DocumentAttributeCondition.

Trait Implementations

impl Clone for DocumentAttributeCondition

fn clone(&self) -> DocumentAttributeCondition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentAttributeCondition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentAttributeCondition

fn eq(&self, other: &DocumentAttributeCondition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentAttributeCondition