# @aws-amplify/graphql-generation-transformer 中文文档

规范地址：https://npmcn.com/package/%40aws-amplify/graphql-generation-transformer/

版本：1\.2\.9
npm 元数据更新时间：2026-09-30T16:49:31.738Z
中文译文更新时间：2026-11-07T13:49:56.952Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-amplify/graphql-generation-transformer
原文对照：https://npmcn.com/package/%40aws-amplify/graphql-generation-transformer/?lang=original
项目主页：https://github.com/aws-amplify/amplify-category-api#readme
源码仓库：https://github.com/aws-amplify/amplify-category-api

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

- 包体积（解压后）：61.9 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：constructs ^10\.3\.0，aws-cdk-lib ^2\.224\.0
- 首次发布：2024-08-15T21:42:59.104Z
- 最新版本发布：2026-09-30T16:49:31.547Z
- 近 30 天下载量：52442（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 5 个）

## 中文简介

放大图QL@ 生成变压器

## 安装

```sh
npm install @aws-amplify/graphql-generation-transformer
```

也可以使用：`pnpm add @aws-amplify/graphql-generation-transformer`、`yarn add @aws-amplify/graphql-generation-transformer`、`bun add @aws-amplify/graphql-generation-transformer`

## README

# 放大图形QL 生成变换器

AWS AppSync API内部的 Amplify GraphQL 世代变换器是一个工具,可以快速而轻松地创建AI-power Crowth 路由. 这个变压器可以通过使用 `@generation` 指令配置生成内容的AI模型和系统提示.

## 安装

```bash
npm install @aws-amplify/graphql-generation-transformer
```

## 指令定义

这个 `@generation` 指令的定义如下:

```graphql
directive @generation(aiModel: String!, systemPrompt: String!, inferenceConfiguration: GenerationInferenceConfiguration) on FIELD_DEFINITION
```

## 特征

1.  AI模型集成:指定用于生成的AI模型.
2.  系统快取配置:定义一个系统快取来指导AI的输出.
3.  推论配置:微调生成参数,如最大符号,温度,和上-p.
4.  与 `@auth` 指令:支持IAM,API密钥等现有认证模式,以及Amazon Cognitto用户池.
5.  解析器创建:生成基于Query字段返回类型的工具定义的解析器与指定的AI模型进行交互.
6.  Bedrock HTTP Data Source Create:为Bedrock创建了AppSync HTTP Data Source,用于与指定的AI模型交互.

## 实例

### 基本用途

#### Scalar 类型生成

```graphql
type Query {
  generateStory(topic: String!): String
    @generation(
      aiModel: "anthropic.claude-3-haiku-20240307-v1:0"
      systemPrompt: "You are a creative storyteller. Generate a short story based on the given topic."
    )
}
```

#### 复杂类型生成

```graphql
type Recipe {
  name: String!
  ingredients: [String!]!
  instructions: [String!]!
  prepTime: Int!
  cookTime: Int!
  servings: Int!
  difficulty: String!
}

type Query {
  generateRecipe(cuisine: String!, dietaryRestrictions: [String]): Recipe
    @generation(
      aiModel: "anthropic.claude-3-haiku-20240307-v1:0"
      systemPrompt: "You are a professional chef specializing in creating recipes. Generate a detailed recipe based on the given cuisine and dietary restrictions."
    )
}
```

### 高级配置

```graphql
type Query {
  generateCode(description: String!): String
    @generation(
      aiModel: "anthropic.claude-3-haiku-20240307-v1:0"
      systemPrompt: "You are an expert programmer. Generate code based on the given description."
      inferenceConfiguration: { maxTokens: 500, temperature: 0.7, topP: 0.9 }
    )
}
```

## 限制

-   这个 `@generation` 指令只能用于查询字段.
-   规定的AI模式必须:
    -   由 Amazon Bedrock 的 / 逆向 API 支持
    -   支持工具的使用
-   目前不支持一些AppSync scalar类型.

## 常见问题

### @aws-amplify/graphql-generation-transformer 是什么？

放大图QL@ 生成变压器

### 如何安装 @aws-amplify/graphql-generation-transformer？

在项目目录运行 npm install @aws-amplify/graphql-generation-transformer，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：constructs（^10\.3\.0）、aws-cdk-lib（^2\.224\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aws-amplify/graphql-generation-transformer 支持 TypeScript 吗？

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

### @aws-amplify/graphql-generation-transformer 支持 ESM 还是 CommonJS？

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

### @aws-amplify/graphql-generation-transformer 可以商用吗？

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

### @aws-amplify/graphql-generation-transformer 的下载量有多少？

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

### @aws-amplify/graphql-generation-transformer 还在维护吗？

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

