@kittycad/lib 4.3.32 → 4.3.33

package/dist/types/src/api/ml/ml_copilot_ws.d.ts

@@ -7,9 +7,21 @@ interface MlCopilotWsParams {
     pr?: number;
 }
 /**
- * Open a websocket to prompt the ML copilot.
+ * Open a websocket to a Zookeeper agent instance.
  *
- * This endpoint accepts typed query parameters via `MlCopilotQuery`. See the field documentation on that struct for details, including replay behavior and wire format.
+ * Remember to authenticate before sending messages. [For WebSockets it's a little different.](/docs/developer-tools/api/authentication?lang=curl#websockets)
+ *
+ * As with all Zoo WebSockets, you must implement a ping-pong interval / heartbeat to keep the connection open. This involves a simple `{ type: "ping" }` every ~5s and **check that a `{ pong: {} } ` is received**.
+ *
+ * For the "standard experience" where the agent continues off conversations, you'll want to set the `replay` query string param to `true` and record "conversation ids", which are then passed as the other query string parameter.
+ *
+ * A list of past conversations can be fetch from [/ml/conversations](/docs/developer-tools/api/ml/list-conversations?lang=curl).
+ *
+ * The general use-case is to fire off `{ type: "user", content: "my prompt goes here" }` messages and interpret the various message types that return.
+ *
+ * Notable behavior: **ONLY KCL IS RETURNED.** It's a common misunderstanding that Zookeeper returns models in formats such as STEP and STL directly. This is incorrect. All outputs are in KCL, which can then be fed into the [Engine API](/docs/developer-tools/engine-api) (specifically the `exec_kcl_project` command) or the [Zoo CLI](/docs/developer-tools/cli/manual) (`zoo kcl snapshot ...`).
+ *
+ * In the future we may add a more direct method, but you can always rely on those.
  *
  * Tags: ml
  *

package/dist/types/src/api/ml/ml_copilot_ws.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ml_copilot_ws.d.ts","sourceRoot":"","sources":["../../../../../src/api/ml/ml_copilot_ws.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAc,MAAM,iBAAiB,CAAA;AAIpD,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AAEhF,UAAU,iBAAiB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;;IAG9B;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,GAAG,GAAG;IAiBnE,MAAM,CAAC,YAAY,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,EAAE,EAAE,SAAS;IAoBxE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,UAAU;IAIvD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,sBAAsB;CAgC9D"}
+{"version":3,"file":"ml_copilot_ws.d.ts","sourceRoot":"","sources":["../../../../../src/api/ml/ml_copilot_ws.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAc,MAAM,iBAAiB,CAAA;AAIpD,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AAEhF,UAAU,iBAAiB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;;IAG9B;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,GAAG,GAAG;IAiBnE,MAAM,CAAC,YAAY,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,EAAE,EAAE,SAAS;IAoBxE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,UAAU;IAIvD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,sBAAsB;CAgC9D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kittycad/lib",
-  "version": "4.3.32",
+  "version": "4.3.33",
   "description": "Javascript library for KittyCAD API",
   "type": "module",
   "keywords": [