@fabric-harness/databricks 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +4 -0
- package/README.md +14 -8
- package/dist/agent.d.ts +5 -5
- package/dist/agent.d.ts.map +1 -1
- package/dist/agent.js +40 -30
- package/dist/agent.js.map +1 -1
- package/dist/ai-gateway.d.ts +25 -0
- package/dist/ai-gateway.d.ts.map +1 -0
- package/dist/ai-gateway.js +51 -0
- package/dist/ai-gateway.js.map +1 -0
- package/dist/app.d.ts +31 -10
- package/dist/app.d.ts.map +1 -1
- package/dist/app.js +68 -19
- package/dist/app.js.map +1 -1
- package/dist/certification.d.ts +62 -0
- package/dist/certification.d.ts.map +1 -0
- package/dist/certification.js +110 -0
- package/dist/certification.js.map +1 -0
- package/dist/certify.d.ts +2 -0
- package/dist/certify.d.ts.map +1 -0
- package/dist/certify.js +707 -0
- package/dist/certify.js.map +1 -0
- package/dist/client.d.ts +2 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +13 -2
- package/dist/client.js.map +1 -1
- package/dist/compatibility.d.ts +54 -0
- package/dist/compatibility.d.ts.map +1 -0
- package/dist/compatibility.js +59 -0
- package/dist/compatibility.js.map +1 -0
- package/dist/cost-budget-actuals.d.ts +29 -1
- package/dist/cost-budget-actuals.d.ts.map +1 -1
- package/dist/cost-budget-actuals.js +51 -0
- package/dist/cost-budget-actuals.js.map +1 -1
- package/dist/governance.d.ts +4 -0
- package/dist/governance.d.ts.map +1 -1
- package/dist/governance.js +27 -4
- package/dist/governance.js.map +1 -1
- package/dist/identity.d.ts +20 -6
- package/dist/identity.d.ts.map +1 -1
- package/dist/identity.js +55 -23
- package/dist/identity.js.map +1 -1
- package/dist/index.d.ts +98 -52
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +141 -53
- package/dist/index.js.map +1 -1
- package/dist/jobs.d.ts +77 -0
- package/dist/jobs.d.ts.map +1 -0
- package/dist/jobs.js +173 -0
- package/dist/jobs.js.map +1 -0
- package/dist/lakebase.d.ts +5 -1
- package/dist/lakebase.d.ts.map +1 -1
- package/dist/lakebase.js +26 -17
- package/dist/lakebase.js.map +1 -1
- package/dist/mlflow-tracing.d.ts +3 -3
- package/dist/model.d.ts +24 -15
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js +155 -32
- package/dist/model.js.map +1 -1
- package/dist/rag-chain.d.ts +118 -0
- package/dist/rag-chain.d.ts.map +1 -0
- package/dist/rag-chain.js +212 -0
- package/dist/rag-chain.js.map +1 -0
- package/dist/rag-eval.d.ts +118 -0
- package/dist/rag-eval.d.ts.map +1 -0
- package/dist/rag-eval.js +151 -0
- package/dist/rag-eval.js.map +1 -0
- package/dist/secrets.d.ts +9 -0
- package/dist/secrets.d.ts.map +1 -0
- package/dist/secrets.js +25 -0
- package/dist/secrets.js.map +1 -0
- package/dist/telemetry-sink.d.ts +12 -0
- package/dist/telemetry-sink.d.ts.map +1 -1
- package/dist/telemetry-sink.js +29 -2
- package/dist/telemetry-sink.js.map +1 -1
- package/dist/tools.d.ts +5 -2
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +5 -16
- package/dist/tools.js.map +1 -1
- package/package.json +7 -5
package/dist/lakebase.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { createRequire } from
|
|
2
|
-
import { redactText } from
|
|
1
|
+
import { createRequire } from "node:module";
|
|
2
|
+
import { redactText } from "@fabric-harness/sdk";
|
|
3
3
|
const require = createRequire(import.meta.url);
|
|
4
4
|
/**
|
|
5
5
|
* Exchange a workspace OAuth token for a Lakebase database credential. The
|
|
6
6
|
* result is cached, refreshed early with jitter, and refreshes are single-flight.
|
|
7
7
|
*/
|
|
8
8
|
export function lakebaseCredentialProvider(options) {
|
|
9
|
-
const workspaceHost = options.workspaceHost.replace(/\/$/,
|
|
9
|
+
const workspaceHost = options.workspaceHost.replace(/\/$/, "");
|
|
10
10
|
const fetchImpl = options.fetchImpl ?? fetch;
|
|
11
11
|
const now = options.now ?? Date.now;
|
|
12
12
|
const random = options.random ?? Math.random;
|
|
@@ -15,12 +15,12 @@ export function lakebaseCredentialProvider(options) {
|
|
|
15
15
|
let cached;
|
|
16
16
|
let refreshing;
|
|
17
17
|
const refresh = async () => {
|
|
18
|
-
const workspaceToken = typeof options.token ===
|
|
18
|
+
const workspaceToken = typeof options.token === "function" ? await options.token() : options.token;
|
|
19
19
|
const response = await fetchImpl(`${workspaceHost}/api/2.0/postgres/credentials`, {
|
|
20
|
-
method:
|
|
20
|
+
method: "POST",
|
|
21
21
|
headers: {
|
|
22
22
|
authorization: `Bearer ${workspaceToken}`,
|
|
23
|
-
|
|
23
|
+
"content-type": "application/json",
|
|
24
24
|
},
|
|
25
25
|
body: JSON.stringify({ endpoint: options.endpoint }),
|
|
26
26
|
});
|
|
@@ -28,13 +28,13 @@ export function lakebaseCredentialProvider(options) {
|
|
|
28
28
|
const text = redactText(await response.text(), { additionalSecrets: [workspaceToken] });
|
|
29
29
|
throw new Error(`Lakebase credential exchange failed: ${response.status} ${response.statusText}: ${text.slice(0, 2000)}`);
|
|
30
30
|
}
|
|
31
|
-
const value = await response.json();
|
|
32
|
-
if (typeof value.token !==
|
|
33
|
-
throw new Error(
|
|
31
|
+
const value = (await response.json());
|
|
32
|
+
if (typeof value.token !== "string" || !value.token) {
|
|
33
|
+
throw new Error("Lakebase credential exchange returned no token.");
|
|
34
34
|
}
|
|
35
35
|
const expiresAt = parseExpireTime(value.expire_time);
|
|
36
36
|
if (!Number.isFinite(expiresAt)) {
|
|
37
|
-
throw new Error(
|
|
37
|
+
throw new Error("Lakebase credential exchange returned an invalid expire_time.");
|
|
38
38
|
}
|
|
39
39
|
const jitter = Math.max(0, refreshJitterMs) * random();
|
|
40
40
|
cached = {
|
|
@@ -53,12 +53,12 @@ export function lakebaseCredentialProvider(options) {
|
|
|
53
53
|
};
|
|
54
54
|
}
|
|
55
55
|
function parseExpireTime(value) {
|
|
56
|
-
if (typeof value ===
|
|
56
|
+
if (typeof value === "number") {
|
|
57
57
|
// Databricks APIs commonly use epoch milliseconds, but tolerate epoch
|
|
58
58
|
// seconds so credentials are not treated as already expired.
|
|
59
59
|
return value < 1_000_000_000_000 ? value * 1000 : value;
|
|
60
60
|
}
|
|
61
|
-
if (typeof value ===
|
|
61
|
+
if (typeof value === "string")
|
|
62
62
|
return new Date(value).getTime();
|
|
63
63
|
return Number.NaN;
|
|
64
64
|
}
|
|
@@ -67,18 +67,22 @@ export function lakebaseClient(options) {
|
|
|
67
67
|
let password = options.password;
|
|
68
68
|
if (password === undefined) {
|
|
69
69
|
if (!options.token || !options.workspaceHost || !options.endpoint) {
|
|
70
|
-
throw new Error(
|
|
70
|
+
throw new Error("Lakebase OAuth requires token, workspaceHost, and endpoint. A workspace token cannot be used directly as the Postgres password.");
|
|
71
71
|
}
|
|
72
72
|
password = lakebaseCredentialProvider({
|
|
73
73
|
workspaceHost: options.workspaceHost,
|
|
74
74
|
endpoint: options.endpoint,
|
|
75
75
|
token: options.token,
|
|
76
76
|
...(options.fetchImpl ? { fetchImpl: options.fetchImpl } : {}),
|
|
77
|
-
...(options.refreshBeforeMs !== undefined
|
|
78
|
-
|
|
77
|
+
...(options.refreshBeforeMs !== undefined
|
|
78
|
+
? { refreshBeforeMs: options.refreshBeforeMs }
|
|
79
|
+
: {}),
|
|
80
|
+
...(options.refreshJitterMs !== undefined
|
|
81
|
+
? { refreshJitterMs: options.refreshJitterMs }
|
|
82
|
+
: {}),
|
|
79
83
|
});
|
|
80
84
|
}
|
|
81
|
-
|
|
85
|
+
const client = factory({
|
|
82
86
|
host: options.host,
|
|
83
87
|
port: options.port ?? 5432,
|
|
84
88
|
database: options.database,
|
|
@@ -87,11 +91,16 @@ export function lakebaseClient(options) {
|
|
|
87
91
|
ssl: options.ssl ?? { rejectUnauthorized: true },
|
|
88
92
|
...(options.max !== undefined ? { max: options.max } : {}),
|
|
89
93
|
});
|
|
94
|
+
// node-postgres treats an idle client error as fatal when Pool has no listener. The failed
|
|
95
|
+
// client is already removed from the pool, so keep the process alive and let a later query
|
|
96
|
+
// establish a fresh connection. Applications can attach telemetry through onPoolError.
|
|
97
|
+
client.on?.("error", options.onPoolError ?? (() => undefined));
|
|
98
|
+
return client;
|
|
90
99
|
}
|
|
91
100
|
function defaultPoolFactory() {
|
|
92
101
|
let PoolCtor;
|
|
93
102
|
try {
|
|
94
|
-
PoolCtor = require(
|
|
103
|
+
PoolCtor = require("pg").Pool;
|
|
95
104
|
}
|
|
96
105
|
catch (error) {
|
|
97
106
|
throw new Error(`Lakebase store requires the optional "pg" package to be installed by the application. Run: pnpm add pg. ${error instanceof Error ? error.message : String(error)}`);
|
package/dist/lakebase.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lakebase.js","sourceRoot":"","sources":["../src/lakebase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGjD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"lakebase.js","sourceRoot":"","sources":["../src/lakebase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGjD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AA0C/C;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAA0C;IAE1C,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IAC7C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;IACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;IAC7C,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,CAAC,GAAG,MAAM,CAAC;IAC9D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,MAAM,CAAC;IAC1D,IAAI,MAAwD,CAAC;IAC7D,IAAI,UAAuC,CAAC;IAE5C,MAAM,OAAO,GAAG,KAAK,IAAqB,EAAE;QAC1C,MAAM,cAAc,GAClB,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,aAAa,+BAA+B,EAAE;YAChF,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,cAAc,EAAE;gBACzC,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;SACrD,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,iBAAiB,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YACxF,MAAM,IAAI,KAAK,CACb,wCAAwC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CACzG,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA+B,CAAC;QACpE,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,GAAG,MAAM,EAAE,CAAC;QACvD,MAAM,GAAG;YACP,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,GAAG,MAAM,CAAC;SAC9E,CAAC;QACF,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC,CAAC;IAEF,OAAO,KAAK,IAAI,EAAE;QAChB,IAAI,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,CAAC,SAAS;YAAE,OAAO,MAAM,CAAC,KAAK,CAAC;QAC5D,UAAU,KAAK,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YACpC,UAAU,GAAG,SAAS,CAAC;QACzB,CAAC,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,sEAAsE;QACtE,6DAA6D;QAC7D,OAAO,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IAChE,OAAO,MAAM,CAAC,GAAG,CAAC;AACpB,CAAC;AAuBD,MAAM,UAAU,cAAc,CAAC,OAA8B;IAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,EAAE,CAAC;IAC5D,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CACb,iIAAiI,CAClI,CAAC;QACJ,CAAC;QACD,QAAQ,GAAG,0BAA0B,CAAC;YACpC,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS;gBACvC,CAAC,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE;gBAC9C,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS;gBACvC,CAAC,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE;gBAC9C,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC;QACrB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,QAAQ;QACR,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE;QAChD,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3D,CAAC,CAAC;IACH,2FAA2F;IAC3F,2FAA2F;IAC3F,uFAAuF;IACvF,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB;IACzB,IAAI,QAA4D,CAAC;IACjE,IAAI,CAAC;QACH,QAAQ,GAAI,OAAO,CAAC,IAAI,CAAkE,CAAC,IAAI,CAAC;IAClG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,2GAA2G,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpK,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}
|
package/dist/mlflow-tracing.d.ts
CHANGED
|
@@ -17,9 +17,9 @@ import type { DatabricksRestClient } from './client.js';
|
|
|
17
17
|
*
|
|
18
18
|
* The V3 payload ({@link buildMlflowTrace}) is implemented to the published
|
|
19
19
|
* API spec — OTLP-shaped spans with base64 ids, unix-nano timestamps and
|
|
20
|
-
* typed attributes — but live verification requires a workspace
|
|
21
|
-
*
|
|
22
|
-
* `
|
|
20
|
+
* typed attributes — but live verification requires a workspace. Set
|
|
21
|
+
* `DATABRICKS_LIVE_TEST=1` and `DATABRICKS_MLFLOW_EXPERIMENT_ID`, then run
|
|
22
|
+
* `pnpm --filter @fabric-harness/databricks test:live` before relying on it.
|
|
23
23
|
*
|
|
24
24
|
* Both `sink.record` and `onEvent` never throw — failures (including the
|
|
25
25
|
* async POST) are reported through `onError`.
|
package/dist/model.d.ts
CHANGED
|
@@ -1,29 +1,38 @@
|
|
|
1
|
-
import type { ModelProvider } from
|
|
1
|
+
import type { ModelMetadata, ModelProvider } from "@fabric-harness/sdk";
|
|
2
|
+
export type DatabricksInferenceMode = "auto" | "ai-gateway" | "serving-endpoints";
|
|
3
|
+
export type DatabricksRequestTags = Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
|
|
2
4
|
export interface DatabricksModelOptions {
|
|
3
|
-
/** Workspace host, e.g. https://adb-1234567890.0.cloud.databricks.com */
|
|
5
|
+
/** Workspace host, e.g. https://adb-1234567890.0.cloud.databricks.com. */
|
|
4
6
|
host: string;
|
|
5
7
|
/**
|
|
6
8
|
* Bearer token, or a resolver awaited per request. Pass a resolver for OAuth principal tokens
|
|
7
9
|
* (service-principal / on-behalf-of) so long-lived agents don't pin a stale token.
|
|
8
10
|
*/
|
|
9
11
|
token: string | (() => string | Promise<string>);
|
|
10
|
-
/** Serving
|
|
12
|
+
/** Serving endpoint or fully-qualified Unity AI Gateway model service. */
|
|
11
13
|
defaultModel?: string;
|
|
12
|
-
|
|
14
|
+
/** Select routing explicitly. `auto` sends `system.ai.*` through Unity AI Gateway. */
|
|
15
|
+
mode?: DatabricksInferenceMode;
|
|
16
|
+
/** Explicit OpenAI-compatible base URL. Overrides `mode` URL construction. */
|
|
17
|
+
baseUrl?: string;
|
|
18
|
+
headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
|
|
19
|
+
/** Tags recorded by Unity AI Gateway usage and inference tables. */
|
|
20
|
+
requestTags?: DatabricksRequestTags;
|
|
21
|
+
/** Optional model metadata used by context budgeting and operator UIs. */
|
|
22
|
+
modelMetadata?: Record<string, Omit<ModelMetadata, "provider" | "model" | "gateway">>;
|
|
23
|
+
/** Fetch implementation for tests or controlled private-network transports. */
|
|
24
|
+
fetchImpl?: typeof fetch;
|
|
13
25
|
}
|
|
26
|
+
/** Build the OpenAI-compatible base URL used for one Databricks inference mode. */
|
|
27
|
+
export declare function databricksModelBaseUrl(host: string, mode: Exclude<DatabricksInferenceMode, "auto">): string;
|
|
28
|
+
/** True for Unity Catalog model-service identifiers accepted by Unity AI Gateway. */
|
|
29
|
+
export declare function isDatabricksModelService(model: string | undefined): boolean;
|
|
14
30
|
/**
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* tool-calls and reasoning effort come for free.
|
|
31
|
+
* Databricks inference provider supporting both Unity AI Gateway model services and custom
|
|
32
|
+
* Model Serving endpoints. In `auto` mode, fully-qualified `system.ai.*` models use AI Gateway and
|
|
33
|
+
* other endpoint names retain the `/serving-endpoints` route.
|
|
19
34
|
*/
|
|
20
35
|
export declare function databricksFoundationModelProvider(options: DatabricksModelOptions): ModelProvider;
|
|
21
|
-
/**
|
|
22
|
-
* Register `databricks/<endpoint>` and `mosaic-ai/<endpoint>` model refs so they resolve via
|
|
23
|
-
* `FABRIC_MODEL` / `init({ model })`. Idempotent. Call this explicitly (the `databricks()` bundle
|
|
24
|
-
* does it for you) — registration is NOT an import side-effect, since the package is `sideEffects:
|
|
25
|
-
* false` and a self-registering import could be tree-shaken. Credentials are read from
|
|
26
|
-
* `providers.databricks` then env (`DATABRICKS_HOST`, `DATABRICKS_TOKEN`/`DATABRICKS_API_KEY`).
|
|
27
|
-
*/
|
|
36
|
+
/** Register `databricks/<model>` model references. */
|
|
28
37
|
export declare function registerDatabricksModelProvider(): void;
|
|
29
38
|
//# sourceMappingURL=model.d.ts.map
|
package/dist/model.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EAKd,MAAM,qBAAqB,CAAC;AAI7B,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,YAAY,GAAG,mBAAmB,CAAC;AAElF,MAAM,MAAM,qBAAqB,GAC7B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAErE,MAAM,WAAW,sBAAsB;IACrC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sFAAsF;IACtF,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EACJ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACrE,oEAAoE;IACpE,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACtF,+EAA+E;IAC/E,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B;AAED,mFAAmF;AACnF,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,uBAAuB,EAAE,MAAM,CAAC,GAC7C,MAAM,CAKR;AAED,qFAAqF;AACrF,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAE3E;AAqGD;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,sBAAsB,GAAG,aAAa,CAEhG;AAgED,sDAAsD;AACtD,wBAAgB,+BAA+B,IAAI,IAAI,CAItD"}
|
package/dist/model.js
CHANGED
|
@@ -1,50 +1,173 @@
|
|
|
1
|
-
import { OpenAICompatibleModelProvider, registerModelProvider } from
|
|
1
|
+
import { OpenAICompatibleModelProvider, currentSubmissionContext, registerModelProvider, } from "@fabric-harness/sdk";
|
|
2
|
+
import { databricksIdentity, databricksPrincipalFromEnv } from "./identity.js";
|
|
3
|
+
import { databricksWorkspaceOrigin } from "./client.js";
|
|
4
|
+
/** Build the OpenAI-compatible base URL used for one Databricks inference mode. */
|
|
5
|
+
export function databricksModelBaseUrl(host, mode) {
|
|
6
|
+
const normalized = databricksWorkspaceOrigin(host);
|
|
7
|
+
return mode === "ai-gateway"
|
|
8
|
+
? `${normalized}/ai-gateway/mlflow/v1`
|
|
9
|
+
: `${normalized}/serving-endpoints`;
|
|
10
|
+
}
|
|
11
|
+
/** True for Unity Catalog model-service identifiers accepted by Unity AI Gateway. */
|
|
12
|
+
export function isDatabricksModelService(model) {
|
|
13
|
+
return model?.startsWith("system.ai.") ?? false;
|
|
14
|
+
}
|
|
15
|
+
class DatabricksModelProvider {
|
|
16
|
+
name = "databricks";
|
|
17
|
+
options;
|
|
18
|
+
gateway;
|
|
19
|
+
serving;
|
|
20
|
+
explicit;
|
|
21
|
+
constructor(options) {
|
|
22
|
+
this.options = options;
|
|
23
|
+
const common = {
|
|
24
|
+
name: this.name,
|
|
25
|
+
apiKey: typeof options.token === "string" ? options.token : "",
|
|
26
|
+
...(typeof options.token === "function" ? { tokenProvider: options.token } : {}),
|
|
27
|
+
...(options.defaultModel !== undefined ? { defaultModel: options.defaultModel } : {}),
|
|
28
|
+
...(options.fetchImpl ? { fetchImpl: options.fetchImpl } : {}),
|
|
29
|
+
};
|
|
30
|
+
this.gateway = new OpenAICompatibleModelProvider({
|
|
31
|
+
...common,
|
|
32
|
+
baseUrl: databricksModelBaseUrl(options.host, "ai-gateway"),
|
|
33
|
+
headers: () => this.resolveHeaders(true),
|
|
34
|
+
});
|
|
35
|
+
this.serving = new OpenAICompatibleModelProvider({
|
|
36
|
+
...common,
|
|
37
|
+
baseUrl: databricksModelBaseUrl(options.host, "serving-endpoints"),
|
|
38
|
+
headers: () => this.resolveHeaders(false),
|
|
39
|
+
});
|
|
40
|
+
this.explicit = options.baseUrl
|
|
41
|
+
? new OpenAICompatibleModelProvider({
|
|
42
|
+
...common,
|
|
43
|
+
baseUrl: options.baseUrl,
|
|
44
|
+
headers: () => this.resolveHeaders(options.baseUrl?.includes("/ai-gateway/") ?? false),
|
|
45
|
+
})
|
|
46
|
+
: undefined;
|
|
47
|
+
}
|
|
48
|
+
generate(request) {
|
|
49
|
+
return this.providerFor(request.model).generate(request);
|
|
50
|
+
}
|
|
51
|
+
stream(request) {
|
|
52
|
+
const provider = this.providerFor(request.model);
|
|
53
|
+
if (!provider.stream)
|
|
54
|
+
throw new Error("databricks: selected provider does not support streaming.");
|
|
55
|
+
return provider.stream(request);
|
|
56
|
+
}
|
|
57
|
+
getModelMetadata(model = this.options.defaultModel) {
|
|
58
|
+
const mode = this.modeFor(model);
|
|
59
|
+
return {
|
|
60
|
+
provider: this.name,
|
|
61
|
+
...(model ? { model } : {}),
|
|
62
|
+
gateway: this.options.baseUrl ?? databricksModelBaseUrl(this.options.host, mode),
|
|
63
|
+
...(model && this.options.modelMetadata?.[model] ? this.options.modelMetadata[model] : {}),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
providerFor(model = this.options.defaultModel) {
|
|
67
|
+
if (this.explicit)
|
|
68
|
+
return this.explicit;
|
|
69
|
+
return this.modeFor(model) === "ai-gateway" ? this.gateway : this.serving;
|
|
70
|
+
}
|
|
71
|
+
modeFor(model) {
|
|
72
|
+
const configured = this.options.mode ?? "auto";
|
|
73
|
+
if (configured !== "auto")
|
|
74
|
+
return configured;
|
|
75
|
+
return isDatabricksModelService(model) ? "ai-gateway" : "serving-endpoints";
|
|
76
|
+
}
|
|
77
|
+
async resolveHeaders(gateway) {
|
|
78
|
+
const configured = typeof this.options.headers === "function"
|
|
79
|
+
? await this.options.headers()
|
|
80
|
+
: (this.options.headers ?? {});
|
|
81
|
+
if (!gateway)
|
|
82
|
+
return configured;
|
|
83
|
+
const supplied = typeof this.options.requestTags === "function"
|
|
84
|
+
? await this.options.requestTags()
|
|
85
|
+
: (this.options.requestTags ?? {});
|
|
86
|
+
const context = currentSubmissionContext();
|
|
87
|
+
const tags = compactTags({
|
|
88
|
+
...(context?.submissionId ? { submission_id: context.submissionId } : {}),
|
|
89
|
+
...(context?.attemptId ? { attempt_id: context.attemptId } : {}),
|
|
90
|
+
...(context?.tenantId ? { tenant_id: context.tenantId } : {}),
|
|
91
|
+
...(context?.agent ? { agent: context.agent } : {}),
|
|
92
|
+
...supplied,
|
|
93
|
+
});
|
|
94
|
+
return Object.keys(tags).length > 0
|
|
95
|
+
? { ...configured, "Databricks-Ai-Gateway-Request-Tags": JSON.stringify(tags) }
|
|
96
|
+
: configured;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
function compactTags(tags) {
|
|
100
|
+
return Object.fromEntries(Object.entries(tags)
|
|
101
|
+
.filter(([key, value]) => key.length > 0 && value.length > 0)
|
|
102
|
+
.map(([key, value]) => [key.slice(0, 128), value.slice(0, 512)]));
|
|
103
|
+
}
|
|
2
104
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* tool-calls and reasoning effort come for free.
|
|
105
|
+
* Databricks inference provider supporting both Unity AI Gateway model services and custom
|
|
106
|
+
* Model Serving endpoints. In `auto` mode, fully-qualified `system.ai.*` models use AI Gateway and
|
|
107
|
+
* other endpoint names retain the `/serving-endpoints` route.
|
|
7
108
|
*/
|
|
8
109
|
export function databricksFoundationModelProvider(options) {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
110
|
+
return new DatabricksModelProvider(options);
|
|
111
|
+
}
|
|
112
|
+
function inferenceMode(value) {
|
|
113
|
+
if (!value)
|
|
114
|
+
return undefined;
|
|
115
|
+
if (value === "auto" || value === "ai-gateway" || value === "serving-endpoints")
|
|
116
|
+
return value;
|
|
117
|
+
throw new Error(`Invalid DATABRICKS_INFERENCE_MODE "${value}". Use auto, ai-gateway, or serving-endpoints.`);
|
|
118
|
+
}
|
|
119
|
+
function origin(value) {
|
|
120
|
+
try {
|
|
121
|
+
return new URL(value).origin;
|
|
122
|
+
}
|
|
123
|
+
catch {
|
|
124
|
+
return value;
|
|
125
|
+
}
|
|
18
126
|
}
|
|
19
127
|
const factory = (parsed, providers, env, warnings) => {
|
|
20
|
-
const settings = providers?.databricks
|
|
21
|
-
const
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
128
|
+
const settings = providers?.databricks;
|
|
129
|
+
const configuredUrl = settings?.baseUrl;
|
|
130
|
+
const rawHost = env.DATABRICKS_HOST ?? (configuredUrl ? origin(configuredUrl) : undefined);
|
|
131
|
+
if (!rawHost)
|
|
132
|
+
throw new Error("Missing Databricks host. Set DATABRICKS_HOST or providers.databricks.baseUrl.");
|
|
133
|
+
const host = rawHost.includes("://") ? rawHost : `https://${rawHost}`;
|
|
134
|
+
const staticToken = settings?.apiKey?.trim() ||
|
|
135
|
+
env[settings?.apiKeyEnv ?? "DATABRICKS_TOKEN"]?.trim() ||
|
|
136
|
+
env.DATABRICKS_API_KEY?.trim();
|
|
137
|
+
let principal;
|
|
138
|
+
if (!staticToken) {
|
|
139
|
+
try {
|
|
140
|
+
principal = databricksPrincipalFromEnv(env);
|
|
141
|
+
}
|
|
142
|
+
catch { }
|
|
143
|
+
}
|
|
144
|
+
if (!staticToken && !principal)
|
|
145
|
+
throw new Error("Missing Databricks credentials. Set DATABRICKS_TOKEN, DATABRICKS_CLIENT_ID + DATABRICKS_CLIENT_SECRET, or providers.databricks.apiKey/apiKeyEnv.");
|
|
146
|
+
const token = staticToken ?? databricksIdentity(principal);
|
|
147
|
+
const explicitBaseUrl = env.DATABRICKS_AI_GATEWAY_BASE_URL ??
|
|
148
|
+
(configuredUrl && new URL(configuredUrl).pathname !== "/" ? configuredUrl : undefined);
|
|
149
|
+
const mode = inferenceMode(env.DATABRICKS_INFERENCE_MODE);
|
|
27
150
|
return {
|
|
28
151
|
model: parsed.modelId,
|
|
29
|
-
provider: databricksFoundationModelProvider({
|
|
30
|
-
|
|
152
|
+
provider: databricksFoundationModelProvider({
|
|
153
|
+
host,
|
|
154
|
+
token,
|
|
155
|
+
defaultModel: parsed.modelId,
|
|
156
|
+
...(explicitBaseUrl ? { baseUrl: explicitBaseUrl } : {}),
|
|
157
|
+
...(mode ? { mode } : {}),
|
|
158
|
+
...(settings?.headers ? { headers: settings.headers } : {}),
|
|
159
|
+
}),
|
|
160
|
+
providerName: "databricks",
|
|
31
161
|
modelId: parsed.modelId,
|
|
32
162
|
warnings,
|
|
33
163
|
};
|
|
34
164
|
};
|
|
35
165
|
let registered = false;
|
|
36
|
-
/**
|
|
37
|
-
* Register `databricks/<endpoint>` and `mosaic-ai/<endpoint>` model refs so they resolve via
|
|
38
|
-
* `FABRIC_MODEL` / `init({ model })`. Idempotent. Call this explicitly (the `databricks()` bundle
|
|
39
|
-
* does it for you) — registration is NOT an import side-effect, since the package is `sideEffects:
|
|
40
|
-
* false` and a self-registering import could be tree-shaken. Credentials are read from
|
|
41
|
-
* `providers.databricks` then env (`DATABRICKS_HOST`, `DATABRICKS_TOKEN`/`DATABRICKS_API_KEY`).
|
|
42
|
-
*/
|
|
166
|
+
/** Register `databricks/<model>` model references. */
|
|
43
167
|
export function registerDatabricksModelProvider() {
|
|
44
168
|
if (registered)
|
|
45
169
|
return;
|
|
46
170
|
registered = true;
|
|
47
|
-
registerModelProvider(
|
|
48
|
-
registerModelProvider('mosaic-ai', factory);
|
|
171
|
+
registerModelProvider("databricks", factory);
|
|
49
172
|
}
|
|
50
173
|
//# sourceMappingURL=model.js.map
|
package/dist/model.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,qBAAqB,CAAC;AAS7B,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAiCxD,mFAAmF;AACnF,MAAM,UAAU,sBAAsB,CACpC,IAAY,EACZ,IAA8C;IAE9C,MAAM,UAAU,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACnD,OAAO,IAAI,KAAK,YAAY;QAC1B,CAAC,CAAC,GAAG,UAAU,uBAAuB;QACtC,CAAC,CAAC,GAAG,UAAU,oBAAoB,CAAC;AACxC,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,wBAAwB,CAAC,KAAyB;IAChE,OAAO,KAAK,EAAE,UAAU,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;AAClD,CAAC;AAED,MAAM,uBAAuB;IAClB,IAAI,GAAG,YAAY,CAAC;IACZ,OAAO,CAAyB;IAChC,OAAO,CAAgC;IACvC,OAAO,CAAgC;IACvC,QAAQ,CAA4C;IAErE,YAAY,OAA+B;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YAC9D,GAAG,CAAC,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChF,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrF,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/D,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,6BAA6B,CAAC;YAC/C,GAAG,MAAM;YACT,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC;YAC3D,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;SACzC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,6BAA6B,CAAC;YAC/C,GAAG,MAAM;YACT,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,mBAAmB,CAAC;YAClE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;SAC1C,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO;YAC7B,CAAC,CAAC,IAAI,6BAA6B,CAAC;gBAChC,GAAG,MAAM;gBACT,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;aACvF,CAAC;YACJ,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,OAAqB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,OAAqB;QAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,MAAM;YAClB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;YAChF,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC3F,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY;QACnD,IAAI,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IAC5E,CAAC;IAEO,OAAO,CAAC,KAAyB;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC;QAC/C,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,UAAU,CAAC;QAC7C,OAAO,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC9E,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAgB;QAC3C,MAAM,UAAU,GACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU;YACxC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YAC9B,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO;YAAE,OAAO,UAAU,CAAC;QAChC,MAAM,QAAQ,GACZ,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,UAAU;YAC5C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YAClC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,wBAAwB,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,WAAW,CAAC;YACvB,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,QAAQ;SACZ,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;YACjC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,oCAAoC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YAC/E,CAAC,CAAC,UAAU,CAAC;IACjB,CAAC;CACF;AAED,SAAS,WAAW,CAAC,IAA4B;IAC/C,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACjB,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;SAC5D,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CACnE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAAC,OAA+B;IAC/E,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,aAAa,CAAC,KAAyB;IAC9C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK,KAAK,mBAAmB;QAAE,OAAO,KAAK,CAAC;IAC9F,MAAM,IAAI,KAAK,CACb,sCAAsC,KAAK,gDAAgD,CAC5F,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,KAAa;IAC3B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,OAAO,GAAyB,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,SAAS,EAAE,UAAU,CAAC;IACvC,MAAM,aAAa,GAAG,QAAQ,EAAE,OAAO,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,eAAe,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,IAAI,CAAC,OAAO;QACV,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,OAAO,EAAE,CAAC;IACtE,MAAM,WAAW,GACf,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE;QACxB,GAAG,CAAC,QAAQ,EAAE,SAAS,IAAI,kBAAkB,CAAC,EAAE,IAAI,EAAE;QACtD,GAAG,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC;IACjC,IAAI,SAAoE,CAAC;IACzE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,IAAI,CAAC;YACH,SAAS,GAAG,0BAA0B,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS;QAC5B,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;IACJ,MAAM,KAAK,GAAG,WAAW,IAAI,kBAAkB,CAAC,SAA0C,CAAC,CAAC;IAC5F,MAAM,eAAe,GACnB,GAAG,CAAC,8BAA8B;QAClC,CAAC,aAAa,IAAI,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzF,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC1D,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,OAAO;QACrB,QAAQ,EAAE,iCAAiC,CAAC;YAC1C,IAAI;YACJ,KAAK;YACL,YAAY,EAAE,MAAM,CAAC,OAAO;YAC5B,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D,CAAC;QACF,YAAY,EAAE,YAAY;QAC1B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,sDAAsD;AACtD,MAAM,UAAU,+BAA+B;IAC7C,IAAI,UAAU;QAAE,OAAO;IACvB,UAAU,GAAG,IAAI,CAAC;IAClB,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import type { CapabilityPolicy, ModelProvider, ModelUsage, RetrieveOptions, RetrievedChunk, Retriever, ToolDef } from "@fabric-harness/sdk";
|
|
2
|
+
/**
|
|
3
|
+
* Structured result of one online RAG inference turn.
|
|
4
|
+
* Mirrors the Databricks AI Cookbook chain:
|
|
5
|
+
* preprocess → retrieve (Vector Search) → prompt augment → generate → post-process.
|
|
6
|
+
*
|
|
7
|
+
* Fabric does **not** reimplement Vector Search or Model Serving — this is a thin
|
|
8
|
+
* orchestration over native Databricks APIs already exposed by this package.
|
|
9
|
+
*/
|
|
10
|
+
export interface RagTurn {
|
|
11
|
+
question: string;
|
|
12
|
+
/** Query actually sent to Vector Search (after optional preprocess). */
|
|
13
|
+
retrievalQuery: string;
|
|
14
|
+
chunks: RetrievedChunk[];
|
|
15
|
+
answer: string;
|
|
16
|
+
/** Retrieved sources available to generation. This does not imply that the answer cited them. */
|
|
17
|
+
sources: Array<{
|
|
18
|
+
id: string;
|
|
19
|
+
textPreview?: string;
|
|
20
|
+
score?: number;
|
|
21
|
+
}>;
|
|
22
|
+
/** Sources actually referenced by an inline `[source-id]` marker in the final answer. */
|
|
23
|
+
citations: Array<{
|
|
24
|
+
id: string;
|
|
25
|
+
textPreview?: string;
|
|
26
|
+
score?: number;
|
|
27
|
+
}>;
|
|
28
|
+
model?: string;
|
|
29
|
+
index?: string;
|
|
30
|
+
latencyMs: {
|
|
31
|
+
preprocess: number;
|
|
32
|
+
retrieve: number;
|
|
33
|
+
generate: number;
|
|
34
|
+
total: number;
|
|
35
|
+
};
|
|
36
|
+
usage?: ModelUsage;
|
|
37
|
+
/** Augmented prompt sent to the model (useful for eval / debugging). */
|
|
38
|
+
augmentedPrompt: string;
|
|
39
|
+
systemPrompt: string;
|
|
40
|
+
}
|
|
41
|
+
export interface RagChainPromptOptions {
|
|
42
|
+
/**
|
|
43
|
+
* System instructions for generation. Default is a grounded-answer rubric with citations.
|
|
44
|
+
* Prefer loading long prompts from a skill/role file in app code.
|
|
45
|
+
*/
|
|
46
|
+
system?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Template for the user message. Placeholders:
|
|
49
|
+
* - `{{question}}` original user question
|
|
50
|
+
* - `{{context}}` retrieved chunks formatted for the model
|
|
51
|
+
*/
|
|
52
|
+
userTemplate?: string;
|
|
53
|
+
}
|
|
54
|
+
export interface RagChainPostProcessOptions {
|
|
55
|
+
/** Append a footer containing only sources cited inline by the answer. Default true. */
|
|
56
|
+
appendSourcesFooter?: boolean;
|
|
57
|
+
/** Maximum generated answer body characters. A validated sources footer is added afterward. */
|
|
58
|
+
maxAnswerChars?: number;
|
|
59
|
+
/** Reject citation-looking markers that do not match a retrieved source. Default `validate`. */
|
|
60
|
+
citationPolicy?: "validate" | "known-only";
|
|
61
|
+
/** Require at least one valid inline citation when context was retrieved. Default false. */
|
|
62
|
+
requireCitations?: boolean;
|
|
63
|
+
/** Bounded model revision attempts when required citations are missing. Default 2. */
|
|
64
|
+
citationRepairAttempts?: number;
|
|
65
|
+
}
|
|
66
|
+
export type RagPreprocess = "none" | ((question: string) => string | Promise<string>);
|
|
67
|
+
/** Inputs once a bundle (or explicit retriever + model) is resolved. */
|
|
68
|
+
export interface DatabricksRagChainResolvedOptions {
|
|
69
|
+
modelProvider: ModelProvider;
|
|
70
|
+
retriever: Retriever;
|
|
71
|
+
/** Optional policy from `databricks()` for agent mode. */
|
|
72
|
+
policy?: CapabilityPolicy;
|
|
73
|
+
/** Optional full tool list from the bundle (agent mode). */
|
|
74
|
+
tools?: ToolDef[];
|
|
75
|
+
model?: string;
|
|
76
|
+
topK?: number;
|
|
77
|
+
/** Maximum characters from all retrieved chunks included in the prompt. Default 32,000. */
|
|
78
|
+
maxContextChars?: number;
|
|
79
|
+
/** Maximum characters included from one retrieved chunk. Default 8,000. */
|
|
80
|
+
maxChunkChars?: number;
|
|
81
|
+
filter?: RetrieveOptions["filter"];
|
|
82
|
+
preprocess?: RagPreprocess;
|
|
83
|
+
prompt?: RagChainPromptOptions;
|
|
84
|
+
postProcess?: RagChainPostProcessOptions;
|
|
85
|
+
/** Index name for telemetry (catalog.schema.index). */
|
|
86
|
+
index?: string;
|
|
87
|
+
}
|
|
88
|
+
export interface DatabricksRagChain {
|
|
89
|
+
/** Deterministic cookbook-style inference chain (not free-form tool calling). */
|
|
90
|
+
invoke(input: {
|
|
91
|
+
question: string;
|
|
92
|
+
signal?: AbortSignal;
|
|
93
|
+
}): Promise<RagTurn>;
|
|
94
|
+
/**
|
|
95
|
+
* Agentic path: same Vector Search as a governed `search` tool + model provider
|
|
96
|
+
* for multi-step agents. Prefer when the agent also needs SQL/Genie/etc.
|
|
97
|
+
*/
|
|
98
|
+
asAgentTools(): {
|
|
99
|
+
modelProvider: ModelProvider;
|
|
100
|
+
tools: ToolDef[];
|
|
101
|
+
policy?: CapabilityPolicy;
|
|
102
|
+
retriever: Retriever;
|
|
103
|
+
};
|
|
104
|
+
readonly retriever: Retriever;
|
|
105
|
+
readonly modelProvider: ModelProvider;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Thin orchestration of Databricks-native Vector Search + Model Serving for the
|
|
109
|
+
* online RAG inference chain documented in the Databricks AI Cookbook.
|
|
110
|
+
*
|
|
111
|
+
* Prefer {@link databricksRagChain} from the package root when you have a
|
|
112
|
+
* `databricks({ vectorSearch })` config — it wires the bundle for you.
|
|
113
|
+
*
|
|
114
|
+
* Does **not** implement offline chunking/indexing (use Databricks Jobs/Lakeflow).
|
|
115
|
+
* Does **not** replace Mosaic Agent Evaluation — export turns with rag-eval helpers.
|
|
116
|
+
*/
|
|
117
|
+
export declare function createDatabricksRagChain(options: DatabricksRagChainResolvedOptions): DatabricksRagChain;
|
|
118
|
+
//# sourceMappingURL=rag-chain.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rag-chain.d.ts","sourceRoot":"","sources":["../src/rag-chain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,eAAe,EACf,cAAc,EACd,SAAS,EACT,OAAO,EACR,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,iGAAiG;IACjG,OAAO,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrE,yFAAyF;IACzF,SAAS,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,wEAAwE;IACxE,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,wFAAwF;IACxF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,+FAA+F;IAC/F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gGAAgG;IAChG,cAAc,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAC3C,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtF,wEAAwE;AACxE,MAAM,WAAW,iCAAiC;IAChD,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,4DAA4D;IAC5D,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2FAA2F;IAC3F,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAC/B,WAAW,CAAC,EAAE,0BAA0B,CAAC;IACzC,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,iFAAiF;IACjF,MAAM,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5E;;;OAGG;IACH,YAAY,IAAI;QACd,aAAa,EAAE,aAAa,CAAC;QAC7B,KAAK,EAAE,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,SAAS,EAAE,SAAS,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;CACvC;AAoBD;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,iCAAiC,GACzC,kBAAkB,CA4JpB"}
|