@kernl-sdk/protocol 0.1.1

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

@@ -0,0 +1,99 @@
+/**
+ * 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

@@ -0,0 +1 @@
+{"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

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

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

@@ -0,0 +1,195 @@
+import { SharedProviderMetadata } from "../provider";
+import type { LanguageModelFinishReason, LanguageModelUsage, LanguageModelWarning } from "./model";
+import type { ToolCallState } from "./item";
+/**
+ * Union of all possible language model stream events.
+ */
+export type LanguageModelStreamEvent = TextStartEvent | TextEndEvent | TextDeltaEvent | ReasoningStartEvent | ReasoningEndEvent | ReasoningDeltaEvent | ToolInputStartEvent | ToolInputEndEvent | ToolInputDeltaEvent | ToolCallEvent | ToolResultEvent | StartEvent | FinishEvent | AbortEvent | ErrorEvent | RawEvent;
+/**
+ * Base interface for all stream events.
+ */
+export interface StreamEventBase {
+    /**
+     * The ID associated with this stream event.
+     */
+    id?: string;
+    /**
+     * Additional provider-specific metadata for the event.
+     */
+    providerMetadata?: SharedProviderMetadata;
+}
+/**
+ * Stream event indicating the start of a text output.
+ */
+export interface TextStartEvent extends StreamEventBase {
+    readonly kind: "text-start";
+    id: string;
+}
+/**
+ * Stream event indicating the end of a text output.
+ */
+export interface TextEndEvent extends StreamEventBase {
+    readonly kind: "text-end";
+    id: string;
+}
+/**
+ * Stream event containing a delta (chunk) of text output.
+ */
+export interface TextDeltaEvent extends StreamEventBase {
+    readonly kind: "text-delta";
+    id: string;
+    /**
+     * The incremental text chunk.
+     */
+    text: string;
+}
+/**
+ * Stream event indicating the start of reasoning output.
+ */
+export interface ReasoningStartEvent extends StreamEventBase {
+    readonly kind: "reasoning-start";
+    id: string;
+}
+/**
+ * Stream event indicating the end of reasoning output.
+ */
+export interface ReasoningEndEvent extends StreamEventBase {
+    readonly kind: "reasoning-end";
+    id: string;
+}
+/**
+ * Stream event containing a delta (chunk) of reasoning output.
+ */
+export interface ReasoningDeltaEvent extends StreamEventBase {
+    readonly kind: "reasoning-delta";
+    id: string;
+    /**
+     * The incremental reasoning text chunk.
+     */
+    text: string;
+}
+/**
+ * Stream event indicating the start of tool input generation.
+ */
+export interface ToolInputStartEvent extends StreamEventBase {
+    readonly kind: "tool-input-start";
+    id: string;
+    /**
+     * The name of the tool being called.
+     */
+    toolName: string;
+    /**
+     * Optional title for the tool call.
+     */
+    title?: string;
+}
+/**
+ * Stream event indicating the end of tool input generation.
+ */
+export interface ToolInputEndEvent extends StreamEventBase {
+    readonly kind: "tool-input-end";
+    id: string;
+}
+/**
+ * Stream event containing a delta (chunk) of tool input.
+ */
+export interface ToolInputDeltaEvent extends StreamEventBase {
+    readonly kind: "tool-input-delta";
+    id: string;
+    /**
+     * The incremental tool input chunk.
+     */
+    delta: string;
+}
+/**
+ * Stream event containing a complete tool call.
+ */
+export interface ToolCallEvent extends StreamEventBase {
+    readonly kind: "tool-call";
+    id: string;
+    /**
+     * The name of the tool being called.
+     */
+    toolName: string;
+    /**
+     * The arguments for the tool call as a JSON string.
+     */
+    arguments: string;
+}
+/**
+ * Stream event containing a tool result from a provider-executed tool.
+ */
+export interface ToolResultEvent extends StreamEventBase {
+    readonly kind: "tool-result";
+    /**
+     * The ID of the tool call that this result is associated with.
+     */
+    callId: string;
+    /**
+     * Name of the tool that generated this result.
+     */
+    toolId: string;
+    /**
+     * The state of the tool call.
+     */
+    state: ToolCallState;
+    /**
+     * Result of the tool call. This is a JSON-serializable value.
+     */
+    result: unknown;
+    /**
+     * Error message if the tool call failed.
+     */
+    error: string | null;
+}
+/**
+ * Stream event indicating the start of agent execution.
+ */
+export interface StartEvent extends StreamEventBase {
+    readonly kind: "stream-start";
+    /**
+     * Warnings for the call (e.g., unsupported settings).
+     */
+    warnings?: LanguageModelWarning[];
+}
+/**
+ * Stream event indicating the completion of agent execution.
+ */
+export interface FinishEvent extends StreamEventBase {
+    readonly kind: "finish";
+    /**
+     * The reason for completion.
+     */
+    finishReason: LanguageModelFinishReason;
+    /**
+     * Total usage data for the execution.
+     */
+    usage: LanguageModelUsage;
+}
+/**
+ * Stream event indicating the agent execution was aborted.
+ */
+export interface AbortEvent extends StreamEventBase {
+    readonly kind: "abort";
+}
+/**
+ * Stream event indicating an error occurred during execution.
+ */
+export interface ErrorEvent extends StreamEventBase {
+    readonly kind: "error";
+    /**
+     * The error that occurred.
+     */
+    error: unknown;
+}
+/**
+ * Stream event containing raw provider-specific data.
+ */
+export interface RawEvent extends StreamEventBase {
+    readonly kind: "raw";
+    /**
+     * The raw value from the provider.
+     */
+    rawValue: unknown;
+}
+//# sourceMappingURL=stream.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/language-model/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,KAAK,EACV,yBAAyB,EACzB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,cAAc,GACd,YAAY,GACZ,cAAc,GACd,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,UAAU,GACV,WAAW,GACX,UAAU,GACV,UAAU,GACV,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,eAAe;IACjD,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,yBAAyB,CAAC;IAExC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,eAAe;IACjD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,eAAe;IACjD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,eAAe;IAC/C,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB"}

