Skip to content

Commit 010d422

Browse files
ncoghlanncoghlan
authored
Sync lmstudio.js schema (2025-07-08) (#118)
Aligns with lmstudio.js release 53
1 parent dd195e2 commit 010d422

5 files changed

Lines changed: 219 additions & 151 deletions

File tree

‎misc/update-sdk-schema.sh‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/bin/bash
2+
3+
# See http://redsymbol.net/articles/unofficial-bash-strict-mode/ for benefit of these options
4+
set -euo pipefail
5+
IFS=$'\n\t'
6+
7+
# Note: `readlink -f` (long available in GNU coreutils) is available on macOS 12.3 and later
8+
script_dir="$(cd -- "$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")" &> /dev/null && pwd)"
9+
10+
# Update submodule to tip of the lmstudio-js main branch and regenerate the exported schema
11+
# (to incorporate Python data model template changes, just run `tox -e sync-sdk-schema`)
12+
13+
pushd "$script_dir/../sdk-schema/lmstudio-js" || exit 1
14+
git switch main
15+
git pull
16+
git submodule update --init --recursive
17+
popd || exit 1
18+
tox -e sync-sdk-schema -- --regen-schema

‎sdk-schema/lms-with-inferred-unions.json‎

Lines changed: 67 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,21 @@
445445
"propertyName": "type"
446446
}
447447
},
448+
"toolCallResult": {
449+
"type": "object",
450+
"properties": {
451+
"content": {
452+
"type": "string"
453+
},
454+
"toolCallId": {
455+
"type": "string"
456+
}
457+
},
458+
"required": [
459+
"content"
460+
],
461+
"additionalProperties": false
462+
},
448463
"citationSource": {
449464
"type": "object",
450465
"properties": {
@@ -1992,35 +2007,6 @@
19922007
"propertyName": "type"
19932008
}
19942009
},
1995-
"preprocessorUpdate": {
1996-
"anyOf": [
1997-
{
1998-
"$ref": "#/definitions/processingUpdateStatusCreate"
1999-
},
2000-
{
2001-
"$ref": "#/definitions/processingUpdateStatusUpdate"
2002-
},
2003-
{
2004-
"$ref": "#/definitions/processingUpdateStatusRemove"
2005-
},
2006-
{
2007-
"$ref": "#/definitions/processingUpdateCitationBlockCreate"
2008-
},
2009-
{
2010-
"$ref": "#/definitions/processingUpdateDebugInfoBlockCreate"
2011-
}
2012-
],
2013-
"discriminator": {
2014-
"mapping": {
2015-
"status.create": "#/definitions/processingUpdateStatusCreate",
2016-
"status.update": "#/definitions/processingUpdateStatusUpdate",
2017-
"status.remove": "#/definitions/processingUpdateStatusRemove",
2018-
"citationBlock.create": "#/definitions/processingUpdateCitationBlockCreate",
2019-
"debugInfoBlock.create": "#/definitions/processingUpdateDebugInfoBlockCreate"
2020-
},
2021-
"propertyName": "type"
2022-
}
2023-
},
20242010
"processingRequestConfirmToolCall": {
20252011
"type": "object",
20262012
"properties": {
@@ -2895,6 +2881,35 @@
28952881
},
28962882
"additionalProperties": false
28972883
},
2884+
"promptPreprocessorUpdate": {
2885+
"anyOf": [
2886+
{
2887+
"$ref": "#/definitions/processingUpdateStatusCreate"
2888+
},
2889+
{
2890+
"$ref": "#/definitions/processingUpdateStatusUpdate"
2891+
},
2892+
{
2893+
"$ref": "#/definitions/processingUpdateStatusRemove"
2894+
},
2895+
{
2896+
"$ref": "#/definitions/processingUpdateCitationBlockCreate"
2897+
},
2898+
{
2899+
"$ref": "#/definitions/processingUpdateDebugInfoBlockCreate"
2900+
}
2901+
],
2902+
"discriminator": {
2903+
"mapping": {
2904+
"status.create": "#/definitions/processingUpdateStatusCreate",
2905+
"status.update": "#/definitions/processingUpdateStatusUpdate",
2906+
"status.remove": "#/definitions/processingUpdateStatusRemove",
2907+
"citationBlock.create": "#/definitions/processingUpdateCitationBlockCreate",
2908+
"debugInfoBlock.create": "#/definitions/processingUpdateDebugInfoBlockCreate"
2909+
},
2910+
"propertyName": "type"
2911+
}
2912+
},
28982913
"modelCompatibilityType": {
28992914
"type": "string",
29002915
"enum": [
@@ -6064,52 +6079,52 @@
60646079
],
60656080
"additionalProperties": false
60666081
},
6067-
"plugins/channel/setPreprocessor/toClientPacket": {
6082+
"plugins/channel/setPromptPreprocessor/toClientPacket": {
60686083
"anyOf": [
60696084
{
6070-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toClientPacketPreprocess"
6085+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacketPreprocess"
60716086
},
60726087
{
6073-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toClientPacketAbort"
6088+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacketAbort"
60746089
}
60756090
],
60766091
"discriminator": {
60776092
"mapping": {
6078-
"preprocess": "#/definitions/plugins/channel/setPreprocessor/toClientPacketPreprocess",
6079-
"abort": "#/definitions/plugins/channel/setPreprocessor/toClientPacketAbort"
6093+
"preprocess": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacketPreprocess",
6094+
"abort": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacketAbort"
60806095
},
60816096
"propertyName": "type"
60826097
}
60836098
},
6084-
"plugins/channel/setPreprocessor/toServerPacket": {
6099+
"plugins/channel/setPromptPreprocessor/toServerPacket": {
60856100
"anyOf": [
60866101
{
6087-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toServerPacketComplete"
6102+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketComplete"
60886103
},
60896104
{
6090-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toServerPacketAborted"
6105+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketAborted"
60916106
},
60926107
{
6093-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toServerPacketError"
6108+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketError"
60946109
}
60956110
],
60966111
"discriminator": {
60976112
"mapping": {
6098-
"complete": "#/definitions/plugins/channel/setPreprocessor/toServerPacketComplete",
6099-
"aborted": "#/definitions/plugins/channel/setPreprocessor/toServerPacketAborted",
6100-
"error": "#/definitions/plugins/channel/setPreprocessor/toServerPacketError"
6113+
"complete": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketComplete",
6114+
"aborted": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketAborted",
6115+
"error": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacketError"
61016116
},
61026117
"propertyName": "type"
61036118
}
61046119
},
6105-
"pseudo/plugins/channel/setPreprocessor": {
6120+
"pseudo/plugins/channel/setPromptPreprocessor": {
61066121
"type": "object",
61076122
"properties": {
61086123
"toClientPacket": {
6109-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toClientPacket"
6124+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacket"
61106125
},
61116126
"toServerPacket": {
6112-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toServerPacket"
6127+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacket"
61136128
}
61146129
},
61156130
"required": [
@@ -6366,8 +6381,8 @@
63666381
"channelRegisterDevelopmentPlugin": {
63676382
"$ref": "#/definitions/pseudo/plugins/channel/registerDevelopmentPlugin"
63686383
},
6369-
"channelSetPreprocessor": {
6370-
"$ref": "#/definitions/pseudo/plugins/channel/setPreprocessor"
6384+
"channelSetPromptPreprocessor": {
6385+
"$ref": "#/definitions/pseudo/plugins/channel/setPromptPreprocessor"
63716386
},
63726387
"channelSetPredictionLoopHandler": {
63736388
"$ref": "#/definitions/pseudo/plugins/channel/setPredictionLoopHandler"
@@ -6393,7 +6408,7 @@
63936408
"rpcSetGlobalConfigSchematics",
63946409
"rpcPluginInitCompleted",
63956410
"channelRegisterDevelopmentPlugin",
6396-
"channelSetPreprocessor",
6411+
"channelSetPromptPreprocessor",
63976412
"channelSetPredictionLoopHandler",
63986413
"channelSetToolsProvider",
63996414
"channelSetGenerator"
@@ -9299,7 +9314,7 @@
92999314
],
93009315
"additionalProperties": false
93019316
},
9302-
"plugins/channel/setPreprocessor/toClientPacketPreprocess": {
9317+
"plugins/channel/setPromptPreprocessor/toClientPacketPreprocess": {
93039318
"type": "object",
93049319
"properties": {
93059320
"type": {
@@ -9349,7 +9364,7 @@
93499364
],
93509365
"additionalProperties": false
93519366
},
9352-
"plugins/channel/setPreprocessor/toClientPacketAbort": {
9367+
"plugins/channel/setPromptPreprocessor/toClientPacketAbort": {
93539368
"type": "object",
93549369
"properties": {
93559370
"type": {
@@ -9368,7 +9383,7 @@
93689383
],
93699384
"additionalProperties": false
93709385
},
9371-
"plugins/channel/setPreprocessor/toServerPacketComplete": {
9386+
"plugins/channel/setPromptPreprocessor/toServerPacketComplete": {
93729387
"type": "object",
93739388
"properties": {
93749389
"type": {
@@ -9391,7 +9406,7 @@
93919406
],
93929407
"additionalProperties": false
93939408
},
9394-
"plugins/channel/setPreprocessor/toServerPacketAborted": {
9409+
"plugins/channel/setPromptPreprocessor/toServerPacketAborted": {
93959410
"type": "object",
93969411
"properties": {
93979412
"type": {
@@ -9410,7 +9425,7 @@
94109425
],
94119426
"additionalProperties": false
94129427
},
9413-
"plugins/channel/setPreprocessor/toServerPacketError": {
9428+
"plugins/channel/setPromptPreprocessor/toServerPacketError": {
94149429
"type": "object",
94159430
"properties": {
94169431
"type": {

‎sdk-schema/lms.json‎

Lines changed: 42 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,21 @@
484484
}
485485
]
486486
},
487+
"toolCallResult": {
488+
"type": "object",
489+
"properties": {
490+
"content": {
491+
"type": "string"
492+
},
493+
"toolCallId": {
494+
"type": "string"
495+
}
496+
},
497+
"required": [
498+
"content"
499+
],
500+
"additionalProperties": false
501+
},
487502
"citationSource": {
488503
"type": "object",
489504
"properties": {
@@ -2421,25 +2436,6 @@
24212436
}
24222437
]
24232438
},
2424-
"preprocessorUpdate": {
2425-
"anyOf": [
2426-
{
2427-
"$ref": "#/definitions/processingUpdateStatusCreate"
2428-
},
2429-
{
2430-
"$ref": "#/definitions/processingUpdateStatusUpdate"
2431-
},
2432-
{
2433-
"$ref": "#/definitions/processingUpdateStatusRemove"
2434-
},
2435-
{
2436-
"$ref": "#/definitions/processingUpdateCitationBlockCreate"
2437-
},
2438-
{
2439-
"$ref": "#/definitions/processingUpdateDebugInfoBlockCreate"
2440-
}
2441-
]
2442-
},
24432439
"processingRequestConfirmToolCall": {
24442440
"type": "object",
24452441
"properties": {
@@ -3379,6 +3375,25 @@
33793375
},
33803376
"additionalProperties": false
33813377
},
3378+
"promptPreprocessorUpdate": {
3379+
"anyOf": [
3380+
{
3381+
"$ref": "#/definitions/processingUpdateStatusCreate"
3382+
},
3383+
{
3384+
"$ref": "#/definitions/processingUpdateStatusUpdate"
3385+
},
3386+
{
3387+
"$ref": "#/definitions/processingUpdateStatusRemove"
3388+
},
3389+
{
3390+
"$ref": "#/definitions/processingUpdateCitationBlockCreate"
3391+
},
3392+
{
3393+
"$ref": "#/definitions/processingUpdateDebugInfoBlockCreate"
3394+
}
3395+
]
3396+
},
33823397
"modelCompatibilityType": {
33833398
"type": "string",
33843399
"enum": [
@@ -7268,7 +7283,7 @@
72687283
],
72697284
"additionalProperties": false
72707285
},
7271-
"plugins/channel/setPreprocessor/toClientPacket": {
7286+
"plugins/channel/setPromptPreprocessor/toClientPacket": {
72727287
"anyOf": [
72737288
{
72747289
"type": "object",
@@ -7337,7 +7352,7 @@
73377352
}
73387353
]
73397354
},
7340-
"plugins/channel/setPreprocessor/toServerPacket": {
7355+
"plugins/channel/setPromptPreprocessor/toServerPacket": {
73417356
"anyOf": [
73427357
{
73437358
"type": "object",
@@ -7400,14 +7415,14 @@
74007415
}
74017416
]
74027417
},
7403-
"pseudo/plugins/channel/setPreprocessor": {
7418+
"pseudo/plugins/channel/setPromptPreprocessor": {
74047419
"type": "object",
74057420
"properties": {
74067421
"toClientPacket": {
7407-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toClientPacket"
7422+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toClientPacket"
74087423
},
74097424
"toServerPacket": {
7410-
"$ref": "#/definitions/plugins/channel/setPreprocessor/toServerPacket"
7425+
"$ref": "#/definitions/plugins/channel/setPromptPreprocessor/toServerPacket"
74117426
}
74127427
},
74137428
"required": [
@@ -8131,8 +8146,8 @@
81318146
"channelRegisterDevelopmentPlugin": {
81328147
"$ref": "#/definitions/pseudo/plugins/channel/registerDevelopmentPlugin"
81338148
},
8134-
"channelSetPreprocessor": {
8135-
"$ref": "#/definitions/pseudo/plugins/channel/setPreprocessor"
8149+
"channelSetPromptPreprocessor": {
8150+
"$ref": "#/definitions/pseudo/plugins/channel/setPromptPreprocessor"
81368151
},
81378152
"channelSetPredictionLoopHandler": {
81388153
"$ref": "#/definitions/pseudo/plugins/channel/setPredictionLoopHandler"
@@ -8158,7 +8173,7 @@
81588173
"rpcSetGlobalConfigSchematics",
81598174
"rpcPluginInitCompleted",
81608175
"channelRegisterDevelopmentPlugin",
8161-
"channelSetPreprocessor",
8176+
"channelSetPromptPreprocessor",
81628177
"channelSetPredictionLoopHandler",
81638178
"channelSetToolsProvider",
81648179
"channelSetGenerator"

‎sdk-schema/lmstudio-js‎

Submodule lmstudio-js updated 83 files

0 commit comments

Comments
 (0)