Skip to main content

@cdklabs/genai-idp-bedrock-llm-processor

Project description

GenAI IDP BedrockLlmProcessor

⚠️ DEPRECATION NOTICE: Starting with v0.5.0 of the GenAI IDP Core accelerator, a unified processing architecture with a single configurable Step Functions workflow will be introduced. While Bedrock LLM-based document processing capabilities will continue to be supported, the current standalone processor package structure will be replaced with an integrated configuration-driven approach. We recommend monitoring the core accelerator's v0.5.0 release notes for migration guidance.

Compatible with GenAI IDP version: 0.4.16 Stability: Experimental License

This package is provided on an "as-is" basis, and may include bugs, errors, or other issues. All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Overview

The GenAI IDP BedrockLlmProcessor implements intelligent document processing using custom extraction with Amazon Bedrock foundation models. This package provides a flexible AWS CDK implementation for extracting structured data from a wide range of document types, offering greater control over the extraction process compared to the BdaProcessor.

The BedrockLlmProcessor is ideal for processing complex or custom document types where you need fine-grained control over the extraction process, or when dealing with documents that don't fit standard templates.

Ready to dive deeper? Explore our comprehensive API documentation to discover all available constructs and configuration options that will help you build powerful custom document processing solutions.

Features

  • Custom Extraction Logic: Fine-grained control over how information is extracted from documents
  • Multiple Classification Methods: Support for page-level and document-level classification
  • Multimodal Processing: Analyze both text and visual elements for improved accuracy
  • Flexible Schema Definition: Define custom extraction schemas for your specific document types
  • Document Summarization: Optional AI-powered document summarization capabilities
  • Evaluation Framework: Built-in mechanisms for evaluating extraction quality
  • Comprehensive Metrics: Detailed CloudWatch metrics for monitoring processing performance
  • Configurable Concurrency: Control processing throughput and resource utilization

Getting Started

Installation

The package is available through npm for JavaScript/TypeScript projects and PyPI for Python projects.

JavaScript/TypeScript (npm)

# Using npm
npm install @cdklabs/genai-idp-bedrock-llm-processor @cdklabs/genai-idp

# Using yarn
yarn add @cdklabs/genai-idp-bedrock-llm-processor @cdklabs/genai-idp

Python (PyPI)

# Using pip
pip install cdklabs.genai-idp-bedrock-llm-processor cdklabs.genai-idp

# Using poetry
poetry add cdklabs.genai-idp-bedrock-llm-processor cdklabs.genai-idp

Basic Usage

Here's how to integrate BedrockLlmProcessor into your IDP solution:

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as kms from 'aws-cdk-lib/aws-kms';
import * as bedrock from '@cdklabs/generative-ai-cdk-constructs/lib/cdk-lib/bedrock';
import { ProcessingEnvironment } from '@cdklabs/genai-idp';
import { BedrockLlmProcessor, BedrockLlmProcessorConfiguration } from '@cdklabs/genai-idp-bedrock-llm-processor';

export class MyIdpStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Create encryption key
    const key = new kms.Key(this, 'IdpKey', {
      enableKeyRotation: true,
    });

    // Create S3 buckets for input and output
    const inputBucket = new s3.Bucket(this, 'InputBucket', {
      encryption: s3.BucketEncryption.KMS,
      encryptionKey: key,
      eventBridgeEnabled: true,
    });

    const outputBucket = new s3.Bucket(this, 'OutputBucket', {
      encryption: s3.BucketEncryption.KMS,
      encryptionKey: key,
    });

    const workingBucket = new s3.Bucket(this, 'WorkingBucket', {
      encryption: s3.BucketEncryption.KMS,
      encryptionKey: key,
    });

    // Create processing environment
    const environment = new ProcessingEnvironment(this, 'Environment', {
      key,
      inputBucket,
      outputBucket,
      workingBucket,
      metricNamespace: 'MyIdpSolution',
    });

    // Create the processor
    const processor = new BedrockLlmProcessor(this, 'Processor', {
      environment,
      // Replace with your own configuration - this is just a sample
      configuration: BedrockLlmProcessorConfiguration.lendingPackageSample(),
      classificationMaxWorkers: 10,
      ocrMaxWorkers: 20,
    });
  }
}

Classification Methods

BedrockLlmProcessor supports two classification methods to accommodate different document types:

  • MULTIMODAL_PAGE_LEVEL_CLASSIFICATION: Uses multimodal models to classify documents at the page level. Analyzes both text and visual elements on each page for classification. This method is effective for documents where each page may belong to a different document type or category.
  • TEXTBASED_HOLISTIC_CLASSIFICATION: Uses text-based analysis to classify the entire document holistically. Considers the full document text content for classification decisions. This method is more efficient and cost-effective as it only processes the extracted text.

Choose the classification method that best suits your document types and processing requirements.

Configuration

BedrockLlmProcessor supports extensive configuration options:

  • Classification Method: Choose how documents are classified and categorized
  • Invokable Models: Specify which models to use for classification, extraction, evaluation, and summarization
  • Guardrails: Apply content guardrails to model interactions
  • Concurrency: Control processing throughput and resource utilization
  • VPC Configuration: Deploy in a VPC for enhanced security and connectivity

For detailed configuration options, refer to the TypeScript type definitions and JSDoc comments in the source code.

Contributing

We welcome contributions to the GenAI IDP BedrockLlmProcessor! Please follow these steps to contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Please ensure your code adheres to our coding standards and includes appropriate tests.

Related Projects

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.


Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file cdklabs_genai_idp_bedrock_llm_processor-0.2.1.tar.gz.

File metadata

File hashes

Hashes for cdklabs_genai_idp_bedrock_llm_processor-0.2.1.tar.gz
Algorithm Hash digest
SHA256 657a9b590b49fbf5214bebfef14221f6a66039888f6ff30c3d7ff82e9b410652
MD5 3fd8657689175d0811c6042d956a64f4
BLAKE2b-256 4019ec9b3b1115792dfd163e242f90a78b080b42b499f0a00e4ea7803408e675

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdklabs_genai_idp_bedrock_llm_processor-0.2.1.tar.gz:

Publisher: release.yml on cdklabs/genai-idp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cdklabs_genai_idp_bedrock_llm_processor-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cdklabs_genai_idp_bedrock_llm_processor-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 38339627af5f320db1564edcb0bc9107dbe6465a7d7d0d07ffd9806d43c43931
MD5 bd3092c0c4ed37f143e23c1df2caa5cc
BLAKE2b-256 89381e969f44dfe52bde84af82301e3e7b68f2e28ac3245154fcca99591066ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdklabs_genai_idp_bedrock_llm_processor-0.2.1-py3-none-any.whl:

Publisher: release.yml on cdklabs/genai-idp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page