@kernl-sdk/protocol 0.1.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/language-model/content.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,MAAM,MAAM,oBAAoB,GAC5B,iBAAiB,GACjB,sBAAsB,GACtB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,uBAAuB,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,aAAa,GACb,WAAW,GACX,YAAY,GACZ,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC"}

package/dist/language-model/content.js

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

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

@@ -0,0 +1,6 @@
+export * from "./item";
+export * from "./model";
+export * from "./request";
+export * from "./stream";
+export * from "./tool";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/language-model/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}

package/dist/language-model/index.js

@@ -0,0 +1,5 @@
+export * from "./item";
+export * from "./model";
+export * from "./request";
+export * from "./stream";
+export * from "./tool";

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

@@ -0,0 +1,183 @@
+import { SharedProviderMetadata } from "../provider";
+import { JSONValue } from "../json";
+import { IN_PROGRESS, COMPLETED, FAILED, INTERRUPTIBLE, UNINTERRUPTIBLE } from "../constants";
+export type LanguageModelItem = Message | Reasoning | ToolCall | ToolResult | Unknown;
+/**
+ * A subset of LanguageModelItem that excludes items that wouldn't
+ * make sense for a model to generate (e.g. system/user messages, tool results).
+ */
+export type LanguageModelResponseItem = AssistantMessage | Reasoning | ToolCall | Unknown;
+export interface SharedBase {
+    /**
+     * Optional provider-specific metadata for the text part.
+     */
+    providerMetadata?: SharedProviderMetadata;
+}
+/**
+ * Shared base for language model items.
+ */
+export interface LanguageModelItemBase extends SharedBase {
+    /**
+     * A unique identifier for the item. Optional by default.
+     */
+    id?: string;
+}
+/**
+ * Defines base properties common to all message or artifact parts.
+ */
+export interface PartBase extends SharedBase {
+    /** Optional metadata associated with this part. */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Text that the model has generated.
+ */
+export interface TextPart extends PartBase {
+    readonly kind: "text";
+    /**
+     * The text content.
+     */
+    text: string;
+}
+/**
+ * A file that has been generated by the model.
+ *
+ * May be base64 encoded strings or binary data.
+ */
+export interface FilePart extends PartBase {
+    readonly kind: "file";
+    /**
+     * The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mimeType: string;
+    /**
+     * Generated file data as base64 encoded strings or binary data.
+     */
+    data: string | Uint8Array;
+    /**
+     * Optional filename for the file
+     */
+    filename?: string;
+}
+/**
+ * Represents a structured data segment (e.g., JSON) within a message or artifact.
+ */
+export interface DataPart extends PartBase {
+    readonly kind: "data";
+    /**
+     * The structured data content.
+     */
+    data: Record<string, unknown>;
+}
+export type MessagePart = TextPart | FilePart | DataPart;
+/**
+ * Reasoning that the model has generated.
+ */
+export interface Reasoning extends LanguageModelItemBase {
+    readonly kind: "reasoning";
+    /**
+     * The reasoning content
+     */
+    text: string;
+}
+/**
+ * This is a catch all for events that are not part of the protocol.
+ *
+ * For example, a model might return an event that is not part of the protocol using this type.
+ *
+ * In that case everything returned from the model should be passed in the `providerMetadata` field.
+ *
+ * This enables new features to be added to be added by a model provider without breaking the protocol.
+ */
+export interface Unknown extends LanguageModelItemBase {
+    readonly kind: "unknown";
+}
+export interface MessageBase extends SharedBase {
+    readonly kind: "message";
+    /**
+     * The unique identifier for the message.
+     */
+    id: string;
+    /**
+     * The content parts of the message.
+     */
+    content: MessagePart[];
+    /**
+     * Optional additional metadata for the message
+     */
+    metadata?: Record<string, unknown>;
+}
+export interface SystemMessage extends MessageBase {
+    /**
+     * Representing a system message to the user
+     */
+    readonly role: "system";
+}
+export interface AssistantMessage extends MessageBase {
+    /**
+     * Representing a message from the assistant
+     */
+    readonly role: "assistant";
+}
+export interface UserMessage extends MessageBase {
+    /**
+     * Representing a message from the user
+     */
+    readonly role: "user";
+}
+export type Message = SystemMessage | AssistantMessage | UserMessage;
+/**
+ * Tool calls that the model has generated.
+ */
+export interface ToolCall extends LanguageModelItemBase {
+    readonly kind: "tool-call";
+    /**
+     * The identifier of the tool call. It must be unique across all tool calls.
+     */
+    callId: string;
+    /**
+     * The id of the tool that should be called.
+     */
+    toolId: string;
+    /**
+     * The state of the tool call.
+     */
+    state: ToolCallState;
+    /**
+     * The stringified JSON object with the arguments of the tool call.
+     */
+    arguments: string;
+}
+/**
+ * Result of a tool call that has been executed by the provider.
+ */
+export interface ToolResult extends LanguageModelItemBase {
+    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 object.
+     */
+    result: NonNullable<JSONValue>;
+    /**
+     * Error message if the tool call failed
+     */
+    error: string | null;
+}
+/**
+ * State of a tool call execution.
+ */
+export type ToolCallState = typeof IN_PROGRESS | typeof COMPLETED | typeof FAILED | typeof INTERRUPTIBLE | typeof UNINTERRUPTIBLE;
+//# sourceMappingURL=item.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"item.d.ts","sourceRoot":"","sources":["../../src/language-model/item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EACL,WAAW,EACX,SAAS,EACT,MAAM,EACN,aAAa,EACb,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,iBAAiB,GACzB,OAAO,GACP,SAAS,GACT,QAAQ,GACR,UAAU,GACV,OAAO,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GACjC,gBAAgB,GAChB,SAAS,GACT,QAAQ,GACR,OAAO,CAAC;AAEZ,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAMD;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,qBAAqB;IACtD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,OAAQ,SAAQ,qBAAqB;IACpD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CAC1B;AAMD,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,OAAO,GAAG,aAAa,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAMrE;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,qBAAqB;IACrD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,qBAAqB;IACvD,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,WAAW,CAAC,SAAS,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,OAAO,WAAW,GAClB,OAAO,SAAS,GAChB,OAAO,MAAM,GACb,OAAO,aAAa,GACpB,OAAO,eAAe,CAAC"}

package/dist/language-model/item.js

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

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

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

@@ -0,0 +1 @@
+{"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/language-model.js

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

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

@@ -0,0 +1,110 @@
+import { SharedProviderMetadata } from "../provider";
+import { LanguageModelResponseItem } from "./item";
+import { LanguageModelRequest } from "./request";
+import { LanguageModelStreamEvent } from "./stream";
+import { LanguageModelFunctionTool, LanguageModelProviderTool } from "./tool";
+/**
+ * Defines the standard interface for language model providers in kernl.
+ */
+export interface 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;
+    /**
+     * Get a response from the model.
+     *
+     * @param request - The request to get a response for.
+     */
+    generate(request: LanguageModelRequest): Promise<LanguageModelResponse>;
+    /**
+     * Get a streamed response from the model.
+     *
+     * @param request - The request to get a response for.
+     */
+    stream(request: LanguageModelRequest): AsyncIterable<LanguageModelStreamEvent>;
+}
+/**
+ * The base response interface for a language model.
+ */
+export interface LanguageModelResponse {
+    /**
+     * The ordered list of content items generated by the model.
+     */
+    content: LanguageModelResponseItem[];
+    /**
+     * Finish reason.
+     */
+    finishReason: LanguageModelFinishReason;
+    /**
+     * The usage information for response.
+     */
+    usage: LanguageModelUsage;
+    /**
+     * Warnings for the call, e.g. unsupported settings.
+     */
+    warnings: LanguageModelWarning[];
+    /**
+     * Raw response data from the underlying model provider.
+     */
+    providerMetadata?: SharedProviderMetadata;
+}
+/**
+ * Reason why a language model finished generating a response.
+ */
+export type LanguageModelFinishReason = "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown";
+/**
+ * Usage information for a language model call.
+ *
+ * If your API return additional usage information, you can add it to the
+ * provider metadata under your provider's key.
+ */
+export interface LanguageModelUsage {
+    /**
+     * The number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+     * The number of output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+    /**
+     * The total number of tokens as reported by the provider.
+     * This number might be different from the sum of `inputTokens` and `outputTokens`
+     * and e.g. include reasoning tokens or other overhead.
+     */
+    totalTokens: number | undefined;
+    /**
+     * The number of reasoning tokens used.
+     */
+    reasoningTokens?: number | undefined;
+    /**
+     * The number of cached input tokens.
+     */
+    cachedInputTokens?: number | undefined;
+}
+/**
+ * Warning from the model provider for this call. The call will proceed, but e.g.
+ * some settings might not be supported, which can lead to suboptimal results.
+ */
+export type LanguageModelWarning = {
+    type: "unsupported-setting";
+    setting: Omit<keyof LanguageModelRequest, "input">;
+    details?: string;
+} | {
+    type: "unsupported-tool";
+    tool: LanguageModelFunctionTool | LanguageModelProviderTool;
+    details?: string;
+} | {
+    type: "other";
+    message: string;
+};
+//# sourceMappingURL=model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/language-model/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;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;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAExE;;;;OAIG;IACH,MAAM,CACJ,OAAO,EAAE,oBAAoB,GAC5B,aAAa,CAAC,wBAAwB,CAAC,CAAC;CAiB5C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAOpC;;OAEG;IACH,OAAO,EAAE,yBAAyB,EAAE,CAAC;IAErC;;OAEG;IACH,YAAY,EAAE,yBAAyB,CAAC;IAExC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IAEjC;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,YAAY,GACZ,OAAO,GACP,OAAO,GACP,SAAS,CAAC;AAEd;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IACE,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,IAAI,CAAC,MAAM,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,yBAAyB,GAAG,yBAAyB,CAAC;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/language-model/model.js

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

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

@@ -0,0 +1,175 @@
+import type { JSONSchema7 } from "json-schema";
+import { SharedProviderOptions } from "../provider";
+import { LanguageModelItem } from "./item";
+import { LanguageModelFunctionTool, LanguageModelProviderTool } from "./tool";
+export type LanguageModelTool = LanguageModelFunctionTool | LanguageModelProviderTool;
+/**
+ * A request to a large language model.
+ */
+export interface LanguageModelRequest {
+    /**
+     * The input to the model.
+     */
+    input: LanguageModelItem[];
+    /**
+     * The model settings to use for the request.
+     */
+    settings: LanguageModelRequestSettings;
+    /**
+     * Response format. The output can either be text or JSON. Default is text.
+     *
+     * If JSON is selected, a schema can optionally be provided to guide the LLM.
+     */
+    responseType?: LanguageModelResponseType;
+    /**
+     * The tools that are available for the model.
+     */
+    tools?: LanguageModelTool[];
+    /**
+  Include raw chunks in the stream. Only applicable for streaming calls.
+   */
+    includeRawChunks?: boolean;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abort?: AbortSignal;
+}
+/**
+ * Response format specification for language model output.
+ *
+ * The output can either be text or JSON. Default is text.
+ * If JSON is selected, a schema can optionally be provided to guide the LLM.
+ */
+export type LanguageModelResponseType = LanguageModelResponseText | LanguageModelResponseJSON;
+/**
+ * Text response format.
+ */
+export interface LanguageModelResponseText {
+    readonly kind: "text";
+}
+/**
+ * JSON response format.
+ */
+export interface LanguageModelResponseJSON {
+    readonly kind: "json";
+    /**
+     * JSON schema that the generated output should conform to.
+     */
+    schema?: JSONSchema7;
+    /**
+     * Name of output that should be generated. Used by some providers for additional LLM guidance.
+     */
+    name?: string;
+    /**
+     * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+     */
+    description?: string;
+}
+/**
+ * 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 LanguageModelRequestSettings {
+    /**
+     * 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?: LanguageModelToolChoice;
+    /**
+     * 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 metadata to be passed directly to the model
+     * request.
+     */
+    providerOptions?: SharedProviderOptions;
+}
+export type LanguageModelToolChoice = {
+    kind: "auto";
+} | {
+    kind: "none";
+} | {
+    kind: "required";
+} | {
+    kind: "tool";
+    toolId: string;
+};
+/**
+ * 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=request.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/language-model/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AAE9E,MAAM,MAAM,iBAAiB,GACzB,yBAAyB,GACzB,yBAAyB,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,4BAA4B,CAAC;IAEvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE5B;;KAEC;IACD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GACjC,yBAAyB,GACzB,yBAAyB,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;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,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC;AAED,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC;;;;;;;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/request.js

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