package/dist/language-model/stream.js

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

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

@@ -0,0 +1,48 @@
+import type { JSONSchema7 } from "json-schema";
+import type { SharedProviderOptions } from "../provider";
+/**
+ * A tool has a name, a description, and a set of parameters.
+ *
+ * Note: this is **not** the user-facing tool definition. The AI SDK methods will
+ * map the user-facing tool definitions to this format.
+ */
+export type LanguageModelFunctionTool = {
+    readonly kind: "function";
+    /**
+     * The name of the tool. Unique within this model call.
+     */
+    name: string;
+    /**
+     * A description of the tool. The language model uses this to understand the
+     * tool's purpose and to provide better completion suggestions.
+     */
+    description?: string;
+    /**
+     * The parameters that the tool expects. The language model uses this to
+     * understand the tool's input requirements and to provide matching suggestions.
+     */
+    parameters: JSONSchema7;
+    /**
+     * The provider-specific options for the tool.
+     */
+    providerOptions?: SharedProviderOptions;
+};
+/**
+ * The configuration of a tool that is defined by the provider.
+ */
+export type LanguageModelProviderTool = {
+    readonly kind: "provider-defined";
+    /**
+     * The ID of the tool. Should follow the format `<provider-id>.<unique-tool-name>`.
+     */
+    id: `${string}.${string}`;
+    /**
+     * The name of the tool that the user must use in the tool set.
+     */
+    name: string;
+    /**
+     * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+     */
+    args: Record<string, unknown>;
+};
+//# sourceMappingURL=tool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tool.d.ts","sourceRoot":"","sources":["../../src/language-model/tool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,EAAE,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B,CAAC"}

package/dist/language-model/tool.js

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

package/dist/provider/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./provider";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/provider/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dist/provider/index.js

@@ -0,0 +1 @@
+export * from "./provider";

package/dist/provider/metadata.d.ts

@@ -0,0 +1,21 @@
+import { JSONObject } from "../json";
+/**
+ * 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

@@ -0,0 +1 @@
+{"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

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

package/dist/provider/provider.d.ts

@@ -0,0 +1,42 @@
+import { EmbeddingModel } from "../embedding-model";
+import { LanguageModel } from "../language-model";
+import { JSONObject } from "../json";
+/**
+ * Provider for language, text embedding, and image generation models.
+ */
+export interface Provider {
+    readonly spec: "1.0";
+    /**
+     * Returns the language model with the given id.
+     *
+     * @throws {NoSuchModelError} If no such model exists.
+     */
+    languageModel(modelId: string): LanguageModel;
+    /**
+     * Returns the text embedding model with the given id.
+     *
+     * @throws {NoSuchModelError} If no such model exists.
+     */
+    textEmbeddingModel(modelId: string): EmbeddingModel<string>;
+}
+/**
+ * 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>;
+export type SharedProviderOptions = Record<string, JSONObject>;
+//# sourceMappingURL=provider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/provider/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,CAAC;IAE9C;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;CAkC7D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC"}

package/dist/provider/provider.js

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

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@kernl-sdk/protocol",
+  "version": "0.1.1",
+  "description": "Kernl Provider Protocol - Standard interfaces for AI model providers",
+  "keywords": [
+    "kernl",
+    "protocol",
+    "ai",
+    "llm"
+  ],
+  "author": "dremnik",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dremnik/kernl.git",
+    "directory": "packages/protocol"
+  },
+  "homepage": "https://github.com/dremnik/kernl#readme",
+  "bugs": {
+    "url": "https://github.com/dremnik/kernl/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "devDependencies": {
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^24.10.0",
+    "tsc-alias": "^1.8.10",
+    "typescript": "5.9.2"
+  },
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "dev": "tsc --watch",
+    "lint": "eslint src/",
+    "check-types": "tsc --noEmit"
+  }
+}

package/src/codec.ts

@@ -0,0 +1,22 @@
+/**
+ * Bidirectional codec for converting between Kernl protocol types and provider-specific types.
+ *
+ * @example
+ * ```typescript
+ * const tools: Codec<LanguageModelTool[], ProviderTool[]> = {
+ *   encode: (tools: Tool[]) => tools.map(convertToProvider),
+ *   decode: () => { throw new Error("codec:unimplemented"); },
+ * };
+ * ```
+ */
+export interface Codec<TKernl, TProvider> {
+  /**
+   * Transform from Kernl protocol format to provider format.
+   */
+  encode: (value: TKernl) => TProvider;
+
+  /**
+   * Transform from provider format to Kernl protocol format.
+   */
+  decode: (value: TProvider) => TKernl;
+}

