@databricks/ai-sdk-provider 0.2.3 → 0.4.0

package/dist/index.d.cts

@@ -1,6 +1,5 @@
-import { LanguageModelV2, ProviderV2 } from "@ai-sdk/provider";
+import { LanguageModelV3, ProviderV3 } from "@ai-sdk/provider";
 import { FetchFunction } from "@ai-sdk/provider-utils";
-import { z } from "zod/v4";
 
 //#region src/databricks-provider.d.ts
 type DatabricksLanguageModelConfig = {
@@ -10,13 +9,22 @@ type DatabricksLanguageModelConfig = {
     path: string;
   }) => string;
   fetch?: FetchFunction;
+  /**
+   * When true, marks all tool calls as dynamic and provider-executed.
+   * This indicates that tool execution is handled remotely by Databricks agents.
+   * Defaults to true.
+   */
+  useRemoteToolCalling?: boolean;
 };
-interface DatabricksProvider extends ProviderV2 {
+interface DatabricksProvider extends ProviderV3 {
   /** Agents */
-  chatAgent(modelId: string): LanguageModelV2;
-  responses(modelId: string): LanguageModelV2;
+  chatAgent(modelId: string): LanguageModelV3;
+  responses(modelId: string): LanguageModelV3;
   /** Foundation Models */
-  chatCompletions(modelId: string): LanguageModelV2;
+  chatCompletions(modelId: string): LanguageModelV3;
+  /** Required overrides from ProviderV3 */
+  textEmbeddingModel(modelId: string): never;
+  languageModel(modelId: string): never;
 }
 interface DatabricksProviderSettings {
   /** Base URL for the Databricks API calls. */
@@ -37,145 +45,14 @@ interface DatabricksProviderSettings {
     baseUrl?: string;
     path: string;
   }) => string;
+  /**
+   * When true, marks all tool calls as dynamic and provider-executed.
+   * This indicates that tool execution is handled remotely by Databricks agents.
+   * Defaults to true.
+   */
+  useRemoteToolCalling?: boolean;
 }
