Interface: ModelClient
Stable model facade shared by Node and generated language bindings.
Methods
Section titled “Methods”listModels()
Section titled “listModels()”listModels(
refresh?):Promise<object[]>
Parameters
Section titled “Parameters”refresh?
Section titled “refresh?”boolean
Returns
Section titled “Returns”Promise<object[]>
metadata()
Section titled “metadata()”metadata(
model):object
Parameters
Section titled “Parameters”string | { class?: "chat-thinking" | "chat-balanced" | "chat-fast" | "embedding"; description?: string; dimension?: number; displayName?: string; family?: string; modelServiceName?: string; name: string; profile?: { cost?: number; quality?: number; speed?: number; }; reasoningEfforts?: ("none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max")[]; serviceNames?: Record<string, string>; state?: string; status?: { deprecated: boolean; }; supportsTools?: boolean; task?: string; }
Returns
Section titled “Returns”object
capabilities
Section titled “capabilities”capabilities:
object
capabilities.applyPatch
Section titled “capabilities.applyPatch”applyPatch:
boolean
capabilities.imageInput
Section titled “capabilities.imageInput”imageInput:
boolean
capabilities.responses
Section titled “capabilities.responses”responses:
boolean
capabilities.webSearch
Section titled “capabilities.webSearch”webSearch:
boolean
rateLimits?
Section titled “rateLimits?”
optionalrateLimits?:object
rateLimits.inputTokensPerMinute
Section titled “rateLimits.inputTokensPerMinute”inputTokensPerMinute:
number|null
rateLimits.outputTokensPerMinute
Section titled “rateLimits.outputTokensPerMinute”outputTokensPerMinute:
number|null
rateLimits.queriesPerHour
Section titled “rateLimits.queriesPerHour”queriesPerHour:
number|null
status
Section titled “status”status:
object
status.deprecated
Section titled “status.deprecated”deprecated:
boolean
route()
Section titled “route()”route(
input?):Promise<ModelRoute>
Parameters
Section titled “Parameters”input?
Section titled “input?”Returns
Section titled “Returns”Promise<ModelRoute>
searchModels()
Section titled “searchModels()”searchModels(
query?,refresh?):Promise<object[]>
Parameters
Section titled “Parameters”query?
Section titled “query?”dimension?
Section titled “dimension?”number = ...
includeDeprecated?
Section titled “includeDeprecated?”boolean = ...
limit?
Section titled “limit?”number = ...
maxDimension?
Section titled “maxDimension?”number = ...
minDimension?
Section titled “minDimension?”number = ...
modelClass?
Section titled “modelClass?”"chat-thinking" | "chat-balanced" | "chat-fast" | "embedding" = ...
string = ...
reasoningEffort?
Section titled “reasoningEffort?”"none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" = ...
requiresTools?
Section titled “requiresTools?”boolean = ...
search?
Section titled “search?”string = ...
string = ...
threshold?
Section titled “threshold?”number = ...
refresh?
Section titled “refresh?”boolean
Returns
Section titled “Returns”Promise<object[]>
status()
Section titled “status()”status():
ModelClientStatus