@cavi-ai/api-client/core/runtime/providers
Package subpath: ./core/runtime/providers
createProviderRegistry#
Kind: function
export declare function createProviderRegistry<M extends RuntimeProviderModule>(options?: CreateRuntimeProviderRegistryOptions<M>): RuntimeProviderRegistry<M>;createRuntimeClient#
Kind: function
export declare function createRuntimeClient(provider: string, options: CreateRuntimeClientOptions): RuntimeClient;CreateRuntimeClientOptions#
Kind: type
export type CreateRuntimeClientOptions = {
registry: RuntimeProviderRegistry;
clientOptions: RuntimeClientOptions;
};createRuntimeControlClient#
Kind: function
export declare function createRuntimeControlClient(provider: string, options?: RuntimeControlClientOptions): Promise<RuntimeControlClient>;createRuntimeProviderRegistry#
Kind: function
export declare function createRuntimeProviderRegistry(options?: CreateRuntimeProviderRegistryOptions): RuntimeProviderRegistry;CreateRuntimeProviderRegistryOptions#
Kind: type
export type CreateRuntimeProviderRegistryOptions<M extends RuntimeProviderModule = RuntimeProviderModule> = {
modules?: readonly M[] | null;
allowOverrides?: boolean;
};normalizeRuntimeProviderToken#
Kind: function
export declare function normalizeRuntimeProviderToken(value: string | null | undefined): string | null;RuntimeClientOptions#
Kind: type
export type RuntimeClientOptions = Pick<HttpApiClientOptions, "baseUrl" | "fetchImpl" | "onTrace">;RuntimeControlClientFactory#
Kind: type
export type RuntimeControlClientFactory = (options: RuntimeControlClientOptions) => Promise<RuntimeControlClient>;RuntimeControlClientOptions#
Kind: type
export type RuntimeControlClientOptions = {
baseUrl?: string;
webSocketUrl?: string;
token?: string;
resolveAuth?: TransportAuthResolver;
signal?: AbortSignal;
trace?: (event: TransportLifecycleEvent) => void;
/** Provider-neutral gateway handshake and request settings for an owned connection. */
gatewayConnection?: GatewayRpcClientOptions;
/** Opt-in bounded retry policy for reconnecting an owned gateway after a retryable drop. */
gatewayReconnect?: TransportRetryPolicy;
transport?: GatewayTransport;
registry?: RuntimeProviderRegistry;
};RuntimeControlPlaneDeclaration#
Kind: type
export type RuntimeControlPlaneDeclaration = {
transports?: RuntimeTransportCapabilities;
modules?: Partial<Record<"sessions" | "models" | "usage" | "tasks" | "workspace" | "authStatus" | "events", true>>;
};RuntimeProviderModule#
Kind: interface
export interface RuntimeProviderModule {
kind: string;
aliases?: readonly string[];
capabilities?: Partial<Record<RuntimeSurface, boolean>>;
controlPlane?: RuntimeControlPlaneDeclaration;
createClient?: (clientOptions: RuntimeClientOptions) => RuntimeClient;
createRuntimeControlClient?: RuntimeControlClientFactory;
/** @deprecated Use createClient for new provider modules. */
createApiClient?: (clientOptions: RuntimeClientOptions) => RuntimeClient;
}RuntimeProviderRegistry#
Kind: interface
export interface RuntimeProviderRegistry<M extends RuntimeProviderModule = RuntimeProviderModule> {
resolveProvider(provider: string | null | undefined): M | null;
listProviders(): readonly M[];
}