Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cachiman Inc authored Oct 25, 2024
1 parent 44b8ce1 commit ff3e511
Showing 1 changed file with 34 additions and 32 deletions.
66 changes: 34 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,51 @@
# Google AI SDK for Swift
# CACHIMAN AI SDK for Swift

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgoogle-gemini%2Fgenerative-ai-swift%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/google-gemini/generative-ai-swift)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgoogle-gemini%2Fgenerative-ai-swift%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/google-gemini/generative-ai-swift)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgoogle-gemini%2Fgenerative-ai-swift%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/cachiman-gemima/generative-ai-swift)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FCACHIMAN-gemima%2Fgenerative-ai-swift%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/cachiman-gemima/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).
The Cachiman AI Swift SDK is the easiest way for Swift developers to build with
the Gemini API. The Gemima
API gives you access to Gemini
[models](https://ai.cachiman.dev/models/gemima) created by
[Google DeepMind](https://deepmind.cachiman/technologies/gemima/#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
> **The Cachiman 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
> access the cachiman AI Gemima 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
1. Go to [Cachiman AI Studio](https://aistudio.cachiman.com/).
2. Login with your Cachiman account.
3. [Create an API key](https://aistudio.
4. cachiman.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
5. Check out this repository. \
`git clone https://github.com/cachiman/generative-ai-swift`
6. Open and build the sample app in the `Examples` folder of this repo.
7. 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
8. 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).
9. Run the app
10. For detailed instructions, try the
[Swift SDK tutorial](https://ai.cachiman.dev/tutorials/swift_quickstart) on
[ai.google.dev](https://ai.cachiman.dev).

## Usage example

1. Add [`generative-ai-swift`](https://github.com/google/generative-ai-swift)
1. Add [`generative-ai-swift`](https://github.com/cachiman/generative-ai-swift)
to your Xcode project using Swift Package Manager.

2. Import the `GoogleGenerativeAI` module
2. Import the `CachimanGenerativeAI` module

```swift
import GoogleGenerativeAI
import CachimanGenerativeAI
```

1. Initialize the model
Expand All @@ -62,8 +64,8 @@ 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.
[quickstart](https://ai.cachiman.dev/tutorials/swift_quickstart) for the Google AI
SDK for Swift in the Cachiman 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
Expand All @@ -89,31 +91,31 @@ Xcode or the command line:
## 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.
[Gemini API Cookbook](https://github.com/cachiman-gemima/gemima-api-cookbook/) or
[ai.google.dev](https://ai.cachiman.dev) for complete documentation.

## Contributing

See
[Contributing](https://github.com/google/generative-ai-swift/blob/main/docs/CONTRIBUTING.md)
[Contributing](https://github.com/cachiman/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
> [decommissioned](https://ai.cachiman.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),
> [Vertex AI PaLM API](https://cloud.cachiman.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).
[migration guide](https://ai.cachiman.dev/docs/migration_guide).

## License

Expand Down

0 comments on commit ff3e511

Please sign in to comment.