summaryrefslogtreecommitdiffhomepage
path: root/packages/openai-stream/src/listModels.ts
blob: df116b0433701d73fcdc447d5b78169fb0828dec (plain)
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
import type { ModelInfo } from "@dispatch/kernel";
import type { FetchLike } from "@dispatch/trace-replay";

/**
 * Generic OpenAI-compatible model-list fetch + mapping. Lives in this library
 * (`@dispatch/openai-stream`) so any OpenAI-compatible provider extension can
 * reuse it without cross-extension code import (isolation-over-DRY: coupling
 * is via this typed library surface, not a sibling's internals).
 *
 * A provider extension supplies its own `id` (used in error labels) via
 * `createOpenAICompatProvider({ id })`.
 */

interface OpenAIModelEntry {
  readonly id: string;
  readonly context_length?: number;
  readonly context_window?: number;
  readonly max_context_length?: number;
  readonly max_tokens?: number;
}

interface OpenAIModelListResponse {
  readonly data: readonly OpenAIModelEntry[];
}

/**
 * Whether a model id is vision-capable (can natively accept image input).
 *
 * The OpenAI-compatible `/models` endpoint does not reliably report image
 * capabilities, so this is a hardcoded heuristic by model id: the Umans Kimi
 * (`umans-kimi-k2.7`) and Umans Qwen (`umans-qwen3.6-35b-a3b`) models are
 * vision-capable; all others are treated as non-vision. This is the single
 * source of truth — the orchestrator's vision handoff and the `consult_vision`
 * tool both consult the `ModelInfo.vision` flag this sets, so adding a model
 * here enables vision everywhere. Pure: id → boolean, no I/O.
 *
 * (When an endpoint gains reliable vision reporting, this can be replaced with
 * a real capability check without changing callers.)
 */
export function isVisionModelId(id: string): boolean {
  const lower = id.toLowerCase();
  return lower.includes("umans-kimi") || lower.includes("umans-qwen");
}

/**
 * Pure mapping: raw OpenAI-compatible model list → ModelInfo[].
 * Extracts `contextWindow` from common field names (providers vary) and
 * detects vision capability via {@link isVisionModelId}. Extracted for direct
 * unit testing with no I/O.
 */
export function parseModelList(data: readonly OpenAIModelEntry[]): readonly ModelInfo[] {
  return data.map((entry) => {
    const contextWindow =
      entry.context_length ?? entry.context_window ?? entry.max_context_length ?? entry.max_tokens;
    const vision = isVisionModelId(entry.id);
    return {
      id: entry.id,
      ...(contextWindow !== undefined ? { contextWindow } : {}),
      ...(vision ? { vision } : {}),
    };
  });
}

export interface ListModelsConfig {
  readonly baseURL: string;
  readonly apiKey: string;
  readonly fetchFn?: FetchLike;
  readonly providerId: string;
}

export async function listModels(config: ListModelsConfig): Promise<readonly ModelInfo[]> {
  const effectiveFetch: FetchLike = config.fetchFn ?? fetch;
  const url = `${config.baseURL}/models`;

  let response: Response;
  try {
    response = await effectiveFetch(url, {
      method: "GET",
      headers: {
        Authorization: `Bearer ${config.apiKey}`,
      },
    });
  } catch (err) {
    throw new Error(
      `listModels[${config.providerId}]: network error — ${err instanceof Error ? err.message : String(err)}`,
    );
  }

  if (!response.ok) {
    const text = await response.text().catch(() => "unknown");
    throw new Error(`listModels[${config.providerId}]: HTTP ${response.status} — ${text}`);
  }

  const body = (await response.json()) as OpenAIModelListResponse;
  if (!Array.isArray(body.data)) {
    throw new Error(
      `listModels[${config.providerId}]: unexpected response shape — missing "data" array`,
    );
  }

  return parseModelList(body.data);
}