项目介绍:generative-ai-js
概述
generative-ai-js 是一个专为 JavaScript 开发者设计的 Google AI SDK,致力于帮助他们便捷地使用 Gemini API。Gemini API 允许开发者访问由 Google DeepMind 打造的 Gemini 模型。这些模型出色之处在于其多模式的特性,能够无缝地处理文本、图像和代码数据。
注意事项
对于希望使用此 SDK 的开发者,官方建议仅在客户端应用中进行原型设计时直接使用 Google AI SDK。如果计划启用计费功能,则强烈建议只在服务器端调用 Google AI Gemini API,以保护 API 密钥的安全,因为在 JavaScript 应用中直接嵌入 API 密钥或在运行时远程获取它会有暴露给恶意攻击者的风险。
快速开始
要开始使用 Gemini API,开发者可以按照以下步骤操作:
- 前往 Google AI Studio 网站。
- 使用 Google 账号进行登录。
- 创建一个 API 密钥,需注意在欧洲地区不提供免费试用级别。
- 尝试使用 Node.js 快速入门教程。
使用示例
以下是如何使用该 SDK 的简单步骤:
-
安装 SDK 包:
npm install @google/generative-ai
-
初始化模型:
const { GoogleGenerativeAI } = require("@google/generative-ai"); const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" });
-
运行提示:
const prompt = "Does this look store-bought or homemade?"; const image = { inlineData: { data: Buffer.from(fs.readFileSync("cookie.png")).toString("base64"), mimeType: "image/png", }, }; const result = await model.generateContent([prompt, image]); console.log(result.response.text());
示例应用
本项目的仓库中提供了示例 Node 和 web 应用,展示了如何使用 SDK 来访问和利用 Gemini 模型处理各种用例。
运行示例 Node 应用的步骤如下:
- 克隆仓库:
git clone https://github.com/google/generative-ai-js
- 获取一个 API 密钥以便使用 Google AI SDK。
- 进入
samples
目录并运行npm install
。 - 将 API 密钥分配给环境变量:
export API_KEY=MY_API_KEY
。 - 打开感兴趣的示例文件,例如
text_generation.js
。在runAll()
函数中,注释掉不想运行的示例。 - 运行示例文件,例如:
node text_generation.js
。
文档
开发者可以通过 Gemini API 烹饪书或 ai.google.dev 获取完整的文档。
贡献
详细的贡献信息请参阅贡献指南文件。
许可证
本仓库的内容基于 Apache License, version 2.0 授权。