syllable-sdk 0.1.0-alpha.30 → 0.1.0-alpha.32

package/models/components/toolupdaterequest.d.ts

@@ -9,95 +9,6 @@ export type ToolUpdateRequest = {
     name: string;
     /**
      * A tool that can be called from an LLM during the conversation.
-     *
-     * @remarks
-     *
-     * The tool can result in one of the following actions depending on the `type` field:
-     * - `action`:
-     *   A request to perform an action.
-     * - `endpoint`:
-     *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
-     * - `context`:
-     *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
-     *   `language` and `say` context vars are currently supported, but this will be made more generic.
-     *
-     * For example, to change the current session language:
-     * {
-     *   "type": "context",
-     *   "tool": {
-     *     "function": {
-     *       "name": "set_language",
-     *       "parameters": {
-     *         "language": {
-     *           "type": "string",
-     *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
-     *         },
-     *         "message": {
-     *           "type": "string",
-     *           "description": "Inform the caller we're now speaking in the new language."
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     *
-     * If `defaults` is provided, it will be used as the default values for the parameters of the
-     * tool call, if the LLM doesn't provide them:
-     * "defaults": {
-     *   "hospital": "Queens Hospital"
-     * }
-     *
-     * Some special "transform" handling is supported if the value is a dict with a single `transform`
-     * key. The parameter value will be transformed by the given `action` before being used as the
-     * default value:
-     *
-     * Removing an unwanted parameter:
-     * "defaults": {
-     *   "hospital": {
-     *     "transform": {
-     *       "action": "remove"
-     *     }
-     *   }
-     * }
-     *
-     * Using a value from another parameter and converting it to a dictionary:
-     * "defaults": {
-     *   "tags.hospital": "{vars.hospital}",
-     *   "tags.foo": "{params.foo}",
-     *   "foo": {
-     *     "transform": {
-     *       "action": "remove"
-     *     }
-     *   }
-     * }
-     *
-     * Add custom parameters from other parameters using Python's `format`:
-     * "defaults": {
-     *   "hello": {
-     *     "transform": {
-     *       "format": "Hello, {name}!"
-     *     }
-     *   }
-     * }
-     *
-     * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
-     * {
-     *   "defaults": {
-     *     "city": {
-     *       "transform": {
-     *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
-     *         "action": "override",
-     *         "format": "The {city}"
-     *       }
-     *     }
-     *   }
-     * }
-     *
-     * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
-     * "defaults": {
-     *   "foo": "@remove",
-     *   "name": "@override Hello, {name}!"
-     * }
      */
     definition: ToolDefinition;
     /**

package/models/components/toolupdaterequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toolupdaterequest.d.ts","sourceRoot":"","sources":["../../src/models/components/toolupdaterequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2FG;IACH,UAAU,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,uBAAuB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,iBAAiB,CAUjB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,kBAAkB,CAAC;IAClC,iEAAiE;IAC1D,MAAM,aAAa,qDAAkC,CAAC;IAC7D,kEAAkE;IAC3D,MAAM,cAAc,wEAAmC,CAAC;IAC/D,4DAA4D;IAC5D,KAAY,QAAQ,GAAG,0BAA0B,CAAC;CACnD;AAED,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM,CAIR;AAED,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}
+{"version":3,"file":"toolupdaterequest.d.ts","sourceRoot":"","sources":["../../src/models/components/toolupdaterequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,uBAAuB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,iBAAiB,CAUjB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,kBAAkB,CAAC;IAClC,iEAAiE;IAC1D,MAAM,aAAa,qDAAkC,CAAC;IAC7D,kEAAkE;IAC3D,MAAM,cAAc,wEAAmC,CAAC;IAC/D,4DAA4D;IAC5D,KAAY,QAAQ,GAAG,0BAA0B,CAAC;CACnD;AAED,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM,CAIR;AAED,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}

package/models/components/toolupdaterequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"toolupdaterequest.js","sourceRoot":"","sources":["../../src/models/components/toolupdaterequest.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AA+KH,0DAMC;AAED,8DAQC;AA7LD,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAGjD,2DAK6B;AA8G7B,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,gDAA4B;IACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,iDAA6B;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,kBAAkB,CAOlC;AAPD,WAAiB,kBAAkB;IACjC,iEAAiE;IACpD,gCAAa,GAAG,uCAA+B,CAAC;IAC7D,kEAAkE;IACrD,iCAAc,GAAG,wCAAgC,CAAC;AAGjE,CAAC,EAPgB,kBAAkB,kCAAlB,kBAAkB,QAOlC;AAED,SAAgB,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,wCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC;AAED,SAAgB,yBAAyB,CACvC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uCAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"toolupdaterequest.js","sourceRoot":"","sources":["../../src/models/components/toolupdaterequest.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAsFH,0DAMC;AAED,8DAQC;AApGD,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAGjD,2DAK6B;AAqB7B,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,gDAA4B;IACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,iDAA6B;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,kBAAkB,CAOlC;AAPD,WAAiB,kBAAkB;IACjC,iEAAiE;IACpD,gCAAa,GAAG,uCAA+B,CAAC;IAC7D,kEAAkE;IACrD,iCAAc,GAAG,wCAAgC,CAAC;AAGjE,CAAC,EAPgB,kBAAkB,kCAAlB,kBAAkB,QAOlC;AAED,SAAgB,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,wCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC;AAED,SAAgB,yBAAyB,CACvC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uCAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}

package/openapi.json

@@ -4357,12 +4357,7 @@
               }
             ],
             "title": "Variables",
-            "description": "Custom context variables for the conversation session. Should be prefixed with \"vars.\".",
-            "examples": [
-              {
-                "vars.hospital": "Weill Cornell Medical Center"
-              }
-            ]
+            "description": "Custom context variables for the conversation session. Keys should be prefixed with \"vars.\"."
           },
           "tool_headers": {
             "anyOf": [
@@ -4500,12 +4495,7 @@
             },
             "type": "object",
             "title": "Variables",
-            "description": "Custom context variables for the conversation session. Should be prefixed with \"vars.\".",
-            "examples": [
-              {
-                "vars.hospital": "Weill Cornell Medical Center"
-              }
-            ]
+            "description": "Custom context variables for the conversation session. Keys should be prefixed with \"vars.\"."
           },
           "tool_headers": {
             "anyOf": [
@@ -4733,12 +4723,7 @@
               }
             ],
             "title": "Variables",
-            "description": "Custom context variables for the conversation session. Should be prefixed with \"vars.\".",
-            "examples": [
-              {
-                "vars.hospital": "Weill Cornell Medical Center"
-              }
-            ]
+            "description": "Custom context variables for the conversation session. Keys should be prefixed with \"vars.\"."
           },
           "tool_headers": {
             "anyOf": [
@@ -5978,18 +5963,7 @@
               }
             ],
             "title": "Attributes",
-            "description": "Arbitrary additional metadata for the event",
-            "examples": [
-              {
-                "contact_type": "operator",
-                "duration_s": 60,
-                "end_time": "2024-05-20T15:31:00.000+00:00",
-                "name": "Operator",
-                "outcome": "success",
-                "phone": "+18042221111",
-                "start_time": "2024-05-20T15:30:00.000+00:00"
-              }
-            ]
+            "description": "Arbitrary additional metadata for the event"
           }
         },
         "type": "object",
@@ -8050,7 +8024,7 @@
           "tool"
         ],
         "title": "ToolDefinition",
-        "description": "A tool that can be called from an LLM during the conversation.\n\nThe tool can result in one of the following actions depending on the `type` field:\n- `action`:\n  A request to perform an action.\n- `endpoint`:\n  An HTTP API call to an external tool. Requires the `endpoint` field to be set too.\n- `context`:\n  Sets context variables based on the tool arguments, e.g. to change the session language. Only\n  `language` and `say` context vars are currently supported, but this will be made more generic.\n\nFor example, to change the current session language:\n{\n  \"type\": \"context\",\n  \"tool\": {\n    \"function\": {\n      \"name\": \"set_language\",\n      \"parameters\": {\n        \"language\": {\n          \"type\": \"string\",\n          \"description\": \"The ISO 639 language code to set for the session e.g. 'en-US'.\"\n        },\n        \"message\": {\n          \"type\": \"string\",\n          \"description\": \"Inform the caller we're now speaking in the new language.\"\n        }\n      }\n    }\n  }\n}\n\nIf `defaults` is provided, it will be used as the default values for the parameters of the\ntool call, if the LLM doesn't provide them:\n\"defaults\": {\n  \"hospital\": \"Queens Hospital\"\n}\n\nSome special \"transform\" handling is supported if the value is a dict with a single `transform`\nkey. The parameter value will be transformed by the given `action` before being used as the\ndefault value:\n\nRemoving an unwanted parameter:\n\"defaults\": {\n  \"hospital\": {\n    \"transform\": {\n      \"action\": \"remove\"\n    }\n  }\n}\n\nUsing a value from another parameter and converting it to a dictionary:\n\"defaults\": {\n  \"tags.hospital\": \"{vars.hospital}\",\n  \"tags.foo\": \"{params.foo}\",\n  \"foo\": {\n    \"transform\": {\n      \"action\": \"remove\"\n    }\n  }\n}\n\nAdd custom parameters from other parameters using Python's `format`:\n\"defaults\": {\n  \"hello\": {\n    \"transform\": {\n      \"format\": \"Hello, {name}!\"\n    }\n  }\n}\n\nModify a value conditionally, e.g. change a `city` parameter with value \"Bronx\" to \"The Bronx\":\n{\n  \"defaults\": {\n    \"city\": {\n      \"transform\": {\n        \"when\": {\"operator\": \"eq\", \"key\": \"city\", \"value\": \"Bronx\"},\n        \"action\": \"override\",\n        \"format\": \"The {city}\"\n      }\n    }\n  }\n}\n\nSome common transform actions can be abbreviated using the `@` prefix to support a string syntax:\n\"defaults\": {\n  \"foo\": \"@remove\",\n  \"name\": \"@override Hello, {name}!\"\n}"
+        "description": "A tool that can be called from an LLM during the conversation."
       },
       "ToolDetailResponse": {
         "properties": {
@@ -8383,19 +8357,11 @@
     },
     {
       "name": "channels",
-      "description": "Operations related to channel configuration.           A channel is an organization-level point of communication, like a phone number or a web           chat. A channel can be associated with an agent by creating a channel target linking           them.",
-      "externalDocs": {
-        "description": "For more information:",
-        "url": "https://docs.syllable.ai/Resources/Channels"
-      }
+      "description": "Operations related to channel configuration.           A channel is an organization-level point of communication, like a phone number or a web           chat. A channel can be associated with an agent by creating a channel target linking           them."
     },
     {
       "name": "channels.targets",
-      "description": "Operations related to channel target configuration. A channel target           links a channel to an agent, allowing users to communicate with the agent through that           channel.",
-      "externalDocs": {
-        "description": "For more information:",
-        "url": "https://docs.syllable.ai/Resources/Channels"
-      }
+      "description": "Operations related to channel target configuration. A channel target           links a channel to an agent, allowing users to communicate with the agent through that           channel."
     },
     {
       "name": "conversations",
@@ -8403,11 +8369,7 @@
     },
     {
       "name": "custom_messages",
-      "description": "Operations related to custom message configuration.           A custom message is a pre-configured message delivered by an agent as a greeting at the           beginning of a conversation. Multiple agents can use the same custom mesasage. A custom           message has one or more rules defined, which allow for different messages to be           dynamically selected and delivered at runtime based on the current time and either           date or day of the week.",
-      "externalDocs": {
-        "description": "For more information:",
-        "url": "https://docs.syllable.ai/Resources/CustomMessages"
-      }
+      "description": "Operations related to custom message configuration.           A custom message is a pre-configured message delivered by an agent as a greeting at the           beginning of a conversation. Multiple agents can use the same custom mesasage. A custom           message has one or more rules defined, which allow for different messages to be           dynamically selected and delivered at runtime based on the current time and either           date or day of the week."
     },
     {
       "name": "dashboards",
@@ -8423,11 +8385,7 @@
     },
     {
       "name": "prompts",
-      "description": "Operations related to prompts. A prompt defines the behavior of an           agent by delivering instructions to the LLM about how the agent should behave.           A prompt can be linked to one or more agents. A prompt can also be linked to tools to           allow an agent using the prompt to use them.",
-      "externalDocs": {
-        "description": "For more information:",
-        "url": "https://docs.syllable.ai/Resources/res_WritePrompt"
-      }
+      "description": "Operations related to prompts. A prompt defines the behavior of an           agent by delivering instructions to the LLM about how the agent should behave.           A prompt can be linked to one or more agents. A prompt can also be linked to tools to           allow an agent using the prompt to use them."
     },
     {
       "name": "services",
@@ -8443,11 +8401,7 @@
     },
     {
       "name": "tools",
-      "description": "Operations related to tool configuration. A tool is a function that an           agent can call to perform actions like accessing databases, making API calls, or           processing data. For an agent to have access to a tool, the prompt associated with that           agent should be linked to the tool and include instructions to use it.",
-      "externalDocs": {
-        "description": "For more information:",
-        "url": "https://docs.syllable.ai/Resources/Tools"
-      }
+      "description": "Operations related to tool configuration. A tool is a function that an           agent can call to perform actions like accessing databases, making API calls, or           processing data. For an agent to have access to a tool, the prompt associated with that           agent should be linked to the tool and include instructions to use it."
     }
   ],
   "x-speakeasy-name-override": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "syllable-sdk",
-  "version": "0.1.0-alpha.30",
+  "version": "0.1.0-alpha.32",
   "author": "Speakeasy",
   "main": "./index.js",
   "sideEffects": false,

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.2",
-  sdkVersion: "0.1.0-alpha.30",
+  sdkVersion: "0.1.0-alpha.32",
   genVersion: "2.493.21",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.30 2.493.21 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.32 2.493.21 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/agentcreate.ts

@@ -54,7 +54,7 @@ export type AgentCreate = {
    */
   languages?: Array<string> | undefined;
   /**
-   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
    */
   variables: Variables | null;
   /**

package/src/models/components/agentresponse.ts

@@ -77,7 +77,7 @@ export type AgentResponse = {
    */
   languages?: Array<string> | undefined;
   /**
-   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
    */
   variables: { [k: string]: string };
   /**

package/src/models/components/agentupdate.ts

@@ -54,7 +54,7 @@ export type AgentUpdate = {
    */
   languages?: Array<string> | undefined;
   /**
-   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
    */
   variables: AgentUpdateVariables | null;
   /**

package/src/models/components/toolcreaterequest.ts

@@ -21,95 +21,6 @@ export type ToolCreateRequest = {
   name: string;
   /**
    * A tool that can be called from an LLM during the conversation.
-   *
-   * @remarks
-   *
-   * The tool can result in one of the following actions depending on the `type` field:
-   * - `action`:
-   *   A request to perform an action.
-   * - `endpoint`:
-   *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
-   * - `context`:
-   *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
-   *   `language` and `say` context vars are currently supported, but this will be made more generic.
-   *
-   * For example, to change the current session language:
-   * {
-   *   "type": "context",
-   *   "tool": {
-   *     "function": {
-   *       "name": "set_language",
-   *       "parameters": {
-   *         "language": {
-   *           "type": "string",
-   *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
-   *         },
-   *         "message": {
-   *           "type": "string",
-   *           "description": "Inform the caller we're now speaking in the new language."
-   *         }
-   *       }
-   *     }
-   *   }
-   * }
-   *
-   * If `defaults` is provided, it will be used as the default values for the parameters of the
-   * tool call, if the LLM doesn't provide them:
-   * "defaults": {
-   *   "hospital": "Queens Hospital"
-   * }
-   *
-   * Some special "transform" handling is supported if the value is a dict with a single `transform`
-   * key. The parameter value will be transformed by the given `action` before being used as the
-   * default value:
-   *
-   * Removing an unwanted parameter:
-   * "defaults": {
-   *   "hospital": {
-   *     "transform": {
-   *       "action": "remove"
-   *     }
-   *   }
-   * }
-   *
-   * Using a value from another parameter and converting it to a dictionary:
-   * "defaults": {
-   *   "tags.hospital": "{vars.hospital}",
-   *   "tags.foo": "{params.foo}",
-   *   "foo": {
-   *     "transform": {
-   *       "action": "remove"
-   *     }
-   *   }
-   * }
-   *
-   * Add custom parameters from other parameters using Python's `format`:
-   * "defaults": {
-   *   "hello": {
-   *     "transform": {
-   *       "format": "Hello, {name}!"
-   *     }
-   *   }
-   * }
-   *
-   * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
-   * {
-   *   "defaults": {
-   *     "city": {
-   *       "transform": {
-   *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
-   *         "action": "override",
-   *         "format": "The {city}"
-   *       }
-   *     }
-   *   }
-   * }
-   *
-   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
-   * "defaults": {
-   *   "foo": "@remove",
-   *   "name": "@override Hello, {name}!"
-   * }
    */
   definition: ToolDefinition;
   /**

package/src/models/components/tooldefinition.ts

@@ -45,95 +45,6 @@ export type Result = {};
 
 /**
  * A tool that can be called from an LLM during the conversation.
- *
- * @remarks
- *
- * The tool can result in one of the following actions depending on the `type` field:
- * - `action`:
- *   A request to perform an action.
- * - `endpoint`:
- *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
- * - `context`:
- *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
- *   `language` and `say` context vars are currently supported, but this will be made more generic.
- *
- * For example, to change the current session language:
- * {
- *   "type": "context",
- *   "tool": {
- *     "function": {
- *       "name": "set_language",
- *       "parameters": {
- *         "language": {
- *           "type": "string",
- *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
- *         },
- *         "message": {
- *           "type": "string",
- *           "description": "Inform the caller we're now speaking in the new language."
- *         }
- *       }
- *     }
- *   }
- * }
- *
- * If `defaults` is provided, it will be used as the default values for the parameters of the
- * tool call, if the LLM doesn't provide them:
- * "defaults": {
- *   "hospital": "Queens Hospital"
- * }
- *
- * Some special "transform" handling is supported if the value is a dict with a single `transform`
- * key. The parameter value will be transformed by the given `action` before being used as the
- * default value:
- *
- * Removing an unwanted parameter:
- * "defaults": {
- *   "hospital": {
- *     "transform": {
- *       "action": "remove"
- *     }
- *   }
- * }
- *
- * Using a value from another parameter and converting it to a dictionary:
- * "defaults": {
- *   "tags.hospital": "{vars.hospital}",
- *   "tags.foo": "{params.foo}",
- *   "foo": {
- *     "transform": {
- *       "action": "remove"
- *     }
- *   }
- * }
- *
- * Add custom parameters from other parameters using Python's `format`:
- * "defaults": {
- *   "hello": {
- *     "transform": {
- *       "format": "Hello, {name}!"
- *     }
- *   }
- * }
- *
- * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
- * {
- *   "defaults": {
- *     "city": {
- *       "transform": {
- *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
- *         "action": "override",
- *         "format": "The {city}"
- *       }
- *     }
- *   }
- * }
- *
- * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
- * "defaults": {
- *   "foo": "@remove",
- *   "name": "@override Hello, {name}!"
- * }
  */
 export type ToolDefinition = {
   /**

package/src/models/components/toolresponse.ts

@@ -28,95 +28,6 @@ export type ToolResponse = {
   name: string;
   /**
    * A tool that can be called from an LLM during the conversation.
-   *
-   * @remarks
-   *
-   * The tool can result in one of the following actions depending on the `type` field:
-   * - `action`:
-   *   A request to perform an action.
-   * - `endpoint`:
-   *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
-   * - `context`:
-   *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
-   *   `language` and `say` context vars are currently supported, but this will be made more generic.
-   *
-   * For example, to change the current session language:
-   * {
-   *   "type": "context",
-   *   "tool": {
-   *     "function": {
-   *       "name": "set_language",
-   *       "parameters": {
-   *         "language": {
-   *           "type": "string",
-   *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
-   *         },
-   *         "message": {
-   *           "type": "string",
-   *           "description": "Inform the caller we're now speaking in the new language."
-   *         }
-   *       }
-   *     }
-   *   }
-   * }
-   *
-   * If `defaults` is provided, it will be used as the default values for the parameters of the
-   * tool call, if the LLM doesn't provide them:
-   * "defaults": {
-   *   "hospital": "Queens Hospital"
-   * }
-   *
-   * Some special "transform" handling is supported if the value is a dict with a single `transform`
-   * key. The parameter value will be transformed by the given `action` before being used as the
-   * default value:
-   *
-   * Removing an unwanted parameter:
-   * "defaults": {
-   *   "hospital": {
-   *     "transform": {
-   *       "action": "remove"
-   *     }
-   *   }
-   * }
-   *
-   * Using a value from another parameter and converting it to a dictionary:
-   * "defaults": {
-   *   "tags.hospital": "{vars.hospital}",
-   *   "tags.foo": "{params.foo}",
-   *   "foo": {
-   *     "transform": {
-   *       "action": "remove"
-   *     }
-   *   }
-   * }
-   *
-   * Add custom parameters from other parameters using Python's `format`:
-   * "defaults": {
-   *   "hello": {
-   *     "transform": {
-   *       "format": "Hello, {name}!"
-   *     }
-   *   }
-   * }
-   *
-   * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
-   * {
-   *   "defaults": {
-   *     "city": {
-   *       "transform": {
-   *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
-   *         "action": "override",
-   *         "format": "The {city}"
-   *       }
-   *     }
-   *   }
-   * }
-   *
-   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
-   * "defaults": {
-   *   "foo": "@remove",
-   *   "name": "@override Hello, {name}!"
-   * }
    */
   definition: ToolDefinition;
   /**