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

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.
Files changed (34) hide show
  1. package/docs/sdks/channels/README.md +0 -3
  2. package/docs/sdks/custommessages/README.md +0 -3
  3. package/docs/sdks/prompts/README.md +0 -3
  4. package/docs/sdks/targets/README.md +0 -3
  5. package/docs/sdks/tools/README.md +0 -3
  6. package/jsr.json +1 -1
  7. package/lib/config.d.ts +2 -2
  8. package/lib/config.js +2 -2
  9. package/mintlify/mint.json +24 -3
  10. package/models/components/agentcreate.d.ts +1 -1
  11. package/models/components/agentresponse.d.ts +1 -1
  12. package/models/components/agentupdate.d.ts +1 -1
  13. package/models/components/toolcreaterequest.d.ts +0 -89
  14. package/models/components/toolcreaterequest.d.ts.map +1 -1
  15. package/models/components/toolcreaterequest.js.map +1 -1
  16. package/models/components/tooldefinition.d.ts +0 -89
  17. package/models/components/tooldefinition.d.ts.map +1 -1
  18. package/models/components/tooldefinition.js.map +1 -1
  19. package/models/components/toolresponse.d.ts +0 -89
  20. package/models/components/toolresponse.d.ts.map +1 -1
  21. package/models/components/toolresponse.js.map +1 -1
  22. package/models/components/toolupdaterequest.d.ts +0 -89
  23. package/models/components/toolupdaterequest.d.ts.map +1 -1
  24. package/models/components/toolupdaterequest.js.map +1 -1
  25. package/openapi.json +10 -56
  26. package/package.json +1 -1
  27. package/src/lib/config.ts +2 -2
  28. package/src/models/components/agentcreate.ts +1 -1
  29. package/src/models/components/agentresponse.ts +1 -1
  30. package/src/models/components/agentupdate.ts +1 -1
  31. package/src/models/components/toolcreaterequest.ts +0 -89
  32. package/src/models/components/tooldefinition.ts +0 -89
  33. package/src/models/components/toolresponse.ts +0 -89
  34. package/src/models/components/toolupdaterequest.ts +0 -89
@@ -21,95 +21,6 @@ export type ToolUpdateRequest = {
21
21
  name: string;
22
22
  /**
23
23
  * A tool that can be called from an LLM during the conversation.
24
- *
25
- * @remarks
26
- *
27
- * The tool can result in one of the following actions depending on the `type` field:
28
- * - `action`:
29
- * A request to perform an action.
30
- * - `endpoint`:
31
- * An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
32
- * - `context`:
33
- * Sets context variables based on the tool arguments, e.g. to change the session language. Only
34
- * `language` and `say` context vars are currently supported, but this will be made more generic.
35
- *
36
- * For example, to change the current session language:
37
- * {
38
- * "type": "context",
39
- * "tool": {
40
- * "function": {
41
- * "name": "set_language",
42
- * "parameters": {
43
- * "language": {
44
- * "type": "string",
45
- * "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
46
- * },
47
- * "message": {
48
- * "type": "string",
49
- * "description": "Inform the caller we're now speaking in the new language."
50
- * }
51
- * }
52
- * }
53
- * }
54
- * }
55
- *
56
- * If `defaults` is provided, it will be used as the default values for the parameters of the
57
- * tool call, if the LLM doesn't provide them:
58
- * "defaults": {
59
- * "hospital": "Queens Hospital"
60
- * }
61
- *
62
- * Some special "transform" handling is supported if the value is a dict with a single `transform`
63
- * key. The parameter value will be transformed by the given `action` before being used as the
64
- * default value:
65
- *
66
- * Removing an unwanted parameter:
67
- * "defaults": {
68
- * "hospital": {
69
- * "transform": {
70
- * "action": "remove"
71
- * }
72
- * }
73
- * }
74
- *
75
- * Using a value from another parameter and converting it to a dictionary:
76
- * "defaults": {
77
- * "tags.hospital": "{vars.hospital}",
78
- * "tags.foo": "{params.foo}",
79
- * "foo": {
80
- * "transform": {
81
- * "action": "remove"
82
- * }
83
- * }
84
- * }
85
- *
86
- * Add custom parameters from other parameters using Python's `format`:
87
- * "defaults": {
88
- * "hello": {
89
- * "transform": {
90
- * "format": "Hello, {name}!"
91
- * }
92
- * }
93
- * }
94
- *
95
- * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
96
- * {
97
- * "defaults": {
98
- * "city": {
99
- * "transform": {
100
- * "when": {"operator": "eq", "key": "city", "value": "Bronx"},
101
- * "action": "override",
102
- * "format": "The {city}"
103
- * }
104
- * }
105
- * }
106
- * }
107
- *
108
- * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
109
- * "defaults": {
110
- * "foo": "@remove",
111
- * "name": "@override Hello, {name}!"
112
- * }
113
24
  */
114
25
  definition: ToolDefinition;
115
26
  /**