Skip to content

Commit 5b1fb41

Browse files
Update api spec (#1324)
YOYO NEW API SPEC! Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent fbdf2dc commit 5b1fb41

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

spec.json

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27675,6 +27675,13 @@
2767527675
}
2767627676
}
2767727677
},
27678+
"forced_tools": {
27679+
"description": "The user can force specific tools to be used for this message.",
27680+
"type": "array",
27681+
"items": {
27682+
"$ref": "#/components/schemas/MlCopilotTool"
27683+
}
27684+
},
2767827685
"project_name": {
2767927686
"nullable": true,
2768027687
"description": "The project name, if any. This can be used to associate the message with a specific project.",
@@ -27728,6 +27735,28 @@
2772827735
"MlCopilotServerMessage": {
2772927736
"description": "The types of messages that can be sent by the server to the client.",
2773027737
"oneOf": [
27738+
{
27739+
"description": "The ID of the conversation, which can be used to track the session.",
27740+
"type": "object",
27741+
"properties": {
27742+
"conversation_id": {
27743+
"type": "object",
27744+
"properties": {
27745+
"conversation_id": {
27746+
"description": "The unique identifier for the conversation.",
27747+
"type": "string"
27748+
}
27749+
},
27750+
"required": [
27751+
"conversation_id"
27752+
]
27753+
}
27754+
},
27755+
"required": [
27756+
"conversation_id"
27757+
],
27758+
"additionalProperties": false
27759+
},
2773127760
{
2773227761
"description": "Delta of the response, e.g. a chunk of text/tokens.",
2773327762
"type": "object",
@@ -27874,6 +27903,46 @@
2787427903
}
2787527904
]
2787627905
},
27906+
"MlCopilotTool": {
27907+
"description": "The tools that can be used by the ML Copilot.",
27908+
"oneOf": [
27909+
{
27910+
"description": "The tool for generating or editing KCL code based on user prompts.",
27911+
"type": "string",
27912+
"enum": [
27913+
"edit_kcl_code"
27914+
]
27915+
},
27916+
{
27917+
"description": "The tool for generating CAD models from textual descriptions.",
27918+
"type": "string",
27919+
"enum": [
27920+
"text_to_cad"
27921+
]
27922+
},
27923+
{
27924+
"description": "The tool for querying a mechanical knowledge base.",
27925+
"type": "string",
27926+
"enum": [
27927+
"mechanical_knowledge_base"
27928+
]
27929+
},
27930+
{
27931+
"description": "The tool for explaining a KCL file(s).",
27932+
"type": "string",
27933+
"enum": [
27934+
"explain_kcl_file"
27935+
]
27936+
},
27937+
{
27938+
"description": "The tool for searching the web for information.",
27939+
"type": "string",
27940+
"enum": [
27941+
"web_search"
27942+
]
27943+
}
27944+
]
27945+
},
2787727946
"MlFeedback": {
2787827947
"description": "Human feedback on an ML response.",
2787927948
"oneOf": [
@@ -28213,6 +28282,26 @@
2821328282
"response",
2821428283
"type"
2821528284
]
28285+
},
28286+
{
28287+
"description": "Explain KCL file response.",
28288+
"type": "object",
28289+
"properties": {
28290+
"response": {
28291+
"description": "The response from explaining the kcl file.",
28292+
"type": "string"
28293+
},
28294+
"type": {
28295+
"type": "string",
28296+
"enum": [
28297+
"explain_kcl_file"
28298+
]
28299+
}
28300+
},
28301+
"required": [
28302+
"response",
28303+
"type"
28304+
]
2821628305
}
2821728306
]
2821828307
},

0 commit comments

Comments
 (0)