hume 0.9.1 → 0.9.3
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.
- package/.mock/definition/api.yml +6 -6
- package/.mock/definition/empathic-voice/__package__.yml +2810 -2703
- package/.mock/definition/empathic-voice/chat.yml +143 -143
- package/.mock/definition/empathic-voice/chatGroups.yml +579 -508
- package/.mock/definition/empathic-voice/chats.yml +490 -449
- package/.mock/definition/empathic-voice/configs.yml +913 -871
- package/.mock/definition/empathic-voice/customVoices.yml +255 -234
- package/.mock/definition/empathic-voice/prompts.yml +523 -526
- package/.mock/definition/empathic-voice/tools.yml +588 -588
- package/.mock/definition/expression-measurement/batch/__package__.yml +1758 -1758
- package/.mock/definition/expression-measurement/stream/__package__.yml +486 -485
- package/.mock/fern.config.json +3 -3
- package/.prettierignore +1 -0
- package/api/resources/empathicVoice/resources/chat/client/Socket.d.ts +4 -1
- package/api/resources/empathicVoice/resources/chat/client/Socket.js +6 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -0
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +77 -3
- package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +25 -0
- package/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
- package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +10 -0
- package/api/resources/empathicVoice/resources/chats/client/Client.js +63 -2
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
- package/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
- package/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
- package/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
- package/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
- package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
- package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
- package/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
- package/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
- package/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
- package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
- package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
- package/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
- package/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
- package/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
- package/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
- package/api/resources/empathicVoice/types/index.d.ts +0 -2
- package/api/resources/empathicVoice/types/index.js +0 -2
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/dist/api/resources/empathicVoice/resources/chat/client/Socket.d.ts +4 -1
- package/dist/api/resources/empathicVoice/resources/chat/client/Socket.js +6 -1
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -0
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +77 -3
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +25 -0
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +10 -0
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +63 -2
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
- package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
- package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
- package/dist/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
- package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
- package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
- package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
- package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
- package/dist/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
- package/dist/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
- package/dist/api/resources/empathicVoice/types/index.d.ts +0 -2
- package/dist/api/resources/empathicVoice/types/index.js +0 -2
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
- package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
- package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
- package/dist/serialization/resources/empathicVoice/types/index.d.ts +0 -2
- package/dist/serialization/resources/empathicVoice/types/index.js +0 -2
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/HumeClient.d.ts +7 -3
- package/dist/wrapper/HumeClient.js +2 -2
- package/package.json +1 -1
- package/reference.md +573 -607
- package/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
- package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
- package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
- package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
- package/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
- package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
- package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
- package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
- package/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
- package/serialization/resources/empathicVoice/types/index.d.ts +0 -2
- package/serialization/resources/empathicVoice/types/index.js +0 -2
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/HumeClient.d.ts +7 -3
- package/wrapper/HumeClient.js +2 -2
- package/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
- package/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
- package/dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
- package/dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -5
- package/dist/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
- package/dist/api/resources/empathicVoice/types/VoiceArgs.js +0 -5
- package/dist/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
- package/dist/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -36
- package/dist/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
- package/dist/serialization/resources/empathicVoice/types/VoiceArgs.js +0 -40
- package/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
- package/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -36
- package/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
- package/serialization/resources/empathicVoice/types/VoiceArgs.js +0 -40
- /package/api/resources/empathicVoice/{types/ExtendedVoiceArgs.js → resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
- /package/{api/resources/empathicVoice/types/VoiceArgs.js → dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
|
@@ -1,596 +1,596 @@
|
|
|
1
1
|
imports:
|
|
2
|
-
|
|
2
|
+
root: __package__.yml
|
|
3
3
|
service:
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
4
|
+
auth: false
|
|
5
|
+
base-path: ''
|
|
6
|
+
endpoints:
|
|
7
|
+
list-tools:
|
|
8
|
+
path: /v0/evi/tools
|
|
9
|
+
method: GET
|
|
10
|
+
auth: true
|
|
11
|
+
docs: >-
|
|
12
|
+
Fetches a paginated list of **Tools**.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
Refer to our [tool
|
|
16
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
17
|
+
for comprehensive instructions on defining and integrating tools into
|
|
18
|
+
EVI.
|
|
19
|
+
pagination:
|
|
20
|
+
offset: $request.page_number
|
|
21
|
+
results: $response.tools_page
|
|
22
|
+
display-name: List tools
|
|
23
|
+
request:
|
|
24
|
+
name: ToolsListToolsRequest
|
|
25
|
+
query-parameters:
|
|
26
|
+
page_number:
|
|
27
|
+
type: optional<integer>
|
|
11
28
|
docs: >-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
display-name: List tools
|
|
23
|
-
request:
|
|
24
|
-
name: ToolsListToolsRequest
|
|
25
|
-
query-parameters:
|
|
26
|
-
page_number:
|
|
27
|
-
type: optional<integer>
|
|
28
|
-
docs: >-
|
|
29
|
-
Specifies the page number to retrieve, enabling pagination.
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
This parameter uses zero-based indexing. For example, setting
|
|
33
|
-
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
34
|
-
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
35
|
-
second page (items 10-19), and so on. Defaults to 0, which
|
|
36
|
-
retrieves the first page.
|
|
37
|
-
page_size:
|
|
38
|
-
type: optional<integer>
|
|
39
|
-
docs: >-
|
|
40
|
-
Specifies the maximum number of results to include per page,
|
|
41
|
-
enabling pagination. The value must be between 1 and 100,
|
|
42
|
-
inclusive.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
For example, if `page_size` is set to 10, each page will include
|
|
46
|
-
up to 10 items. Defaults to 10.
|
|
47
|
-
restrict_to_most_recent:
|
|
48
|
-
type: optional<boolean>
|
|
49
|
-
docs: >-
|
|
50
|
-
By default, `restrict_to_most_recent` is set to true, returning
|
|
51
|
-
only the latest version of each tool. To include all versions of
|
|
52
|
-
each tool in the list, set `restrict_to_most_recent` to false.
|
|
53
|
-
name:
|
|
54
|
-
type: optional<string>
|
|
55
|
-
docs: Filter to only include tools with this name.
|
|
56
|
-
response:
|
|
57
|
-
docs: Success
|
|
58
|
-
type: root.ReturnPagedUserDefinedTools
|
|
59
|
-
errors:
|
|
60
|
-
- root.BadRequestError
|
|
61
|
-
examples:
|
|
62
|
-
- query-parameters:
|
|
63
|
-
page_number: 0
|
|
64
|
-
page_size: 2
|
|
65
|
-
response:
|
|
66
|
-
body:
|
|
67
|
-
page_number: 0
|
|
68
|
-
page_size: 2
|
|
69
|
-
total_pages: 1
|
|
70
|
-
tools_page:
|
|
71
|
-
- tool_type: FUNCTION
|
|
72
|
-
id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2
|
|
73
|
-
version: 0
|
|
74
|
-
version_type: FIXED
|
|
75
|
-
version_description: Fetches user's current location.
|
|
76
|
-
name: get_current_location
|
|
77
|
-
created_on: 1715267200693
|
|
78
|
-
modified_on: 1715267200693
|
|
79
|
-
fallback_content: Unable to fetch location.
|
|
80
|
-
description: Fetches user's current location.
|
|
81
|
-
parameters: >-
|
|
82
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
83
|
-
"string", "description": "The city and state, e.g. San
|
|
84
|
-
Francisco, CA" }}, "required": ["location"] }
|
|
85
|
-
- tool_type: FUNCTION
|
|
86
|
-
id: 4442f3ea-9038-40e3-a2ce-1522b7de770f
|
|
87
|
-
version: 0
|
|
88
|
-
version_type: FIXED
|
|
89
|
-
version_description: >-
|
|
90
|
-
Fetches current weather and uses celsius or fahrenheit based
|
|
91
|
-
on location of user.
|
|
92
|
-
name: get_current_weather
|
|
93
|
-
created_on: 1715266126705
|
|
94
|
-
modified_on: 1715266126705
|
|
95
|
-
fallback_content: Unable to fetch location.
|
|
96
|
-
description: >-
|
|
97
|
-
Fetches current weather and uses celsius or fahrenheit based
|
|
98
|
-
on location of user.
|
|
99
|
-
parameters: >-
|
|
100
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
101
|
-
"string", "description": "The city and state, e.g. San
|
|
102
|
-
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
103
|
-
["celsius", "fahrenheit"], "description": "The temperature
|
|
104
|
-
unit to use. Infer this from the users location." } },
|
|
105
|
-
"required": ["location", "format"] }
|
|
106
|
-
create-tool:
|
|
107
|
-
path: /v0/evi/tools
|
|
108
|
-
method: POST
|
|
109
|
-
auth: true
|
|
110
|
-
docs: >-
|
|
111
|
-
Creates a **Tool** that can be added to an [EVI
|
|
112
|
-
configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
Refer to our [tool
|
|
116
|
-
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
117
|
-
for comprehensive instructions on defining and integrating tools into
|
|
118
|
-
EVI.
|
|
119
|
-
display-name: Create tool
|
|
120
|
-
request:
|
|
121
|
-
name: PostedUserDefinedTool
|
|
122
|
-
body:
|
|
123
|
-
properties:
|
|
124
|
-
name:
|
|
125
|
-
type: string
|
|
126
|
-
docs: Name applied to all versions of a particular Tool.
|
|
127
|
-
version_description:
|
|
128
|
-
type: optional<string>
|
|
129
|
-
docs: An optional description of the Tool version.
|
|
130
|
-
description:
|
|
131
|
-
type: optional<string>
|
|
132
|
-
docs: >-
|
|
133
|
-
An optional description of what the Tool does, used by the
|
|
134
|
-
supplemental LLM to choose when and how to call the function.
|
|
135
|
-
parameters:
|
|
136
|
-
type: string
|
|
137
|
-
docs: >-
|
|
138
|
-
Stringified JSON defining the parameters used by this version of
|
|
139
|
-
the Tool.
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
These parameters define the inputs needed for the Tool’s
|
|
143
|
-
execution, including the expected data type and description for
|
|
144
|
-
each input field. Structured as a stringified JSON schema, this
|
|
145
|
-
format ensures the Tool receives data in the expected format.
|
|
146
|
-
fallback_content:
|
|
147
|
-
type: optional<string>
|
|
148
|
-
docs: >-
|
|
149
|
-
Optional text passed to the supplemental LLM in place of the
|
|
150
|
-
tool call result. The LLM then uses this text to generate a
|
|
151
|
-
response back to the user, ensuring continuity in the
|
|
152
|
-
conversation if the Tool errors.
|
|
153
|
-
content-type: application/json
|
|
154
|
-
response:
|
|
155
|
-
docs: Created
|
|
156
|
-
type: optional<root.ReturnUserDefinedTool>
|
|
157
|
-
errors:
|
|
158
|
-
- root.BadRequestError
|
|
159
|
-
examples:
|
|
160
|
-
- request:
|
|
161
|
-
name: get_current_weather
|
|
162
|
-
parameters: >-
|
|
163
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
164
|
-
"string", "description": "The city and state, e.g. San Francisco,
|
|
165
|
-
CA" }, "format": { "type": "string", "enum": ["celsius",
|
|
166
|
-
"fahrenheit"], "description": "The temperature unit to use. Infer
|
|
167
|
-
this from the users location." } }, "required": ["location",
|
|
168
|
-
"format"] }
|
|
169
|
-
version_description: >-
|
|
170
|
-
Fetches current weather and uses celsius or fahrenheit based on
|
|
171
|
-
location of user.
|
|
172
|
-
description: This tool is for getting the current weather.
|
|
173
|
-
fallback_content: Unable to fetch current weather.
|
|
174
|
-
response:
|
|
175
|
-
body:
|
|
176
|
-
tool_type: FUNCTION
|
|
177
|
-
id: aa9b71c4-723c-47ff-9f83-1a1829e74376
|
|
178
|
-
version: 0
|
|
179
|
-
version_type: FIXED
|
|
180
|
-
version_description: >-
|
|
181
|
-
Fetches current weather and uses celsius or fahrenheit based on
|
|
182
|
-
location of user.
|
|
183
|
-
name: get_current_weather
|
|
184
|
-
created_on: 1715275452390
|
|
185
|
-
modified_on: 1715275452390
|
|
186
|
-
fallback_content: Unable to fetch current weather.
|
|
187
|
-
description: This tool is for getting the current weather.
|
|
188
|
-
parameters: >-
|
|
189
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
190
|
-
"string", "description": "The city and state, e.g. San
|
|
191
|
-
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
192
|
-
["celsius", "fahrenheit"], "description": "The temperature unit
|
|
193
|
-
to use. Infer this from the users location." } }, "required":
|
|
194
|
-
["location", "format"] }
|
|
195
|
-
list-tool-versions:
|
|
196
|
-
path: /v0/evi/tools/{id}
|
|
197
|
-
method: GET
|
|
198
|
-
auth: true
|
|
199
|
-
docs: >-
|
|
200
|
-
Fetches a list of a **Tool's** versions.
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
Refer to our [tool
|
|
204
|
-
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
205
|
-
for comprehensive instructions on defining and integrating tools into
|
|
206
|
-
EVI.
|
|
207
|
-
path-parameters:
|
|
208
|
-
id:
|
|
209
|
-
type: string
|
|
210
|
-
docs: Identifier for a Tool. Formatted as a UUID.
|
|
211
|
-
display-name: List tool versions
|
|
212
|
-
request:
|
|
213
|
-
name: ToolsListToolVersionsRequest
|
|
214
|
-
query-parameters:
|
|
215
|
-
page_number:
|
|
216
|
-
type: optional<integer>
|
|
217
|
-
docs: >-
|
|
218
|
-
Specifies the page number to retrieve, enabling pagination.
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
This parameter uses zero-based indexing. For example, setting
|
|
222
|
-
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
223
|
-
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
224
|
-
second page (items 10-19), and so on. Defaults to 0, which
|
|
225
|
-
retrieves the first page.
|
|
226
|
-
page_size:
|
|
227
|
-
type: optional<integer>
|
|
228
|
-
docs: >-
|
|
229
|
-
Specifies the maximum number of results to include per page,
|
|
230
|
-
enabling pagination. The value must be between 1 and 100,
|
|
231
|
-
inclusive.
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
For example, if `page_size` is set to 10, each page will include
|
|
235
|
-
up to 10 items. Defaults to 10.
|
|
236
|
-
restrict_to_most_recent:
|
|
237
|
-
type: optional<boolean>
|
|
238
|
-
docs: >-
|
|
239
|
-
By default, `restrict_to_most_recent` is set to true, returning
|
|
240
|
-
only the latest version of each tool. To include all versions of
|
|
241
|
-
each tool in the list, set `restrict_to_most_recent` to false.
|
|
242
|
-
response:
|
|
243
|
-
docs: Success
|
|
244
|
-
type: root.ReturnPagedUserDefinedTools
|
|
245
|
-
errors:
|
|
246
|
-
- root.BadRequestError
|
|
247
|
-
examples:
|
|
248
|
-
- path-parameters:
|
|
249
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
250
|
-
response:
|
|
251
|
-
body:
|
|
252
|
-
page_number: 0
|
|
253
|
-
page_size: 10
|
|
254
|
-
total_pages: 1
|
|
255
|
-
tools_page:
|
|
256
|
-
- tool_type: FUNCTION
|
|
257
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
258
|
-
version: 1
|
|
259
|
-
version_type: FIXED
|
|
260
|
-
version_description: >-
|
|
261
|
-
Fetches current weather and uses celsius, fahrenheit, or
|
|
262
|
-
kelvin based on location of user.
|
|
263
|
-
name: get_current_weather
|
|
264
|
-
created_on: 1715277014228
|
|
265
|
-
modified_on: 1715277602313
|
|
266
|
-
fallback_content: Unable to fetch current weather.
|
|
267
|
-
description: This tool is for getting the current weather.
|
|
268
|
-
parameters: >-
|
|
269
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
270
|
-
"string", "description": "The city and state, e.g. San
|
|
271
|
-
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
272
|
-
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
273
|
-
temperature unit to use. Infer this from the users
|
|
274
|
-
location." } }, "required": ["location", "format"] }
|
|
275
|
-
create-tool-version:
|
|
276
|
-
path: /v0/evi/tools/{id}
|
|
277
|
-
method: POST
|
|
278
|
-
auth: true
|
|
279
|
-
docs: >-
|
|
280
|
-
Updates a **Tool** by creating a new version of the **Tool**.
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
Refer to our [tool
|
|
284
|
-
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
285
|
-
for comprehensive instructions on defining and integrating tools into
|
|
286
|
-
EVI.
|
|
287
|
-
path-parameters:
|
|
288
|
-
id:
|
|
289
|
-
type: string
|
|
290
|
-
docs: Identifier for a Tool. Formatted as a UUID.
|
|
291
|
-
display-name: Create tool version
|
|
292
|
-
request:
|
|
293
|
-
name: PostedUserDefinedToolVersion
|
|
294
|
-
body:
|
|
295
|
-
properties:
|
|
296
|
-
version_description:
|
|
297
|
-
type: optional<string>
|
|
298
|
-
docs: An optional description of the Tool version.
|
|
299
|
-
description:
|
|
300
|
-
type: optional<string>
|
|
301
|
-
docs: >-
|
|
302
|
-
An optional description of what the Tool does, used by the
|
|
303
|
-
supplemental LLM to choose when and how to call the function.
|
|
304
|
-
parameters:
|
|
305
|
-
type: string
|
|
306
|
-
docs: >-
|
|
307
|
-
Stringified JSON defining the parameters used by this version of
|
|
308
|
-
the Tool.
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
These parameters define the inputs needed for the Tool’s
|
|
312
|
-
execution, including the expected data type and description for
|
|
313
|
-
each input field. Structured as a stringified JSON schema, this
|
|
314
|
-
format ensures the Tool receives data in the expected format.
|
|
315
|
-
fallback_content:
|
|
316
|
-
type: optional<string>
|
|
317
|
-
docs: >-
|
|
318
|
-
Optional text passed to the supplemental LLM in place of the
|
|
319
|
-
tool call result. The LLM then uses this text to generate a
|
|
320
|
-
response back to the user, ensuring continuity in the
|
|
321
|
-
conversation if the Tool errors.
|
|
322
|
-
content-type: application/json
|
|
323
|
-
response:
|
|
324
|
-
docs: Created
|
|
325
|
-
type: optional<root.ReturnUserDefinedTool>
|
|
326
|
-
errors:
|
|
327
|
-
- root.BadRequestError
|
|
328
|
-
examples:
|
|
329
|
-
- path-parameters:
|
|
330
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
331
|
-
request:
|
|
332
|
-
parameters: >-
|
|
333
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
334
|
-
"string", "description": "The city and state, e.g. San Francisco,
|
|
335
|
-
CA" }, "format": { "type": "string", "enum": ["celsius",
|
|
336
|
-
"fahrenheit", "kelvin"], "description": "The temperature unit to
|
|
337
|
-
use. Infer this from the users location." } }, "required":
|
|
338
|
-
["location", "format"] }
|
|
339
|
-
version_description: >-
|
|
340
|
-
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
341
|
-
based on location of user.
|
|
342
|
-
fallback_content: Unable to fetch current weather.
|
|
343
|
-
description: This tool is for getting the current weather.
|
|
344
|
-
response:
|
|
345
|
-
body:
|
|
346
|
-
tool_type: FUNCTION
|
|
347
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
348
|
-
version: 1
|
|
349
|
-
version_type: FIXED
|
|
350
|
-
version_description: >-
|
|
351
|
-
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
352
|
-
based on location of user.
|
|
353
|
-
name: get_current_weather
|
|
354
|
-
created_on: 1715277014228
|
|
355
|
-
modified_on: 1715277602313
|
|
356
|
-
fallback_content: Unable to fetch current weather.
|
|
357
|
-
description: This tool is for getting the current weather.
|
|
358
|
-
parameters: >-
|
|
359
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
360
|
-
"string", "description": "The city and state, e.g. San
|
|
361
|
-
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
362
|
-
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
363
|
-
temperature unit to use. Infer this from the users location." }
|
|
364
|
-
}, "required": ["location", "format"] }
|
|
365
|
-
delete-tool:
|
|
366
|
-
path: /v0/evi/tools/{id}
|
|
367
|
-
method: DELETE
|
|
368
|
-
auth: true
|
|
29
|
+
Specifies the page number to retrieve, enabling pagination.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
This parameter uses zero-based indexing. For example, setting
|
|
33
|
+
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
34
|
+
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
35
|
+
second page (items 10-19), and so on. Defaults to 0, which
|
|
36
|
+
retrieves the first page.
|
|
37
|
+
page_size:
|
|
38
|
+
type: optional<integer>
|
|
369
39
|
docs: >-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
type: string
|
|
380
|
-
docs: Identifier for a Tool. Formatted as a UUID.
|
|
381
|
-
display-name: Delete tool
|
|
382
|
-
errors:
|
|
383
|
-
- root.BadRequestError
|
|
384
|
-
examples:
|
|
385
|
-
- path-parameters:
|
|
386
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
387
|
-
update-tool-name:
|
|
388
|
-
path: /v0/evi/tools/{id}
|
|
389
|
-
method: PATCH
|
|
390
|
-
auth: true
|
|
40
|
+
Specifies the maximum number of results to include per page,
|
|
41
|
+
enabling pagination. The value must be between 1 and 100,
|
|
42
|
+
inclusive.
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
For example, if `page_size` is set to 10, each page will include
|
|
46
|
+
up to 10 items. Defaults to 10.
|
|
47
|
+
restrict_to_most_recent:
|
|
48
|
+
type: optional<boolean>
|
|
391
49
|
docs: >-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
50
|
+
By default, `restrict_to_most_recent` is set to true, returning
|
|
51
|
+
only the latest version of each tool. To include all versions of
|
|
52
|
+
each tool in the list, set `restrict_to_most_recent` to false.
|
|
53
|
+
name:
|
|
54
|
+
type: optional<string>
|
|
55
|
+
docs: Filter to only include tools with name.
|
|
56
|
+
response:
|
|
57
|
+
docs: Success
|
|
58
|
+
type: root.ReturnPagedUserDefinedTools
|
|
59
|
+
errors:
|
|
60
|
+
- root.BadRequestError
|
|
61
|
+
examples:
|
|
62
|
+
- query-parameters:
|
|
63
|
+
page_number: 0
|
|
64
|
+
page_size: 2
|
|
65
|
+
response:
|
|
66
|
+
body:
|
|
67
|
+
page_number: 0
|
|
68
|
+
page_size: 2
|
|
69
|
+
total_pages: 1
|
|
70
|
+
tools_page:
|
|
71
|
+
- tool_type: FUNCTION
|
|
72
|
+
id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2
|
|
73
|
+
version: 0
|
|
74
|
+
version_type: FIXED
|
|
75
|
+
version_description: Fetches user's current location.
|
|
76
|
+
name: get_current_location
|
|
77
|
+
created_on: 1715267200693
|
|
78
|
+
modified_on: 1715267200693
|
|
79
|
+
fallback_content: Unable to fetch location.
|
|
80
|
+
description: Fetches user's current location.
|
|
81
|
+
parameters: >-
|
|
82
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
83
|
+
"string", "description": "The city and state, e.g. San
|
|
84
|
+
Francisco, CA" }}, "required": ["location"] }
|
|
85
|
+
- tool_type: FUNCTION
|
|
86
|
+
id: 4442f3ea-9038-40e3-a2ce-1522b7de770f
|
|
87
|
+
version: 0
|
|
88
|
+
version_type: FIXED
|
|
89
|
+
version_description: >-
|
|
90
|
+
Fetches current weather and uses celsius or fahrenheit based
|
|
91
|
+
on location of user.
|
|
92
|
+
name: get_current_weather
|
|
93
|
+
created_on: 1715266126705
|
|
94
|
+
modified_on: 1715266126705
|
|
95
|
+
fallback_content: Unable to fetch location.
|
|
96
|
+
description: >-
|
|
97
|
+
Fetches current weather and uses celsius or fahrenheit based
|
|
98
|
+
on location of user.
|
|
99
|
+
parameters: >-
|
|
100
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
101
|
+
"string", "description": "The city and state, e.g. San
|
|
102
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
103
|
+
["celsius", "fahrenheit"], "description": "The temperature
|
|
104
|
+
unit to use. Infer this from the users location." } },
|
|
105
|
+
"required": ["location", "format"] }
|
|
106
|
+
create-tool:
|
|
107
|
+
path: /v0/evi/tools
|
|
108
|
+
method: POST
|
|
109
|
+
auth: true
|
|
110
|
+
docs: >-
|
|
111
|
+
Creates a **Tool** that can be added to an [EVI
|
|
112
|
+
configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
Refer to our [tool
|
|
116
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
117
|
+
for comprehensive instructions on defining and integrating tools into
|
|
118
|
+
EVI.
|
|
119
|
+
display-name: Create tool
|
|
120
|
+
request:
|
|
121
|
+
name: PostedUserDefinedTool
|
|
122
|
+
body:
|
|
123
|
+
properties:
|
|
124
|
+
name:
|
|
125
|
+
type: string
|
|
126
|
+
docs: Name applied to all versions of a particular Tool.
|
|
127
|
+
version_description:
|
|
128
|
+
type: optional<string>
|
|
129
|
+
docs: An optional description of the Tool version.
|
|
130
|
+
description:
|
|
131
|
+
type: optional<string>
|
|
132
|
+
docs: >-
|
|
133
|
+
An optional description of what the Tool does, used by the
|
|
134
|
+
supplemental LLM to choose when and how to call the function.
|
|
135
|
+
parameters:
|
|
136
|
+
type: string
|
|
137
|
+
docs: >-
|
|
138
|
+
Stringified JSON defining the parameters used by this version of
|
|
139
|
+
the Tool.
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
These parameters define the inputs needed for the Tool’s
|
|
143
|
+
execution, including the expected data type and description for
|
|
144
|
+
each input field. Structured as a stringified JSON schema, this
|
|
145
|
+
format ensures the Tool receives data in the expected format.
|
|
146
|
+
fallback_content:
|
|
147
|
+
type: optional<string>
|
|
148
|
+
docs: >-
|
|
149
|
+
Optional text passed to the supplemental LLM in place of the
|
|
150
|
+
tool call result. The LLM then uses this text to generate a
|
|
151
|
+
response back to the user, ensuring continuity in the
|
|
152
|
+
conversation if the Tool errors.
|
|
153
|
+
content-type: application/json
|
|
154
|
+
response:
|
|
155
|
+
docs: Created
|
|
156
|
+
type: optional<root.ReturnUserDefinedTool>
|
|
157
|
+
errors:
|
|
158
|
+
- root.BadRequestError
|
|
159
|
+
examples:
|
|
160
|
+
- request:
|
|
161
|
+
name: get_current_weather
|
|
162
|
+
parameters: >-
|
|
163
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
164
|
+
"string", "description": "The city and state, e.g. San Francisco,
|
|
165
|
+
CA" }, "format": { "type": "string", "enum": ["celsius",
|
|
166
|
+
"fahrenheit"], "description": "The temperature unit to use. Infer
|
|
167
|
+
this from the users location." } }, "required": ["location",
|
|
168
|
+
"format"] }
|
|
169
|
+
version_description: >-
|
|
170
|
+
Fetches current weather and uses celsius or fahrenheit based on
|
|
171
|
+
location of user.
|
|
172
|
+
description: This tool is for getting the current weather.
|
|
173
|
+
fallback_content: Unable to fetch current weather.
|
|
174
|
+
response:
|
|
175
|
+
body:
|
|
176
|
+
tool_type: FUNCTION
|
|
177
|
+
id: aa9b71c4-723c-47ff-9f83-1a1829e74376
|
|
178
|
+
version: 0
|
|
179
|
+
version_type: FIXED
|
|
180
|
+
version_description: >-
|
|
181
|
+
Fetches current weather and uses celsius or fahrenheit based on
|
|
182
|
+
location of user.
|
|
183
|
+
name: get_current_weather
|
|
184
|
+
created_on: 1715275452390
|
|
185
|
+
modified_on: 1715275452390
|
|
186
|
+
fallback_content: Unable to fetch current weather.
|
|
187
|
+
description: This tool is for getting the current weather.
|
|
188
|
+
parameters: >-
|
|
189
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
190
|
+
"string", "description": "The city and state, e.g. San
|
|
191
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
192
|
+
["celsius", "fahrenheit"], "description": "The temperature unit
|
|
193
|
+
to use. Infer this from the users location." } }, "required":
|
|
194
|
+
["location", "format"] }
|
|
195
|
+
list-tool-versions:
|
|
196
|
+
path: /v0/evi/tools/{id}
|
|
197
|
+
method: GET
|
|
198
|
+
auth: true
|
|
199
|
+
docs: >-
|
|
200
|
+
Fetches a list of a **Tool's** versions.
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
Refer to our [tool
|
|
204
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
205
|
+
for comprehensive instructions on defining and integrating tools into
|
|
206
|
+
EVI.
|
|
207
|
+
path-parameters:
|
|
208
|
+
id:
|
|
209
|
+
type: string
|
|
210
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
211
|
+
display-name: List tool versions
|
|
212
|
+
request:
|
|
213
|
+
name: ToolsListToolVersionsRequest
|
|
214
|
+
query-parameters:
|
|
215
|
+
page_number:
|
|
216
|
+
type: optional<integer>
|
|
426
217
|
docs: >-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
docs: Identifier for a Tool. Formatted as a UUID.
|
|
438
|
-
version:
|
|
439
|
-
type: integer
|
|
440
|
-
docs: >-
|
|
441
|
-
Version number for a Tool.
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This
|
|
445
|
-
versioning system supports iterative development, allowing you to
|
|
446
|
-
progressively refine tools and revert to previous versions if
|
|
447
|
-
needed.
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
Version numbers are integer values representing different iterations
|
|
451
|
-
of the Tool. Each update to the Tool increments its version number.
|
|
452
|
-
display-name: Get tool version
|
|
453
|
-
response:
|
|
454
|
-
docs: Success
|
|
455
|
-
type: optional<root.ReturnUserDefinedTool>
|
|
456
|
-
errors:
|
|
457
|
-
- root.BadRequestError
|
|
458
|
-
examples:
|
|
459
|
-
- path-parameters:
|
|
460
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
461
|
-
version: 1
|
|
462
|
-
response:
|
|
463
|
-
body:
|
|
464
|
-
tool_type: FUNCTION
|
|
465
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
466
|
-
version: 1
|
|
467
|
-
version_type: FIXED
|
|
468
|
-
version_description: >-
|
|
469
|
-
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
470
|
-
based on location of user.
|
|
471
|
-
name: string
|
|
472
|
-
created_on: 1715277014228
|
|
473
|
-
modified_on: 1715277602313
|
|
474
|
-
fallback_content: Unable to fetch current weather.
|
|
475
|
-
description: This tool is for getting the current weather.
|
|
476
|
-
parameters: >-
|
|
477
|
-
{ "type": "object", "properties": { "location": { "type":
|
|
478
|
-
"string", "description": "The city and state, e.g. San
|
|
479
|
-
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
480
|
-
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
481
|
-
temperature unit to use. Infer this from the users location." }
|
|
482
|
-
}, "required": ["location", "format"] }
|
|
483
|
-
delete-tool-version:
|
|
484
|
-
path: /v0/evi/tools/{id}/version/{version}
|
|
485
|
-
method: DELETE
|
|
486
|
-
auth: true
|
|
218
|
+
Specifies the page number to retrieve, enabling pagination.
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
This parameter uses zero-based indexing. For example, setting
|
|
222
|
+
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
223
|
+
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
224
|
+
second page (items 10-19), and so on. Defaults to 0, which
|
|
225
|
+
retrieves the first page.
|
|
226
|
+
page_size:
|
|
227
|
+
type: optional<integer>
|
|
487
228
|
docs: >-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
type: string
|
|
498
|
-
docs: Identifier for a Tool. Formatted as a UUID.
|
|
499
|
-
version:
|
|
500
|
-
type: integer
|
|
501
|
-
docs: >-
|
|
502
|
-
Version number for a Tool.
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This
|
|
506
|
-
versioning system supports iterative development, allowing you to
|
|
507
|
-
progressively refine tools and revert to previous versions if
|
|
508
|
-
needed.
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
Version numbers are integer values representing different iterations
|
|
512
|
-
of the Tool. Each update to the Tool increments its version number.
|
|
513
|
-
display-name: Delete tool version
|
|
514
|
-
errors:
|
|
515
|
-
- root.BadRequestError
|
|
516
|
-
examples:
|
|
517
|
-
- path-parameters:
|
|
518
|
-
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
519
|
-
version: 1
|
|
520
|
-
update-tool-description:
|
|
521
|
-
path: /v0/evi/tools/{id}/version/{version}
|
|
522
|
-
method: PATCH
|
|
523
|
-
auth: true
|
|
229
|
+
Specifies the maximum number of results to include per page,
|
|
230
|
+
enabling pagination. The value must be between 1 and 100,
|
|
231
|
+
inclusive.
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
For example, if `page_size` is set to 10, each page will include
|
|
235
|
+
up to 10 items. Defaults to 10.
|
|
236
|
+
restrict_to_most_recent:
|
|
237
|
+
type: optional<boolean>
|
|
524
238
|
docs: >-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
239
|
+
By default, `restrict_to_most_recent` is set to true, returning
|
|
240
|
+
only the latest version of each tool. To include all versions of
|
|
241
|
+
each tool in the list, set `restrict_to_most_recent` to false.
|
|
242
|
+
response:
|
|
243
|
+
docs: Success
|
|
244
|
+
type: root.ReturnPagedUserDefinedTools
|
|
245
|
+
errors:
|
|
246
|
+
- root.BadRequestError
|
|
247
|
+
examples:
|
|
248
|
+
- path-parameters:
|
|
249
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
250
|
+
response:
|
|
251
|
+
body:
|
|
252
|
+
page_number: 0
|
|
253
|
+
page_size: 10
|
|
254
|
+
total_pages: 1
|
|
255
|
+
tools_page:
|
|
256
|
+
- tool_type: FUNCTION
|
|
257
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
258
|
+
version: 1
|
|
259
|
+
version_type: FIXED
|
|
260
|
+
version_description: >-
|
|
261
|
+
Fetches current weather and uses celsius, fahrenheit, or
|
|
262
|
+
kelvin based on location of user.
|
|
263
|
+
name: get_current_weather
|
|
264
|
+
created_on: 1715277014228
|
|
265
|
+
modified_on: 1715277602313
|
|
266
|
+
fallback_content: Unable to fetch current weather.
|
|
267
|
+
description: This tool is for getting the current weather.
|
|
268
|
+
parameters: >-
|
|
269
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
270
|
+
"string", "description": "The city and state, e.g. San
|
|
271
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
272
|
+
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
273
|
+
temperature unit to use. Infer this from the users
|
|
274
|
+
location." } }, "required": ["location", "format"] }
|
|
275
|
+
create-tool-version:
|
|
276
|
+
path: /v0/evi/tools/{id}
|
|
277
|
+
method: POST
|
|
278
|
+
auth: true
|
|
279
|
+
docs: >-
|
|
280
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
Refer to our [tool
|
|
284
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
285
|
+
for comprehensive instructions on defining and integrating tools into
|
|
286
|
+
EVI.
|
|
287
|
+
path-parameters:
|
|
288
|
+
id:
|
|
289
|
+
type: string
|
|
290
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
291
|
+
display-name: Create tool version
|
|
292
|
+
request:
|
|
293
|
+
name: PostedUserDefinedToolVersion
|
|
294
|
+
body:
|
|
295
|
+
properties:
|
|
296
|
+
version_description:
|
|
297
|
+
type: optional<string>
|
|
298
|
+
docs: An optional description of the Tool version.
|
|
299
|
+
description:
|
|
300
|
+
type: optional<string>
|
|
301
|
+
docs: >-
|
|
302
|
+
An optional description of what the Tool does, used by the
|
|
303
|
+
supplemental LLM to choose when and how to call the function.
|
|
304
|
+
parameters:
|
|
305
|
+
type: string
|
|
306
|
+
docs: >-
|
|
307
|
+
Stringified JSON defining the parameters used by this version of
|
|
308
|
+
the Tool.
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
These parameters define the inputs needed for the Tool’s
|
|
312
|
+
execution, including the expected data type and description for
|
|
313
|
+
each input field. Structured as a stringified JSON schema, this
|
|
314
|
+
format ensures the Tool receives data in the expected format.
|
|
315
|
+
fallback_content:
|
|
316
|
+
type: optional<string>
|
|
317
|
+
docs: >-
|
|
318
|
+
Optional text passed to the supplemental LLM in place of the
|
|
319
|
+
tool call result. The LLM then uses this text to generate a
|
|
320
|
+
response back to the user, ensuring continuity in the
|
|
321
|
+
conversation if the Tool errors.
|
|
322
|
+
content-type: application/json
|
|
323
|
+
response:
|
|
324
|
+
docs: Created
|
|
325
|
+
type: optional<root.ReturnUserDefinedTool>
|
|
326
|
+
errors:
|
|
327
|
+
- root.BadRequestError
|
|
328
|
+
examples:
|
|
329
|
+
- path-parameters:
|
|
330
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
331
|
+
request:
|
|
332
|
+
parameters: >-
|
|
333
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
334
|
+
"string", "description": "The city and state, e.g. San Francisco,
|
|
335
|
+
CA" }, "format": { "type": "string", "enum": ["celsius",
|
|
336
|
+
"fahrenheit", "kelvin"], "description": "The temperature unit to
|
|
337
|
+
use. Infer this from the users location." } }, "required":
|
|
338
|
+
["location", "format"] }
|
|
339
|
+
version_description: >-
|
|
340
|
+
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
341
|
+
based on location of user.
|
|
342
|
+
fallback_content: Unable to fetch current weather.
|
|
343
|
+
description: This tool is for getting the current weather.
|
|
344
|
+
response:
|
|
345
|
+
body:
|
|
346
|
+
tool_type: FUNCTION
|
|
347
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
348
|
+
version: 1
|
|
349
|
+
version_type: FIXED
|
|
350
|
+
version_description: >-
|
|
351
|
+
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
352
|
+
based on location of user.
|
|
353
|
+
name: get_current_weather
|
|
354
|
+
created_on: 1715277014228
|
|
355
|
+
modified_on: 1715277602313
|
|
356
|
+
fallback_content: Unable to fetch current weather.
|
|
357
|
+
description: This tool is for getting the current weather.
|
|
358
|
+
parameters: >-
|
|
359
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
360
|
+
"string", "description": "The city and state, e.g. San
|
|
361
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
362
|
+
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
363
|
+
temperature unit to use. Infer this from the users location." }
|
|
364
|
+
}, "required": ["location", "format"] }
|
|
365
|
+
delete-tool:
|
|
366
|
+
path: /v0/evi/tools/{id}
|
|
367
|
+
method: DELETE
|
|
368
|
+
auth: true
|
|
369
|
+
docs: >-
|
|
370
|
+
Deletes a **Tool** and its versions.
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
Refer to our [tool
|
|
374
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
375
|
+
for comprehensive instructions on defining and integrating tools into
|
|
376
|
+
EVI.
|
|
377
|
+
path-parameters:
|
|
378
|
+
id:
|
|
379
|
+
type: string
|
|
380
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
381
|
+
display-name: Delete tool
|
|
382
|
+
errors:
|
|
383
|
+
- root.BadRequestError
|
|
384
|
+
examples:
|
|
385
|
+
- path-parameters:
|
|
386
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
387
|
+
update-tool-name:
|
|
388
|
+
path: /v0/evi/tools/{id}
|
|
389
|
+
method: PATCH
|
|
390
|
+
auth: true
|
|
391
|
+
docs: >-
|
|
392
|
+
Updates the name of a **Tool**.
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
Refer to our [tool
|
|
396
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
397
|
+
for comprehensive instructions on defining and integrating tools into
|
|
398
|
+
EVI.
|
|
399
|
+
path-parameters:
|
|
400
|
+
id:
|
|
401
|
+
type: string
|
|
402
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
403
|
+
display-name: Update tool name
|
|
404
|
+
request:
|
|
405
|
+
name: PostedUserDefinedToolName
|
|
406
|
+
body:
|
|
407
|
+
properties:
|
|
408
|
+
name:
|
|
409
|
+
type: string
|
|
410
|
+
docs: Name applied to all versions of a particular Tool.
|
|
411
|
+
content-type: application/json
|
|
412
|
+
response:
|
|
413
|
+
docs: Success
|
|
414
|
+
type: text
|
|
415
|
+
errors:
|
|
416
|
+
- root.BadRequestError
|
|
417
|
+
examples:
|
|
418
|
+
- path-parameters:
|
|
419
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
420
|
+
request:
|
|
421
|
+
name: get_current_temperature
|
|
422
|
+
get-tool-version:
|
|
423
|
+
path: /v0/evi/tools/{id}/version/{version}
|
|
424
|
+
method: GET
|
|
425
|
+
auth: true
|
|
426
|
+
docs: >-
|
|
427
|
+
Fetches a specified version of a **Tool**.
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
Refer to our [tool
|
|
431
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
432
|
+
for comprehensive instructions on defining and integrating tools into
|
|
433
|
+
EVI.
|
|
434
|
+
path-parameters:
|
|
435
|
+
id:
|
|
436
|
+
type: string
|
|
437
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
438
|
+
version:
|
|
439
|
+
type: integer
|
|
440
|
+
docs: >-
|
|
441
|
+
Version number for a Tool.
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This
|
|
445
|
+
versioning system supports iterative development, allowing you to
|
|
446
|
+
progressively refine tools and revert to previous versions if
|
|
447
|
+
needed.
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
Version numbers are integer values representing different iterations
|
|
451
|
+
of the Tool. Each update to the Tool increments its version number.
|
|
452
|
+
display-name: Get tool version
|
|
453
|
+
response:
|
|
454
|
+
docs: Success
|
|
455
|
+
type: optional<root.ReturnUserDefinedTool>
|
|
456
|
+
errors:
|
|
457
|
+
- root.BadRequestError
|
|
458
|
+
examples:
|
|
459
|
+
- path-parameters:
|
|
460
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
461
|
+
version: 1
|
|
462
|
+
response:
|
|
463
|
+
body:
|
|
464
|
+
tool_type: FUNCTION
|
|
465
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
466
|
+
version: 1
|
|
467
|
+
version_type: FIXED
|
|
468
|
+
version_description: >-
|
|
469
|
+
Fetches current weather and uses celsius, fahrenheit, or kelvin
|
|
470
|
+
based on location of user.
|
|
471
|
+
name: string
|
|
472
|
+
created_on: 1715277014228
|
|
473
|
+
modified_on: 1715277602313
|
|
474
|
+
fallback_content: Unable to fetch current weather.
|
|
475
|
+
description: This tool is for getting the current weather.
|
|
476
|
+
parameters: >-
|
|
477
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
478
|
+
"string", "description": "The city and state, e.g. San
|
|
479
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
480
|
+
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
481
|
+
temperature unit to use. Infer this from the users location." }
|
|
482
|
+
}, "required": ["location", "format"] }
|
|
483
|
+
delete-tool-version:
|
|
484
|
+
path: /v0/evi/tools/{id}/version/{version}
|
|
485
|
+
method: DELETE
|
|
486
|
+
auth: true
|
|
487
|
+
docs: >-
|
|
488
|
+
Deletes a specified version of a **Tool**.
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
Refer to our [tool
|
|
492
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
493
|
+
for comprehensive instructions on defining and integrating tools into
|
|
494
|
+
EVI.
|
|
495
|
+
path-parameters:
|
|
496
|
+
id:
|
|
497
|
+
type: string
|
|
498
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
499
|
+
version:
|
|
500
|
+
type: integer
|
|
501
|
+
docs: >-
|
|
502
|
+
Version number for a Tool.
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This
|
|
506
|
+
versioning system supports iterative development, allowing you to
|
|
507
|
+
progressively refine tools and revert to previous versions if
|
|
508
|
+
needed.
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
Version numbers are integer values representing different iterations
|
|
512
|
+
of the Tool. Each update to the Tool increments its version number.
|
|
513
|
+
display-name: Delete tool version
|
|
514
|
+
errors:
|
|
515
|
+
- root.BadRequestError
|
|
516
|
+
examples:
|
|
517
|
+
- path-parameters:
|
|
518
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
519
|
+
version: 1
|
|
520
|
+
update-tool-description:
|
|
521
|
+
path: /v0/evi/tools/{id}/version/{version}
|
|
522
|
+
method: PATCH
|
|
523
|
+
auth: true
|
|
524
|
+
docs: >-
|
|
525
|
+
Updates the description of a specified **Tool** version.
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
Refer to our [tool
|
|
529
|
+
use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
|
|
530
|
+
for comprehensive instructions on defining and integrating tools into
|
|
531
|
+
EVI.
|
|
532
|
+
path-parameters:
|
|
533
|
+
id:
|
|
534
|
+
type: string
|
|
535
|
+
docs: Identifier for a Tool. Formatted as a UUID.
|
|
536
|
+
version:
|
|
537
|
+
type: integer
|
|
538
|
+
docs: >-
|
|
539
|
+
Version number for a Tool.
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This
|
|
543
|
+
versioning system supports iterative development, allowing you to
|
|
544
|
+
progressively refine tools and revert to previous versions if
|
|
545
|
+
needed.
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
Version numbers are integer values representing different iterations
|
|
549
|
+
of the Tool. Each update to the Tool increments its version number.
|
|
550
|
+
display-name: Update tool description
|
|
551
|
+
request:
|
|
552
|
+
name: PostedUserDefinedToolVersionDescription
|
|
553
|
+
body:
|
|
554
|
+
properties:
|
|
555
|
+
version_description:
|
|
556
|
+
type: optional<string>
|
|
557
|
+
docs: An optional description of the Tool version.
|
|
558
|
+
content-type: application/json
|
|
559
|
+
response:
|
|
560
|
+
docs: Success
|
|
561
|
+
type: optional<root.ReturnUserDefinedTool>
|
|
562
|
+
errors:
|
|
563
|
+
- root.BadRequestError
|
|
564
|
+
examples:
|
|
565
|
+
- path-parameters:
|
|
566
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
567
|
+
version: 1
|
|
568
|
+
request:
|
|
569
|
+
version_description: >-
|
|
570
|
+
Fetches current temperature, precipitation, wind speed, AQI, and
|
|
571
|
+
other weather conditions. Uses Celsius, Fahrenheit, or kelvin
|
|
572
|
+
depending on user's region.
|
|
573
|
+
response:
|
|
574
|
+
body:
|
|
575
|
+
tool_type: FUNCTION
|
|
576
|
+
id: 00183a3f-79ba-413d-9f3b-609864268bea
|
|
577
|
+
version: 1
|
|
578
|
+
version_type: FIXED
|
|
579
|
+
version_description: >-
|
|
580
|
+
Fetches current temperature, precipitation, wind speed, AQI, and
|
|
581
|
+
other weather conditions. Uses Celsius, Fahrenheit, or kelvin
|
|
582
|
+
depending on user's region.
|
|
583
|
+
name: string
|
|
584
|
+
created_on: 1715277014228
|
|
585
|
+
modified_on: 1715277602313
|
|
586
|
+
fallback_content: Unable to fetch current weather.
|
|
587
|
+
description: This tool is for getting the current weather.
|
|
588
|
+
parameters: >-
|
|
589
|
+
{ "type": "object", "properties": { "location": { "type":
|
|
590
|
+
"string", "description": "The city and state, e.g. San
|
|
591
|
+
Francisco, CA" }, "format": { "type": "string", "enum":
|
|
592
|
+
["celsius", "fahrenheit", "kelvin"], "description": "The
|
|
593
|
+
temperature unit to use. Infer this from the users location." }
|
|
594
|
+
}, "required": ["location", "format"] }
|
|
595
|
+
source:
|
|
596
|
+
openapi: stenographer-openapi.json
|