feat(cz-git,cli): add aiModel option to support multiple OpenAI mod…

…els (#185)

* Remove AI model `text-davinci-003` and configure field `aiType`
* Add configure field `aiModel`: 'gpt-3.5-turbo' | 'gpt-4' | 'gpt-4o' | 'gpt-4o-mini' | string...
* (cli): add options `-M=|--ai-model=` and `--api-model=`
* The AI Model option only support for the OpenAI API's `/chat/completions` endpoint model now.

link #180

README.md

@@ -70,14 +70,14 @@ DX first and more engineered, lightweight, customizable, standard output format
 
 ```bash
 $ npm i -D cz-git
-+ cz-git          (1.9 MB)
-added 1 package in 0.582s
++ cz-git          (1.75 MB)
+added 1 package in 0.552s
 ```
 
 [⇒ Why czg](https://cz-git.qbb.sh/cli/why.html)
 ```bash
 $ npm i -g czg
-+ czg             (1.5 MB)
++ czg             (1.31 MB)
 added 1 package in 0.531s
 ```
 
@@ -179,7 +179,7 @@ added 1 package in 0.531s
 [⇒ FAQ](https://cz-git.qbb.sh/faq/)
 
 <a target="_blank" href="https://packagephobia.com/result?p=cz-git,czg">
-  <img src="https://user-images.githubusercontent.com/40693636/252157675-32634902-fc02-4a07-a12c-a07ec5ee5f1a.png" alt="size-overview"><br>
+  <img src="https://cdn.jsdelivr.net/gh/Zhengqbbb/Zhengqbbb@v1.1.6/image/cz-git-v1.10.0.png" alt="size-overview"><br>
   <sub>https://packagephobia.com/result?p=cz-git,czg</sub>
 </a>
 

docs/.vitepress/theme/components/HomePage.vue

@@ -48,8 +48,8 @@ useMediumZoom()
                 $ npm install -D cz-git<br>
                 + cz-git
                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-                (<span c-orange-5> 1.9 MB </span>) <br>added &nbsp;<span c-orange-5>1</span>&nbsp; package
-                in &nbsp;<span c-orange-5>0.582s</span>
+                (<span c-orange-5> 1.75 MB </span>) <br>added &nbsp;<span c-orange-5>1</span>&nbsp; package
+                in &nbsp;<span c-orange-5>0.552s</span>
             </p>
         </div>
         <div class="feat">

docs/.vitepress/theme/style/main.css

@@ -100,9 +100,9 @@ img.error {
 img.error::before {
   content: '';
   position: absolute;
-  left: 0; 
+  left: 0;
   top: 0;
-  width: 100%; 
+  width: 100%;
   height: 100%;
   color: transparent;
   --un-icon: url("data:image/svg+xml,%3Csvg class='icon' viewBox='0 0 1024 1024' xmlns='http://www.w3.org/2000/svg' width='200' height='200'%3E%3Cpath d='M304.128 456.192c48.64 0 88.064-39.424 88.064-88.064s-39.424-88.064-88.064-88.064-88.064 39.424-88.064 88.064 39.424 88.064 88.064 88.064zm0-116.224c15.36 0 28.16 12.288 28.16 28.16s-12.288 28.16-28.16 28.16-28.16-12.288-28.16-28.16 12.288-28.16 28.16-28.16z' fill='%23aaaaaa'/%3E%3Cpath d='M887.296 159.744H136.704C96.768 159.744 64 192 64 232.448v559.104c0 39.936 32.256 72.704 72.704 72.704h198.144L500.224 688.64l-36.352-222.72 162.304-130.56-61.44 143.872 92.672 214.016-105.472 171.008h335.36C927.232 864.256 960 832 960 791.552V232.448c0-39.936-32.256-72.704-72.704-72.704zm-138.752 71.68v.512H857.6c16.384 0 30.208 13.312 30.208 30.208v399.872L673.28 408.064l75.264-176.64zM304.64 792.064H165.888c-16.384 0-30.208-13.312-30.208-30.208v-9.728l138.752-164.352 104.96 124.416-74.752 79.872zm81.92-355.84l37.376 228.864-.512.512-142.848-169.984c-3.072-3.584-9.216-3.584-12.288 0L135.68 652.8V262.144c0-16.384 13.312-30.208 30.208-30.208h474.624L386.56 436.224zm501.248 325.632c0 16.896-13.312 30.208-29.696 30.208H680.96l57.344-93.184-87.552-202.24 7.168-7.68 229.888 272.896z' fill='%23aaaaaa'/%3E%3C/svg%3E");
@@ -114,7 +114,7 @@ img.error::after {
   color: inherit;
   font-size: 0.85rem;
   position: absolute;
-  left: 0; 
+  left: 0;
   bottom: 0;
   width: 100%;
   background-color: var(--vp-c-bg-nav);
@@ -185,7 +185,7 @@ img.error::after {
 .VPHome .VPTeamMembersItem {
   border: 1px solid var(--vp-button-alt-border);
 }
-.VPHome .VPTeamMembersItem .profile { 
+.VPHome .VPTeamMembersItem .profile {
   background: none;
   color: var(--vp-button-alt-text);
 }
@@ -233,6 +233,11 @@ img.error::after {
   color: var(--vp-custom-block-danger-text-deep);
 }
 
+.vp-doc .custom-block a {
+    text-decoration-color: inherit;
+    -webkit-text-decoration-color: inherit;
+}
+
 .vp-doc .custom-block a:hover,
 .vp-doc .custom-block a:active {
   color: inherit;
@@ -255,7 +260,7 @@ img.error::after {
 .dark .DocSearch-Button-Key {
   box-shadow: none;
 }
-.DocSearch-Modal .cls-1, 
+.DocSearch-Modal .cls-1,
 .DocSearch-Modal .cls-2{
   fill: var(--vp-c-docsearch-logo-color);
 }

docs/cli/ai.md

@@ -18,10 +18,12 @@ czg --api-key=sk-xxxxx
 ## Options
 
 | Shorthand, Name | Description |
-| --- | --- | 
-|  `-N=<number>`<br>`--ai-num=<number>` | Setting AI return number subjects and Turn on choose mode |
-| `--no-ai` | Turn off AI prompt mode in this session |  
+| --- | --- |
+|  `-N=<number>`<br>`--ai-num=<number>` | Sets AI return multiple subjects and Turn on choose mode |
+| `-M=<model>`<br>`--ai-model=<model>` | Sets AI model in this session |
+| `--no-ai` | Turn off AI prompt mode in this session |
 | `--api-key=<token>` | Setup OpenAI API secret key to local (.config/.czrc) |
+| `--api-model=<model>` | Setup request OpenAI API model to local (.config/.czrc) |
 | `--api-proxy=<proxy_URL>` | Setup request OpenAI API proxy to local (.config/.czrc)<br>e.g:<br> 1. `npx czg --api-proxy="socks5://127.0.0.1:1080"`<br>2. `npx czg --api-proxy="http://127.0.0.1:1080"`  |
 | `--api-endpoint=<url>` | Setup request OpenAI API endpoint to local<br>Default `"https://api.openai.com/v1"`  |
 | `--unset-proxy` | Unset request API proxy on local configure |

docs/cli/index.md

@@ -26,7 +26,7 @@ description: Interactive Commitizen CLI that generate standardized git commit me
 <br />
 
 - 🤖 **OpenAI Support.** Let the AI generate your git commit message.
-- ⚡️ **Lightweight** : Zero Dependencies (1.6MB)
+- ⚡️ **Lightweight** : Zero Dependencies (1.31MB)
 - 🤗 **Simpler and Faster** : No plugin, No adapter, No extra steps, You can use `npx` | `npm script` | `global install`... quick start CLI in your any project
 - 😎 **Highly Customizable** : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need
 
@@ -82,41 +82,45 @@ More information about configure file and options. See → [Config](/config/)
     https://cz-git.qbb.sh/cli/
     https://github.com/Zhengqbbb/cz-git
 
-[33mSYNOPSIS:[0m
+[33mSYNOPSIS:[39m
     czg [subcommand...] [options...] [git-commit-options...]
 
-SUBCOMMAND:
-    ai               Turn on OpenAI generate subject mode
-    break            Turn on appends a ! after the type/scope
-    emoji            Turn on output message with emoji mode
-    checkbox         Turn on scope checkbox mode
-    gpg              Turn on use GPG sign commit message
-
-OPTIONS:
-    :, --alias=      Directly submit the defined commit message
-    --config=        Specify the configuration file to use
-
-  OpenAI:
-    -N=,--ai-num=    Setting AI return number subjects and Turn on choose mode
-    --api-key=       Setup request OpenAI API secret key to local (.config/.czrc)
-    --api-proxy=     Setup request OpenAI API proxy      to local (.config/.czrc)
-    --api-endpoint=  Setup request OpenAI API endpoint   to local (.config/.czrc)
-                     [default: "https://api.openai.com/v1"]
-
-FLAG:
-    -r, --retry      Directly retry submit by the last message
-    --no-ai          Turn off AI prompt mode in this session
-    --unset-proxy    Unset request API proxy on local configure
-    -h, --help       Show help
-    -v, --version    Show version
-
-EXAMPLES:
-    czg
-    czg emoji
-    czg :fd
-    czg --config="./config/cz.json"
-    czg --api-key="sk-XXXXX"
-    czg ai -N=3
+SUBCOMMAND:
+    ai               Turn on OpenAI generate subject mode
+    break            Turn on appends a ! after the type/scope
+    emoji            Turn on output message with emoji mode
+    checkbox         Turn on scope checkbox mode
+    gpg              Turn on use GPG sign commit message
+
+OPTIONS:
+    :, --alias=      Directly submit the defined commit message
+    --config=        Specify the configuration file to use
+
+  OpenAI:
+    -N=,--ai-num=    Sets AI return multiple subjects and Turn on choose mode
+    -M=,--ai-model=  Sets AI model in this session
+                     [default: "gpt-4o-mini"]
+                     [example: "gpt-3.5-turbo", "gpt-4o", "gpt-4o-mini" ...]
+    --api-key=       Setup request OpenAI API secret key to local (.config/.czrc)
+    --api-model=     Setup request OpenAI API model      to local (.config/.czrc)
+    --api-proxy=     Setup request OpenAI API proxy      to local (.config/.czrc)
+    --api-endpoint=  Setup request OpenAI API endpoint   to local (.config/.czrc)
+                     [default: "https://api.openai.com/v1"]
+
+FLAG:
+    -r, --retry      Directly retry submit by the last message
+    --no-ai          Turn off AI prompt mode in this session
+    --unset-proxy    Unset request API proxy on local configure
+    -h, --help       Show help
+    -v, --version    Show version
+
+EXAMPLES:
+    czg
+    czg emoji
+    czg :fd
+    czg --config="./config/cz.json"
+    czg --api-key="sk-XXXXX"
+    czg ai -N=3 -M="gpt-4o"
 
 Extends 'git commit' options.
 See 'git commit --help' for more information.

docs/cli/why.md

@@ -25,9 +25,9 @@ $ du -sh ./node_modules
 102M ./node_modules
 
 $ npm install -D czg
-added 1 package, and audited 2 packages in 408 ms
+added 1 package, and audited 2 packages in 531 ms
 $ du -sh ./node_modules/*
-1.3M ./node_modules/czg
+1.31M ./node_modules/czg
 ```
 
 ## What is different from cz-git

docs/config/engineer.md

@@ -118,6 +118,33 @@ Try running command to **use OpenAI API to auto generate **subject** in the curr
 Demo And Usage [⇒ see the recipes](/recipes/openai)
 :::
 
+## aiModel
+
+- **description**: Choose the AI model you want to use
+- **examples**: `gpt-3.5-turbo` | `gpt-4` | `gpt-4o` | `gpt-4o-mini` <br>... (and models compatible with the [/chat/completions endpoint](https://platform.openai.com/docs/models/model-endpoint-compatibility)) <br>For example: [GitHub models](https://github.com/marketplace/models) and local models ([Ollama](https://ollama.com/library))
+- **type**: `string`
+- **default**: `gpt-4o-mini`
+
+:::tip
+Try running the command to **switch AI models directly in the current session**
+- Commitizen CLI + cz-git: `czai=1 cz_aimodel=gpt-3.5-turbo cz`
+- czg CLI: `czg ai -M=gpt-3.5-turbo`
+
+Demo And Usage [⇒ see the recipes](/recipes/openai)
+:::
+
+:::info
+If `aiModel` is set globally or in the project, it will override the value set using `npx czg --api-model=<model>`
+
+<hr>
+
+**Priority explanation, from high to low:**
+1. Environment variable specification `cz_aimodel=`, `czg` command parameter specification `-M=|--ai-model=`
+2. Global configuration or project configuration: `aiModel` field
+3. The `apiModel` field in `~/.config/.czrc` configured via the `npx czg --api-model=<model>` command
+:::
+
+
 ## aiNumber
 
 - **description** : If >1 will **turn on select mode**, select generate options like returned by OpenAI
@@ -132,18 +159,6 @@ Try running command to **select multiple results returned by OpenAI in the curre
 Demo And Usage [⇒ see the recipes](/recipes/openai)
 :::
 
-## aiType
-
-- **description** : Choose the AI model you want to use
-
-|     aiType&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;     |     Model&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        | Description | 
-|     ---        |      ---         | --- |
-| openAI-Turbo   | gpt-3.5-turbo     | faster and optimized for chat at 1/10th the cost of `text-davinci-003` |
-| openAI-Davinci | text-davinci-003  |  better quality, longer output, and consistent instruction-following |
-
-- **type** : `"openAI-Turbo" | "openAI-Davinci"`
-- **default** : `openAI-Turbo`
-
 ## aiDiffIgnore
 
 - **description** : To ignore selection diff codes when sending AI API requests
@@ -165,7 +180,7 @@ export interface GenerateAIPromptType {
   diff?: string
 }
 ```
-- **example** : 
+- **example** :
 
 ```js
 module.exports = {

docs/guide/introduction.md

@@ -65,8 +65,8 @@ Support OpenAI, and more engineered, lightweight, customizable, standard output
 
 ```sh
 $ npm install -D cz-git
-+ cz-git          (1.9 MB)
-added 1 package in 0.582s
++ cz-git          (1.75 MB)
+added 1 package in 0.552s
 ```
 
 [⇒ Why cz-git](/guide/why.html)

docs/guide/why.md

@@ -31,7 +31,7 @@ $ npm install -D cz-conventional-changelog
 added 147 packages in 21s
 
 $ npm install -D cz-git
-added 1 package in 0.582s
+added 1 package in 0.552s
 ```
 
 ---

docs/package.json

@@ -1,5 +1,6 @@
 {
   "name": "docs",
+  "version": "1.10.0-beta.1",
   "private": true,
   "scripts": {
     "docs:build": "vitepress build",