|
6 | 6 |
|
7 | 7 | <h1>AI Commit</h1> |
8 | 8 |
|
9 | | -使用 Azure/OpenAI API 审查 Git 暂存区修改,生成符合 Conventional Commit 规范的提交消息,简化提交流程,保持提交规范一致。 |
| 9 | +使用 OpenAI / Azure OpenAI / DeepSeek / Gemini API 审查 Git 暂存区修改,生成符合 Conventional Commit 规范的提交消息,简化提交流程,保持提交规范一致。 |
10 | 10 |
|
11 | 11 | [English](./README.md) · **简体中文** · [报告问题][github-issues-link] · [请求功能][github-issues-link] |
12 | 12 |
|
|
27 | 27 |
|
28 | 28 | ## ✨ 特性 |
29 | 29 |
|
30 | | -- 🤯 支持使用 ChatGPT / Azure API 根据 git diffs 自动生成提交信息 |
| 30 | +- 🤯 支持使用 OpenAI / Azure OpenAI / DeepSeek / Gemini API 根据 git diffs 自动生成提交信息 |
31 | 31 | - 🗺️ 支持多语言提交信息 |
32 | 32 | - 😜 支持添加 Gitmoji |
33 | 33 | - 🛠️ 支持自定义系统提示词 |
|
55 | 55 |
|
56 | 56 | ### ⚙️ 配置 |
57 | 57 |
|
58 | | -> **Note** Version >= 0.0.5 不需要配置 `EMOJI_ENABLED` 和 `FULL_GITMOJI_SPEC`,默认提示词为 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md),如果不需要使用 `Gitmoji`,请将 `SYSTEM_PROMPT` 设置为您的自定义提示词, 请参考 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md)。 |
| 58 | +> **Note** Version >= 0.0.5 不需要配置 `EMOJI_ENABLED` 和 `FULL_GITMOJI_SPEC`,默认提示词为 [prompt/without_gitmoji.md](./prompt/with_gitmoji.md),如果不需要使用 `Gitmoji`,请将 `SYSTEM_PROMPT` 设置为您的自定义提示词, 请参考 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md)。 |
59 | 59 |
|
60 | 60 | 在 `VSCode` 设置中,找到 "ai-commit" 配置项,并根据需要进行配置 |
61 | 61 |
|
62 | | -| 配置 | 类型 | 默认 | 必要 | 备注 | |
63 | | -| :----------------- | :----: | :----: | :--: | :------------------------------------------------------------------------------------: | |
64 | | -| OPENAI_API_KEY | string | None | 是 | [OpenAI 令牌](https://platform.openai.com/account/api-keys) | |
65 | | -| OPENAI_BASE_URL | string | None | 否 | 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} | |
66 | | -| OPENAI_MODEL | string | gpt-4o | 是 | OpenAI MODEL, 你可以通过运行 `Show Available OpenAI Models` 命令从列表中选择一个模型。 | |
67 | | -| AZURE_API_VERSION | string | None | 否 | AZURE_API_VERSION | |
68 | | -| AI_COMMIT_LANGUAGE | string | en | 是 | 支持 19 种语言 | |
69 | | -| SYSTEM_PROMPT | string | None | 否 | 自定义系统提示词 | |
70 | | -| OPENAI_TEMPERATURE | number | 0.7 | 否 | 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造性 | |
| 62 | +| 配置 | 类型 | 默认 | 必要 | 备注 | |
| 63 | +| :----------------- | :----: | :------------------: | :--: | :---------------------------------------------------------------------------------------------: | |
| 64 | +| AI_PROVIDER | string | openai | Yes | Select AI Provider: `openai` or `gemini`. | |
| 65 | +| OPENAI_API_KEY | string | None | 是 | [OpenAI 令牌](https://platform.openai.com/account/api-keys) | |
| 66 | +| OPENAI_BASE_URL | string | None | 否 | 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} | |
| 67 | +| OPENAI_MODEL | string | gpt-4o | 是 | OpenAI MODEL, 你可以通过运行 `Show Available OpenAI Models` 命令从列表中选择一个模型。 | |
| 68 | +| AZURE_API_VERSION | string | None | 否 | AZURE_API_VERSION | |
| 69 | +| OPENAI_TEMPERATURE | number | 0.7 | 否 | 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造性 | |
| 70 | +| GEMINI_API_KEY | string | None | Yes | 将`AI Provider`设置为`Gemini`时需要。[Gemini API key](https://makersuite.google.com/app/apikey) | |
| 71 | +| GEMINI_MODEL | string | gemini-2.0-flash-001 | Yes | 模型选择仅限于配 Gemini 模型。置。 | |
| 72 | +| GEMINI_TEMPERATURE | number | 0.7 | No | `Gemini` 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造 | |
| 73 | +| AI_COMMIT_LANGUAGE | string | en | 是 | 支持 19 种语言 | |
| 74 | +| SYSTEM_PROMPT | string | None | 否 | 自定义系统提示词 | |
71 | 75 |
|
72 | 76 | ## ⌨️ 本地开发 |
73 | 77 |
|
|
0 commit comments