js-genai

官方 TS SDK,几行代码接入 Gemini 多模态与流式对话

开源 free 开发框架
访问官网 ↗ GitHub ↗ 文档 ↗
GitHub 星标 ★ 1690
维护状态 活跃
是否开源 是
定价模式 free

项目预览

项目数据

分类开发框架
开发团队googleapis
所属国家
定价模式free
价格说明开源 SDK,免费使用;调用 Gemini/Vertex AI 按 Google Cloud 计费
访问状态
是否开源是
开源协议Apache-2.0
主要语言TypeScript
技术栈/模型
GitHub 星标★ 1690
30天Star增速
HF 下载量
上线时间2024-12-06 00:00:00
代码更新—
仓库体积—
本站数据更新—
维护状态活跃
中文支持
访问方式
移动端支持
综合评分
收录时间2026-10-19
浏览次数0

项目介绍

js-genai 是 Google 官方推出的 TypeScript/JavaScript SDK,用于在 Node.js 和浏览器中调用 Gemini 与 Vertex AI 的生成式模型。它解决的是前端与全栈开发者接入 Google 大模型时缺少统一、类型安全客户端的问题,替代手写 REST 请求和零散封装。核心能力包括:文本与多模态(图片、音频、视频)生成、流式响应、函数调用(工具调用)、结构化输出、嵌入向量、会话与聊天管理、文件上传与缓存,以及 Gemini Live 实时语音交互;同时支持 Vertex AI 的企业级鉴权和部署方式。SDK 提供完整 TypeScript 类型定义,与官方 API 同步更新,适合在 Web 应用、后端服务和 AI Agent 中快速集成 Google 模型能力。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

正在加载星标数据…

技术标签

使用教程

—

难度:入门 约 10 分钟 部署方式:库/依赖 6 步

环境要求

  • Node.js(3.0.0 起要求 Node.js 22 或更高)
  • npm 包管理环境
  • Google AI Studio 提供的 Gemini API Key
  • TypeScript 或 JavaScript 项目环境

安装与启动步骤

  1. 1获取 API Key

    在 Google AI Studio 创建 API Key,供 SDK 初始化时使用。

  2. 2检查 Node.js

    确认 Node.js 版本;若使用 3.0.0 及以上版本需 Node.js 22+。

    node -v
  3. 3安装 SDK

    在项目目录执行 npm 安装官方包 @google/genai。

    npm install @google/genai
  4. 4配置环境变量

    macOS/Linux 用 export 设置 GEMINI_API_KEY;Windows 可用 set 或系统环境变量。

    export GEMINI_API_KEY=AIzaSyxxxxxxxxxxxxxxxxxxxxxxxx
  5. 5编写示例代码

    新建 index.ts,导入 GoogleGenAI,用 apiKey 初始化并调用 models.generateContent。

  6. 6运行示例

    按你项目的 TypeScript/Node.js 运行方式执行该文件,观察控制台输出。

关键配置

配置项必填说明示例
GEMINI_API_KEY是Gemini API Key,供 GoogleGenAI 初始化鉴权使用AIzaSyxxxxxxxxxxxxxxxxxxxxxxxx

如何确认成功

运行后控制台打印模型对“Why is the sky blue?”的回答,且无鉴权错误。

常见问题

Q:如何避免 SDK 大版本带来意外变更?

A:README 建议将 SDK 版本固定为 < 3.0.0,以避免非预期更新。

Q:对 Node.js 版本有什么要求?

A:从 SDK 3.0.0 起要求 Node.js 22 或更高版本。

Q:API Key 可以放在前端代码里吗?

A:不可以。README 明确警告避免在客户端代码中暴露 API Key。

Q:SDK 支持哪些 Google 后端?

A:支持 Gemini Developer API 和 Gemini Enterprise Agent Platform。

注意事项

  • 不要把 Gemini API Key 暴露在浏览器端或公开仓库中。
  • README 未给出具体运行命令,需按你的 TypeScript/JavaScript 项目配置执行。
  • 下个大版本将调整自动函数调用行为,直接调用 Models.generateContent 将不能触发 AFC,应改用 Chats 模块。
  • 如不希望跟随大版本变化,安装时固定 @google/genai 版本小于 3.0.0。

核心亮点

  • Google 官方维护,与 Gemini/Vertex AI API 同步更新,类型定义完整
  • 同时支持浏览器和 Node.js,覆盖流式输出、函数调用、多模态、Live 实时语音等完整能力
  • 提供 Vertex AI 企业鉴权路径,便于从原型平滑迁移到生产环境

不足之处

  • 强绑定 Google 模型生态,无法直接切换其他厂商模型
  • 相比社区封装,官方 SDK 抽象层较薄,高级编排能力需自行实现

适用场景

  • Web 前端直接集成 Gemini 多模态对话与流式生成
  • Node.js 后端构建函数调用型 AI Agent 或 RAG 服务
  • 企业通过 Vertex AI 在 GCP 上部署带鉴权的生成式应用

替代项目

vercel/ai、langchainjs

上一篇:python-genai

下一篇:genai-processors

同类项目推荐

dsh-our-free-model 开源

装个插件就能免密钥白嫖前沿大模型,不限量

在 dsh 里装上这个插件即可,无需登录、注册或填 API Key,就能使用包括 DeepSeek V4.1 Fl···

★ 23542 2026-10-04
ComfyUI-sol-attn 开源

在 ComfyUI 中让视频生成注意力更快更省显存

NVIDIA Sol-Attn for ComfyUI / Triton kernel on SM89 - SM121, with zero-copy MiniMax ···

★ 155 2026-08-09
langchain 开源

组装 AI 应用的乐高积木,从想法到上线不换工具

The agent engineering platform.

★ 148017 2026-08-09
transformers 开源

全球最大的模型仓库全家桶,想用的模型一把抓

Transformers: the model-definition framework for state-of-the-art machine learning m···

★ 167809 2026-08-09