-declare const createDatabricksProvider: (settings: DatabricksProviderSettings) => DatabricksProvider; //#endregion
-//#region src/tools.d.ts
-
-//# sourceMappingURL=databricks-provider.d.ts.map
-declare const DATABRICKS_TOOL_CALL_ID = "databricks-tool-call";
-/**
- * The AI-SDK requires that tools used by the model are defined ahead of time.
- *
- * Since tool calls can be orchestrated by Databricks' agents we don't know the name, input, or output schemas
- * of the tools until the model is called.
- *
- * In the DatabricksProvider we transform all tool calls to fit this definition, and keep the
- * original name as part of the metadata. This allows us to parse any tool orchestrated by Databricks' agents,
- * while still being able to render the tool call and result in the UI, and pass it back to the model with the correct name.
- */
-declare const DATABRICKS_TOOL_DEFINITION: {
-  name: string;
-  description: string;
-  inputSchema: z.ZodAny;
-  outputSchema: z.ZodAny;
-};
-
-//#endregion
-//#region src/mcp.d.ts
-//# sourceMappingURL=tools.d.ts.map
-/**
- * MCP Approval Utility Functions
- *
- * Shared utilities for handling MCP (Model Context Protocol) approval requests
- * and responses across client and server code.
- */
-/** Key used in tool output to indicate approval status */
-declare const MCP_APPROVAL_STATUS_KEY = "__approvalStatus__";
-/** Type string for MCP approval requests in provider metadata */
-declare const MCP_APPROVAL_REQUEST_TYPE = "mcp_approval_request";
-/** Type string for MCP approval responses in provider metadata */
-declare const MCP_APPROVAL_RESPONSE_TYPE = "mcp_approval_response";
-/** Approval status output object shape */
-type ApprovalStatusOutput = {
-  [MCP_APPROVAL_STATUS_KEY]: boolean;
-};
-/** State of an MCP approval request */
-type McpApprovalState = 'awaiting-approval' | 'approved' | 'denied';
-/** Databricks-specific metadata attached to tool calls */
-interface DatabricksToolMetadata {
-  type?: string;
-  toolName?: string;
-  itemId?: string;
-  serverLabel?: string;
-  mcpServerName?: string;
-  approvalRequestId?: string;
-  approve?: boolean;
-  reason?: string;
-}
-/**
- * Check if output contains an approval status marker.
- *
- * @example
- * if (isApprovalStatusOutput(output)) {
- *   console.log(output.__approvalStatus__); // TypeScript knows this is boolean
- * }
- */
-declare function isApprovalStatusOutput(output: unknown): output is ApprovalStatusOutput;
-/**
- * Check if provider metadata indicates an MCP approval request.
- *
- * @example
- * const metadata = extractDatabricksMetadata(part);
- * if (isMcpApprovalRequest(metadata)) {
- *   // Handle MCP approval request
- * }
- */
-declare function isMcpApprovalRequest(metadata: DatabricksToolMetadata | Record<string, unknown> | undefined): boolean;
-/**
- * Check if provider metadata indicates an MCP approval response.
- */
-declare function isMcpApprovalResponse(metadata: DatabricksToolMetadata | Record<string, unknown> | undefined): boolean;
-/**
- * Extract Databricks metadata from a tool call part's callProviderMetadata.
- *
- * @example
- * const metadata = extractDatabricksMetadata(part);
- * const toolName = metadata?.toolName;
- * const isMcp = isMcpApprovalRequest(metadata);
- */
-declare function extractDatabricksMetadata(part: {
-  callProviderMetadata?: Record<string, unknown>;
-}): DatabricksToolMetadata | undefined;
-/**
- * Extract the approval status boolean from an output object.
- *
- * @returns `true` if approved, `false` if denied, `undefined` if not an approval output
- *
- * @example
- * const status = extractApprovalStatus(output);
- * if (status !== undefined) {
- *   console.log(status ? 'Approved' : 'Denied');
- * }
- */
-declare function extractApprovalStatus(output: unknown): boolean | undefined;
-/**
- * Extract approval status from a tool result's output value.
- * Handles the nested structure where output.type === 'json' and value contains the status.
- *
- * @example
- * const status = extractApprovalStatusFromToolResult(toolResult.output);
- */
-declare function extractApprovalStatusFromToolResult(output: {
-  type: string;
-  value?: unknown;
-}): boolean | undefined;
-/**
- * Create an approval status output object.
- *
- * @example
- * await addToolResult({
- *   toolCallId,
- *   output: createApprovalStatusOutput(true), // Approve
- * });
- */
-declare function createApprovalStatusOutput(approve: boolean): ApprovalStatusOutput;
-/**
- * Determine the MCP approval state from a tool output.
- *
- * Logic:
- * - No output → 'awaiting-approval' (user hasn't responded yet)
- * - Output with __approvalStatus__: true → 'approved'
- * - Output with __approvalStatus__: false → 'denied'
- * - Output without __approvalStatus__ → 'approved' (tool executed, so it was approved)
- *
- * @example
- * const approvalState = getMcpApprovalState(part.output);
- * // 'awaiting-approval' | 'approved' | 'denied'
- */
-declare function getMcpApprovalState(output: unknown): McpApprovalState;
-
+declare const createDatabricksProvider: (settings: DatabricksProviderSettings) => DatabricksProvider;
 //#endregion
