From 49256bc606cae32fa7d434d93675c48b924a9acb Mon Sep 17 00:00:00 2001 From: Max P Date: Mon, 19 Aug 2024 16:30:44 +0200 Subject: [PATCH] Update example config references in README - Removed JSON example config from README - Added references to `ait.commit.sample.config.json` and `ait.pull_request.sample.config.json` - Renamed `ait.pull.sample.config.json` to `ait.pull_request.sample.config.json` --- README.md | 15 ++------------- ...ig.json => ait.pull_request.sample.config.json | 0 2 files changed, 2 insertions(+), 13 deletions(-) rename ait.pull.sample.config.json => ait.pull_request.sample.config.json (100%) diff --git a/README.md b/README.md index b024158..d760783 100644 --- a/README.md +++ b/README.md @@ -72,20 +72,9 @@ This command will look for a configuration file named `ait.KAI.config`. - `--max_tokens`: The maximum number of tokens (words or parts of words) in the API response. Default is `150`. - `--temperature`: Controls the randomness or creativity of the model's output. Lower values make the output more deterministic, while higher values make it more random. Default is `0.7`. -### Example Config File (`ait.config.json.sample`) +### Example Config Files -```json -{ - "api_key": "YOUR_OPENAI_API_KEY_HERE", - "diff_expression": "main...", - "log_expression": "main...", - "system_prompt": "You are a helpful assistant that creates pull request descriptions.", - "prompt": "Please create a pull request description based on these changes.", - "model": "gpt-4", - "max_tokens": 150, - "temperature": 0.7 -} -``` +See the [ait.commit.sample.config.json](ait.commit.sample.config.json) and [ait.pull_request.sample.config.json](ait.pull_request.sample.config.json) files for examples of configuration files. ### Error Handling diff --git a/ait.pull.sample.config.json b/ait.pull_request.sample.config.json similarity index 100% rename from ait.pull.sample.config.json rename to ait.pull_request.sample.config.json