@genesis-xyz/ai

中文文档
0.0.8发布于 2024/01/25MITTypeScriptES Module近 30 天下载 1.2万

允许用户用自己的 OpenAI API 密钥签名的 Auth, 这样您就可以构建由用户驱动的应用程序 。 你的应用,他们的API用法.

中文使用文档
文档目录6 节
  1. 使用 AI 签名
  2. 为什么要用"签入AI"来构建应用程序??
  3. 安装
  4. 使用量
  5. 财务问题
  6. 用户:我如何获得 OpenAI API 密钥?

使用 AI 签名

允许用户用自己的 OpenAI API 密钥签名的 Auth, 这样您就可以构建由用户驱动的应用程序 。 你的应用,他们的API用法.

用户 OpenAI API 密钥将不会与您的应用程序共享 。 相反,你的应用程序会收到一个 apiKey 财务报告和审定财务报表 baseURL 用于使用用户 API 密钥的 OpenAI API 代理服务器.

为什么要用"签入AI"来构建应用程序??

因为我们相信开发者应该更容易为AI应用程序进行实验并构建出新的想法.

对于他们所搭建的每一个新应用,开发者也开始负责使用OpenAI API的成本,以及如果使用量增加,利用GPT-4等尖端模型可以携带一大笔帐单的应用. 将成本负担乘以几个应用创意,这需要大量的管理费,使得建立新的应用创意更难证明合理.

因此,让用户直接将个人的OpenAI API密钥粘贴到应用程序中越来越普遍. 用户在每一个想要尝试的新应用中手动粘贴API密钥.

Genesis通过为用户提供用自己的OpenAI API密钥签名的方式,为用户尝试更多的AI应用提供了更安全的方法,并赋予开发者更轻松地构建应用理念的能力,而无需承担计算的全部成本负担. 这对每个参与者来说都是双赢的.

安装

bun add @genesis-xyz/ai

把这个脚本添加到 <head> 您网站的标记 :

<script src="https://unpkg.com/@passes/polyfill@^0.1.5"></script>

使用量

requestOpenAIAPI 返回以下类型,可直接传递到 OpenAI sdk 构造器.

type RequestOpenAIAPIResult = {
  apiKey: string;
  baseURL: string;
};

与 openai sdk : (中文(简体) )

import { requestOpenAIAPI } from '@genesis-xyz/ai';
import { OpenAI } from 'openai';

// Request the user to "Sign In With OpenAI"
const openai = new OpenAI(await requestOpenAIAPI());

const chat = await openai.chat.completions.create({
  model: 'gpt-4',
  stream: true,
  messages: [{ role: 'user', content: 'Hello OpenAI!' }],
});

与客户端 fetch数字 :

import { requestOpenAIAPI } from '@genesis-xyz/ai';
import { OpenAI } from 'openai';

// Request the user to "Sign In With OpenAI"
const { baseURL, apiKey } = await requestOpenAIAPI();

// Use fetch to request the OpenAI API
const result = await fetch(`${baseURL}/chat/completions`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model: 'gpt-4',
    messages: [{ role: 'user', content: 'Hello OpenAI!' }],
  }),
})

财务问题

怎么会这样?

请求用户提供 OpenAI API 密钥

  1. 当一个用户第一次为您的应用程序签名时,会打开一个新的分页并请求用户输入他们的OpenAI API密钥,并用 Passkey 进行安全保护.
  2. API密钥被加密并存储,以便于未来访问.
  3. 你的应用程序得到一个 apiKey 财务报告和审定财务报表 baseURL 用于配置 openai SDK(英语:SDK).

代理 OpenAI API

  1. 您的应用程序发送请求到提供的 baseURL,这是OpenAI的API的代理.
  2. 代理用用户的OpenAI API密钥向OpenAI发送请求.
  3. OpenAI的回复被流到您的应用程序.
用户数据是如何安全的?
  • 加密的 API 密钥. 用户 API 密钥被包裹在(加密的)JWT中,既用于存储也用于传输,这意味着密钥从未被直接暴露到请求的站点,也从未通过网络以纯文本传输.
  • 反转代理. Genesis 主持一个用于代理OpenAI API请求的安全中介层,处理用户API密钥的解密,并将请求转发给OpenAI. 反向代理允许客户端使用OpenAI API的全部功能(包括流出)而从未处理过用户API密钥.

用户:我如何获得 OpenAI API 密钥?

目前,这是一个人工过程:

  1. 如果您已经拥有 OpenAI 账户, 请签名 在开发者平台上如果没有,就在这里注册一个账户.

    oai-dev-platform
  2. 要获得 API 密钥,请单击 锁定图标 在左侧工具栏中.

    dev-platform-sidebar-toggle
  3. 您可以在此页面上看到您创建的所有 API 密钥 。 要创建新的 API 密钥, 请选择 Create new secret key,给出名称,然后复制出现的 API 密钥.

    • 注意: 任何先前创建的 API 密钥都无法从此页面取回, 因此在创建时一定要保存密钥 .
    api-key-list
  4. 粘贴文本字段中的 API 密钥并批准请求 .

    genesis-request

版本与发布记录

@genesis-xyz/ai 共发布 8 个版本,首次发布于 2024/01/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.8latest2024/01/252 年前
0.0.72024/01/252 年前
0.0.62024/01/242 年前
0.0.52024/01/212 年前
0.0.42024/01/202 年前
0.0.32024/01/192 年前

关于 @genesis-xyz/ai 的常见问题

@genesis-xyz/ai 是什么?

允许用户用自己的 OpenAI API 密钥签名的 Auth, 这样您就可以构建由用户驱动的应用程序 。 你的应用,他们的API用法.

如何安装 @genesis-xyz/ai?

在项目目录运行 npm install @genesis-xyz/ai,或使用 pnpm add / yarn add / bun add。

@genesis-xyz/ai 支持 TypeScript 吗?

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

@genesis-xyz/ai 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@genesis-xyz/ai 可以商用吗?

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

@genesis-xyz/ai 的下载量有多少?

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

@genesis-xyz/ai 还在维护吗?

最新版本 0.0.8 发布于 2024/01/25(2 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/01/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。