@kernl-sdk/protocol 0.2.8 → 0.3.0

package/dist/language-model/language-model.d.ts

@@ -1,114 +0,0 @@
-/**
- * Language Model Protocol
- *
- * Defines the standard interface for language model providers in Kernl.
- */
-export type LanguageModel = {
-    /**
-     * The language model must specify which language model interface version it implements.
-     */
-    readonly spec: "1.0";
-    /**
-     * Provider ID.
-     */
-    readonly provider: string;
-    /**
-     * Provider-specific model ID.
-     */
-    readonly modelId: string;
-    /**
-     * Supported URL patterns by media type for the provider.
-     *
-     * The keys are media type patterns or full media types (e.g. `*\/*` for everything, `audio/*`, `video/*`, or `application/pdf`).
-     * and the values are arrays of regular expressions that match the URL paths.
-     *
-     * The matching should be against lower-case URLs.
-     *
-     * Matched URLs are supported natively by the model and are not downloaded.
-     *
-     * @returns A map of supported URL patterns by media type (as a promise or a plain object).
-     */
-    supportedUrls: PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
-    /**
-     * Generates a language model output (non-streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
-     */
-    doGenerate(options: LanguageModelV3CallOptions): PromiseLike<{
-        /**
-         * Ordered content that the model has generated.
-         */
-        content: Array<LanguageModelV3Content>;
-        /**
-         * Finish reason.
-         */
-        finishReason: LanguageModelV3FinishReason;
-        /**
-         * Usage information.
-         */
-        usage: LanguageModelV3Usage;
-        /**
-         * Additional provider-specific metadata. They are passed through
-         * from the provider to the AI SDK and enable provider-specific
-         * results that can be fully encapsulated in the provider.
-         */
-        providerMetadata?: SharedV3ProviderMetadata;
-        /**
-         * Optional request information for telemetry and debugging purposes.
-         */
-        request?: {
-            /**
-             * Request HTTP body that was sent to the provider API.
-             */
-            body?: unknown;
-        };
-        /**
-         * Optional response information for telemetry and debugging purposes.
-         */
-        response?: LanguageModelV3ResponseMetadata & {
-            /**
-             * Response headers.
-             */
-            headers?: SharedV3Headers;
-            /**
-             * Response HTTP body.
-             */
-            body?: unknown;
-        };
-        /**
-         * Warnings for the call, e.g. unsupported settings.
-         */
-        warnings: Array<LanguageModelV3CallWarning>;
-    }>;
-    /**
-     * Generates a language model output (streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
-     *
-     * @return A stream of higher-level language model output parts.
-     */
-    doStream(options: LanguageModelV3CallOptions): PromiseLike<{
-        stream: ReadableStream<LanguageModelV3StreamPart>;
-        /**
-         * Optional request information for telemetry and debugging purposes.
-         */
-        request?: {
-            /**
-             * Request HTTP body that was sent to the provider API.
-             */
-            body?: unknown;
-        };
-        /**
-         * Optional response data.
-         */
-        response?: {
-            /**
-             * Response headers.
-             */
-            headers?: SharedV3Headers;
-        };
-    }>;
-};
-//# sourceMappingURL=language-model.d.ts.map

package/dist/language-model/language-model.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"language-model.d.ts","sourceRoot":"","sources":["../../src/language-model/language-model.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;OAWG;IACH,aAAa,EACT,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,GACrC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,0BAA0B,GAAG,WAAW,CAAC;QAC3D;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAEvC;;WAEG;QACH,YAAY,EAAE,2BAA2B,CAAC;QAE1C;;WAEG;QACH,KAAK,EAAE,oBAAoB,CAAC;QAE5B;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;QAE5C;;WAEG;QACH,OAAO,CAAC,EAAE;YACR;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;SAChB,CAAC;QAEF;;WAEG;QACH,QAAQ,CAAC,EAAE,+BAA+B,GAAG;YAC3C;;eAEG;YACH,OAAO,CAAC,EAAE,eAAe,CAAC;YAE1B;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;SAChB,CAAC;QAEF;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;KAC7C,CAAC,CAAC;IAEH;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,GAAG,WAAW,CAAC;QACzD,MAAM,EAAE,cAAc,CAAC,yBAAyB,CAAC,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE;YACR;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;SAChB,CAAC;QAEF;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT;;eAEG;YACH,OAAO,CAAC,EAAE,eAAe,CAAC;SAC3B,CAAC;KACH,CAAC,CAAC;CACJ,CAAC"}

