# @gapi/openai 中文文档

规范地址：https://npmcn.com/package/%40gapi/openai/

版本：1\.8\.263
npm 元数据更新时间：2026-11-15T16:23:35.327Z
中文译文更新时间：2026-11-15T23:07:26.221Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：34.4 kB，30 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@gapi/core ^1\.8\.171
- 首次发布：2023-02-25T10:09:44.321Z
- 最新版本发布：2026-11-15T16:23:35.175Z
- 近 30 天下载量：4881（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：127（近 12 个月 116 个）

## 中文简介

`bash npm install @gapi/openai`

## 安装

```sh
npm install @gapi/openai
```

也可以使用：`pnpm add @gapi/openai`、`yarn add @gapi/openai`、`bun add @gapi/openai`

## README

### @gapi/ openai (英语)

#### 安装

```bash
npm install @gapi/openai
```

#### 使用量

```typescript
import { Module } from '@gapi/core';
import { OpenAIModue } from '@gapi/openai';

@Module({
  imports: [
    OpenAIModue.forRoot({
      organization: 'org-ahnoIvsiO25Jq4hXeMxO3Fo8',
      apiKey: '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',
    })
  ]
})
export class AppModule {}
```

#### 导入后曝光了图克l突变

```graphql
mutation {
  createCompletion(
    payload: {
      model: "text-davinci-003"
      prompt: "Can you write a description for a trello like card based on this text 'Create home landing page'"
      max_tokens: 2048
    }
  ) {
    id
    object
    created
    model
    choices {
      text
      index
      logprobs
      finish_reason
    }
    usage {
      prompt_tokens
      completion_tokens
      total_tokens
    }
  }
}
```

#### 创建聊天补全提示

```graphql
mutation {
  createChatCompletion(
    payload: {
      model: "gpt-3.5-turbo"
      prompt: "Can you write a description for card based on this text 'Create inside user portal page which will show when user log in to the system'"
      max_tokens: 2048
    }
  ) {
    id
    object
    created
    model
    choices {
      text
      message {
        role
        content
      }
      index
      logprobs
      finish_reason
    }
    usage {
      prompt_tokens
      completion_tokens
      total_tokens
    }
  }
}

```

#### 使用内部提供的注射符来扩展 OpenAPI 图克l 端点 `OpenAI`

```typescript
import { Controller, GraphQLNonNull, Inject, Mutation, Type } from '@gapi/core';
import {
  CreateCompletionInputType,
  CreateCompletionRequest,
  CreateCompletionType,
  OpenAI,
} from '@gapi/openai';
import { from } from 'rxjs';
import { map } from 'rxjs/operators';

@Controller()
export class CustomControllerController {
  constructor(@Inject(OpenAI) private openai: OpenAI) {}

  @Type(CreateCompletionType)
  @Mutation({
    payload: {
      type: new GraphQLNonNull(CreateCompletionInputType),
    },
  })
  createCompletion(root, { payload }: { payload: CreateCompletionRequest }) {
    return from(
      this.openai.createCompletion({
        ...payload,
        max_tokens: payload.max_tokens ?? 2048,
      }),
    ).pipe(map((res) => res.data));
  }


  @Type(CreateCompletionType)
  @Mutation({
    payload: {
      type: new GraphQLNonNull(CreateCompletionInputType),
    },
  })
  createChatCompletion(
    root,
    { payload }: { payload: CreateCompletionRequest },
  ) {
    return from(
      this.openai.createChatCompletion({
        messages: [{
          role: 'user',
          content: payload.prompt as string
        }],
        max_tokens: payload.max_tokens ?? 2048,
      }),
    ).pipe(map((res) => res.data));
  }
}

```

## 常见问题

### @gapi/openai 是什么？

bash npm install @gapi/openai

### 如何安装 @gapi/openai？

在项目目录运行 npm install @gapi/openai，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@gapi/core（^1\.8\.171）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gapi/openai 支持 TypeScript 吗？

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

### @gapi/openai 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gapi/openai 可以商用吗？

@gapi/openai 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gapi/openai 的下载量有多少？

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

### @gapi/openai 还在维护吗？

最新版本 1\.8\.263 发布于 2026/11/16（今天）；至今共发布 127 个版本，其中过去 12 个月发布了 116 个；首次发布于 2023/02/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

