Google AI SDK for Swift

nephew209 nephew209

The Google AI Swift SDK is the easiest way for Swift developers to build with the Gemini API. The Gemini API gives you access to Gemini models created by Google DeepMind. Gemini models are built from the ground up to be multimodal, so you can reason seamlessly across text, images, and code.

Caution

The Google AI SDK for Swift is recommended for prototyping only. If you plan to enable billing, we strongly recommend that you use a backend SDK to access the Google AI Gemini API. You risk potentially exposing your API key to malicious actors if you embed your API key directly in your Swift app or fetch it remotely at runtime.

Get started with the Gemini API

1. Go to Google AI Studio.
2. Login with your Google account.
3. Create an API key. Note that in Europe the free tier is not available.
4. Check out this repository.
   git clone https://github.com/google/generative-ai-swift
5. Open and build the sample app in the Examples folder of this repo.
6. Run the app once to ensure the build script generates an empty GenerativeAI-Info.plist file
7. Paste your API key into the API_KEY property in the GenerativeAI-Info.plist file.
8. Run the app
9. For detailed instructions, try the Swift SDK tutorial on ai.google.dev.

Usage example

1. Add generative-ai-swift to your Xcode project using Swift Package Manager.

2. Import the GoogleGenerativeAI module

import GoogleGenerativeAI

1. Initialize the model

let model = GenerativeModel(name: "gemini-1.5-flash-latest", apiKey: "YOUR_API_KEY")

1. Run a prompt

let cookieImage = UIImage(...)
let prompt = "Do these look store-bought or homemade?"

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

For detailed instructions, you can find a quickstart for the Google AI SDK for Swift in the Google documentation.

This quickstart describes how to add your API key and the Swift package to your app, initialize the model, and then call the API to access the model. It also describes some additional use cases and features, like streaming, counting tokens, and controlling responses.

Logging

To enable additional logging in the Xcode console, including a cURL command and raw stream response for each model request, add -GoogleGenerativeAIDebugLogEnabled as Arguments Passed On Launch in the Xcode scheme.

Command Line Tool

A command line tool is available to experiment with Gemini model requests via Xcode or the command line:

1. open Examples/GenerativeAICLI/Package.swift
2. Run in Xcode and examine the console to see the options.
3. Edit the scheme's Arguments Passed On Launch with the desired options.

Documentation

See the Gemini API Cookbook or ai.google.dev for complete documentation.

Contributing

See Contributing for more information on contributing to the Google AI SDK for Swift.

Developers who use the PaLM SDK for Swift (Decommissioned)

Important

The PaLM API is now decommissioned. This means that users cannot use a PaLM model in a prompt, tune a new PaLM model, or run inference on PaLM-tuned models.

Note: This is different from the Vertex AI PaLM API, which is scheduled to be decommissioned in October 2024.

​​If you're using the PaLM SDK for Swift, migrate your code to the Gemini API and update your app's generative-ai-swift dependency to version 0.4.0 or higher. For more information on migrating from PaLM to Gemini, see the migration guide.

License

The contents of this repository are licensed under the Apache License, version 2.0.