Struct aws_sdk_qbusiness::types::DocumentEnrichmentConfiguration

#[non_exhaustive]
pub struct DocumentEnrichmentConfiguration {
    pub inline_configurations: Option<Vec<InlineDocumentEnrichmentConfiguration>>,
    pub pre_extraction_hook_configuration: Option<HookConfiguration>,
    pub post_extraction_hook_configuration: Option<HookConfiguration>,
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

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.

inline_configurations: Option<Vec<InlineDocumentEnrichmentConfiguration>>

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.

pre_extraction_hook_configuration: Option<HookConfiguration>

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

post_extraction_hook_configuration: Option<HookConfiguration>

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

Implementations

impl DocumentEnrichmentConfiguration

pub fn inline_configurations(&self) -> &[InlineDocumentEnrichmentConfiguration]

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inline_configurations.is_none().

pub fn pre_extraction_hook_configuration(&self) -> Option<&HookConfiguration>

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

pub fn post_extraction_hook_configuration(&self) -> Option<&HookConfiguration>

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

impl DocumentEnrichmentConfiguration

pub fn builder() -> DocumentEnrichmentConfigurationBuilder

Creates a new builder-style object to manufacture DocumentEnrichmentConfiguration.

Trait Implementations

impl Clone for DocumentEnrichmentConfiguration

fn clone(&self) -> DocumentEnrichmentConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentEnrichmentConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DocumentEnrichmentConfiguration

fn eq(&self, other: &DocumentEnrichmentConfiguration) -> 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 DocumentEnrichmentConfiguration