-//# sourceMappingURL=mcp.d.ts.map
-
-export { ApprovalStatusOutput, DATABRICKS_TOOL_CALL_ID, DATABRICKS_TOOL_DEFINITION, DatabricksLanguageModelConfig, DatabricksProvider, DatabricksProviderSettings, DatabricksToolMetadata, MCP_APPROVAL_REQUEST_TYPE, MCP_APPROVAL_RESPONSE_TYPE, MCP_APPROVAL_STATUS_KEY, McpApprovalState, createApprovalStatusOutput, createDatabricksProvider, extractApprovalStatus, extractApprovalStatusFromToolResult, extractDatabricksMetadata, getMcpApprovalState, isApprovalStatusOutput, isMcpApprovalRequest, isMcpApprovalResponse };
+export { DatabricksLanguageModelConfig, DatabricksProvider, DatabricksProviderSettings, createDatabricksProvider };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/databricks-provider.ts","../src/tools.ts","../src/mcp.ts"],"sourcesContent":null,"mappings":";;;;;KAMY,6BAAA;;iBAEK;EAFL,GAAA,EAAA,CAAA,OAAA,EAAA;IAA6B,IAAA,EAAA,MAAA;EAAA,CAAA,EAExB,GAAA,MAAA;EAAM,KAEb,CAAA,EAAA,aAAA;AAAa,CAAA;AAGN,UAAA,kBAAA,SAA2B,UAAR,CAAA;EAAA;EAAA,SAEN,CAAA,OAAA,EAAA,MAAA,CAAA,EAAA,eAAA;EAAe,SACf,CAAA,OAAA,EAAA,MAAA,CAAA,EAAA,eAAA;EAAe;EAGM,eANP,CAAA,OAAA,EAAA,MAAA,CAAA,EAMR,eANQ;AAAU;AASrC,UAAA,0BAAA,CAA0B;EAAA;EAAA,OAI/B,EAAA,MAAA;EAAM;EAQK,OAAA,CAAA,EARX,MAQW,CAAA,MAAA,EAAA,MAAA,CAAA;EAQV;EAiDZ,QAAA,CAAA,EAAA,MAAA;EAAA;;AAAA;;UAzDS;;AC/BV;;;;;;;cDuCa,qCACD,+BACT;;;;cCzCU,uBAAA;;;;ADGb;;;;AAIuB;AAGvB;;AAE8B,cCAjB,0BDAiB,EAAA;EAAe,IACf,EAAA,MAAA;EAAe,WAGT,EAAA,MAAA;EAAe,WANP,ECQ5B,CAAA,CAAA,MDR4B;EAAU,YAAA,UAAA;AAStD,CAAA;;;;;;;;;;AAhBA;;AAEiB,cEIJ,uBAAA,GFJI,oBAAA;;AAEM,cEKV,yBAAA,GFLU,sBAAA;AAGvB;AAAoC,cEKvB,0BAAA,GFLuB,uBAAA;;AAGN,KESlB,oBAAA,GFTkB;EAAe,CEU1C,uBAAuB,CFPU,EAAA,OAAA;CAAe;AANG;AASrC,KEQL,gBAAA,GFRK,mBAA0B,GAAA,UAAA,GAAA,QAAA;;AAI/B,UEOK,sBAAA,CFPL;EAAM,IAQR,CAAA,EAAA,MAAA;EAAa,QAAA,CAAA,EAAA,MAAA;EAQV,MAAA,CAAA,EAAA,MAAA;EAiDZ,WAAA,CAAA,EAAA,MAAA;EAAA,aAhDW,CAAA,EAAA,MAAA;EAA0B,iBACnC,CAAA,EAAA,MAAA;EA+CF,OAAA,CAAA,EAAA,OAAA;;;;ACxFD;;;;;;;iBCqDgB,sBAAA,6BAAmD;;;;ADzCnE;;;;;;iBC2DgB,oBAAA,WACJ,yBAAyB;;;;iBAQrB,qBAAA,WACJ,yBAAyB;;;;;AAxErC;;AAGA;;AAGa,iBAmFG,yBAAA,CAnFuB,IAAA,EAAA;yBAoFd;AA7EzB,CAAA,CAAA,EA8EI,sBA9EQ,GAAoB,SAC7B;;AAIH;;AAGA;;;;;;;;iBAwFgB,qBAAA;AAjEhB;;;;;;;iBA+EgB,mCAAA;;;AA7DhB,CAAA,CAAA,EAAgB,OAAA,GAAA,SAAA;;;;AAC2B;;;;AAQ3C;;AACY,iBAkFI,0BAAA,CAlFJ,OAAA,EAAA,OAAA,CAAA,EAkFkD,oBAlFlD;;AAA+B;;;;;;;;;AAiB3C;;;AAEI,iBAoFY,mBAAA,CApFZ,MAAA,EAAA,OAAA,CAAA,EAoFkD,gBApFlD;;;AAAsB"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/databricks-provider.ts"],"mappings":";;;;KAMY,6BAAA;EACV,QAAA;EACA,OAAA,QAAe,MAAA;EACf,GAAA,GAAM,OAAA;IAAW,IAAA;EAAA;EACjB,KAAA,GAAQ,aAAA;EAFR;;;;;EAQA,oBAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,UAAA;EAHtB;EAKpB,SAAA,CAAU,OAAA,WAAkB,eAAA;EAC5B,SAAA,CAAU,OAAA,WAAkB,eAAA;EAHM;EAMlC,eAAA,CAAgB,OAAA,WAAkB,eAAA;EAJN;EAO5B,kBAAA,CAAmB,OAAA;EACnB,aAAA,CAAc,OAAA;AAAA;AAAA,UAGC,0BAAA;EAbqC;EAepD,OAAA;EAbA;EAeA,OAAA,GAAU,MAAA;EAfkB;EAiB5B,QAAA;EAhBU;;;;EAsBV,KAAA,GAAQ,aAAA;EAhBR;;;EAqBA,SAAA,IAAa,OAAA;IAAW,OAAA;IAAkB,IAAA;EAAA;EAjBD;;;;;EAwBzC,oBAAA;AAAA;AAAA,cAGW,wBAAA,GACX,QAAA,EAAU,0BAAA,KACT,kBAAA"}

