Spaces:
Runtime error
Runtime error
File size: 8,215 Bytes
077865a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | import type {
ChatMessage,
ChatCompletionResponse,
ChatCompletionChunk,
Platform,
} from '@freellmapi/shared/types.js';
import { BaseProvider, providerHttpError, type CompletionOptions } from './base.js';
/**
* Generic provider for platforms that use an OpenAI-compatible API.
* Covers: Groq, Cerebras, NVIDIA NIM, Mistral, OpenRouter,
* GitHub Models, Fireworks AI.
*/
export class OpenAICompatProvider extends BaseProvider {
readonly platform: Platform;
readonly name: string;
private readonly baseUrl: string;
private readonly extraHeaders: Record<string, string>;
private readonly validateUrl?: string;
/** Per-provider HTTP timeout override. Cloud APIs finish in ~15s; locally-hosted
* inference (llama.cpp / vLLM on CPU) can take 30-120s for long prompts. Default 15000. */
private readonly timeoutMs: number;
/** NVIDIA NIM models reject any request that permits parallel tool calls with
* `400 This model only supports single tool-calls at once!`. When set, pin
* parallel_tool_calls to false whenever tools are in play. See issue #255. */
private readonly forceSingleToolCall: boolean;
constructor(opts: {
platform: Platform;
name: string;
baseUrl: string;
extraHeaders?: Record<string, string>;
validateUrl?: string;
timeoutMs?: number;
keyless?: boolean;
forceSingleToolCall?: boolean;
}) {
super();
this.platform = opts.platform;
this.name = opts.name;
this.baseUrl = opts.baseUrl;
this.extraHeaders = opts.extraHeaders ?? {};
this.validateUrl = opts.validateUrl;
this.timeoutMs = opts.timeoutMs ?? 15000;
this.keyless = opts.keyless ?? false;
this.forceSingleToolCall = opts.forceSingleToolCall ?? false;
}
/** Resolve the parallel_tool_calls flag to send upstream. For providers that
* only accept single tool calls (NVIDIA NIM), force `false` whenever tools are
* present so the model never tries to emit two at once and 400s; otherwise pass
* the caller's value through unchanged. See issue #255. */
private resolveParallelToolCalls(options?: CompletionOptions): boolean | undefined {
if (this.forceSingleToolCall && options?.tools && options.tools.length > 0) return false;
return options?.parallel_tool_calls;
}
/** Keyless providers (Kilo's anonymous free tier) must send NO Authorization
* header β a stored sentinel like `Bearer no-key` could be treated as an
* invalid key. Everyone else sends the bearer as usual. */
private authHeader(apiKey: string): Record<string, string> {
return this.keyless ? {} : { 'Authorization': `Bearer ${apiKey}` };
}
async chatCompletion(
apiKey: string,
messages: ChatMessage[],
modelId: string,
options?: CompletionOptions,
): Promise<ChatCompletionResponse> {
const res = await this.fetchWithTimeout(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
...this.authHeader(apiKey),
'Content-Type': 'application/json',
...this.extraHeaders,
},
body: JSON.stringify({
model: modelId,
messages,
temperature: options?.temperature,
max_tokens: options?.max_tokens,
top_p: options?.top_p,
tools: options?.tools,
tool_choice: options?.tool_choice,
parallel_tool_calls: this.resolveParallelToolCalls(options),
}),
}, options?.timeoutMs ?? this.timeoutMs);
if (!res.ok) {
const err = await res.json().catch(() => ({}));
throw providerHttpError(res, `${this.name} API error ${res.status}: ${(err as any).error?.message ?? res.statusText}`);
}
let data: ChatCompletionResponse;
try {
data = await res.json() as ChatCompletionResponse;
} catch {
// A 200 whose body isn't a single JSON document β typically a base URL
// pointing at a non-OpenAI-compatible API (e.g. Ollama's native NDJSON
// /api endpoints instead of /v1, #189). Surface what's wrong instead of
// the raw JSON.parse position error.
throw new Error(
`${this.name} returned 200 with a non-JSON body β the endpoint is not OpenAI-compatible. ` +
`Check the base URL (for Ollama use http://host:11434/v1, for llama.cpp/vLLM/LM Studio the /v1 path).`,
);
}
normalizeChoices(data);
data._routed_via = { platform: this.platform, model: modelId };
return data;
}
async *streamChatCompletion(
apiKey: string,
messages: ChatMessage[],
modelId: string,
options?: CompletionOptions,
): AsyncGenerator<ChatCompletionChunk> {
const res = await this.fetchWithTimeout(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
...this.authHeader(apiKey),
'Content-Type': 'application/json',
...this.extraHeaders,
},
body: JSON.stringify({
model: modelId,
messages,
temperature: options?.temperature,
max_tokens: options?.max_tokens,
top_p: options?.top_p,
tools: options?.tools,
tool_choice: options?.tool_choice,
parallel_tool_calls: this.resolveParallelToolCalls(options),
stream: true,
}),
}, this.timeoutMs);
if (!res.ok) {
const err = await res.json().catch(() => ({}));
throw providerHttpError(res, `${this.name} API error ${res.status}: ${(err as any).error?.message ?? res.statusText}`);
}
yield* this.readSseStream(res);
}
async validateKey(apiKey: string): Promise<boolean> {
// Note: transport errors (DNS / timeout / TLS) propagate to the caller.
// health.ts catches them and marks status='error' WITHOUT incrementing
// the consecutive-failure counter β only confirmed 401/403 disables a key.
const url = this.validateUrl ?? `${this.baseUrl}/models`;
// 30s (not 10s): some upstreams return a large /v1/models catalog that
// takes >10s from high-latency regions (e.g. NVIDIA NIM measured ~11.2s
// from India). A 10s cap aborted those calls and health.ts marked a
// perfectly good key status='error'. 30s aligns with chatCompletion's
// own slow-upstream allowance and costs nothing for fast providers.
const res = await this.fetchWithTimeout(url, {
method: 'GET',
headers: {
...this.authHeader(apiKey),
...this.extraHeaders,
},
}, 30000);
return res.status !== 401 && res.status !== 403;
}
}
/**
* Some providers (Z.ai glm-4.5-flash, Cloudflare DeepSeek-R1-distill, others)
* return reasoning models' actual answer in `message.reasoning_content` with
* `message.content === ""`. Fold reasoning_content into content so OpenAI-
* compatible clients see a non-empty assistant message.
*
* Other providers (Mistral magistral-medium) return `message.content` as an
* array of text segments instead of a string. Flatten to string.
*/
function normalizeChoices(data: ChatCompletionResponse): void {
for (const choice of data.choices ?? []) {
const msg = choice.message as ChatMessage & {
reasoning_content?: string;
reasoning?: string;
content: unknown;
};
// Flatten array content (Mistral magistral) β join text segments.
if (Array.isArray(msg.content)) {
msg.content = (msg.content as Array<{ text?: string; type?: string }>)
.map(seg => (typeof seg === 'string' ? seg : (seg.text ?? '')))
.join('');
}
// Fold reasoning into content if content is empty AND there are no
// tool_calls. With tool_calls present, content=null is the correct OpenAI
// shape; folding reasoning would confuse clients that branch on content.
// Field naming varies by provider: Z.ai uses `reasoning_content`, Ollama
// uses `reasoning`. Prefer `reasoning_content` when both are set.
const hasToolCalls = Array.isArray(msg.tool_calls) && msg.tool_calls.length > 0;
if (!hasToolCalls && (msg.content === '' || msg.content == null)) {
const fold = (typeof msg.reasoning_content === 'string' && msg.reasoning_content.length > 0)
? msg.reasoning_content
: (typeof msg.reasoning === 'string' && msg.reasoning.length > 0 ? msg.reasoning : null);
if (fold !== null) msg.content = fold;
}
}
}
|