@databricks/appkit 0.77.0 → 0.79.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.
Files changed (16) hide show
  1. package/dist/agents/databricks.d.ts +65 -0
  2. package/dist/agents/databricks.d.ts.map +1 -1
  3. package/dist/agents/databricks.js +77 -2
  4. package/dist/agents/databricks.js.map +1 -1
  5. package/dist/appkit/package.js +1 -1
  6. package/dist/connectors/serving/client.js +17 -1
  7. package/dist/connectors/serving/client.js.map +1 -1
  8. package/dist/core/agent/run-agent.js +6 -6
  9. package/dist/core/agent/run-agent.js.map +1 -1
  10. package/dist/plugins/agents/agents.d.ts.map +1 -1
  11. package/dist/plugins/agents/agents.js +4 -11
  12. package/dist/plugins/agents/agents.js.map +1 -1
  13. package/dist/shared/src/schemas/manifest.d.ts +33 -33
  14. package/docs/api/appkit/Class.DatabricksAdapter.md +56 -8
  15. package/package.json +1 -1
  16. package/sbom.cdx.json +1 -1
package/dist/shared/src/schemas/manifest.d.ts CHANGED
@@ -13,8 +13,8 @@ declare const resourceFieldEntrySchema: z.ZodObject<{
13
13
  type: z.ZodLiteral<"kind">;
14
14
  resourceKind: z.ZodEnum<{
15
15
  volume: "volume";
16
- warehouse: "warehouse";
17
16
  genie_space: "genie_space";
17
+ warehouse: "warehouse";
18
18
  postgres_project: "postgres_project";
19
19
  postgres_branch: "postgres_branch";
20
20
  postgres_database: "postgres_database";
@@ -59,8 +59,8 @@ declare const pluginManifestSchema: z.ZodObject<{
59
59
  type: z.ZodLiteral<"kind">;
60
60
  resourceKind: z.ZodEnum<{
61
61
  volume: "volume";
62
- warehouse: "warehouse";
63
62
  genie_space: "genie_space";
63
+ warehouse: "warehouse";
64
64
  postgres_project: "postgres_project";
65
65
  postgres_branch: "postgres_branch";
66
66
  postgres_database: "postgres_database";
@@ -100,8 +100,8 @@ declare const pluginManifestSchema: z.ZodObject<{
100
100
  type: z.ZodLiteral<"kind">;
101
101
  resourceKind: z.ZodEnum<{
102
102
  volume: "volume";
103
- warehouse: "warehouse";
104
103
  genie_space: "genie_space";
104
+ warehouse: "warehouse";
105
105
  postgres_project: "postgres_project";
106
106
  postgres_branch: "postgres_branch";
107
107
  postgres_database: "postgres_database";
@@ -140,8 +140,8 @@ declare const pluginManifestSchema: z.ZodObject<{
140
140
  type: z.ZodLiteral<"kind">;
141
141
  resourceKind: z.ZodEnum<{
142
142
  volume: "volume";
143
- warehouse: "warehouse";
144
143
  genie_space: "genie_space";
144
+ warehouse: "warehouse";
145
145
  postgres_project: "postgres_project";
146
146
  postgres_branch: "postgres_branch";
147
147
  postgres_database: "postgres_database";
@@ -162,9 +162,9 @@ declare const pluginManifestSchema: z.ZodObject<{
162
162
  type: z.ZodLiteral<"sql_warehouse">;
163
163
  }, z.core.$strict>, z.ZodObject<{
164
164
  permission: z.ZodEnum<{
165
- CAN_QUERY: "CAN_QUERY";
166
165
  CAN_VIEW: "CAN_VIEW";
167
166
  CAN_MANAGE: "CAN_MANAGE";
167
+ CAN_QUERY: "CAN_QUERY";
168
168
  }>;
169
169
  alias: z.ZodString;
170
170
  resourceKey: z.ZodString;
@@ -181,8 +181,8 @@ declare const pluginManifestSchema: z.ZodObject<{
181
181
  type: z.ZodLiteral<"kind">;
182
182
  resourceKind: z.ZodEnum<{
183
183
  volume: "volume";
184
- warehouse: "warehouse";
185
184
  genie_space: "genie_space";
185
+ warehouse: "warehouse";
186
186
  postgres_project: "postgres_project";
187
187
  postgres_branch: "postgres_branch";
188
188
  postgres_database: "postgres_database";
@@ -221,8 +221,8 @@ declare const pluginManifestSchema: z.ZodObject<{
221
221
  type: z.ZodLiteral<"kind">;
222
222
  resourceKind: z.ZodEnum<{
223
223
  volume: "volume";
224
- warehouse: "warehouse";
225
224
  genie_space: "genie_space";
225
+ warehouse: "warehouse";
226
226
  postgres_project: "postgres_project";
227
227
  postgres_branch: "postgres_branch";
228
228
  postgres_database: "postgres_database";
@@ -260,8 +260,8 @@ declare const pluginManifestSchema: z.ZodObject<{
260
260
  type: z.ZodLiteral<"kind">;
261
261
  resourceKind: z.ZodEnum<{
262
262
  volume: "volume";
263
- warehouse: "warehouse";
264
263
  genie_space: "genie_space";
264
+ warehouse: "warehouse";
265
265
  postgres_project: "postgres_project";
266
266
  postgres_branch: "postgres_branch";
267
267
  postgres_database: "postgres_database";
@@ -299,8 +299,8 @@ declare const pluginManifestSchema: z.ZodObject<{
299
299
  type: z.ZodLiteral<"kind">;
300
300
  resourceKind: z.ZodEnum<{
301
301
  volume: "volume";
302
- warehouse: "warehouse";
303
302
  genie_space: "genie_space";
303
+ warehouse: "warehouse";
304
304
  postgres_project: "postgres_project";
305
305
  postgres_branch: "postgres_branch";
306
306
  postgres_database: "postgres_database";
@@ -338,8 +338,8 @@ declare const pluginManifestSchema: z.ZodObject<{
338
338
  type: z.ZodLiteral<"kind">;
339
339
  resourceKind: z.ZodEnum<{
340
340
  volume: "volume";
341
- warehouse: "warehouse";
342
341
  genie_space: "genie_space";
342
+ warehouse: "warehouse";
343
343
  postgres_project: "postgres_project";
344
344
  postgres_branch: "postgres_branch";
345
345
  postgres_database: "postgres_database";
@@ -377,8 +377,8 @@ declare const pluginManifestSchema: z.ZodObject<{
377
377
  type: z.ZodLiteral<"kind">;
378
378
  resourceKind: z.ZodEnum<{
379
379
  volume: "volume";
380
- warehouse: "warehouse";
381
380
  genie_space: "genie_space";
381
+ warehouse: "warehouse";
382
382
  postgres_project: "postgres_project";
383
383
  postgres_branch: "postgres_branch";
384
384
  postgres_database: "postgres_database";
@@ -416,8 +416,8 @@ declare const pluginManifestSchema: z.ZodObject<{
416
416
  type: z.ZodLiteral<"kind">;
417
417
  resourceKind: z.ZodEnum<{
418
418
  volume: "volume";
419
- warehouse: "warehouse";
420
419
  genie_space: "genie_space";
420
+ warehouse: "warehouse";
421
421
  postgres_project: "postgres_project";
422
422
  postgres_branch: "postgres_branch";
423
423
  postgres_database: "postgres_database";
@@ -438,10 +438,10 @@ declare const pluginManifestSchema: z.ZodObject<{
438
438
  type: z.ZodLiteral<"postgres">;
439
439
  }, z.core.$strict>, z.ZodObject<{
440
440
  permission: z.ZodEnum<{
441
- CAN_EDIT: "CAN_EDIT";
442
441
  CAN_VIEW: "CAN_VIEW";
443
442
  CAN_MANAGE: "CAN_MANAGE";
444
443
  CAN_RUN: "CAN_RUN";
444
+ CAN_EDIT: "CAN_EDIT";
445
445
  }>;
446
446
  alias: z.ZodString;
447
447
  resourceKey: z.ZodString;
@@ -458,8 +458,8 @@ declare const pluginManifestSchema: z.ZodObject<{
458
458
  type: z.ZodLiteral<"kind">;
459
459
  resourceKind: z.ZodEnum<{
460
460
  volume: "volume";
461
- warehouse: "warehouse";
462
461
  genie_space: "genie_space";
462
+ warehouse: "warehouse";
463
463
  postgres_project: "postgres_project";
464
464
  postgres_branch: "postgres_branch";
465
465
  postgres_database: "postgres_database";
@@ -480,8 +480,8 @@ declare const pluginManifestSchema: z.ZodObject<{
480
480
  type: z.ZodLiteral<"genie_space">;
481
481
  }, z.core.$strict>, z.ZodObject<{
482
482
  permission: z.ZodEnum<{
483
- CAN_EDIT: "CAN_EDIT";
484
483
  CAN_MANAGE: "CAN_MANAGE";
484
+ CAN_EDIT: "CAN_EDIT";
485
485
  CAN_READ: "CAN_READ";
486
486
  }>;
487
487
  alias: z.ZodString;
@@ -499,8 +499,8 @@ declare const pluginManifestSchema: z.ZodObject<{
499
499
  type: z.ZodLiteral<"kind">;
500
500
  resourceKind: z.ZodEnum<{
501
501
  volume: "volume";
502
- warehouse: "warehouse";
503
502
  genie_space: "genie_space";
503
+ warehouse: "warehouse";
504
504
  postgres_project: "postgres_project";
505
505
  postgres_branch: "postgres_branch";
506
506
  postgres_database: "postgres_database";
@@ -538,8 +538,8 @@ declare const pluginManifestSchema: z.ZodObject<{
538
538
  type: z.ZodLiteral<"kind">;
539
539
  resourceKind: z.ZodEnum<{
540
540
  volume: "volume";
541
- warehouse: "warehouse";
542
541
  genie_space: "genie_space";
542
+ warehouse: "warehouse";
543
543
  postgres_project: "postgres_project";
544
544
  postgres_branch: "postgres_branch";
545
545
  postgres_database: "postgres_database";
@@ -580,8 +580,8 @@ declare const pluginManifestSchema: z.ZodObject<{
580
580
  type: z.ZodLiteral<"kind">;
581
581
  resourceKind: z.ZodEnum<{
582
582
  volume: "volume";
583
- warehouse: "warehouse";
584
583
  genie_space: "genie_space";
584
+ warehouse: "warehouse";
585
585
  postgres_project: "postgres_project";
586
586
  postgres_branch: "postgres_branch";
587
587
  postgres_database: "postgres_database";
@@ -621,8 +621,8 @@ declare const pluginManifestSchema: z.ZodObject<{
621
621
  type: z.ZodLiteral<"kind">;
622
622
  resourceKind: z.ZodEnum<{
623
623
  volume: "volume";
624
- warehouse: "warehouse";
625
624
  genie_space: "genie_space";
625
+ warehouse: "warehouse";
626
626
  postgres_project: "postgres_project";
627
627
  postgres_branch: "postgres_branch";
628
628
  postgres_database: "postgres_database";
@@ -661,8 +661,8 @@ declare const pluginManifestSchema: z.ZodObject<{
661
661
  type: z.ZodLiteral<"kind">;
662
662
  resourceKind: z.ZodEnum<{
663
663
  volume: "volume";
664
- warehouse: "warehouse";
665
664
  genie_space: "genie_space";
665
+ warehouse: "warehouse";
666
666
  postgres_project: "postgres_project";
667
667
  postgres_branch: "postgres_branch";
668
668
  postgres_database: "postgres_database";
@@ -683,9 +683,9 @@ declare const pluginManifestSchema: z.ZodObject<{
683
683
  type: z.ZodLiteral<"sql_warehouse">;
684
684
  }, z.core.$strict>, z.ZodObject<{
685
685
  permission: z.ZodEnum<{
686
- CAN_QUERY: "CAN_QUERY";
687
686
  CAN_VIEW: "CAN_VIEW";
688
687
  CAN_MANAGE: "CAN_MANAGE";
688
+ CAN_QUERY: "CAN_QUERY";
689
689
  }>;
690
690
  alias: z.ZodString;
691
691
  resourceKey: z.ZodString;
@@ -702,8 +702,8 @@ declare const pluginManifestSchema: z.ZodObject<{
702
702
  type: z.ZodLiteral<"kind">;
703
703
  resourceKind: z.ZodEnum<{
704
704
  volume: "volume";
705
- warehouse: "warehouse";
706
705
  genie_space: "genie_space";
706
+ warehouse: "warehouse";
707
707
  postgres_project: "postgres_project";
708
708
  postgres_branch: "postgres_branch";
709
709
  postgres_database: "postgres_database";
@@ -742,8 +742,8 @@ declare const pluginManifestSchema: z.ZodObject<{
742
742
  type: z.ZodLiteral<"kind">;
743
743
  resourceKind: z.ZodEnum<{
744
744
  volume: "volume";
745
- warehouse: "warehouse";
746
745
  genie_space: "genie_space";
746
+ warehouse: "warehouse";
747
747
  postgres_project: "postgres_project";
748
748
  postgres_branch: "postgres_branch";
749
749
  postgres_database: "postgres_database";
@@ -781,8 +781,8 @@ declare const pluginManifestSchema: z.ZodObject<{
781
781
  type: z.ZodLiteral<"kind">;
782
782
  resourceKind: z.ZodEnum<{
783
783
  volume: "volume";
784
- warehouse: "warehouse";
785
784
  genie_space: "genie_space";
785
+ warehouse: "warehouse";
786
786
  postgres_project: "postgres_project";
787
787
  postgres_branch: "postgres_branch";
788
788
  postgres_database: "postgres_database";
@@ -820,8 +820,8 @@ declare const pluginManifestSchema: z.ZodObject<{
820
820
  type: z.ZodLiteral<"kind">;
821
821
  resourceKind: z.ZodEnum<{
822
822
  volume: "volume";
823
- warehouse: "warehouse";
824
823
  genie_space: "genie_space";
824
+ warehouse: "warehouse";
825
825
  postgres_project: "postgres_project";
826
826
  postgres_branch: "postgres_branch";
827
827
  postgres_database: "postgres_database";
@@ -859,8 +859,8 @@ declare const pluginManifestSchema: z.ZodObject<{
859
859
  type: z.ZodLiteral<"kind">;
860
860
  resourceKind: z.ZodEnum<{
861
861
  volume: "volume";
862
- warehouse: "warehouse";
863
862
  genie_space: "genie_space";
863
+ warehouse: "warehouse";
864
864
  postgres_project: "postgres_project";
865
865
  postgres_branch: "postgres_branch";
866
866
  postgres_database: "postgres_database";
@@ -898,8 +898,8 @@ declare const pluginManifestSchema: z.ZodObject<{
898
898
  type: z.ZodLiteral<"kind">;
899
899
  resourceKind: z.ZodEnum<{
900
900
  volume: "volume";
901
- warehouse: "warehouse";
902
901
  genie_space: "genie_space";
902
+ warehouse: "warehouse";
903
903
  postgres_project: "postgres_project";
904
904
  postgres_branch: "postgres_branch";
905
905
  postgres_database: "postgres_database";
@@ -937,8 +937,8 @@ declare const pluginManifestSchema: z.ZodObject<{
937
937
  type: z.ZodLiteral<"kind">;
938
938
  resourceKind: z.ZodEnum<{
939
939
  volume: "volume";
940
- warehouse: "warehouse";
941
940
  genie_space: "genie_space";
941
+ warehouse: "warehouse";
942
942
  postgres_project: "postgres_project";
943
943
  postgres_branch: "postgres_branch";
944
944
  postgres_database: "postgres_database";
@@ -959,10 +959,10 @@ declare const pluginManifestSchema: z.ZodObject<{
959
959
  type: z.ZodLiteral<"postgres">;
960
960
  }, z.core.$strict>, z.ZodObject<{
961
961
  permission: z.ZodEnum<{
962
- CAN_EDIT: "CAN_EDIT";
963
962
  CAN_VIEW: "CAN_VIEW";
964
963
  CAN_MANAGE: "CAN_MANAGE";
965
964
  CAN_RUN: "CAN_RUN";
965
+ CAN_EDIT: "CAN_EDIT";
966
966
  }>;
967
967
  alias: z.ZodString;
968
968
  resourceKey: z.ZodString;
@@ -979,8 +979,8 @@ declare const pluginManifestSchema: z.ZodObject<{
979
979
  type: z.ZodLiteral<"kind">;
980
980
  resourceKind: z.ZodEnum<{
981
981
  volume: "volume";
982
- warehouse: "warehouse";
983
982
  genie_space: "genie_space";
983
+ warehouse: "warehouse";
984
984
  postgres_project: "postgres_project";
985
985
  postgres_branch: "postgres_branch";
986
986
  postgres_database: "postgres_database";
@@ -1001,8 +1001,8 @@ declare const pluginManifestSchema: z.ZodObject<{
1001
1001
  type: z.ZodLiteral<"genie_space">;
1002
1002
  }, z.core.$strict>, z.ZodObject<{
1003
1003
  permission: z.ZodEnum<{
1004
- CAN_EDIT: "CAN_EDIT";
1005
1004
  CAN_MANAGE: "CAN_MANAGE";
1005
+ CAN_EDIT: "CAN_EDIT";
1006
1006
  CAN_READ: "CAN_READ";
1007
1007
  }>;
1008
1008
  alias: z.ZodString;
@@ -1020,8 +1020,8 @@ declare const pluginManifestSchema: z.ZodObject<{
1020
1020
  type: z.ZodLiteral<"kind">;
1021
1021
  resourceKind: z.ZodEnum<{
1022
1022
  volume: "volume";
1023
- warehouse: "warehouse";
1024
1023
  genie_space: "genie_space";
1024
+ warehouse: "warehouse";
1025
1025
  postgres_project: "postgres_project";
1026
1026
  postgres_branch: "postgres_branch";
1027
1027
  postgres_database: "postgres_database";
@@ -1059,8 +1059,8 @@ declare const pluginManifestSchema: z.ZodObject<{
1059
1059
  type: z.ZodLiteral<"kind">;
1060
1060
  resourceKind: z.ZodEnum<{
1061
1061
  volume: "volume";
1062
- warehouse: "warehouse";
1063
1062
  genie_space: "genie_space";
1063
+ warehouse: "warehouse";
1064
1064
  postgres_project: "postgres_project";
1065
1065
  postgres_branch: "postgres_branch";
1066
1066
  postgres_database: "postgres_database";
package/docs/api/appkit/Class.DatabricksAdapter.md CHANGED
@@ -89,6 +89,54 @@ run(input: AgentInput, context: AgentRunContext): AsyncGenerator<AgentEvent, voi
89
89
 
90
90
  ***
91
91
 
92
+ ### fromAiGateway()[​](#fromaigateway "Direct link to fromAiGateway()")
93
+
94
+ ```ts
95
+ static fromAiGateway(options: AiGatewayOptions): Promise<DatabricksAdapter>;
96
+
97
+ ```
98
+
99
+ Creates a DatabricksAdapter that talks to the Databricks AI Gateway Chat Completions endpoint (`/ai-gateway/mlflow/v1/chat/completions`).
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 SDK's `apiClient.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
+
103
+ #### Parameters[​](#parameters-2 "Direct link to Parameters")
104
+
105
+ | Parameter | Type |
106
+ | --------- | ------------------ |
107
+ | `options` | `AiGatewayOptions` |
108
+
109
+ #### Returns[​](#returns-2 "Direct link to Returns")
110
+
111
+ `Promise`<`DatabricksAdapter`>
112
+
113
+ #### Example[​](#example "Direct link to Example")
114
+
115
+ ```ts
116
+ import { createApp, createAgent } from "@databricks/appkit";
117
+ import { agents, DatabricksAdapter } from "@databricks/appkit/beta";
118
+
119
+ const adapter = await DatabricksAdapter.fromAiGateway({
120
+ model: "system.ai.claude-opus-5-5",
121
+ });
122
+
123
+ await createApp({
124
+ plugins: [
125
+ agents({
126
+ agents: {
127
+ assistant: createAgent({
128
+ instructions: "You are a helpful assistant.",
129
+ model: adapter,
130
+ }),
131
+ },
132
+ }),
133
+ ],
134
+ });
135
+
136
+ ```
137
+
138
+ ***
139
+
92
140
  ### fromModelServing()[​](#frommodelserving "Direct link to fromModelServing()")
93
141
 
94
142
  ```ts
@@ -98,18 +146,18 @@ static fromModelServing(endpointName?: string, options?: ModelServingOptions): P
98
146
 
99
147
  Creates a DatabricksAdapter from a Model Serving endpoint name. Auto-creates a WorkspaceClient internally. Reads the endpoint name from the argument or the `DATABRICKS_SERVING_ENDPOINT_NAME` env var.
100
148
 
101
- #### Parameters[​](#parameters-2 "Direct link to Parameters")
149
+ #### Parameters[​](#parameters-3 "Direct link to Parameters")
102
150
 
103
151
  | Parameter | Type |
104
152
  | --------------- | --------------------- |
105
153
  | `endpointName?` | `string` |
106
154
  | `options?` | `ModelServingOptions` |
107
155
 
108
- #### Returns[​](#returns-2 "Direct link to Returns")
156
+ #### Returns[​](#returns-3 "Direct link to Returns")
109
157
 
110
158
  `Promise`<`DatabricksAdapter`>
111
159
 
112
- #### Example[​](#example "Direct link to Example")
160
+ #### Example[​](#example-1 "Direct link to Example")
113
161
 
114
162
  ```ts
115
163
  // Reads endpoint from DATABRICKS_SERVING_ENDPOINT_NAME env var
@@ -139,13 +187,13 @@ Creates a DatabricksAdapter for a Databricks Model Serving endpoint.
139
187
 
140
188
  Routes through the shared `connectors/serving/stream` helper, which delegates to the SDK's `apiClient.request({ raw: true })`. That gives the adapter centralised URL encoding + authentication with the rest of the serving surface — no bespoke `fetch()` + `authenticate()` plumbing.
141
189
 
142
- #### Parameters[​](#parameters-3 "Direct link to Parameters")
190
+ #### Parameters[​](#parameters-4 "Direct link to Parameters")
143
191
 
144
192
  | Parameter | Type |
145
193
  | --------- | ------------------------ |
146
194
  | `options` | `ServingEndpointOptions` |
147
195
 
148
- #### Returns[​](#returns-3 "Direct link to Returns")
196
+ #### Returns[​](#returns-4 "Direct link to Returns")
149
197
 
150
198
  `Promise`<`DatabricksAdapter`>
151
199
 
@@ -162,17 +210,17 @@ Discoverability shim for the Supervisor API adapter. Returns an [AgentAdapter](.
162
210
 
163
211
  Dynamic-imports `./supervisor-api` to avoid forming a load-time cycle: both files share `connectors/serving/client.ts`.
164
212
 
165
- #### Parameters[​](#parameters-4 "Direct link to Parameters")
213
+ #### Parameters[​](#parameters-5 "Direct link to Parameters")
166
214
 
167
215
  | Parameter | Type |
168
216
  | --------- | ------------------------------------------------------------------------------------------------- |
169
217
  | `options` | [`SupervisorApiAdapterOptions`](./docs/api/appkit/Interface.SupervisorApiAdapterOptions.md) |
170
218
 
171
- #### Returns[​](#returns-4 "Direct link to Returns")
219
+ #### Returns[​](#returns-5 "Direct link to Returns")
172
220
 
173
221
  `Promise`<[`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md)>
174
222
 
175
- #### Example[​](#example-1 "Direct link to Example")
223
+ #### Example[​](#example-2 "Direct link to Example")
176
224
 
177
225
  ```ts
178
226
  import { DatabricksAdapter } from "@databricks/appkit/beta";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@databricks/appkit",
3
3
  "type": "module",
4
- "version": "0.77.0",
4
+ "version": "0.79.0",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "bin": {