Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/publicaffairs/openai-gemini
Gemini ➜ OpenAI API proxy. Serverless!
https://github.com/publicaffairs/openai-gemini
chatgpt-api gemini-ai gemini-pro gemini-pro-vision gpt-4-vision-preview openai proxy serverless
Last synced: 4 days ago
JSON representation
Gemini ➜ OpenAI API proxy. Serverless!
- Host: GitHub
- URL: https://github.com/publicaffairs/openai-gemini
- Owner: PublicAffairs
- License: mit
- Created: 2024-02-19T12:07:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-26T21:12:20.000Z (28 days ago)
- Last Synced: 2024-12-13T11:10:09.028Z (11 days ago)
- Topics: chatgpt-api, gemini-ai, gemini-pro, gemini-pro-vision, gpt-4-vision-preview, openai, proxy, serverless
- Language: JavaScript
- Homepage: https://my-openai-gemini-demo.vercel.app/
- Size: 38.1 KB
- Stars: 396
- Watchers: 2
- Forks: 249
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
- License: LICENSE
Awesome Lists containing this project
README
## Why
The Gemini API is [free](https://ai.google.dev/pricing "limits applied!"),
but there are many tools that work exclusively with the OpenAI API.
This project provides a personal OpenAI-compatible endpoint for free.
## Serverless?
Although it runs in the cloud, it does not require server maintenance.
It can be easily deployed to various providers for free
(with generous limits suitable for personal use).
> [!TIP]
> Running the proxy endpoint locally is also an option,
> though it's more appropriate for development use.
## How to start
You will need a personal Google [API key](https://makersuite.google.com/app/apikey).
> [!IMPORTANT]
> Even if you are located outside of the [supported regions](https://ai.google.dev/gemini-api/docs/available-regions#available_regions),
> it is still possible to acquire one using a VPN.
Deploy the project to one of the providers, using the instructions below.
You will need to set up an account there.
If you opt for “button-deploy”, you'll be guided through the process of forking the repository first,
which is necessary for continuous integration (CI).
### Deploy with Vercel
[](https://vercel.com/new/clone?repository-url=https://github.com/PublicAffairs/openai-gemini&repository-name=my-openai-gemini)
- Alternatively can be deployed with [cli](https://vercel.com/docs/cli):
`vercel deploy`
- Serve locally: `vercel dev`
- Vercel _Functions_ [limitations](https://vercel.com/docs/functions/limitations) (with _Edge_ runtime)
### Deploy to Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/PublicAffairs/openai-gemini&integrationName=integrationName&integrationSlug=integrationSlug&integrationDescription=integrationDescription)
- Alternatively can be deployed with [cli](https://docs.netlify.com/cli/get-started/):
`netlify deploy`
- Serve locally: `netlify dev`
- Two different api bases provided:
- `/v1` (e.g. `/v1/chat/completions` endpoint)
_Functions_ [limits](https://docs.netlify.com/functions/get-started/?fn-language=js#synchronous-function-2)
- `/edge/v1`
_Edge functions_ [limits](https://docs.netlify.com/edge-functions/limits/)
### Deploy to Cloudflare
[](https://deploy.workers.cloudflare.com/?url=https://github.com/PublicAffairs/openai-gemini)
- Alternatively can be deployed manually pasting content of [`src/worker.mjs`](../resize-images/src/worker.mjs)
to https://workers.cloudflare.com/playground (see there `Deploy` button).
- Alternatively can be deployed with [cli](https://developers.cloudflare.com/workers/wrangler/):
`wrangler deploy`
- Serve locally: `wrangler dev`
- _Worker_ [limits](https://developers.cloudflare.com/workers/platform/limits/#worker-limits)
### Deploy to Deno
See details [here](https://github.com/PublicAffairs/openai-gemini/discussions/19).
### Serve locally - with Node, Deno, Bun
Only for Node: `npm install`.
Then `npm run start` / `npm run start:deno` / `npm run start:bun`.
#### Dev mode (watch source changes)
Only for Node: `npm install --include=dev`
Then: `npm run dev` / `npm run dev:deno` / `npm run dev:bun`.
## How to use
If you open your newly-deployed site in a browser, you will only see a `404 Not Found` message. This is expected, as the API is not designed for direct browser access.
To utilize it, you should enter your API address and your Gemini API key into the corresponding fields in your software settings.
> [!NOTE]
> Not all software tools allow overriding the OpenAI endpoint, but many do
> (however these settings can sometimes be deeply hidden).
Typically, you should specify the API base in this format:
`https://my-super-proxy.vercel.app/v1`
The relevant field may be labeled as "_OpenAI proxy_".
You might need to look under "_Advanced settings_" or similar sections.
Alternatively, it could be in some config file (check the relevant documentation for details).
For some command-line tools, you may need to set an environment variable, _e.g._:
```sh
OPENAI_BASE_URL="https://my-super-proxy.vercel.app/v1"
```
_..or_:
```sh
OPENAI_API_BASE="https://my-super-proxy.vercel.app/v1"
```
## Models
Requests use the specified [model] if its name starts with "gemini-", "learnlm-",
or "models/". Otherwise, these defaults apply:
- `chat/completions`: `gemini-1.5-pro-latest`
- `embeddings`: `text-embedding-004`
[model]: https://ai.google.dev/gemini-api/docs/models/gemini
## Media
[Vision] and [audio] input supported as per OpenAI [specs].
Implemented via [`inlineData`](https://ai.google.dev/api/caching#Part).
[vision]: https://platform.openai.com/docs/guides/vision
[audio]: https://platform.openai.com/docs/guides/audio?audio-generation-quickstart-example=audio-in
[specs]: https://platform.openai.com/docs/api-reference/chat/create
---
## Supported API endpoints and applicable parameters
- [x] `chat/completions`
Currently, most of the parameters that are applicable to both APIs have been implemented,
with the exception of function calls.
- [x] `messages`
- [x] `content`
- [x] `role`
- [x] "system" (=>`system_instruction`)
- [x] "user"
- [x] "assistant"
- [ ] "tool" (v1beta)
- [ ] `name`
- [ ] `tool_calls`
- [x] `model`
- [x] `frequency_penalty`
- [ ] `logit_bias`
- [ ] `logprobs`
- [ ] `top_logprobs`
- [x] `max_tokens`, `max_completion_tokens`
- [x] `n` (`candidateCount` <8, not for streaming)
- [x] `presence_penalty`
- [x] `response_format`
- [x] "json_object"
- [x] "json_schema" (a select subset of an OpenAPI 3.0 schema object)
- [x] "text"
- [ ] `seed`
- [x] `stop`: string|array (`stopSequences` [1,5])
- [x] `stream`
- [x] `stream_options`
- [x] `include_usage`
- [x] `temperature` (0.0..2.0 for OpenAI, but Gemini supports up to infinity)
- [x] `top_p`
- [ ] `tools` (v1beta)
- [ ] `tool_choice` (v1beta)
- [ ] `parallel_tool_calls`
- [ ] `completions`
- [x] `embeddings`
- [x] `models`