summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-08-17 08:43:53 +0300
committerPaul Buetow <paul@buetow.org>2025-08-17 08:43:53 +0300
commit07d02d93dbb7a8167758f678c68b5a1a520167c8 (patch)
treeffa0698323175c2c5fa591420f2c33d1bcb9e069 /README.md
parentd44ae13e97eff75704b0fbd90814811dcc98eff5 (diff)
llm: add GitHub Copilot provider
- Implement copilot client reading COPILOT_API_KEY - Wire copilot_base_url and copilot_model config - Update README and config example; defaults to gpt-4.1 - Keep OpenAI default at gpt-4.1 for consistency
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index bffb1d6..fad4e81 100644
--- a/README.md
+++ b/README.md
@@ -8,20 +8,27 @@ At the moment this project is only in the proof of PoC phase.
## LLM provider
-Hexai exposes a simple LLM provider interface. It supports OpenAI and a local Ollama server. Provider selection and models are configured via a JSON configuration file.
+Hexai exposes a simple LLM provider interface. It supports OpenAI, GitHub Copilot, and a local Ollama server. Provider selection and models are configured via a JSON configuration file.
### Selecting a provider
-- Set `provider` in the config file to `openai` or `ollama`.
+- Set `provider` in the config file to `openai`, `copilot`, or `ollama`.
- If omitted, Hexai defaults to `openai`.
### OpenAI configuration
- Required: `OPENAI_API_KEY` — provided via environment variable only.
- In config file:
- - `openai_model` — model name (default: `gpt-4o-mini`).
+ - `openai_model` — model name (default: `gpt-4.1`).
- `openai_base_url` — API base (default: `https://api.openai.com/v1`).
+### Copilot configuration
+
+- Required: `COPILOT_API_KEY` — provided via environment variable only.
+- In config file:
+ - `copilot_model` — model name (default: `gpt-4.1`).
+ - `copilot_base_url` — API base (default: `https://api.githubcopilot.com`).
+
### Ollama configuration (local)
- In config file:
@@ -59,6 +66,8 @@ Notes:
"no_disk_io": true,
"trigger_characters": [".", ":", "/", "_", ";", "?"],
"provider": "ollama",
+ "copilot_model": "gpt-4.1",
+ "copilot_base_url": "https://api.githubcopilot.com",
"openai_model": "gpt-4.1",
"openai_base_url": "https://api.openai.com/v1",
"ollama_model": "qwen2.5-coder:latest",
@@ -67,8 +76,9 @@ Notes:
```
* context_mode: minimal | window | file-on-new-func | always-full
-* provider: ollama or openai
+* provider: openai | copilot | ollama
* openai_model, openai_base_url: OpenAI-only options
+* copilot_model, copilot_base_url: Copilot-only options
* ollama_model, ollama_base_url: Ollama-only options
Minimal config (defaults to OpenAI):
@@ -76,7 +86,7 @@ Minimal config (defaults to OpenAI):
{}
```
-Ensure `OPENAI_API_KEY` is set in your environment.
+Ensure `OPENAI_API_KEY` or `COPILOT_API_KEY` is set in your environment according to your chosen provider.
## Inline triggers