# @cdklabs/genai-idp 中文文档

规范地址：https://npmcn.com/package/%40cdklabs/genai-idp/

版本：0\.3\.1
npm 元数据更新时间：2026-05-18T07:53:43.658Z
中文译文更新时间：2026-11-09T19:12:53.048Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cdklabs/genai-idp
原文对照：https://npmcn.com/package/%40cdklabs/genai-idp/?lang=original
项目主页：https://github.com/cdklabs/genai-idp#readme
源码仓库：https://github.com/cdklabs/genai-idp

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：21.4 MB，1384 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@aws-cdk/aws-bedrock-agentcore-alpha ^2\.241\.0-alpha\.0，@aws-cdk/aws-bedrock-alpha ^2\.241\.0-alpha\.0，@aws-cdk/aws-glue-alpha ^2\.241\.0-alpha\.0，@aws-cdk/aws-lambda-python-alpha ^2\.241\.0-alpha\.0，@aws-cdk/aws-sagemaker-alpha ^2\.241\.0-alpha\.0，@cdklabs/generative-ai-cdk-constructs ^0\.1\.314，aws-cdk-lib ^2\.241\.0，constructs ^10\.5\.1
- 首次发布：2025-09-24T09:27:21.456Z
- 最新版本发布：2026-05-18T07:53:43.305Z
- 近 30 天下载量：1812（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 4 个）

## 中文简介

