Skip to content

Commit e303be7

Browse files
committed
docs: enhance API service documentation and configuration
- Add support for Ollama API service in the README - Add detailed instructions for configuring the Gemini API service - Remove duplicate section for Gemini API service configuration Signed-off-by: appleboy <[email protected]>
1 parent a61a5da commit e303be7

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A CLI written in [Go](https://go.dev) language that writes git commit messages o
1818

1919
## Feature
2020

21-
* Support [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Groq][30] and [OpenRouter][50].
21+
* Support [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30] and [OpenRouter][50].
2222
* Support [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
2323
* Support Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
2424
* Support customize generate diffs with n lines of context, the default is three.
@@ -114,6 +114,20 @@ codegpt config set openai.api_key xxxxxxxxxxxxxxxx
114114
codegpt config set openai.model xxxxx-gpt-35-turbo
115115
```
116116

117+
### Support [Gemni][60] API Service
118+
119+
Build with the Gemini API, you can see the [Gemini API documentation][61]. Update the `provider` and `api_key` in your config file. Please create an API key from the [Gemini API][62] page.
120+
121+
```sh
122+
codegpt config ser openai.provider gemini
123+
codegpt config set openai.api_key xxxxxxx
124+
codegpt config set openai.model gemini-1.5-flash-latest
125+
```
126+
127+
[60]: https://ai.google.dev/gemini-api
128+
[61]: https://ai.google.dev/gemini-api/docs
129+
[62]: https://aistudio.google.com/app/apikey
130+
117131
### How to change to [Groq][30] API Service
118132

119133
Please get the `API key` from Groq API Service, please vist [here][31]. Update the `base_url` and `api_key` in your config file.
@@ -189,20 +203,6 @@ codegpt config set openai.model meta-llama/llama-3-8b-instruct:free
189203
[52]:https://openrouter.ai/terms#services
190204
[53]:https://openrouter.ai/api/v1/models
191205

192-
### Support [Gemni][60] API Service
193-
194-
Build with the Gemini API, you can see the [Gemini API documentation][61]. Update the `provider` and `api_key` in your config file. Please create an API key from the [Gemini API][62] page.
195-
196-
```sh
197-
codegpt config ser openai.provider gemini
198-
codegpt config set openai.api_key xxxxxxx
199-
codegpt config set openai.model gemini-1.5-flash-latest
200-
```
201-
202-
[60]: https://ai.google.dev/gemini-api
203-
[61]: https://ai.google.dev/gemini-api/docs
204-
[62]: https://aistudio.google.com/app/apikey
205-
206206
For including your app on openrouter.ai rankings and Shows in rankings on openrouter.ai, you can set the `openai.headers` in your config file.
207207

208208
```sh

0 commit comments

Comments
 (0)