@dbx-tools/shared-model 0.3.44 → 0.4.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/lib/index.d.ts +14 -0
- package/lib/index.js +14 -0
- package/lib/src/classify.d.ts +111 -0
- package/lib/src/classify.js +261 -0
- package/lib/src/display.d.ts +19 -0
- package/lib/src/display.js +106 -0
- package/lib/src/model.d.ts +107 -0
- package/lib/src/model.js +123 -0
- package/lib/src/openai-chat.d.ts +108 -0
- package/lib/src/openai-chat.js +87 -0
- package/lib/src/openai-responses.d.ts +175 -0
- package/lib/src/openai-responses.js +686 -0
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/package.json +10 -6
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Wire-format types for the model toolkit: the model class taxonomy,
|
|
3
|
+
* the Foundation Model API score profile, the minimal serving-endpoint
|
|
4
|
+
* descriptor, and the model-lookup request / ranked-result contract.
|
|
5
|
+
* Pure types and zod schemas - no Node-only imports - so a browser
|
|
6
|
+
* client (or an agent tool's `inputSchema`) can validate a lookup
|
|
7
|
+
* request and type a ranked response without dragging in server
|
|
8
|
+
* dependencies.
|
|
9
|
+
*
|
|
10
|
+
* @module
|
|
11
|
+
*/
|
|
12
|
+
import { z } from "zod";
|
|
13
|
+
/**
|
|
14
|
+
* Class of a Databricks Model Serving endpoint - its modality plus,
|
|
15
|
+
* for chat models, a capability band. Chat endpoints split by measured
|
|
16
|
+
* `quality` into a three-rung ladder; embeddings are a separate
|
|
17
|
+
* modality, not a rung on that ladder.
|
|
18
|
+
*
|
|
19
|
+
* String enum so the value is the slug used in cache keys, logs, query
|
|
20
|
+
* strings, and serialized configs - and is what a client sends to
|
|
21
|
+
* request a class.
|
|
22
|
+
*/
|
|
23
|
+
export declare enum ModelClass {
|
|
24
|
+
ChatThinking = "chat-thinking",
|
|
25
|
+
ChatBalanced = "chat-balanced",
|
|
26
|
+
ChatFast = "chat-fast",
|
|
27
|
+
Embedding = "embedding"
|
|
28
|
+
}
|
|
29
|
+
export declare const ModelClassSchema: z.ZodEnum<typeof ModelClass>;
|
|
30
|
+
/**
|
|
31
|
+
* Foundation Model API quality / speed / cost scores Databricks
|
|
32
|
+
* publishes per pay-per-token endpoint (the bars shown in the AI
|
|
33
|
+
* Playground). Surfaced from the serving list under
|
|
34
|
+
* `config.served_entities[].foundation_model.ai_gateway_model_profile`
|
|
35
|
+
* so the class classifier can rank models from live, workspace-local
|
|
36
|
+
* numbers instead of a hand-maintained table. Scales are relative and
|
|
37
|
+
* unitless; all axes are absent for custom or brand-new endpoints that
|
|
38
|
+
* have no profile yet.
|
|
39
|
+
*/
|
|
40
|
+
export declare const ModelProfileSchema: z.ZodObject<{
|
|
41
|
+
quality: z.ZodOptional<z.ZodNumber>;
|
|
42
|
+
speed: z.ZodOptional<z.ZodNumber>;
|
|
43
|
+
cost: z.ZodOptional<z.ZodNumber>;
|
|
44
|
+
}, z.core.$strip>;
|
|
45
|
+
export type ModelProfile = z.infer<typeof ModelProfileSchema>;
|
|
46
|
+
/**
|
|
47
|
+
* Minimal descriptor for a Databricks Model Serving endpoint - a
|
|
48
|
+
* stable subset of the SDK type so cache hits and `/models` responses
|
|
49
|
+
* never expose SDK internals.
|
|
50
|
+
*/
|
|
51
|
+
export declare const ServingEndpointSummarySchema: z.ZodObject<{
|
|
52
|
+
name: z.ZodString;
|
|
53
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
54
|
+
task: z.ZodOptional<z.ZodString>;
|
|
55
|
+
state: z.ZodOptional<z.ZodString>;
|
|
56
|
+
description: z.ZodOptional<z.ZodString>;
|
|
57
|
+
profile: z.ZodOptional<z.ZodObject<{
|
|
58
|
+
quality: z.ZodOptional<z.ZodNumber>;
|
|
59
|
+
speed: z.ZodOptional<z.ZodNumber>;
|
|
60
|
+
cost: z.ZodOptional<z.ZodNumber>;
|
|
61
|
+
}, z.core.$strip>>;
|
|
62
|
+
class: z.ZodOptional<z.ZodEnum<typeof ModelClass>>;
|
|
63
|
+
dimension: z.ZodOptional<z.ZodNumber>;
|
|
64
|
+
}, z.core.$strip>;
|
|
65
|
+
export type ServingEndpointSummary = z.infer<typeof ServingEndpointSummarySchema>;
|
|
66
|
+
/**
|
|
67
|
+
* A model-lookup request: search string, capability ceiling, both, or
|
|
68
|
+
* nothing. This is the caller-facing query the `@dbx-tools/model`
|
|
69
|
+
* ranker reads - shaped as a zod schema (with per-field descriptions)
|
|
70
|
+
* so an agent tool can adopt it directly as its `inputSchema` and a
|
|
71
|
+
* browser client can validate args before calling the model service.
|
|
72
|
+
*
|
|
73
|
+
* Every field is optional: an empty query ranks the live catalogue by
|
|
74
|
+
* class alone. The "this class and below" ceiling semantics and the
|
|
75
|
+
* match-then-class ordering live in the service, not here - this
|
|
76
|
+
* surface is declarative.
|
|
77
|
+
*/
|
|
78
|
+
export declare const ModelQuerySchema: z.ZodObject<{
|
|
79
|
+
search: z.ZodOptional<z.ZodString>;
|
|
80
|
+
modelClass: z.ZodOptional<z.ZodEnum<typeof ModelClass>>;
|
|
81
|
+
limit: z.ZodOptional<z.ZodNumber>;
|
|
82
|
+
threshold: z.ZodOptional<z.ZodNumber>;
|
|
83
|
+
}, z.core.$strip>;
|
|
84
|
+
export type ModelQuery = z.infer<typeof ModelQuerySchema>;
|
|
85
|
+
/**
|
|
86
|
+
* One ranked lookup result. Backs an agent tool's `outputSchema` and a
|
|
87
|
+
* `/models` ranked response.
|
|
88
|
+
*/
|
|
89
|
+
export declare const RankedModelSchema: z.ZodObject<{
|
|
90
|
+
endpoint: z.ZodObject<{
|
|
91
|
+
name: z.ZodString;
|
|
92
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
93
|
+
task: z.ZodOptional<z.ZodString>;
|
|
94
|
+
state: z.ZodOptional<z.ZodString>;
|
|
95
|
+
description: z.ZodOptional<z.ZodString>;
|
|
96
|
+
profile: z.ZodOptional<z.ZodObject<{
|
|
97
|
+
quality: z.ZodOptional<z.ZodNumber>;
|
|
98
|
+
speed: z.ZodOptional<z.ZodNumber>;
|
|
99
|
+
cost: z.ZodOptional<z.ZodNumber>;
|
|
100
|
+
}, z.core.$strip>>;
|
|
101
|
+
class: z.ZodOptional<z.ZodEnum<typeof ModelClass>>;
|
|
102
|
+
dimension: z.ZodOptional<z.ZodNumber>;
|
|
103
|
+
}, z.core.$strip>;
|
|
104
|
+
modelClass: z.ZodEnum<typeof ModelClass>;
|
|
105
|
+
score: z.ZodOptional<z.ZodNumber>;
|
|
106
|
+
}, z.core.$strip>;
|
|
107
|
+
export type RankedModel = z.infer<typeof RankedModelSchema>;
|
package/lib/src/model.js
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Wire-format types for the model toolkit: the model class taxonomy,
|
|
3
|
+
* the Foundation Model API score profile, the minimal serving-endpoint
|
|
4
|
+
* descriptor, and the model-lookup request / ranked-result contract.
|
|
5
|
+
* Pure types and zod schemas - no Node-only imports - so a browser
|
|
6
|
+
* client (or an agent tool's `inputSchema`) can validate a lookup
|
|
7
|
+
* request and type a ranked response without dragging in server
|
|
8
|
+
* dependencies.
|
|
9
|
+
*
|
|
10
|
+
* @module
|
|
11
|
+
*/
|
|
12
|
+
import { z } from "zod";
|
|
13
|
+
/**
|
|
14
|
+
* Class of a Databricks Model Serving endpoint - its modality plus,
|
|
15
|
+
* for chat models, a capability band. Chat endpoints split by measured
|
|
16
|
+
* `quality` into a three-rung ladder; embeddings are a separate
|
|
17
|
+
* modality, not a rung on that ladder.
|
|
18
|
+
*
|
|
19
|
+
* String enum so the value is the slug used in cache keys, logs, query
|
|
20
|
+
* strings, and serialized configs - and is what a client sends to
|
|
21
|
+
* request a class.
|
|
22
|
+
*/
|
|
23
|
+
export var ModelClass;
|
|
24
|
+
(function (ModelClass) {
|
|
25
|
+
ModelClass["ChatThinking"] = "chat-thinking";
|
|
26
|
+
ModelClass["ChatBalanced"] = "chat-balanced";
|
|
27
|
+
ModelClass["ChatFast"] = "chat-fast";
|
|
28
|
+
ModelClass["Embedding"] = "embedding";
|
|
29
|
+
})(ModelClass || (ModelClass = {}));
|
|
30
|
+
const ModelClassDescriptions = {
|
|
31
|
+
[ModelClass.ChatThinking]: "Most capable reasoning for hard, multi-step tasks; slowest and most expensive.",
|
|
32
|
+
[ModelClass.ChatBalanced]: "Good default for most chat and agent work; balances quality, speed, and cost.",
|
|
33
|
+
[ModelClass.ChatFast]: "Fastest and cheapest; best for simple tasks like classification, routing, and short summaries.",
|
|
34
|
+
[ModelClass.Embedding]: "Produces text embeddings (vectors), not chat replies; not interchangeable with chat models.",
|
|
35
|
+
};
|
|
36
|
+
export const ModelClassSchema = z.enum(ModelClass).describe(`Endpoint class slug: ${Object.values(ModelClass)
|
|
37
|
+
.map((modelClass) => {
|
|
38
|
+
return `'${modelClass}' (${ModelClassDescriptions[modelClass]})`;
|
|
39
|
+
})
|
|
40
|
+
.join(", ")}.`);
|
|
41
|
+
/**
|
|
42
|
+
* Foundation Model API quality / speed / cost scores Databricks
|
|
43
|
+
* publishes per pay-per-token endpoint (the bars shown in the AI
|
|
44
|
+
* Playground). Surfaced from the serving list under
|
|
45
|
+
* `config.served_entities[].foundation_model.ai_gateway_model_profile`
|
|
46
|
+
* so the class classifier can rank models from live, workspace-local
|
|
47
|
+
* numbers instead of a hand-maintained table. Scales are relative and
|
|
48
|
+
* unitless; all axes are absent for custom or brand-new endpoints that
|
|
49
|
+
* have no profile yet.
|
|
50
|
+
*/
|
|
51
|
+
export const ModelProfileSchema = z.object({
|
|
52
|
+
quality: z.number().optional().describe("Relative quality score; higher is better."),
|
|
53
|
+
speed: z.number().optional().describe("Relative throughput score; higher is faster."),
|
|
54
|
+
cost: z.number().optional().describe("Relative price score; lower is cheaper."),
|
|
55
|
+
});
|
|
56
|
+
/**
|
|
57
|
+
* Minimal descriptor for a Databricks Model Serving endpoint - a
|
|
58
|
+
* stable subset of the SDK type so cache hits and `/models` responses
|
|
59
|
+
* never expose SDK internals.
|
|
60
|
+
*/
|
|
61
|
+
export const ServingEndpointSummarySchema = z.object({
|
|
62
|
+
name: z
|
|
63
|
+
.string()
|
|
64
|
+
.describe("Endpoint name as listed by the Model Serving REST API; the id used to invoke the model."),
|
|
65
|
+
displayName: z
|
|
66
|
+
.string()
|
|
67
|
+
.optional()
|
|
68
|
+
.describe("Human-readable label for the endpoint: a Databricks-provided name when present (a display-name tag or external-model name), else a title-cased rendering of `name` with vendor prefixes stripped. `name` remains the invoke id."),
|
|
69
|
+
task: z.string().optional().describe("Task hint, e.g. 'llm/v1/chat' or 'llm/v1/embeddings'."),
|
|
70
|
+
state: z.string().optional().describe("Deployment state, e.g. ready, updating, or failed."),
|
|
71
|
+
description: z.string().optional().describe("Free-form endpoint description; informational."),
|
|
72
|
+
profile: ModelProfileSchema.optional().describe("Foundation Model API quality/speed/cost scores when the endpoint is a scored pay-per-token model; absent otherwise."),
|
|
73
|
+
class: ModelClassSchema.optional().describe("Class the endpoint was classified into; absent when the classifier doesn't recognize it."),
|
|
74
|
+
dimension: z
|
|
75
|
+
.number()
|
|
76
|
+
.optional()
|
|
77
|
+
.describe("Embedding vector length, measured by a best-effort server-side ping. Only set for embedding endpoints, and only when the probe succeeded."),
|
|
78
|
+
});
|
|
79
|
+
/**
|
|
80
|
+
* A model-lookup request: search string, capability ceiling, both, or
|
|
81
|
+
* nothing. This is the caller-facing query the `@dbx-tools/model`
|
|
82
|
+
* ranker reads - shaped as a zod schema (with per-field descriptions)
|
|
83
|
+
* so an agent tool can adopt it directly as its `inputSchema` and a
|
|
84
|
+
* browser client can validate args before calling the model service.
|
|
85
|
+
*
|
|
86
|
+
* Every field is optional: an empty query ranks the live catalogue by
|
|
87
|
+
* class alone. The "this class and below" ceiling semantics and the
|
|
88
|
+
* match-then-class ordering live in the service, not here - this
|
|
89
|
+
* surface is declarative.
|
|
90
|
+
*/
|
|
91
|
+
export const ModelQuerySchema = z.object({
|
|
92
|
+
search: z
|
|
93
|
+
.string()
|
|
94
|
+
.optional()
|
|
95
|
+
.describe("Loose name fuzzy-matched against endpoint names, e.g. 'claude sonnet'. Omit to rank by class alone."),
|
|
96
|
+
modelClass: ModelClassSchema.optional().describe("Capability ceiling: a chat class restricts to that band and the less-capable chat bands below it; 'embedding' restricts to embedding endpoints. Omit to consider every chat band."),
|
|
97
|
+
limit: z
|
|
98
|
+
.number()
|
|
99
|
+
.int()
|
|
100
|
+
.positive()
|
|
101
|
+
.max(50)
|
|
102
|
+
.optional()
|
|
103
|
+
.describe("Maximum number of ranked results to return."),
|
|
104
|
+
threshold: z
|
|
105
|
+
.number()
|
|
106
|
+
.min(0)
|
|
107
|
+
.max(1)
|
|
108
|
+
.optional()
|
|
109
|
+
.describe("Fuzzy-match distance cutoff (0 = exact, 1 = match anything). Default 0.4."),
|
|
110
|
+
});
|
|
111
|
+
/**
|
|
112
|
+
* One ranked lookup result. Backs an agent tool's `outputSchema` and a
|
|
113
|
+
* `/models` ranked response.
|
|
114
|
+
*/
|
|
115
|
+
export const RankedModelSchema = z.object({
|
|
116
|
+
endpoint: ServingEndpointSummarySchema.describe("The matched serving endpoint."),
|
|
117
|
+
modelClass: ModelClassSchema.describe("Class the endpoint was classified into."),
|
|
118
|
+
score: z
|
|
119
|
+
.number()
|
|
120
|
+
.optional()
|
|
121
|
+
.describe("Fuzzy-match distance (0 = exact .. 1 = worst) when the query carried a search; absent for class-only ranking."),
|
|
122
|
+
});
|
|
123
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,4CAA8B,CAAA;IAC9B,4CAA8B,CAAA;IAC9B,oCAAsB,CAAA;IACtB,qCAAuB,CAAA;AACzB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAED,MAAM,sBAAsB,GAA+B;IACzD,CAAC,UAAU,CAAC,YAAY,CAAC,EACvB,gFAAgF;IAClF,CAAC,UAAU,CAAC,YAAY,CAAC,EACvB,+EAA+E;IACjF,CAAC,UAAU,CAAC,QAAQ,CAAC,EACnB,gGAAgG;IAClG,CAAC,UAAU,CAAC,SAAS,CAAC,EACpB,6FAA6F;CAChG,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CACzD,wBAAyB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAkB;KAChE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;IAClB,OAAO,IAAI,UAAU,MAAM,sBAAsB,CAAC,UAAU,CAAC,GAAG,CAAC;AACnE,CAAC,CAAC;KACD,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;IACpF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IACrF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;CAChF,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CACP,yFAAyF,CAC1F;IACH,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,iOAAiO,CAClO;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;IAC7F,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oDAAoD,CAAC;IAC3F,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;IAC7F,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC7C,qHAAqH,CACtH;IACD,KAAK,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACzC,0FAA0F,CAC3F;IACD,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,2IAA2I,CAC5I;CACJ,CAAC,CAAC;AAGH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,qGAAqG,CACtG;IACH,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC9C,mLAAmL,CACpL;IACD,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,GAAG,CAAC,EAAE,CAAC;SACP,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC;IAC1D,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,2EAA2E,CAAC;CACzF,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,4BAA4B,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAChF,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IAChF,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,+GAA+G,CAChH;CACJ,CAAC,CAAC","sourcesContent":["/**\n * Wire-format types for the model toolkit: the model class taxonomy,\n * the Foundation Model API score profile, the minimal serving-endpoint\n * descriptor, and the model-lookup request / ranked-result contract.\n * Pure types and zod schemas - no Node-only imports - so a browser\n * client (or an agent tool's `inputSchema`) can validate a lookup\n * request and type a ranked response without dragging in server\n * dependencies.\n *\n * @module\n */\n\nimport { z } from \"zod\";\n\n/**\n * Class of a Databricks Model Serving endpoint - its modality plus,\n * for chat models, a capability band. Chat endpoints split by measured\n * `quality` into a three-rung ladder; embeddings are a separate\n * modality, not a rung on that ladder.\n *\n * String enum so the value is the slug used in cache keys, logs, query\n * strings, and serialized configs - and is what a client sends to\n * request a class.\n */\nexport enum ModelClass {\n  ChatThinking = \"chat-thinking\",\n  ChatBalanced = \"chat-balanced\",\n  ChatFast = \"chat-fast\",\n  Embedding = \"embedding\",\n}\n\nconst ModelClassDescriptions: Record<ModelClass, string> = {\n  [ModelClass.ChatThinking]:\n    \"Most capable reasoning for hard, multi-step tasks; slowest and most expensive.\",\n  [ModelClass.ChatBalanced]:\n    \"Good default for most chat and agent work; balances quality, speed, and cost.\",\n  [ModelClass.ChatFast]:\n    \"Fastest and cheapest; best for simple tasks like classification, routing, and short summaries.\",\n  [ModelClass.Embedding]:\n    \"Produces text embeddings (vectors), not chat replies; not interchangeable with chat models.\",\n};\n\nexport const ModelClassSchema = z.enum(ModelClass).describe(\n  `Endpoint class slug: ${(Object.values(ModelClass) as ModelClass[])\n    .map((modelClass) => {\n      return `'${modelClass}' (${ModelClassDescriptions[modelClass]})`;\n    })\n    .join(\", \")}.`,\n);\n\n/**\n * Foundation Model API quality / speed / cost scores Databricks\n * publishes per pay-per-token endpoint (the bars shown in the AI\n * Playground). Surfaced from the serving list under\n * `config.served_entities[].foundation_model.ai_gateway_model_profile`\n * so the class classifier can rank models from live, workspace-local\n * numbers instead of a hand-maintained table. Scales are relative and\n * unitless; all axes are absent for custom or brand-new endpoints that\n * have no profile yet.\n */\nexport const ModelProfileSchema = z.object({\n  quality: z.number().optional().describe(\"Relative quality score; higher is better.\"),\n  speed: z.number().optional().describe(\"Relative throughput score; higher is faster.\"),\n  cost: z.number().optional().describe(\"Relative price score; lower is cheaper.\"),\n});\nexport type ModelProfile = z.infer<typeof ModelProfileSchema>;\n\n/**\n * Minimal descriptor for a Databricks Model Serving endpoint - a\n * stable subset of the SDK type so cache hits and `/models` responses\n * never expose SDK internals.\n */\nexport const ServingEndpointSummarySchema = z.object({\n  name: z\n    .string()\n    .describe(\n      \"Endpoint name as listed by the Model Serving REST API; the id used to invoke the model.\",\n    ),\n  displayName: z\n    .string()\n    .optional()\n    .describe(\n      \"Human-readable label for the endpoint: a Databricks-provided name when present (a display-name tag or external-model name), else a title-cased rendering of `name` with vendor prefixes stripped. `name` remains the invoke id.\",\n    ),\n  task: z.string().optional().describe(\"Task hint, e.g. 'llm/v1/chat' or 'llm/v1/embeddings'.\"),\n  state: z.string().optional().describe(\"Deployment state, e.g. ready, updating, or failed.\"),\n  description: z.string().optional().describe(\"Free-form endpoint description; informational.\"),\n  profile: ModelProfileSchema.optional().describe(\n    \"Foundation Model API quality/speed/cost scores when the endpoint is a scored pay-per-token model; absent otherwise.\",\n  ),\n  class: ModelClassSchema.optional().describe(\n    \"Class the endpoint was classified into; absent when the classifier doesn't recognize it.\",\n  ),\n  dimension: z\n    .number()\n    .optional()\n    .describe(\n      \"Embedding vector length, measured by a best-effort server-side ping. Only set for embedding endpoints, and only when the probe succeeded.\",\n    ),\n});\nexport type ServingEndpointSummary = z.infer<typeof ServingEndpointSummarySchema>;\n\n/**\n * A model-lookup request: search string, capability ceiling, both, or\n * nothing. This is the caller-facing query the `@dbx-tools/model`\n * ranker reads - shaped as a zod schema (with per-field descriptions)\n * so an agent tool can adopt it directly as its `inputSchema` and a\n * browser client can validate args before calling the model service.\n *\n * Every field is optional: an empty query ranks the live catalogue by\n * class alone. The \"this class and below\" ceiling semantics and the\n * match-then-class ordering live in the service, not here - this\n * surface is declarative.\n */\nexport const ModelQuerySchema = z.object({\n  search: z\n    .string()\n    .optional()\n    .describe(\n      \"Loose name fuzzy-matched against endpoint names, e.g. 'claude sonnet'. Omit to rank by class alone.\",\n    ),\n  modelClass: ModelClassSchema.optional().describe(\n    \"Capability ceiling: a chat class restricts to that band and the less-capable chat bands below it; 'embedding' restricts to embedding endpoints. Omit to consider every chat band.\",\n  ),\n  limit: z\n    .number()\n    .int()\n    .positive()\n    .max(50)\n    .optional()\n    .describe(\"Maximum number of ranked results to return.\"),\n  threshold: z\n    .number()\n    .min(0)\n    .max(1)\n    .optional()\n    .describe(\"Fuzzy-match distance cutoff (0 = exact, 1 = match anything). Default 0.4.\"),\n});\nexport type ModelQuery = z.infer<typeof ModelQuerySchema>;\n\n/**\n * One ranked lookup result. Backs an agent tool's `outputSchema` and a\n * `/models` ranked response.\n */\nexport const RankedModelSchema = z.object({\n  endpoint: ServingEndpointSummarySchema.describe(\"The matched serving endpoint.\"),\n  modelClass: ModelClassSchema.describe(\"Class the endpoint was classified into.\"),\n  score: z\n    .number()\n    .optional()\n    .describe(\n      \"Fuzzy-match distance (0 = exact .. 1 = worst) when the query carried a search; absent for class-only ranking.\",\n    ),\n});\nexport type RankedModel = z.infer<typeof RankedModelSchema>;\n"]}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAI Chat Completions wire shapes, as Databricks Model Serving speaks them.
|
|
3
|
+
*
|
|
4
|
+
* These are the request/reply payload types for `/chat/completions` and a
|
|
5
|
+
* serving endpoint's `invocations` URL. They are deliberately declared here
|
|
6
|
+
* rather than imported from the OpenAI or AI SDK packages: both keep these
|
|
7
|
+
* fields under internal namespaces that are not part of their public API,
|
|
8
|
+
* whereas the wire payload itself is the stable contract every caller in this
|
|
9
|
+
* repo actually codes against.
|
|
10
|
+
*
|
|
11
|
+
* Pure types plus one text-flattening helper - no zod, no runtime deps - so a
|
|
12
|
+
* browser client, a Node proxy, and an AppKit plugin can all agree on the shape
|
|
13
|
+
* without any of them pulling in the others' dependencies.
|
|
14
|
+
*
|
|
15
|
+
* @module
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* The roles OpenAI defines for a chat turn. {@link ChatMessage.role} is typed as
|
|
19
|
+
* a plain string rather than this union, because providers add their own (for
|
|
20
|
+
* example Databricks-hosted Claude replays a `"reasoning"` turn); use this when
|
|
21
|
+
* you want the standard set named.
|
|
22
|
+
*/
|
|
23
|
+
export type ChatRole = "system" | "developer" | "user" | "assistant" | "tool";
|
|
24
|
+
/**
|
|
25
|
+
* One entry of a structured `content` array. Only `type` and `text` are read
|
|
26
|
+
* here; the index signature keeps provider-specific parts (images, thinking
|
|
27
|
+
* blocks, cache markers) intact through a parse/serialize round trip.
|
|
28
|
+
*/
|
|
29
|
+
export interface ChatContentPart {
|
|
30
|
+
type?: string;
|
|
31
|
+
text?: string;
|
|
32
|
+
[key: string]: unknown;
|
|
33
|
+
}
|
|
34
|
+
/** The function a tool call invokes, with its arguments as a JSON string. */
|
|
35
|
+
export interface ChatToolCallFunction {
|
|
36
|
+
name: string;
|
|
37
|
+
/** JSON-encoded argument object. Streamed in fragments, so assemble before parsing. */
|
|
38
|
+
arguments: string;
|
|
39
|
+
}
|
|
40
|
+
/** One tool call attached to an assistant turn. */
|
|
41
|
+
export interface ChatToolCall {
|
|
42
|
+
id: string;
|
|
43
|
+
/** `"function"` in practice; widened so an unrecognized type round-trips. */
|
|
44
|
+
type: string;
|
|
45
|
+
function: ChatToolCallFunction;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* A single chat message. `content` is nullable because an assistant turn that
|
|
49
|
+
* only calls tools carries `content: null`.
|
|
50
|
+
*/
|
|
51
|
+
export interface ChatMessage {
|
|
52
|
+
/** See {@link ChatRole} for the standard values; widened for provider extensions. */
|
|
53
|
+
role: string;
|
|
54
|
+
content?: string | ChatContentPart[] | null;
|
|
55
|
+
tool_calls?: ChatToolCall[];
|
|
56
|
+
/** Set on a `tool` turn, keying it back to the call it answers. */
|
|
57
|
+
tool_call_id?: string;
|
|
58
|
+
name?: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Top-level request fields an OpenAI client may send that Databricks Model
|
|
62
|
+
* Serving rejects outright, failing the whole turn rather than ignoring them.
|
|
63
|
+
*
|
|
64
|
+
* Databricks validates the chat body strictly, so an unrecognized key comes
|
|
65
|
+
* back as `parallel_tool_calls: Extra inputs are not permitted` (the
|
|
66
|
+
* gateway's pydantic validation) or `json: unknown field "parallel_tool_calls"`
|
|
67
|
+
* (its strict JSON decode), depending on the endpoint. Everything listed here
|
|
68
|
+
* is either OpenAI-platform bookkeeping with no bearing on the completion, or -
|
|
69
|
+
* in the case of `parallel_tool_calls` - a real setting Databricks has no way
|
|
70
|
+
* to accept, so dropping it is the only way the request can succeed at all.
|
|
71
|
+
*
|
|
72
|
+
* Callers that translate a request field-by-field (an allowlist, as
|
|
73
|
+
* `openaiResponses.responsesToChat` does) never need this; it exists for the
|
|
74
|
+
* paths that forward a client body largely as-is.
|
|
75
|
+
*/
|
|
76
|
+
export declare const UNSUPPORTED_CHAT_FIELDS: readonly string[];
|
|
77
|
+
/**
|
|
78
|
+
* Delete the fields Databricks rejects from a chat request body, in place.
|
|
79
|
+
* Returns the names actually removed so a caller can log what it dropped.
|
|
80
|
+
*
|
|
81
|
+
* @param body - Parsed chat request body. Mutated.
|
|
82
|
+
* @param extra - Additional field names to drop, for a workspace or endpoint
|
|
83
|
+
* that rejects something not yet in {@link UNSUPPORTED_CHAT_FIELDS}.
|
|
84
|
+
*/
|
|
85
|
+
export declare function stripUnsupportedChatFields(body: Record<string, unknown>, extra?: readonly string[]): string[];
|
|
86
|
+
/** Options for {@link chatContentToText}. */
|
|
87
|
+
export interface ChatContentToTextOptions {
|
|
88
|
+
/**
|
|
89
|
+
* Placed between parts. Defaults to `""`, which reassembles a message that was
|
|
90
|
+
* split purely for transport; pass `"\n\n"` when the parts are separate
|
|
91
|
+
* paragraphs that a human will read.
|
|
92
|
+
*/
|
|
93
|
+
separator?: string;
|
|
94
|
+
/**
|
|
95
|
+
* Restrict to these `type` values. Defaults to accepting any part carrying
|
|
96
|
+
* `text`, which covers the `input_text` / `output_text` / `text` spellings
|
|
97
|
+
* different APIs use for the same thing.
|
|
98
|
+
*/
|
|
99
|
+
types?: readonly string[];
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Flatten a message `content` value to plain text. Accepts the string form and
|
|
103
|
+
* the structured-parts form ({@link ChatContentPart}), and yields `""` for
|
|
104
|
+
* anything else (null, a lone image part, a malformed payload). Typed as
|
|
105
|
+
* `unknown` because most callers are reading a just-parsed JSON body, and the
|
|
106
|
+
* point of this helper is that they do not have to pre-check it.
|
|
107
|
+
*/
|
|
108
|
+
export declare function chatContentToText(content: unknown, options?: ChatContentToTextOptions): string;
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAI Chat Completions wire shapes, as Databricks Model Serving speaks them.
|
|
3
|
+
*
|
|
4
|
+
* These are the request/reply payload types for `/chat/completions` and a
|
|
5
|
+
* serving endpoint's `invocations` URL. They are deliberately declared here
|
|
6
|
+
* rather than imported from the OpenAI or AI SDK packages: both keep these
|
|
7
|
+
* fields under internal namespaces that are not part of their public API,
|
|
8
|
+
* whereas the wire payload itself is the stable contract every caller in this
|
|
9
|
+
* repo actually codes against.
|
|
10
|
+
*
|
|
11
|
+
* Pure types plus one text-flattening helper - no zod, no runtime deps - so a
|
|
12
|
+
* browser client, a Node proxy, and an AppKit plugin can all agree on the shape
|
|
13
|
+
* without any of them pulling in the others' dependencies.
|
|
14
|
+
*
|
|
15
|
+
* @module
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* Top-level request fields an OpenAI client may send that Databricks Model
|
|
19
|
+
* Serving rejects outright, failing the whole turn rather than ignoring them.
|
|
20
|
+
*
|
|
21
|
+
* Databricks validates the chat body strictly, so an unrecognized key comes
|
|
22
|
+
* back as `parallel_tool_calls: Extra inputs are not permitted` (the
|
|
23
|
+
* gateway's pydantic validation) or `json: unknown field "parallel_tool_calls"`
|
|
24
|
+
* (its strict JSON decode), depending on the endpoint. Everything listed here
|
|
25
|
+
* is either OpenAI-platform bookkeeping with no bearing on the completion, or -
|
|
26
|
+
* in the case of `parallel_tool_calls` - a real setting Databricks has no way
|
|
27
|
+
* to accept, so dropping it is the only way the request can succeed at all.
|
|
28
|
+
*
|
|
29
|
+
* Callers that translate a request field-by-field (an allowlist, as
|
|
30
|
+
* `openaiResponses.responsesToChat` does) never need this; it exists for the
|
|
31
|
+
* paths that forward a client body largely as-is.
|
|
32
|
+
*/
|
|
33
|
+
export const UNSUPPORTED_CHAT_FIELDS = [
|
|
34
|
+
// Tool-calling concurrency hint. Databricks rejects it; the upstream provider
|
|
35
|
+
// decides parallelism itself.
|
|
36
|
+
"parallel_tool_calls",
|
|
37
|
+
// Response-persistence and bookkeeping fields for OpenAI's own platform.
|
|
38
|
+
"store",
|
|
39
|
+
"metadata",
|
|
40
|
+
"service_tier",
|
|
41
|
+
"prompt_cache_key",
|
|
42
|
+
"safety_identifier",
|
|
43
|
+
];
|
|
44
|
+
/**
|
|
45
|
+
* Delete the fields Databricks rejects from a chat request body, in place.
|
|
46
|
+
* Returns the names actually removed so a caller can log what it dropped.
|
|
47
|
+
*
|
|
48
|
+
* @param body - Parsed chat request body. Mutated.
|
|
49
|
+
* @param extra - Additional field names to drop, for a workspace or endpoint
|
|
50
|
+
* that rejects something not yet in {@link UNSUPPORTED_CHAT_FIELDS}.
|
|
51
|
+
*/
|
|
52
|
+
export function stripUnsupportedChatFields(body, extra = []) {
|
|
53
|
+
const dropped = [];
|
|
54
|
+
for (const field of [...UNSUPPORTED_CHAT_FIELDS, ...extra]) {
|
|
55
|
+
if (!(field in body))
|
|
56
|
+
continue;
|
|
57
|
+
delete body[field];
|
|
58
|
+
dropped.push(field);
|
|
59
|
+
}
|
|
60
|
+
return dropped;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Flatten a message `content` value to plain text. Accepts the string form and
|
|
64
|
+
* the structured-parts form ({@link ChatContentPart}), and yields `""` for
|
|
65
|
+
* anything else (null, a lone image part, a malformed payload). Typed as
|
|
66
|
+
* `unknown` because most callers are reading a just-parsed JSON body, and the
|
|
67
|
+
* point of this helper is that they do not have to pre-check it.
|
|
68
|
+
*/
|
|
69
|
+
export function chatContentToText(content, options = {}) {
|
|
70
|
+
if (typeof content === "string")
|
|
71
|
+
return content;
|
|
72
|
+
if (!Array.isArray(content))
|
|
73
|
+
return "";
|
|
74
|
+
const { separator = "", types } = options;
|
|
75
|
+
const parts = [];
|
|
76
|
+
for (const raw of content) {
|
|
77
|
+
if (!raw || typeof raw !== "object")
|
|
78
|
+
continue;
|
|
79
|
+
const part = raw;
|
|
80
|
+
if (types && (typeof part.type !== "string" || !types.includes(part.type)))
|
|
81
|
+
continue;
|
|
82
|
+
if (typeof part.text === "string")
|
|
83
|
+
parts.push(part.text);
|
|
84
|
+
}
|
|
85
|
+
return parts.join(separator);
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"openai-chat.js","sourceRoot":"","sources":["../../src/openai-chat.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAkDH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAsB;IACxD,8EAA8E;IAC9E,8BAA8B;IAC9B,qBAAqB;IACrB,yEAAyE;IACzE,OAAO;IACP,UAAU;IACV,cAAc;IACd,kBAAkB;IAClB,mBAAmB;CACpB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CACxC,IAA6B,EAC7B,QAA2B,EAAE;IAE7B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,uBAAuB,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC;YAAE,SAAS;QAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAkBD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAgB,EAChB,UAAoC,EAAE;IAEtC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,OAAO,CAAC;IAChD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,SAAS;QAC9C,MAAM,IAAI,GAAG,GAAsB,CAAC;QACpC,IAAI,KAAK,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAAE,SAAS;QACrF,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC/B,CAAC","sourcesContent":["/**\n * OpenAI Chat Completions wire shapes, as Databricks Model Serving speaks them.\n *\n * These are the request/reply payload types for `/chat/completions` and a\n * serving endpoint's `invocations` URL. They are deliberately declared here\n * rather than imported from the OpenAI or AI SDK packages: both keep these\n * fields under internal namespaces that are not part of their public API,\n * whereas the wire payload itself is the stable contract every caller in this\n * repo actually codes against.\n *\n * Pure types plus one text-flattening helper - no zod, no runtime deps - so a\n * browser client, a Node proxy, and an AppKit plugin can all agree on the shape\n * without any of them pulling in the others' dependencies.\n *\n * @module\n */\n\n/**\n * The roles OpenAI defines for a chat turn. {@link ChatMessage.role} is typed as\n * a plain string rather than this union, because providers add their own (for\n * example Databricks-hosted Claude replays a `\"reasoning\"` turn); use this when\n * you want the standard set named.\n */\nexport type ChatRole = \"system\" | \"developer\" | \"user\" | \"assistant\" | \"tool\";\n\n/**\n * One entry of a structured `content` array. Only `type` and `text` are read\n * here; the index signature keeps provider-specific parts (images, thinking\n * blocks, cache markers) intact through a parse/serialize round trip.\n */\nexport interface ChatContentPart {\n  type?: string;\n  text?: string;\n  [key: string]: unknown;\n}\n\n/** The function a tool call invokes, with its arguments as a JSON string. */\nexport interface ChatToolCallFunction {\n  name: string;\n  /** JSON-encoded argument object. Streamed in fragments, so assemble before parsing. */\n  arguments: string;\n}\n\n/** One tool call attached to an assistant turn. */\nexport interface ChatToolCall {\n  id: string;\n  /** `\"function\"` in practice; widened so an unrecognized type round-trips. */\n  type: string;\n  function: ChatToolCallFunction;\n}\n\n/**\n * A single chat message. `content` is nullable because an assistant turn that\n * only calls tools carries `content: null`.\n */\nexport interface ChatMessage {\n  /** See {@link ChatRole} for the standard values; widened for provider extensions. */\n  role: string;\n  content?: string | ChatContentPart[] | null;\n  tool_calls?: ChatToolCall[];\n  /** Set on a `tool` turn, keying it back to the call it answers. */\n  tool_call_id?: string;\n  name?: string;\n}\n\n/**\n * Top-level request fields an OpenAI client may send that Databricks Model\n * Serving rejects outright, failing the whole turn rather than ignoring them.\n *\n * Databricks validates the chat body strictly, so an unrecognized key comes\n * back as `parallel_tool_calls: Extra inputs are not permitted` (the\n * gateway's pydantic validation) or `json: unknown field \"parallel_tool_calls\"`\n * (its strict JSON decode), depending on the endpoint. Everything listed here\n * is either OpenAI-platform bookkeeping with no bearing on the completion, or -\n * in the case of `parallel_tool_calls` - a real setting Databricks has no way\n * to accept, so dropping it is the only way the request can succeed at all.\n *\n * Callers that translate a request field-by-field (an allowlist, as\n * `openaiResponses.responsesToChat` does) never need this; it exists for the\n * paths that forward a client body largely as-is.\n */\nexport const UNSUPPORTED_CHAT_FIELDS: readonly string[] = [\n  // Tool-calling concurrency hint. Databricks rejects it; the upstream provider\n  // decides parallelism itself.\n  \"parallel_tool_calls\",\n  // Response-persistence and bookkeeping fields for OpenAI's own platform.\n  \"store\",\n  \"metadata\",\n  \"service_tier\",\n  \"prompt_cache_key\",\n  \"safety_identifier\",\n];\n\n/**\n * Delete the fields Databricks rejects from a chat request body, in place.\n * Returns the names actually removed so a caller can log what it dropped.\n *\n * @param body - Parsed chat request body. Mutated.\n * @param extra - Additional field names to drop, for a workspace or endpoint\n *   that rejects something not yet in {@link UNSUPPORTED_CHAT_FIELDS}.\n */\nexport function stripUnsupportedChatFields(\n  body: Record<string, unknown>,\n  extra: readonly string[] = [],\n): string[] {\n  const dropped: string[] = [];\n  for (const field of [...UNSUPPORTED_CHAT_FIELDS, ...extra]) {\n    if (!(field in body)) continue;\n    delete body[field];\n    dropped.push(field);\n  }\n  return dropped;\n}\n\n/** Options for {@link chatContentToText}. */\nexport interface ChatContentToTextOptions {\n  /**\n   * Placed between parts. Defaults to `\"\"`, which reassembles a message that was\n   * split purely for transport; pass `\"\\n\\n\"` when the parts are separate\n   * paragraphs that a human will read.\n   */\n  separator?: string;\n  /**\n   * Restrict to these `type` values. Defaults to accepting any part carrying\n   * `text`, which covers the `input_text` / `output_text` / `text` spellings\n   * different APIs use for the same thing.\n   */\n  types?: readonly string[];\n}\n\n/**\n * Flatten a message `content` value to plain text. Accepts the string form and\n * the structured-parts form ({@link ChatContentPart}), and yields `\"\"` for\n * anything else (null, a lone image part, a malformed payload). Typed as\n * `unknown` because most callers are reading a just-parsed JSON body, and the\n * point of this helper is that they do not have to pre-check it.\n */\nexport function chatContentToText(\n  content: unknown,\n  options: ChatContentToTextOptions = {},\n): string {\n  if (typeof content === \"string\") return content;\n  if (!Array.isArray(content)) return \"\";\n  const { separator = \"\", types } = options;\n  const parts: string[] = [];\n  for (const raw of content) {\n    if (!raw || typeof raw !== \"object\") continue;\n    const part = raw as ChatContentPart;\n    if (types && (typeof part.type !== \"string\" || !types.includes(part.type))) continue;\n    if (typeof part.text === \"string\") parts.push(part.text);\n  }\n  return parts.join(separator);\n}\n"]}
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAI Responses API <-> Chat Completions translation.
|
|
3
|
+
*
|
|
4
|
+
* Some clients speak only the Responses API (`POST /v1/responses`) - the Codex
|
|
5
|
+
* CLI is the motivating one. Databricks now also exposes native Responses
|
|
6
|
+
* surfaces (`/serving-endpoints/responses` and `/serving-endpoints/open-responses`),
|
|
7
|
+
* while most endpoints still speak Chat Completions at `/invocations`. This
|
|
8
|
+
* module bridges the two, in both directions:
|
|
9
|
+
*
|
|
10
|
+
* - {@link responsesToChat} lowers a Responses request body to a chat
|
|
11
|
+
* completions body (instructions -> system message, typed `input` items ->
|
|
12
|
+
* `messages`, `tools`/`tool_choice` carried through, function-call outputs
|
|
13
|
+
* folded back into the transcript).
|
|
14
|
+
* - {@link chatToResponsesRequest} raises a chat-completions request into a
|
|
15
|
+
* Responses request (the inverse of {@link responsesToChat}), for routing a
|
|
16
|
+
* chat client at a Responses-only model like Codex.
|
|
17
|
+
* - {@link chatToResponse} lifts a non-streaming chat completion back into a
|
|
18
|
+
* Responses `response` object.
|
|
19
|
+
* - {@link responseToChatCompletion} lifts a native Responses `response`
|
|
20
|
+
* back into a chat-completions body (the inverse of {@link chatToResponse}).
|
|
21
|
+
* - {@link createResponsesStreamTranslator} lifts a streaming chat completion
|
|
22
|
+
* (an OpenAI SSE `chat.completion.chunk` stream) into the Responses SSE
|
|
23
|
+
* event stream those clients consume (`response.created`,
|
|
24
|
+
* `response.output_text.delta`, function-call argument deltas,
|
|
25
|
+
* `response.completed`).
|
|
26
|
+
* - {@link readResponsesOutput} reads the other direction: pull the answer
|
|
27
|
+
* text and citations out of a `response` object returned by an endpoint
|
|
28
|
+
* that speaks Responses natively (the Databricks native web-search tool).
|
|
29
|
+
* - {@link sanitizeResponsesTools} keeps only `function` tools on a Responses
|
|
30
|
+
* request body (for `/open-responses` / Anthropic, which reject Codex
|
|
31
|
+
* built-ins like `web_search`).
|
|
32
|
+
* - {@link sanitizeOpenResponsesInput} rewrites `output_*` content part types
|
|
33
|
+
* in `input` to `input_*`, and drops Claude thinking / reasoning blocks
|
|
34
|
+
* that Open Responses rejects on replay (`redacted_thinking`, …).
|
|
35
|
+
*
|
|
36
|
+
* Only the surface real clients exercise is translated; unknown fields are
|
|
37
|
+
* ignored rather than rejected, so a newer client degrades instead of breaking.
|
|
38
|
+
*
|
|
39
|
+
* Browser-safe: pure functions over plain JSON, no transport and no Node
|
|
40
|
+
* built-ins, so the same translation runs in a proxy, a server route, or a test.
|
|
41
|
+
*
|
|
42
|
+
* @module
|
|
43
|
+
*/
|
|
44
|
+
/**
|
|
45
|
+
* Lower a Responses request body to a chat-completions body. Returns the chat
|
|
46
|
+
* body plus whether the caller asked for streaming (the server needs it to pick
|
|
47
|
+
* the upstream `accept` header and the translation path).
|
|
48
|
+
*/
|
|
49
|
+
export declare function responsesToChat(body: Record<string, unknown>): {
|
|
50
|
+
chat: Record<string, unknown>;
|
|
51
|
+
stream: boolean;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Raise a chat-completions request into a Responses request body. Inverse of
|
|
55
|
+
* {@link responsesToChat}: used when a chat client hits a Responses-only
|
|
56
|
+
* Databricks model (e.g. Codex) so the proxy can POST to
|
|
57
|
+
* `/serving-endpoints/responses` without the client knowing.
|
|
58
|
+
*/
|
|
59
|
+
export declare function chatToResponsesRequest(body: Record<string, unknown>): {
|
|
60
|
+
responses: Record<string, unknown>;
|
|
61
|
+
stream: boolean;
|
|
62
|
+
};
|
|
63
|
+
/** Lift a non-streaming chat completion JSON into a Responses `response` object. */
|
|
64
|
+
export declare function chatToResponse(chat: Record<string, unknown>, model: string): unknown;
|
|
65
|
+
/**
|
|
66
|
+
* Lift a native Responses `response` object into a chat-completions body.
|
|
67
|
+
* Inverse of {@link chatToResponse}: used after a Responses-only upstream call
|
|
68
|
+
* when the client spoke Chat Completions.
|
|
69
|
+
*/
|
|
70
|
+
export declare function responseToChatCompletion(response: Record<string, unknown>, model: string): Record<string, unknown>;
|
|
71
|
+
/**
|
|
72
|
+
* Incremental chat-chunk -> Responses-SSE translator. `feed` and `finish` both
|
|
73
|
+
* return the SSE bytes to forward, or `""` when a chunk produced no event.
|
|
74
|
+
*/
|
|
75
|
+
export interface ResponsesStreamTranslator {
|
|
76
|
+
/** Translate one upstream `chat.completion.chunk` object. */
|
|
77
|
+
feed(chunk: Record<string, unknown>): string;
|
|
78
|
+
/** Close any open items and emit `response.completed`. Call once, at end of stream. */
|
|
79
|
+
finish(): string;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Translate an upstream chat-completions SSE stream into the Responses SSE
|
|
83
|
+
* event stream a Responses client consumes.
|
|
84
|
+
*
|
|
85
|
+
* Upstream chunks are `chat.completion.chunk` objects whose `choices[0].delta`
|
|
86
|
+
* carries incremental `content` (assistant text) and/or `tool_calls` (function
|
|
87
|
+
* calls, streamed by `index` with partial `arguments`). We emit the Responses
|
|
88
|
+
* lifecycle around them:
|
|
89
|
+
*
|
|
90
|
+
* response.created
|
|
91
|
+
* -> per text run: output_item.added → output_text.delta* → output_item.done
|
|
92
|
+
* -> per tool call: output_item.added → function_call_arguments.delta*
|
|
93
|
+
* → function_call_arguments.done → output_item.done
|
|
94
|
+
* response.completed (with the assembled final `response` object)
|
|
95
|
+
*
|
|
96
|
+
* The translator is intentionally tolerant: malformed/keepalive lines yield
|
|
97
|
+
* nothing.
|
|
98
|
+
*/
|
|
99
|
+
export declare function createResponsesStreamTranslator(model: string, responseId: string): ResponsesStreamTranslator;
|
|
100
|
+
/** A source the model cited, as carried by a Responses content-part annotation. */
|
|
101
|
+
export interface ResponsesCitation {
|
|
102
|
+
url: string;
|
|
103
|
+
title?: string;
|
|
104
|
+
}
|
|
105
|
+
/** What {@link readResponsesOutput} pulls out of a `response` object. */
|
|
106
|
+
export interface ResponsesOutput {
|
|
107
|
+
/** The assistant's answer, with the output items concatenated. */
|
|
108
|
+
text: string;
|
|
109
|
+
/** Cited sources in first-seen order, deduplicated by URL. */
|
|
110
|
+
citations: ResponsesCitation[];
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Read the answer text and cited sources out of a Responses `response` payload.
|
|
114
|
+
*
|
|
115
|
+
* This is the inverse of {@link chatToResponse}: it consumes what an endpoint
|
|
116
|
+
* speaking Responses natively returns, rather than producing it. The Databricks
|
|
117
|
+
* native web-search tool answers this way, with each source attached as a
|
|
118
|
+
* `url_citation` annotation on the content part that used it.
|
|
119
|
+
*
|
|
120
|
+
* Prefers the flattened `output_text` when the payload carries it, and falls
|
|
121
|
+
* back to walking `output[].content[].text`. Every field is optional upstream,
|
|
122
|
+
* so a payload missing any of it yields empty results rather than throwing.
|
|
123
|
+
*/
|
|
124
|
+
export declare function readResponsesOutput(payload: Record<string, unknown>): ResponsesOutput;
|
|
125
|
+
/**
|
|
126
|
+
* Strip tool types the upstream model doesn't support from a Responses request
|
|
127
|
+
* body, returning a shallow copy safe to forward (the input is not mutated).
|
|
128
|
+
*
|
|
129
|
+
* Clients like the Codex CLI include built-in Responses tools (`web_search`,
|
|
130
|
+
* `local_shell`, `custom`, ...) alongside their `function` tools. Databricks'
|
|
131
|
+
* Open Responses surface for Anthropic/Claude (and other non-OpenAI providers)
|
|
132
|
+
* only accepts `function` tools and hard-errors otherwise:
|
|
133
|
+
* "Anthropic does not support tool type 'web_search'. Only 'function' is supported."
|
|
134
|
+
* Call this before forwarding to `/serving-endpoints/open-responses`. The OpenAI
|
|
135
|
+
* `/serving-endpoints/responses` path should keep built-ins (GPT supports them).
|
|
136
|
+
* If filtering empties the list, `tools` / `tool_choice` / `parallel_tool_calls`
|
|
137
|
+
* are dropped so we never send an empty `tools: []`.
|
|
138
|
+
*/
|
|
139
|
+
export declare function sanitizeResponsesTools(body: Record<string, unknown>): Record<string, unknown>;
|
|
140
|
+
/**
|
|
141
|
+
* Content-part / input-item types Claude extended thinking uses on the wire.
|
|
142
|
+
*
|
|
143
|
+
* Shared so both wire surfaces strip the same set: the Responses path here
|
|
144
|
+
* ({@link sanitizeOpenResponsesInput}) and the Chat Completions path in
|
|
145
|
+
* `@dbx-tools/appkit-mastra`'s serving sanitize. Anthropic signs these blocks,
|
|
146
|
+
* so a replay that mutates one is rejected outright - both paths must agree on
|
|
147
|
+
* what counts as a reasoning block.
|
|
148
|
+
*/
|
|
149
|
+
export declare const REASONING_TYPES: ReadonlySet<string>;
|
|
150
|
+
/**
|
|
151
|
+
* Rewrite Responses `input` so Open Responses will accept it.
|
|
152
|
+
*
|
|
153
|
+
* Two OpenAI / Codex shapes that Databricks Open Responses (Claude, Gemini, …)
|
|
154
|
+
* reject:
|
|
155
|
+
*
|
|
156
|
+
* 1. Prior assistant turns with `output_text` / `output_*` content parts —
|
|
157
|
+
* Open Responses only allows `input_text`, `input_image`, `input_file`,
|
|
158
|
+
* `input_audio`. Map every `output_<kind>` part to `input_<kind>`.
|
|
159
|
+
* 2. Replayed extended-thinking blocks (`thinking`, `redacted_thinking`,
|
|
160
|
+
* `reasoning` content parts, and top-level `reasoning` input items). Claude
|
|
161
|
+
* signs those; any client round-trip that mutates them (or a cross-provider
|
|
162
|
+
* replay) fails with e.g.
|
|
163
|
+
* "messages.N.content.M: Invalid `data` in `redacted_thinking` block"
|
|
164
|
+
* Strip them — the UI/client already showed the thinking; replay does not
|
|
165
|
+
* need the signed blob. Same policy as appkit-mastra's serving sanitize.
|
|
166
|
+
*
|
|
167
|
+
* Returns a shallow copy when anything changes; otherwise the input body.
|
|
168
|
+
*/
|
|
169
|
+
export declare function sanitizeOpenResponsesInput(body: Record<string, unknown>): Record<string, unknown>;
|
|
170
|
+
/**
|
|
171
|
+
* Full Open Responses request sanitizer: strip non-`function` tools, rewrite
|
|
172
|
+
* `output_*` content parts, and drop thinking / reasoning blocks. Safe no-op
|
|
173
|
+
* when nothing needs changing.
|
|
174
|
+
*/
|
|
175
|
+
export declare function sanitizeOpenResponsesRequest(body: Record<string, unknown>): Record<string, unknown>;
|