Skip to main content

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

Project description

GenAI IDP BedrockLlmProcessor

Compatible with GenAI IDP version: 0.3.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, ClassificationMethod } 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,
      configuration: /* Your BedrockLlmProcessorConfiguration */,
      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

cdklabs_genai_idp_bedrock_llm_processor-0.0.2.tar.gz (235.9 kB view details)

Uploaded Source

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.0.2.tar.gz.

File metadata

File hashes

Hashes for cdklabs_genai_idp_bedrock_llm_processor-0.0.2.tar.gz
Algorithm Hash digest
SHA256 e8c7bdac5e54030844ead0d8999087ccce8f60e2d6a2ec348109aec2212ce340
MD5 c3fec721d00b20adebd3cf7a9813ea03
BLAKE2b-256 c43e39e8a9843a46207226eb5b755cc87f74d4fef25f03efaf0a6743f53b6b19

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdklabs_genai_idp_bedrock_llm_processor-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fa73c5034b0470697d70c3ab88d96c34ab4e94c8ac0308683ce56286920fb331
MD5 23eab32b970cd730f7e8203fbac3fac4
BLAKE2b-256 5e5981ab762fb0677cf35e016b56ff562fb9373482d76015000d718125077912

See more details on using hashes here.

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