Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google-gemini/generative-ai-swift
The official Swift library for the Google Gemini API
https://github.com/google-gemini/generative-ai-swift
gemini gemini-api swift
Last synced: about 1 month ago
JSON representation
The official Swift library for the Google Gemini API
- Host: GitHub
- URL: https://github.com/google-gemini/generative-ai-swift
- Owner: google-gemini
- License: apache-2.0
- Created: 2023-04-25T18:19:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T18:21:38.000Z (about 2 months ago)
- Last Synced: 2024-12-17T19:27:27.036Z (about 2 months ago)
- Topics: gemini, gemini-api, swift
- Language: Swift
- Homepage: https://ai.google.dev/gemini-api/docs/get-started/tutorial?lang=swift
- Size: 426 KB
- Stars: 974
- Watchers: 24
- Forks: 154
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Google AI SDK for Swift
[](https://swiftpackageindex.com/google-gemini/generative-ai-swift)
[](https://swiftpackageindex.com/google-gemini/generative-ai-swift)
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](https://ai.google.dev/models/gemini) created by
[Google DeepMind](https://deepmind.google/technologies/gemini/#introduction).
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](https://aistudio.google.com/).
2. Login with your Google account.
3. [Create an API key](https://aistudio.google.com/app/apikey). 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](https://ai.google.dev/tutorials/swift_quickstart) on
[ai.google.dev](https://ai.google.dev).
## Usage example
1. Add [`generative-ai-swift`](https://github.com/google/generative-ai-swift)
to your Xcode project using Swift Package Manager.
2. Import the `GoogleGenerativeAI` module
```swift
import GoogleGenerativeAI
```
1. Initialize the model
```swift
let model = GenerativeModel(name: "gemini-1.5-flash-latest", apiKey: "YOUR_API_KEY")
```
1. Run a prompt
```swift
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](https://ai.google.dev/tutorials/swift_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`
1. Run in Xcode and examine the console to see the options.
1. Edit the scheme's `Arguments Passed On Launch` with the desired options.
## Documentation
See the
[Gemini API Cookbook](https://github.com/google-gemini/gemini-api-cookbook/) or
[ai.google.dev](https://ai.google.dev) for complete documentation.
## Contributing
See
[Contributing](https://github.com/google/generative-ai-swift/blob/main/docs/CONTRIBUTING.md)
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](https://ai.google.dev/palm_docs/deprecation). 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](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text),
> 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](https://ai.google.dev/docs/migration_guide).
## License
The contents of this repository are licensed under the
[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).