package/dist/language-model/settings.d.ts

@@ -1,99 +0,0 @@
-/**
- * Settings to use when calling an LLM.
- *
- * This class holds optional model configuration parameters (e.g. temperature,
- * topP, penalties, truncation, etc.).
- *
- * Not all models/providers support all of these parameters, so please check the API documentation
- * for the specific model and provider you are using.
- */
-export interface LanguageModelSettings {
-    /**
-     * The temperature to use when calling the model.
-     */
-    temperature?: number;
-    /**
-     * The topP to use when calling the model.
-     */
-    topP?: number;
-    /**
-     * The frequency penalty to use when calling the model.
-     */
-    frequencyPenalty?: number;
-    /**
-     * The presence penalty to use when calling the model.
-     */
-    presencePenalty?: number;
-    /**
-     * The tool choice to use when calling the model.
-     */
-    toolChoice?: ModelSettingsToolChoice;
-    /**
-     * Whether to use parallel tool calls when calling the model.
-     * Defaults to false if not provided.
-     */
-    parallelToolCalls?: boolean;
-    /**
-     * The truncation strategy to use when calling the model.
-     */
-    truncation?: "auto" | "disabled";
-    /**
-     * The maximum number of output tokens to generate.
-     */
-    maxTokens?: number;
-    /**
-     * Whether to store the generated model response for later retrieval.
-     * Defaults to true if not provided.
-     */
-    store?: boolean;
-    /**
-     * The reasoning settings to use when calling the model.
-     */
-    reasoning?: ModelSettingsReasoning;
-    /**
-     * The text settings to use when calling the model.
-     */
-    text?: ModelSettingsText;
-    /**
-     * Additional provider specific settings to be passed directly to the model
-     * request.
-     */
-    providerData?: Record<string, any>;
-}
-export type ModelSettingsToolChoice = "auto" | "required" | "none";
-/**
- * Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
- *
- * Supported for providers:
- *
- *  - OpenAI
- *  - ... ?
- */
-export type ModelSettingsReasoningEffort = "minimal" | "low" | "medium" | "high" | null;
-/**
- * Configuration options for model reasoning
- */
-export type ModelSettingsReasoning = {
-    /**
-     * Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
-     */
-    effort?: ModelSettingsReasoningEffort | null;
-    /**
-     * A summary of the reasoning performed by the model.
-     * This can be useful for debugging and understanding the model's reasoning process.
-     * One of `auto`, `concise`, or `detailed`.
-     */
-    summary?: "auto" | "concise" | "detailed" | null;
-};
-export interface ModelSettingsText {
-    /**
-     * Constrains the verbosity of the model's response.
-     *
-     * Supported for providers:
-     *
-     *  - OpenAI
-     *  - ... ?
-     */
-    verbosity?: "low" | "medium" | "high" | null;
-}
-//# sourceMappingURL=settings.d.ts.map

package/dist/language-model/settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/language-model/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC;IAErC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACpC;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GACpC,SAAS,GACT,KAAK,GACL,QAAQ,GACR,MAAM,GACN,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;CAClD,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;CAC9C"}

package/dist/language-model/settings.js

@@ -1 +0,0 @@
-export {};

package/dist/provider/metadata.d.ts

@@ -1,21 +0,0 @@
-import { JSONObject } from "../json.js";
-/**
- * Additional provider-specific metadata.
- *
- * They are passed through to the provider from the AI SDK
- * and enable provider-specific functionality
- * that can be fully encapsulated in the provider.
- *
- * The outer record is keyed by the provider name, and the inner
- * record is keyed by the provider-specific metadata key.
- *
- * ```ts
- * {
- *   "anthropic": {
- *     "cacheControl": { "type": "ephemeral" }
- *   }
- * }
- * ```
- */
-export type SharedProviderMetadata = Record<string, JSONObject>;
-//# sourceMappingURL=metadata.d.ts.map

package/dist/provider/metadata.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/provider/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC"}

package/dist/provider/metadata.js

@@ -1 +0,0 @@
-export {};