package/dist/index.d.mts

@@ -0,0 +1,58 @@
+import { FetchFunction } from "@ai-sdk/provider-utils";
+import { LanguageModelV3, ProviderV3 } from "@ai-sdk/provider";
+
+//#region src/databricks-provider.d.ts
+type DatabricksLanguageModelConfig = {
+  provider: string;
+  headers: () => Record<string, string | undefined>;
+  url: (options: {
+    path: string;
+  }) => string;
+  fetch?: FetchFunction;
+  /**
+   * When true, marks all tool calls as dynamic and provider-executed.
+   * This indicates that tool execution is handled remotely by Databricks agents.
+   * Defaults to true.
+   */
+  useRemoteToolCalling?: boolean;
+};
+interface DatabricksProvider extends ProviderV3 {
+  /** Agents */
+  chatAgent(modelId: string): LanguageModelV3;
+  responses(modelId: string): LanguageModelV3;
+  /** Foundation Models */
+  chatCompletions(modelId: string): LanguageModelV3;
+  /** Required overrides from ProviderV3 */
+  textEmbeddingModel(modelId: string): never;
+  languageModel(modelId: string): never;
+}
+interface DatabricksProviderSettings {
+  /** Base URL for the Databricks API calls. */
+  baseURL: string;
+  /** Custom headers to include in the requests. */
+  headers?: Record<string, string>;
+  /** Provider name. Overrides the `databricks` default name for 3rd party providers. */
+  provider?: string;
+  /**
+   * Custom fetch implementation. You can use it as a middleware to intercept requests,
+   * or to provide a custom fetch implementation for e.g. testing.
+   * */
+  fetch?: FetchFunction;
+  /**
+   * Optional function to format the URL
+   */
+  formatUrl?: (options: {
+    baseUrl?: string;
+    path: string;
+  }) => string;
+  /**
+   * When true, marks all tool calls as dynamic and provider-executed.
+   * This indicates that tool execution is handled remotely by Databricks agents.
+   * Defaults to true.
+   */
+  useRemoteToolCalling?: boolean;
+}
+declare const createDatabricksProvider: (settings: DatabricksProviderSettings) => DatabricksProvider;
+//#endregion
+export { DatabricksLanguageModelConfig, DatabricksProvider, DatabricksProviderSettings, createDatabricksProvider };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/databricks-provider.ts"],"mappings":";;;;KAMY,6BAAA;EACV,QAAA;EACA,OAAA,QAAe,MAAA;EACf,GAAA,GAAM,OAAA;IAAW,IAAA;EAAA;EACjB,KAAA,GAAQ,aAAA;EAFR;;;;;EAQA,oBAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,UAAA;EAHtB;EAKpB,SAAA,CAAU,OAAA,WAAkB,eAAA;EAC5B,SAAA,CAAU,OAAA,WAAkB,eAAA;EAHM;EAMlC,eAAA,CAAgB,OAAA,WAAkB,eAAA;EAJN;EAO5B,kBAAA,CAAmB,OAAA;EACnB,aAAA,CAAc,OAAA;AAAA;AAAA,UAGC,0BAAA;EAbqC;EAepD,OAAA;EAbA;EAeA,OAAA,GAAU,MAAA;EAfkB;EAiB5B,QAAA;EAhBU;;;;EAsBV,KAAA,GAAQ,aAAA;EAhBR;;;EAqBA,SAAA,IAAa,OAAA;IAAW,OAAA;IAAkB,IAAA;EAAA;EAjBD;;;;;EAwBzC,oBAAA;AAAA;AAAA,cAGW,wBAAA,GACX,QAAA,EAAU,0BAAA,KACT,kBAAA"}