@galdor/provider-openai 0.3.0 → 0.3.1

package/README.md

@@ -0,0 +1,47 @@
+# @galdor/provider-openai
+
+The [OpenAI](https://platform.openai.com/docs) (Chat Completions API) provider
+adapter for [galdor](https://github.com/YasserCR/galdor-bun). Implements the core
+`Provider` interface, so it drops into any graph, agent, or council.
+
+Because it speaks the Chat Completions wire format, it also targets
+**OpenAI-compatible** endpoints (Groq, Together, MiniMax, Mistral, DeepSeek,
+vLLM, Ollama, …) via `baseURL`. Covers generate + streaming, tool calling,
+structured output, vision, reasoning effort, the typed error taxonomy with
+`Retry-After`, cancellation, and a stream-safe header timeout (60 s default).
+
+## Install
+
+```bash
+bun add @galdor/provider-openai   # or: npm install @galdor/provider-openai
+```
+
+## Usage
+
+```ts
+import { newOpenAI } from "@galdor/provider-openai";
+import { userMessage, messageText } from "@galdor/core/schema";
+
+const provider = newOpenAI({ apiKey: process.env.OPENAI_API_KEY! });
+
+const res = await provider.generate({
+  model: "gpt-4o-mini",
+  messages: [userMessage("Explain MCP in one sentence.")],
+});
+console.log(messageText(res.message), res.usage);
+```
+
+Point it at an OpenAI-compatible backend with `baseURL`:
+
+```ts
+const groq = newOpenAI({ apiKey: process.env.GROQ_API_KEY!, baseURL: "https://api.groq.com/openai/v1" });
+const local = newOpenAI({ apiKey: "no-key", baseURL: "http://localhost:11434/v1" }); // Ollama
+```
+
+> Tip: [`@galdor/providerset`](https://www.npmjs.com/package/@galdor/providerset)
+> resolves these aliases by name (`groq`, `ollama`, …) with the right preset
+> `baseURL`.
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galdor/provider-openai",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "type": "module",
   "description": "OpenAI (Chat Completions API) provider adapter for galdor-bun. Also targets OpenAI-compatible endpoints (Groq, Together, MiniMax, Mistral, DeepSeek, vLLM, Ollama, ...) via baseURL.",
   "author": {
@@ -31,6 +31,6 @@
     "bun": ">=1.3"
   },
   "dependencies": {
-    "@galdor/core": "0.3.0"
+    "@galdor/core": "0.3.1"
   }
 }