[![Compatible with GenAI IDP version: 0.5.2](https://img.shields.io/badge/Compatible%20with%20GenAI%20IDP-0.5.2-brightgreen)](https://github.com/aws-solutions-library-samples/accelerated-intelligent-document-processing-on-aws/releases/tag/v0.5.2) \[稳定

## 安装

```sh
npm install @cdklabs/genai-idp
```

也可以使用：`pnpm add @cdklabs/genai-idp`、`yarn add @cdklabs/genai-idp`、`bun add @cdklabs/genai-idp`

## README

# GenAI 境内流离失所者核心一揽子计划

[![Compatible with GenAI IDP version: 0.5.2](https://img.shields.io/badge/Compatible%20with%20GenAI%20IDP-0.5.2-brightgreen)](https://github.com/aws-solutions-library-samples/accelerated-intelligent-document-processing-on-aws/releases/tag/v0.5.2) ![Stability: Experimental](https://img.shields.io/badge/Stability-Experimental-important.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

> 此软件包是在"是"的基础上提供的,可能包括错误,出错或其他问题. 所有类别都在积极开发中,在任何类别中都需进行非后向相容修改或去除 未来版本. 这些限制不受《公约》的约束 [语义版本](https://semver.org/) 型号. 这意味着虽然您可能使用它们,但在升级到此软件包的更新版本时可能需要更新您的源代码.

* * *

## 概览

GenAI IDP核心软件包为构建智能文件处理解决方案提供了基础AWS CDK架构. 这个软件包作为GenAI智能文档处理(IDP)加速器的骨干,使各组织能够利用AWS最新的AI/ML服务,将无结构化的文档大规模地转换为结构化的数据.

关于所有现有建筑及其特性的全面参考,请探索 [API 文档](https://npmcn.com/package/%40cdklabs/genai-idp/API.md)。该详细指南将帮助您了解这个软件包的全部能力以及如何在您的项目中加以利用.

## 特征

-   **模块结构**: 可组合的 CDK 构造, 可以创建完整的文档处理解决方案
-   **文件处理基础设施**: 文件摄入、跟踪和管理的核心组成部分
-   **处理环境 API**: 用于监测文件处理状况和结果的图表QL API
-   **Web 应用程序支持**: 文件跟踪和管理的可选安全网络界面
-   **可扩展设计**: 设计用于多种文件处理模式和AI/ML服务
-   **安全第一办法**: 内置加密支持、 IAM 权限和安全数据处理
-   **观察性**:用于监测和排除故障的综合云表计量、日志和警报

## 开始

### 安装

该软件包通过npm为JavaScript/TypeScript项目提供,为Python项目提供PyPI.

#### Java 脚本/ Type 脚本( npm)

```bash
# Using npm
npm install @cdklabs/genai-idp

# Using yarn
yarn add @cdklabs/genai-idp
```

#### Python (PyPI) (英语)

```bash
# Using pip
pip install cdklabs.genai-idp

# Using poetry
poetry add cdklabs.genai-idp
```

### 基本用途

以下是如何使用国内流离失所者核心结构的简单例子:

```typescript
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 { ProcessingEnvironment } from '@cdklabs/genai-idp';

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',
    });

    // Attach document processors to the environment
    // (processors are provided by separate packages)
  }
}
```

## API 参考

### 关键部件

-   **处理环境**: 主持文件处理工作流程的主要构造
-   **处理环境**: 用于监测文件处理状态的 GraphQL API
-   **文件处理器**: 文件处理执行的接口
-   **日志级别**: 用于控制日志动词的 Enum

关于详细的API文档,请参见源代码中的TypeScript类型定义和JSDoc评论.

## 捐款

我们欢迎向GenAI境内流离失所者核心一揽子计划提供捐款! 请遵照这些步骤作出贡献:

1.  叉子存储器
2.  创建特性分支( E)`git checkout -b feature/amazing-feature`(中文(简体) )
3.  提交更改( E)`git commit -m 'Add some amazing feature'`(中文(简体) )
4.  推向分行(`git push origin feature/amazing-feature`(中文(简体) )
5.  打开拉请求

请确保您的代码符合我们的编码标准,并包括适当的测试.

## 相关项目

-   [@cdklabs/genai-idp-bda-处理器](https://npmcn.com/package/%40cdklabs/genai-idp-bda-processor): BdaProcessor 使用 Amazon Bedrock 数据自动化程序执行
-   [@cdklabs/genai-idp-bedrock-llm-处理器](https://npmcn.com/package/%40cdklabs/genai-idp-bedrock-llm-processor): BedrockLlm 应用亚马逊 Bedrock 模型自定义提取程序
-   [@cdklabs/genai-idp-sagemaker-udop-处理器](https://npmcn.com/package/%40cdklabs/genai-idp-sagemaker-udop-processor): SagemakerUdop 专用文件处理程序使用 SageMaker 端点

## 许可证

这个项目根据Apache许可证2.0获得许可——见 [自由主义](https://npmcn.com/package/%40cdklabs/genai-idp/LICENSE) 详细文件.

* * *

版权:Amazon.com公司或其附属公司。 所有权利保留.

## 常见问题

### @cdklabs/genai-idp 是什么？

\[稳定

### 如何安装 @cdklabs/genai-idp？

在项目目录运行 npm install @cdklabs/genai-idp，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aws-cdk/aws-bedrock-agentcore-alpha（^2\.241\.0-alpha\.0）、@aws-cdk/aws-bedrock-alpha（^2\.241\.0-alpha\.0）、@aws-cdk/aws-glue-alpha（^2\.241\.0-alpha\.0）、@aws-cdk/aws-lambda-python-alpha（^2\.241\.0-alpha\.0）、@aws-cdk/aws-sagemaker-alpha（^2\.241\.0-alpha\.0）、@cdklabs/generative-ai-cdk-constructs（^0\.1\.314）、aws-cdk-lib（^2\.241\.0）、constructs（^10\.5\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cdklabs/genai-idp 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cdklabs/genai-idp 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cdklabs/genai-idp 可以商用吗？

@cdklabs/genai-idp 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cdklabs/genai-idp 的下载量有多少？

根据 npm 官方下载统计，@cdklabs/genai-idp 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,812 次，日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cdklabs/genai-idp 还在维护吗？

最新版本 0\.3\.1 发布于 2026/05/18（5 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 4 个；首次发布于 2025/09/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。