适用于 Swift 的 Google AI SDK

适用于 Swift 的 Google AI SDK 是 Swift 开发者使用 Gemini API 进行构建的最简便方法。Gemini API 使您可以访问由 Google DeepMind 创建的 Gemini 模型。Gemini 模型从一开始就被设计为多模态，因此您可以无缝地进行文本、图像和代码的推理。

注意

建议仅将适用于 Swift 的 Google AI SDK 用于原型设计。 如果您计划启用结算，我们强烈建议您使用后端 SDK 来访问 Google AI Gemini API。如果您将 API 密钥直接嵌入到您的 Swift 应用程序中，或者在运行时远程获取它，您可能会将您的 API 密钥暴露给恶意行为者。

开始使用 Gemini API

  1. 转到 Google AI Studio。
  2. 使用您的 Google 帐户登录。
  3. 创建一个 API 密钥。请注意，在欧洲，免费层不可用。
  4. 查看此存储库。
    git clone https://github.com/google/generative-ai-swift
  5. 打开并构建此 repo 的 Examples 文件夹中的示例应用程序。
  6. 运行该应用程序一次，以确保构建脚本生成一个空的 GenerativeAI-Info.plist 文件
  7. 将您的 API 密钥粘贴到 GenerativeAI-Info.plist 文件中的 API_KEY 属性中。
  8. 运行该应用程序
  9. 有关详细说明，请尝试在 ai.google.dev 上的 Swift SDK 教程。

用法示例

  1. 使用 Swift Package Manager 将 generative-ai-swift 添加到您的 Xcode 项目。

  2. 导入 GoogleGenerativeAI 模块

import GoogleGenerativeAI
  1. 初始化模型
let model = GenerativeModel(name: "gemini-1.5-flash-latest", apiKey: "YOUR_API_KEY")
  1. 运行提示词
let cookieImage = UIImage(...)
let prompt = "Do these look store-bought or homemade?"

let response = try await model.generateContent(prompt, cookieImage)

有关详细说明，您可以在 Google 文档中找到适用于 Swift 的 Google AI SDK 的 快速入门。

此快速入门介绍了如何将您的 API 密钥和 Swift 包添加到您的应用程序，初始化模型，然后调用 API 来访问模型。它还介绍了一些其他用例和功能，例如流式传输、计算令牌和控制响应。

日志记录

要在 Xcode 控制台中启用额外的日志记录，包括每个模型请求的 cURL 命令和原始流响应，请在 Xcode 方案中添加 -GoogleGenerativeAIDebugLogEnabled 作为 Arguments Passed On Launch。

命令行工具

提供了一个命令行工具，可以通过 Xcode 或命令行来试验 Gemini 模型请求

  1. open Examples/GenerativeAICLI/Package.swift
  2. 在 Xcode 中运行并检查控制台以查看选项。
  3. 使用所需的选项编辑方案的 Arguments Passed On Launch。

文档

有关完整文档，请参阅 Gemini API Cookbook 或 ai.google.dev。

贡献

有关贡献于 Swift 的 Google AI SDK 的更多信息，请参阅 Contributing。

使用 Swift 的 PaLM SDK 的开发者（已停用）

重要

PaLM API 现在已停用。这意味着用户无法在提示词中使用 PaLM 模型、调整新的 PaLM 模型或对 PaLM 调整的模型运行推理。

注意：这与计划于 2024 年 10 月停用的 Vertex AI PaLM API 不同。

如果您正在使用 Swift 的 PaLM SDK，请将您的代码迁移到 Gemini API 并将您应用程序的 generative-ai-swift 依赖项更新到 0.4.0 或更高版本。有关从 PaLM 迁移到 Gemini 的更多信息，请参阅迁移指南。

许可

本存储库的内容已获得 Apache License，版本 2.0 的许可。