@databricks/appkit-ui 0.88.0 → 0.89.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/CLAUDE.md +7 -2
- package/dist/cli/commands/doctor/checks-existence.js +16 -16
- package/dist/cli/commands/doctor/checks-existence.js.map +1 -1
- package/dist/cli/commands/doctor/checks.js +15 -18
- package/dist/cli/commands/doctor/checks.js.map +1 -1
- package/dist/cli/commands/doctor/databricks-client.js +8 -6
- package/dist/cli/commands/doctor/databricks-client.js.map +1 -1
- package/dist/cli/commands/registry/workspace-picker.js +34 -24
- package/dist/cli/commands/registry/workspace-picker.js.map +1 -1
- package/dist/react/genie/genie-chart-inference.js.map +1 -1
- package/dist/react/genie/genie-query-transform.d.ts +5 -2
- package/dist/react/genie/genie-query-transform.d.ts.map +1 -1
- package/dist/react/genie/genie-query-transform.js +14 -8
- package/dist/react/genie/genie-query-transform.js.map +1 -1
- package/dist/react/table/table-wrapper.js +6 -1
- package/dist/react/table/table-wrapper.js.map +1 -1
- package/dist/react/table/types.d.ts +5 -1
- package/dist/react/table/types.d.ts.map +1 -1
- package/dist/react/ui/button.d.ts +1 -1
- package/dist/shared/src/genie.d.ts +9 -3
- package/dist/shared/src/genie.d.ts.map +1 -1
- package/dist/shared/src/workspace-client/factory.d.ts +0 -1
- package/dist/shared/src/workspace-client/index.d.ts +1 -2
- package/dist/shared/src/workspace-client/modular.d.ts +19 -0
- package/dist/shared/src/workspace-client/types.d.ts +1 -2
- package/dist/workspace-client/client.js +81 -23
- package/dist/workspace-client/client.js.map +1 -1
- package/dist/workspace-client/errors.d.ts +14 -2
- package/dist/workspace-client/errors.d.ts.map +1 -0
- package/dist/workspace-client/errors.js +45 -2
- package/dist/workspace-client/errors.js.map +1 -0
- package/dist/workspace-client/factory.d.ts +1 -1
- package/dist/workspace-client/factory.js.map +1 -1
- package/dist/workspace-client/index.d.ts +4 -3
- package/dist/workspace-client/index.js +2 -2
- package/dist/workspace-client/modular.d.ts +109 -0
- package/dist/workspace-client/modular.d.ts.map +1 -0
- package/dist/workspace-client/modular.js +447 -0
- package/dist/workspace-client/modular.js.map +1 -0
- package/dist/workspace-client/options.d.ts +29 -0
- package/dist/workspace-client/options.d.ts.map +1 -0
- package/dist/workspace-client/types.d.ts +35 -38
- package/dist/workspace-client/types.d.ts.map +1 -1
- package/docs/api/appkit/Class.ApiError.md +110 -0
- package/docs/api/appkit/Class.DatabricksAdapter.md +2 -2
- package/docs/api/appkit/Class.SupervisorApiAdapter.md +1 -1
- package/docs/api/appkit/Function.generateDatabaseCredential.md +2 -2
- package/docs/api/appkit/Function.getWorkspaceClient.md +2 -2
- package/docs/api/appkit/Interface.DirectoryEntry.md +62 -0
- package/docs/api/appkit/Interface.DownloadResponse.md +45 -0
- package/docs/api/appkit/Interface.JobAPI.md +20 -12
- package/docs/api/appkit/Interface.LakebasePoolConfig.md +1 -1
- package/docs/api/appkit/Interface.WorkspaceClient.md +168 -26
- package/docs/api/appkit/Interface.WorkspaceClientOptions.md +1 -14
- package/docs/api/appkit/TypeAlias.FilesDirectoryEntry.md +8 -0
- package/docs/api/appkit/TypeAlias.FilesDownloadResponse.md +8 -0
- package/docs/api/appkit/TypeAlias.JobsExport.md +1 -1
- package/docs/api/appkit/TypeAlias.WorkspaceClientLike.md +16 -0
- package/docs/api/appkit-ui/data/DataTable.md +16 -16
- package/docs/api/appkit.md +7 -2
- package/docs/plugins/files.md +20 -3
- package/docs/plugins/jobs.md +9 -9
- package/docs/plugins/testing.md +10 -8
- package/llms.txt +7 -2
- package/node_modules/@databricks/sdk-genie/LICENSE +203 -0
- package/node_modules/@databricks/sdk-genie/README.md +23 -0
- package/node_modules/@databricks/sdk-genie/dist/package.js +7 -0
- package/node_modules/@databricks/sdk-genie/dist/package.js.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/client.d.ts +175 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/client.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/client.js +829 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/client.js.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/index.d.ts +3 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/index.js +4 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/model.d.ts +1799 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/model.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/model.js +1097 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/model.js.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/transport.d.ts +37 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/transport.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/transport.js +73 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/transport.js.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/utils.d.ts +43 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/utils.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/utils.js +130 -0
- package/node_modules/@databricks/sdk-genie/dist/v1/utils.js.map +1 -0
- package/node_modules/@databricks/sdk-genie/package.json +46 -0
- package/node_modules/@databricks/sdk-statementexecution/LICENSE +203 -0
- package/node_modules/@databricks/sdk-statementexecution/README.md +23 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/package.js +7 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/package.js.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/client.d.ts +91 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/client.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/client.js +183 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/client.js.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/index.d.ts +3 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/index.js +4 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/model.d.ts +506 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/model.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/model.js +302 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/model.js.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/transport.d.ts +37 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/transport.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/transport.js +73 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/transport.js.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/utils.d.ts +25 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/utils.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/utils.js +87 -0
- package/node_modules/@databricks/sdk-statementexecution/dist/v1/utils.js.map +1 -0
- package/node_modules/@databricks/sdk-statementexecution/package.json +46 -0
- package/node_modules/@databricks/sdk-vectorsearch/LICENSE +203 -0
- package/node_modules/@databricks/sdk-vectorsearch/README.md +23 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/package.js +7 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/package.js.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/client.d.ts +70 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/client.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/client.js +474 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/client.js.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/index.d.ts +3 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/index.js +4 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/model.d.ts +704 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/model.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/model.js +635 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/model.js.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/transport.d.ts +37 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/transport.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/transport.js +73 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/transport.js.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/utils.d.ts +37 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/utils.d.ts.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/utils.js +104 -0
- package/node_modules/@databricks/sdk-vectorsearch/dist/v1/utils.js.map +1 -0
- package/node_modules/@databricks/sdk-vectorsearch/package.json +46 -0
- package/package.json +29 -4
- package/sbom.cdx.json +1 -1
- package/dist/shared/src/workspace-client/errors.d.ts +0 -1
- package/dist/shared/src/workspace-client/legacy.d.ts +0 -3
- package/dist/workspace-client/legacy.d.ts +0 -34
- package/dist/workspace-client/legacy.d.ts.map +0 -1
- package/dist/workspace-client/legacy.js +0 -23
- package/dist/workspace-client/legacy.js.map +0 -1
- package/docs/api/appkit/Interface.WorkspaceClientLike.md +0 -67
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { files, jobs, serving, sql } from "@databricks/sdk-experimental";
|
|
1
|
+
import { App, AppsClient, AuthConfigError, BaseRun, CancelRunRequest, ColumnInfo, ConnectionInfo, ConnectionsClient, DatabaseClient, DatabaseCredential, DatabaseInstance, Disposition, EndpointHealth, EndpointInfo, EndpointState, ExecuteStatementRequest, Experiment, ExperimentsClient, ExternalLink, FilesClient, FilesDirectoryEntry, FilesDownloadResponse, Format, FunctionInfo, FunctionsClient, GenerateDatabaseCredentialRequest, GenieClient, GenieGetMessageQueryResultResponse, GenieMessage, GetConnectionRequest, GetFunctionRequest, GetInferenceEndpointRequest, GetJobRequest, GetJobResponse, GetRunOutputRequest, GetRunOutputResponse, GetRunRequest, GetRunResponse, GetVolumeRequest, GetWarehouseResponse, InferenceEndpoint, InferenceEndpointDetailed, JobsClient, ListAppsRequest, ListAppsResponse, ListConnectionsRequest, ListConnectionsResponse, ListDatabaseInstancesRequest, ListDatabaseInstancesResponse, ListExperimentsRequest, ListExperimentsResponse, ListInferenceEndpointsRequest, ListInferenceEndpointsResponse, ListRunsRequest, ModelServingClient, ModularApiError, PostgresClient, QueryVectorIndexRequest, QueryVectorIndexResponse, ResultData, ResultManifest, RunNowRequest, RunNowResponse, Schema, ScimClient, ServiceError, StatementExecutionClient, StatementParameter, StatementResponse, StatementStatus, StatementStatus_State, SubmitRunRequest, SubmitRunResponse, TablesClient, VectorSearchClient, VolumeInfo, VolumesClient, WarehousesClient, WorkspaceAuth, WorkspaceRequest, buildAppsClient, buildConnectionsClient, buildDatabaseClient, buildExperimentsClient, buildFilesClient, buildFunctionsClient, buildGenieClient, buildJobsClient, buildModelServingClient, buildPostgresClient, buildScimClient, buildStatementExecutionClient, buildTablesClient, buildVectorSearchClient, buildVolumesClient, buildWarehousesClient, buildWorkspaceAuth, isAuthConfigError, resolveProfile } from "./modular.js";
|
|
3
2
|
|
|
4
3
|
//#region src/workspace-client/types.d.ts
|
|
5
4
|
/**
|
|
@@ -7,43 +6,41 @@ import { files, jobs, serving, sql } from "@databricks/sdk-experimental";
|
|
|
7
6
|
* modular Databricks SDK: each service is its own accessor, so services can be
|
|
8
7
|
* migrated one at a time behind this stable interface.
|
|
9
8
|
*
|
|
10
|
-
* Accessors are legacy-typed for now (delegated to the underlying legacy SDK
|
|
11
|
-
* client); see the module docblock.
|
|
12
9
|
*/
|
|
13
|
-
interface WorkspaceClient
|
|
14
|
-
/** UC Volumes / Files API. */
|
|
15
|
-
readonly files:
|
|
16
|
-
/** SQL Warehouses. */
|
|
17
|
-
readonly warehouses:
|
|
18
|
-
/** Genie
|
|
19
|
-
readonly genie:
|
|
20
|
-
/**
|
|
21
|
-
readonly
|
|
22
|
-
/**
|
|
23
|
-
readonly
|
|
24
|
-
/**
|
|
25
|
-
readonly
|
|
26
|
-
/**
|
|
27
|
-
readonly
|
|
28
|
-
/**
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
readonly
|
|
34
|
-
/**
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
readonly
|
|
40
|
-
/**
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
10
|
+
interface WorkspaceClient extends WorkspaceAuth {
|
|
11
|
+
/** UC Volumes / Files API (modular SDK). */
|
|
12
|
+
readonly files: FilesClient;
|
|
13
|
+
/** SQL Warehouses (modular SDK). */
|
|
14
|
+
readonly warehouses: WarehousesClient;
|
|
15
|
+
/** Genie (modular SDK). */
|
|
16
|
+
readonly genie: GenieClient;
|
|
17
|
+
/** Lakebase provisioned database instances + credentials (modular SDK). */
|
|
18
|
+
readonly database: DatabaseClient;
|
|
19
|
+
/** Databricks Apps (modular SDK). */
|
|
20
|
+
readonly apps: AppsClient;
|
|
21
|
+
/** Jobs (modular SDK, Jobs API 2.2). */
|
|
22
|
+
readonly jobs: JobsClient;
|
|
23
|
+
/** MLflow Experiments (modular SDK). */
|
|
24
|
+
readonly experiments: ExperimentsClient;
|
|
25
|
+
/** Vector Search (modular SDK; index metadata only, queries use `request()`). */
|
|
26
|
+
readonly vectorSearch: VectorSearchClient;
|
|
27
|
+
/** Unity Catalog Tables (modular SDK). */
|
|
28
|
+
readonly tables: TablesClient;
|
|
29
|
+
/** Lakebase Postgres: autoscaling projects, branches, endpoints (modular SDK). */
|
|
30
|
+
readonly postgres: PostgresClient;
|
|
31
|
+
/** Unity Catalog Volumes (modular SDK). */
|
|
32
|
+
readonly volumes: VolumesClient;
|
|
33
|
+
/** Unity Catalog Functions (modular SDK). */
|
|
34
|
+
readonly functions: FunctionsClient;
|
|
35
|
+
/** Unity Catalog Connections (modular SDK). */
|
|
36
|
+
readonly connections: ConnectionsClient;
|
|
37
|
+
/** Statement Execution (modular SDK). */
|
|
38
|
+
readonly statementExecution: StatementExecutionClient;
|
|
39
|
+
/** Serving endpoints (modular SDK). */
|
|
40
|
+
readonly modelServing: ModelServingClient;
|
|
41
|
+
/** Current user (modular SDK SCIM client; `me({})` returns the caller). */
|
|
42
|
+
readonly currentUser: ScimClient;
|
|
46
43
|
}
|
|
47
44
|
//#endregion
|
|
48
|
-
export { WorkspaceClient
|
|
45
|
+
export { WorkspaceClient };
|
|
49
46
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/workspace-client/types.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/workspace-client/types.ts"],"mappings":";;;;;;;;;UAkCiB,eAAA,SAAwB,aAAA;EA0BtB;EAAA,SAxBR,KAAA,EAAO,WAAA;EA6BE;EAAA,SA1BT,UAAA,EAAY,gBAAA;EAgCC;EAAA,SA7Bb,KAAA,EAAO,WAAA;EAmCO;EAAA,SAhCd,QAAA,EAAU,cAAA;EAXoB;EAAA,SAc9B,IAAA,EAAM,UAAA;EAdqC;EAAA,SAiB3C,IAAA,EAAM,UAAA;EAfN;EAAA,SAkBA,WAAA,EAAa,iBAAA;EAfb;EAAA,SAkBA,YAAA,EAAc,kBAAA;EAfd;EAAA,SAkBA,MAAA,EAAQ,YAAA;EAfR;EAAA,SAiBA,QAAA,EAAU,cAAA;EAdV;EAAA,SAiBA,OAAA,EAAS,aAAA;EAdT;EAAA,SAiBA,SAAA,EAAW,eAAA;EAdX;EAAA,SAiBA,WAAA,EAAa,iBAAA;EAdb;EAAA,SAiBA,kBAAA,EAAoB,wBAAA;EAdpB;EAAA,SAiBA,YAAA,EAAc,kBAAA;EAfd;EAAA,SAkBA,WAAA,EAAa,UAAA;AAAA"}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Class: ApiError
|
|
2
|
+
|
|
3
|
+
## Extends[](#extends "Direct link to Extends")
|
|
4
|
+
|
|
5
|
+
* `Error`
|
|
6
|
+
|
|
7
|
+
## Constructors[](#constructors "Direct link to Constructors")
|
|
8
|
+
|
|
9
|
+
### Constructor[](#constructor "Direct link to Constructor")
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
new ApiError(
|
|
13
|
+
message: string,
|
|
14
|
+
errorCode: string,
|
|
15
|
+
statusCode: number,
|
|
16
|
+
response?: unknown,
|
|
17
|
+
details?: unknown[]): ApiError;
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
#### Parameters[](#parameters "Direct link to Parameters")
|
|
22
|
+
|
|
23
|
+
| Parameter | Type | Default value |
|
|
24
|
+
| ------------ | ------------ | ------------- |
|
|
25
|
+
| `message` | `string` | `undefined` |
|
|
26
|
+
| `errorCode` | `string` | `undefined` |
|
|
27
|
+
| `statusCode` | `number` | `undefined` |
|
|
28
|
+
| `response?` | `unknown` | `undefined` |
|
|
29
|
+
| `details?` | `unknown`\[] | `[]` |
|
|
30
|
+
|
|
31
|
+
#### Returns[](#returns "Direct link to Returns")
|
|
32
|
+
|
|
33
|
+
`ApiError`
|
|
34
|
+
|
|
35
|
+
#### Overrides[](#overrides "Direct link to Overrides")
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
Error.constructor
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Properties[](#properties "Direct link to Properties")
|
|
43
|
+
|
|
44
|
+
### details[](#details "Direct link to details")
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly details: unknown[] = [];
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### errorCode[](#errorcode "Direct link to errorCode")
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
readonly errorCode: string;
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### response?[](#response "Direct link to response?")
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
readonly optional response: unknown;
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### statusCode[](#statuscode "Direct link to statusCode")
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
readonly statusCode: number;
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Methods[](#methods "Direct link to Methods")
|
|
79
|
+
|
|
80
|
+
### isRetryable()[](#isretryable "Direct link to isRetryable()")
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
isRetryable(): boolean;
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Like the legacy SDK: only 429 is retryable by status alone.
|
|
88
|
+
|
|
89
|
+
#### Returns[](#returns-1 "Direct link to Returns")
|
|
90
|
+
|
|
91
|
+
`boolean`
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### \[hasInstance]\()[](#hasinstance "Direct link to \[hasInstance]()")
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
static hasInstance: boolean;
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
#### Parameters[](#parameters-1 "Direct link to Parameters")
|
|
103
|
+
|
|
104
|
+
| Parameter | Type |
|
|
105
|
+
| --------- | --------- |
|
|
106
|
+
| `value` | `unknown` |
|
|
107
|
+
|
|
108
|
+
#### Returns[](#returns-2 "Direct link to Returns")
|
|
109
|
+
|
|
110
|
+
`boolean`
|
|
@@ -98,7 +98,7 @@ static fromAiGateway(options: AiGatewayOptions): Promise<DatabricksAdapter>;
|
|
|
98
98
|
|
|
99
99
|
Creates a DatabricksAdapter that talks to the Databricks AI Gateway Chat Completions endpoint (`/ai-gateway/mlflow/v1/chat/completions`).
|
|
100
100
|
|
|
101
|
-
Unlike [fromModelServing](#frommodelserving), the target model is named in the request body (`model`, e.g. `"system.ai.claude-opus-5-5"`) rather than in the URL: the gateway is a single fixed path that routes by the body's `model`. Auth and transport reuse the
|
|
101
|
+
Unlike [fromModelServing](#frommodelserving), the target model is named in the request body (`model`, e.g. `"system.ai.claude-opus-5-5"`) rather than in the URL: the gateway is a single fixed path that routes by the body's `model`. Auth and transport reuse the workspace client's `request()`, same as the serving path, so no bespoke `fetch()` + token handling. The request/response wire format and tool-calling loop are identical to the serving path.
|
|
102
102
|
|
|
103
103
|
#### Parameters[](#parameters-2 "Direct link to Parameters")
|
|
104
104
|
|
|
@@ -185,7 +185,7 @@ static fromServingEndpoint(options: ServingEndpointOptions): Promise<DatabricksA
|
|
|
185
185
|
|
|
186
186
|
Creates a DatabricksAdapter for a Databricks Model Serving endpoint.
|
|
187
187
|
|
|
188
|
-
Routes through the shared `connectors/serving/stream` helper, which delegates to the
|
|
188
|
+
Routes through the shared `connectors/serving/stream` helper, which delegates to the workspace client's raw `request()`. That gives the adapter centralised URL encoding + authentication with the rest of the serving surface — no bespoke `fetch()` + `authenticate()` plumbing.
|
|
189
189
|
|
|
190
190
|
#### Parameters[](#parameters-4 "Direct link to Parameters")
|
|
191
191
|
|
|
@@ -4,7 +4,7 @@ Adapter that calls the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/
|
|
|
4
4
|
|
|
5
5
|
Streams SSE events in the OpenAI Responses API wire format and maps them to the AppKit `AgentEvent` protocol. Tool execution is handled server-side, so the adapter ignores the agents-plugin tool index.
|
|
6
6
|
|
|
7
|
-
Authentication is handled via the Databricks SDK credential chain — the same mechanism used by `DatabricksAdapter.fromModelServing`. The transport is injected via SupervisorApiAdapterCtorOptions.streamBody; the [fromSupervisorApi](./docs/api/appkit/Function.fromSupervisorApi.md) factory wires it through the
|
|
7
|
+
Authentication is handled via the Databricks SDK credential chain — the same mechanism used by `DatabricksAdapter.fromModelServing`. The transport is injected via SupervisorApiAdapterCtorOptions.streamBody; the [fromSupervisorApi](./docs/api/appkit/Function.fromSupervisorApi.md) factory wires it through the workspace client's raw `request()`.
|
|
8
8
|
|
|
9
9
|
Set `DEBUG=appkit:agents:supervisor-api` to log the outbound request shape (model, instructions length, input shape, tool count) and to be notified when the recovery path engages (no incremental deltas, text pulled from `response.completed.output[]`). The no-delta warning includes a per-turn event-type histogram and the SA-reported status/error/ incomplete\_details, so it's already actionable without DEBUG.
|
|
10
10
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Function: generateDatabaseCredential()
|
|
2
2
|
|
|
3
3
|
```ts
|
|
4
|
-
function generateDatabaseCredential(workspaceClient:
|
|
4
|
+
function generateDatabaseCredential(workspaceClient: LakebaseWorkspaceClient, request: GenerateDatabaseCredentialRequest): Promise<DatabaseCredential>;
|
|
5
5
|
|
|
6
6
|
```
|
|
7
7
|
|
|
@@ -13,7 +13,7 @@ This generates a time-limited OAuth token (expires after 1 hour) that can be use
|
|
|
13
13
|
|
|
14
14
|
| Parameter | Type | Description |
|
|
15
15
|
| ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
16
|
-
| `workspaceClient` | `
|
|
16
|
+
| `workspaceClient` | `LakebaseWorkspaceClient` | Databricks workspace client for authentication |
|
|
17
17
|
| `request` | [`GenerateDatabaseCredentialRequest`](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters including endpoint path and optional UC claims |
|
|
18
18
|
|
|
19
19
|
## Returns[](#returns "Direct link to Returns")
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Function: getWorkspaceClient()
|
|
2
2
|
|
|
3
3
|
```ts
|
|
4
|
-
function getWorkspaceClient(config: Partial<LakebasePoolConfig>):
|
|
4
|
+
function getWorkspaceClient(config: Partial<LakebasePoolConfig>): LakebaseWorkspaceClient;
|
|
5
5
|
|
|
6
6
|
```
|
|
7
7
|
|
|
@@ -15,4 +15,4 @@ Get workspace client from config or SDK default auth chain
|
|
|
15
15
|
|
|
16
16
|
## Returns[](#returns "Direct link to Returns")
|
|
17
17
|
|
|
18
|
-
`
|
|
18
|
+
`LakebaseWorkspaceClient`
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# ~~Interface: DirectoryEntry~~
|
|
2
|
+
|
|
3
|
+
A single entry returned when listing a directory (Files API wire shape).
|
|
4
|
+
|
|
5
|
+
## Deprecated[](#deprecated "Direct link to Deprecated")
|
|
6
|
+
|
|
7
|
+
Legacy snake\_case shape; use [FilesDirectoryEntry](./docs/api/appkit/TypeAlias.FilesDirectoryEntry.md).
|
|
8
|
+
|
|
9
|
+
## Properties[](#properties "Direct link to Properties")
|
|
10
|
+
|
|
11
|
+
### ~~file\_size?~~[](#file_size "Direct link to file_size")
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
optional file_size: number;
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
The length of the file in bytes. Omitted for directories.
|
|
19
|
+
|
|
20
|
+
***
|
|
21
|
+
|
|
22
|
+
### ~~is\_directory?~~[](#is_directory "Direct link to is_directory")
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
optional is_directory: boolean;
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
True if the path is a directory.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### ~~last\_modified?~~[](#last_modified "Direct link to last_modified")
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
optional last_modified: number;
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Last modification time in milliseconds since unix epoch.
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### ~~name?~~[](#name "Direct link to name")
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
optional name: string;
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The name of the file or directory (last path component).
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### ~~path?~~[](#path "Direct link to path")
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
optional path: string;
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The absolute path of the file or directory.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# ~~Interface: DownloadResponse~~
|
|
2
|
+
|
|
3
|
+
Response object for file downloads containing a readable stream.
|
|
4
|
+
|
|
5
|
+
## Deprecated[](#deprecated "Direct link to Deprecated")
|
|
6
|
+
|
|
7
|
+
Legacy header-keyed shape; use [FilesDownloadResponse](./docs/api/appkit/TypeAlias.FilesDownloadResponse.md).
|
|
8
|
+
|
|
9
|
+
## Properties[](#properties "Direct link to Properties")
|
|
10
|
+
|
|
11
|
+
### ~~content-length?~~[](#content-length "Direct link to content-length")
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
optional content-length: number;
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
***
|
|
19
|
+
|
|
20
|
+
### ~~content-type?~~[](#content-type "Direct link to content-type")
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
optional content-type: string;
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### ~~contents?~~[](#contents "Direct link to contents")
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
optional contents: ReadableStream<any>;
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
38
|
+
### ~~last-modified?~~[](#last-modified "Direct link to last-modified")
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
optional last-modified: string;
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Last modified time in HTTP-date (RFC 7231) format.
|
|
@@ -28,7 +28,8 @@ Cancel a specific run.
|
|
|
28
28
|
### getJob()[](#getjob "Direct link to getJob()")
|
|
29
29
|
|
|
30
30
|
```ts
|
|
31
|
-
getJob(): Promise<ExecutionResult<
|
|
31
|
+
getJob(): Promise<ExecutionResult<{
|
|
32
|
+
}>>;
|
|
32
33
|
|
|
33
34
|
```
|
|
34
35
|
|
|
@@ -36,14 +37,15 @@ Get the job definition.
|
|
|
36
37
|
|
|
37
38
|
#### Returns[](#returns-1 "Direct link to Returns")
|
|
38
39
|
|
|
39
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
40
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<{ }>>
|
|
40
41
|
|
|
41
42
|
***
|
|
42
43
|
|
|
43
44
|
### getRun()[](#getrun "Direct link to getRun()")
|
|
44
45
|
|
|
45
46
|
```ts
|
|
46
|
-
getRun(runId: number): Promise<ExecutionResult<
|
|
47
|
+
getRun(runId: number): Promise<ExecutionResult<{
|
|
48
|
+
}>>;
|
|
47
49
|
|
|
48
50
|
```
|
|
49
51
|
|
|
@@ -57,14 +59,15 @@ Get a specific run by ID.
|
|
|
57
59
|
|
|
58
60
|
#### Returns[](#returns-2 "Direct link to Returns")
|
|
59
61
|
|
|
60
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
62
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<{ }>>
|
|
61
63
|
|
|
62
64
|
***
|
|
63
65
|
|
|
64
66
|
### getRunOutput()[](#getrunoutput "Direct link to getRunOutput()")
|
|
65
67
|
|
|
66
68
|
```ts
|
|
67
|
-
getRunOutput(runId: number): Promise<ExecutionResult<
|
|
69
|
+
getRunOutput(runId: number): Promise<ExecutionResult<{
|
|
70
|
+
}>>;
|
|
68
71
|
|
|
69
72
|
```
|
|
70
73
|
|
|
@@ -78,14 +81,17 @@ Get output of a specific run.
|
|
|
78
81
|
|
|
79
82
|
#### Returns[](#returns-3 "Direct link to Returns")
|
|
80
83
|
|
|
81
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
84
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<{ }>>
|
|
82
85
|
|
|
83
86
|
***
|
|
84
87
|
|
|
85
88
|
### lastRun()[](#lastrun "Direct link to lastRun()")
|
|
86
89
|
|
|
87
90
|
```ts
|
|
88
|
-
lastRun(): Promise<ExecutionResult<
|
|
91
|
+
lastRun(): Promise<ExecutionResult<
|
|
92
|
+
| {
|
|
93
|
+
}
|
|
94
|
+
| undefined>>;
|
|
89
95
|
|
|
90
96
|
```
|
|
91
97
|
|
|
@@ -93,7 +99,7 @@ Get the most recent run for this job.
|
|
|
93
99
|
|
|
94
100
|
#### Returns[](#returns-4 "Direct link to Returns")
|
|
95
101
|
|
|
96
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
102
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)< | { } | `undefined`>>
|
|
97
103
|
|
|
98
104
|
***
|
|
99
105
|
|
|
@@ -102,7 +108,8 @@ Get the most recent run for this job.
|
|
|
102
108
|
```ts
|
|
103
109
|
listRuns(options?: {
|
|
104
110
|
limit?: number;
|
|
105
|
-
}): Promise<ExecutionResult<
|
|
111
|
+
}): Promise<ExecutionResult<{
|
|
112
|
+
}[]>>;
|
|
106
113
|
|
|
107
114
|
```
|
|
108
115
|
|
|
@@ -117,7 +124,7 @@ List runs for this job.
|
|
|
117
124
|
|
|
118
125
|
#### Returns[](#returns-5 "Direct link to Returns")
|
|
119
126
|
|
|
120
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
127
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<{ }\[]>>
|
|
121
128
|
|
|
122
129
|
***
|
|
123
130
|
|
|
@@ -146,7 +153,8 @@ Trigger and poll until completion, yielding status updates.
|
|
|
146
153
|
### runNow()[](#runnow "Direct link to runNow()")
|
|
147
154
|
|
|
148
155
|
```ts
|
|
149
|
-
runNow(params?: Record<string, unknown>): Promise<ExecutionResult<
|
|
156
|
+
runNow(params?: Record<string, unknown>): Promise<ExecutionResult<{
|
|
157
|
+
}>>;
|
|
150
158
|
|
|
151
159
|
```
|
|
152
160
|
|
|
@@ -160,4 +168,4 @@ Trigger the configured job with validated params. Returns the run response.
|
|
|
160
168
|
|
|
161
169
|
#### Returns[](#returns-7 "Direct link to Returns")
|
|
162
170
|
|
|
163
|
-
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)
|
|
171
|
+
`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<{ }>>
|