package/src/constants.ts

@@ -0,0 +1,15 @@
+/**
+ * Protocol Constants
+ *
+ * Centralized constants for the Kernl protocol.
+ */
+
+// ----------------------------
+// Tool states
+// ----------------------------
+
+export const IN_PROGRESS = "in_progress";
+export const COMPLETED = "completed";
+export const FAILED = "failed";
+export const INTERRUPTIBLE = "interruptible";
+export const UNINTERRUPTIBLE = "uninterruptible";

package/src/embedding-model/index.ts

@@ -0,0 +1,2 @@
+export * from "./model";
+export * from "./request";

package/src/embedding-model/model.ts

@@ -0,0 +1,76 @@
+import { SharedProviderMetadata } from "@/provider";
+
+import { EmbeddingModelRequest } from "./request";
+
+export type Embedding = number[];
+
+/**
+ * Embedding model interface.
+ *
+ * TValue is the type of values that can be embedded.
+ * Currently string for text, but could support images, audio, etc. in the future.
+ */
+export interface EmbeddingModel<TValue = string> {
+  /**
+   * The embedding model must specify which embedding model interface version it implements.
+   */
+  readonly spec: "1.0";
+
+  /**
+   * Provider ID.
+   */
+  readonly provider: string;
+
+  /**
+   * Provider-specific model ID.
+   */
+  readonly modelId: string;
+
+  /**
+   * Maximum number of values that can be embedded in a single call.
+   * undefined means no limit is known.
+   */
+  readonly maxEmbeddingsPerCall?: number;
+
+  /**
+   * Whether this model can handle multiple embed calls in parallel.
+   */
+  readonly supportsParallelCalls?: boolean;
+
+  /**
+   * Generate embeddings for the given input values.
+   *
+   * @param request - The embedding request.
+   */
+  embed(request: EmbeddingModelRequest<TValue>): Promise<EmbeddingModelResponse>;
+}
+
+/**
+ * The response from an embedding model.
+ */
+export interface EmbeddingModelResponse {
+  /**
+   * Generated embeddings in the same order as input values.
+   */
+  embeddings: Embedding[];
+
+  /**
+   * Token usage for the embedding call.
+   */
+  usage: EmbeddingModelUsage;
+
+  /**
+   * Provider-specific metadata.
+   */
+  providerMetadata?: SharedProviderMetadata;
+}
+
+/**
+ * Usage information for an embedding model call.
+ */
+export interface EmbeddingModelUsage {
+  /**
+   * The number of input tokens used.
+   */
+  inputTokens: number | undefined;
+}

package/src/embedding-model/request.ts

@@ -0,0 +1,31 @@
+import { SharedProviderOptions } from "@/provider";
+
+export interface EmbeddingModelRequest<TValue = string> {
+  /**
+   * Values to embed.
+   */
+  values: TValue[];
+
+  /**
+   * Optional settings for the embedding request.
+   */
+  settings?: EmbeddingModelRequestSettings;
+
+  /**
+   * Abort signal for cancelling the operation.
+   */
+  abort?: AbortSignal;
+}
+
+export interface EmbeddingModelRequestSettings {
+  /**
+   * Desired dimension of the output embeddings.
+   * Not supported by all providers.
+   */
+  dimensions?: number;
+
+  /**
+   * Additional provider-specific options.
+   */
+  providerOptions?: SharedProviderOptions;
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+/**
+ * Kernl Provider Protocol
+ *
+ * Standard interfaces and types for AI model providers.
+ */
+
+// Constants
+export * from "./constants";
+
+// Language Model Protocol
+export * from "./language-model";
+
+// Embedding Model Protocol
+export * from "./embedding-model";
+
+// Provider Base Types
+export * from "./provider";
+
+// Codec Interface
+export * from "./codec";