hume 0.8.8 → 0.8.10
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/expression-measurement/batch.yml +86 -78
- package/.mock/definition/expression-measurement/stream.yml +4 -2
- package/.mock/fern.config.json +1 -1
- package/api/resources/empathicVoice/resources/chat/client/Client.js +3 -0
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +2 -2
- package/api/resources/empathicVoice/resources/chats/client/Client.js +2 -2
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/expressionMeasurement/resources/batch/types/CompletedState.d.ts +6 -0
- package/api/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/FacsScore.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.d.ts → api/resources/expressionMeasurement/resources/batch/types/FailedState.d.ts} +1 -1
- package/{dist/api/resources/expressionMeasurement/resources/batch/types/StateInferenceQueued.d.ts → api/resources/expressionMeasurement/resources/batch/types/InProgressState.d.ts} +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/InferenceRequest.d.ts +0 -2
- package/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceFailed.d.ts → QueuedState.d.ts} +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/SentimentScore.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/StateInference.d.ts +4 -4
- package/api/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.d.ts +0 -2
- package/api/resources/expressionMeasurement/resources/batch/types/ToxicityScore.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/index.d.ts +4 -4
- package/api/resources/expressionMeasurement/resources/batch/types/index.js +4 -4
- package/api/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.d.ts → JobDetails.d.ts} +1 -1
- package/api/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.d.ts +2 -0
- package/api/resources/expressionMeasurement/resources/stream/types/index.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/types/index.js +1 -1
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/core/websocket/ws.js +3 -0
- package/dist/api/resources/empathicVoice/resources/chat/client/Client.js +3 -0
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +2 -2
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +2 -2
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/expressionMeasurement/resources/batch/types/CompletedState.d.ts +6 -0
- package/dist/api/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/types/FacsScore.d.ts +1 -1
- package/{api/resources/expressionMeasurement/resources/batch/types/StateInferenceQueued.d.ts → dist/api/resources/expressionMeasurement/resources/batch/types/FailedState.d.ts} +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/types/InProgressState.d.ts +6 -0
- package/dist/api/resources/expressionMeasurement/resources/batch/types/InferenceRequest.d.ts +0 -2
- package/dist/api/resources/expressionMeasurement/resources/batch/types/QueuedState.d.ts +6 -0
- package/dist/api/resources/expressionMeasurement/resources/batch/types/SentimentScore.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/types/StateInference.d.ts +4 -4
- package/dist/api/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.d.ts +0 -2
- package/dist/api/resources/expressionMeasurement/resources/batch/types/ToxicityScore.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/types/index.d.ts +4 -4
- package/dist/api/resources/expressionMeasurement/resources/batch/types/index.js +4 -4
- package/dist/api/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.d.ts → JobDetails.d.ts} +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.d.ts +2 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/types/index.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/types/index.js +1 -1
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/core/websocket/ws.js +3 -0
- package/{serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceCompletedInference.d.ts → dist/serialization/resources/expressionMeasurement/resources/batch/types/CompletedState.d.ts} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceCompletedInference.js → CompletedState.js} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.d.ts +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/FacsScore.d.ts +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/FacsScore.js +1 -1
- package/{serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.d.ts → dist/serialization/resources/expressionMeasurement/resources/batch/types/FailedState.d.ts} +2 -2
- package/{serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.js → dist/serialization/resources/expressionMeasurement/resources/batch/types/FailedState.js} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceInProgress.d.ts → InProgressState.d.ts} +2 -2
- package/{serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceInProgress.js → dist/serialization/resources/expressionMeasurement/resources/batch/types/InProgressState.js} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/InferenceRequest.d.ts +0 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/InferenceRequest.js +0 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceQueued.d.ts → QueuedState.d.ts} +2 -2
- package/{serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceQueued.js → dist/serialization/resources/expressionMeasurement/resources/batch/types/QueuedState.js} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/SentimentScore.d.ts +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/SentimentScore.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInference.d.ts +8 -8
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInference.js +8 -8
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.d.ts +0 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.js +0 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/ToxicityScore.d.ts +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/ToxicityScore.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/index.d.ts +4 -4
- package/dist/serialization/resources/expressionMeasurement/resources/batch/types/index.js +4 -4
- package/{serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessageJobDetails.d.ts → dist/serialization/resources/expressionMeasurement/resources/stream/types/JobDetails.d.ts} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.js → JobDetails.js} +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.d.ts +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.js +2 -2
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.d.ts +2 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.js +2 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/index.d.ts +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/index.js +1 -1
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/version.d.ts +1 -0
- package/dist/version.js +4 -0
- package/package.json +1 -1
- package/reference.md +505 -505
- package/{dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceCompletedInference.d.ts → serialization/resources/expressionMeasurement/resources/batch/types/CompletedState.d.ts} +2 -2
- package/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceCompletedInference.js → CompletedState.js} +2 -2
- package/serialization/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.d.ts +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/DescriptionsScore.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/FacsScore.d.ts +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/FacsScore.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.d.ts → serialization/resources/expressionMeasurement/resources/batch/types/FailedState.d.ts} +2 -2
- package/{dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.js → serialization/resources/expressionMeasurement/resources/batch/types/FailedState.js} +2 -2
- package/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceInProgress.d.ts → InProgressState.d.ts} +2 -2
- package/{dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceInProgress.js → serialization/resources/expressionMeasurement/resources/batch/types/InProgressState.js} +2 -2
- package/serialization/resources/expressionMeasurement/resources/batch/types/InferenceRequest.d.ts +0 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/InferenceRequest.js +0 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/{StateInferenceQueued.d.ts → QueuedState.d.ts} +2 -2
- package/{dist/serialization/resources/expressionMeasurement/resources/batch/types/StateInferenceQueued.js → serialization/resources/expressionMeasurement/resources/batch/types/QueuedState.js} +2 -2
- package/serialization/resources/expressionMeasurement/resources/batch/types/SentimentScore.d.ts +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/SentimentScore.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/StateInference.d.ts +8 -8
- package/serialization/resources/expressionMeasurement/resources/batch/types/StateInference.js +8 -8
- package/serialization/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.d.ts +0 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.js +0 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/ToxicityScore.d.ts +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/ToxicityScore.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/batch/types/index.d.ts +4 -4
- package/serialization/resources/expressionMeasurement/resources/batch/types/index.js +4 -4
- package/{dist/serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessageJobDetails.d.ts → serialization/resources/expressionMeasurement/resources/stream/types/JobDetails.d.ts} +2 -2
- package/serialization/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.js → JobDetails.js} +2 -2
- package/serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.d.ts +2 -2
- package/serialization/resources/expressionMeasurement/resources/stream/types/StreamErrorMessage.js +2 -2
- package/serialization/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.d.ts +2 -0
- package/serialization/resources/expressionMeasurement/resources/stream/types/StreamModelsEndpointPayload.js +2 -0
- package/serialization/resources/expressionMeasurement/resources/stream/types/index.d.ts +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/types/index.js +1 -1
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/version.d.ts +1 -0
- package/version.js +4 -0
- package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceCompletedInference.d.ts +0 -6
- package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceInProgress.d.ts +0 -6
- package/dist/api/resources/expressionMeasurement/resources/batch/types/StateInferenceCompletedInference.d.ts +0 -6
- package/dist/api/resources/expressionMeasurement/resources/batch/types/StateInferenceInProgress.d.ts +0 -6
- /package/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceCompletedInference.js → CompletedState.js} +0 -0
- /package/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceFailed.js → FailedState.js} +0 -0
- /package/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceInProgress.js → InProgressState.js} +0 -0
- /package/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceQueued.js → QueuedState.js} +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.js → JobDetails.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceCompletedInference.js → CompletedState.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceFailed.js → FailedState.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceInProgress.js → InProgressState.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/batch/types/{StateInferenceQueued.js → QueuedState.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/types/{StreamErrorMessageJobDetails.js → JobDetails.js} +0 -0
package/reference.md
CHANGED
|
@@ -1,26 +1,11 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
6
|
-
<dl>
|
|
7
|
-
<dd>
|
|
8
|
-
|
|
9
|
-
#### 📝 Description
|
|
10
|
-
|
|
11
|
-
<dl>
|
|
12
|
-
<dd>
|
|
3
|
+
## EmpathicVoice Tools
|
|
13
4
|
|
|
5
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
|
|
14
6
|
<dl>
|
|
15
7
|
<dd>
|
|
16
8
|
|
|
17
|
-
Sort and filter jobs.
|
|
18
|
-
|
|
19
|
-
</dd>
|
|
20
|
-
</dl>
|
|
21
|
-
</dd>
|
|
22
|
-
</dl>
|
|
23
|
-
|
|
24
9
|
#### 🔌 Usage
|
|
25
10
|
|
|
26
11
|
<dl>
|
|
@@ -30,7 +15,10 @@ Sort and filter jobs.
|
|
|
30
15
|
<dd>
|
|
31
16
|
|
|
32
17
|
```typescript
|
|
33
|
-
await client.
|
|
18
|
+
await client.empathicVoice.tools.listTools({
|
|
19
|
+
pageNumber: 0,
|
|
20
|
+
pageSize: 2,
|
|
21
|
+
});
|
|
34
22
|
```
|
|
35
23
|
|
|
36
24
|
</dd>
|
|
@@ -46,7 +34,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
46
34
|
<dl>
|
|
47
35
|
<dd>
|
|
48
36
|
|
|
49
|
-
**request:** `Hume.
|
|
37
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
50
38
|
|
|
51
39
|
</dd>
|
|
52
40
|
</dl>
|
|
@@ -54,7 +42,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
54
42
|
<dl>
|
|
55
43
|
<dd>
|
|
56
44
|
|
|
57
|
-
**requestOptions:** `
|
|
45
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
58
46
|
|
|
59
47
|
</dd>
|
|
60
48
|
</dl>
|
|
@@ -65,25 +53,10 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
65
53
|
</dl>
|
|
66
54
|
</details>
|
|
67
55
|
|
|
68
|
-
<details><summary><code>client.
|
|
69
|
-
<dl>
|
|
70
|
-
<dd>
|
|
71
|
-
|
|
72
|
-
#### 📝 Description
|
|
73
|
-
|
|
74
|
-
<dl>
|
|
75
|
-
<dd>
|
|
76
|
-
|
|
56
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
77
57
|
<dl>
|
|
78
58
|
<dd>
|
|
79
59
|
|
|
80
|
-
Start a new measurement inference job.
|
|
81
|
-
|
|
82
|
-
</dd>
|
|
83
|
-
</dl>
|
|
84
|
-
</dd>
|
|
85
|
-
</dl>
|
|
86
|
-
|
|
87
60
|
#### 🔌 Usage
|
|
88
61
|
|
|
89
62
|
<dl>
|
|
@@ -93,9 +66,13 @@ Start a new measurement inference job.
|
|
|
93
66
|
<dd>
|
|
94
67
|
|
|
95
68
|
```typescript
|
|
96
|
-
await client.
|
|
97
|
-
|
|
98
|
-
|
|
69
|
+
await client.empathicVoice.tools.createTool({
|
|
70
|
+
name: "get_current_weather",
|
|
71
|
+
parameters:
|
|
72
|
+
'{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
|
|
73
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
74
|
+
description: "This tool is for getting the current weather.",
|
|
75
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
99
76
|
});
|
|
100
77
|
```
|
|
101
78
|
|
|
@@ -112,7 +89,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
112
89
|
<dl>
|
|
113
90
|
<dd>
|
|
114
91
|
|
|
115
|
-
**request:** `Hume.
|
|
92
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
116
93
|
|
|
117
94
|
</dd>
|
|
118
95
|
</dl>
|
|
@@ -120,7 +97,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
120
97
|
<dl>
|
|
121
98
|
<dd>
|
|
122
99
|
|
|
123
|
-
**requestOptions:** `
|
|
100
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
124
101
|
|
|
125
102
|
</dd>
|
|
126
103
|
</dl>
|
|
@@ -131,11 +108,11 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
131
108
|
</dl>
|
|
132
109
|
</details>
|
|
133
110
|
|
|
134
|
-
<details><summary><code>client.
|
|
111
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools</code></summary>
|
|
135
112
|
<dl>
|
|
136
113
|
<dd>
|
|
137
114
|
|
|
138
|
-
####
|
|
115
|
+
#### 🔌 Usage
|
|
139
116
|
|
|
140
117
|
<dl>
|
|
141
118
|
<dd>
|
|
@@ -143,14 +120,16 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
143
120
|
<dl>
|
|
144
121
|
<dd>
|
|
145
122
|
|
|
146
|
-
|
|
123
|
+
```typescript
|
|
124
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
125
|
+
```
|
|
147
126
|
|
|
148
127
|
</dd>
|
|
149
128
|
</dl>
|
|
150
129
|
</dd>
|
|
151
130
|
</dl>
|
|
152
131
|
|
|
153
|
-
####
|
|
132
|
+
#### ⚙️ Parameters
|
|
154
133
|
|
|
155
134
|
<dl>
|
|
156
135
|
<dd>
|
|
@@ -158,24 +137,15 @@ Get the request details and state of a given job.
|
|
|
158
137
|
<dl>
|
|
159
138
|
<dd>
|
|
160
139
|
|
|
161
|
-
|
|
162
|
-
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
163
|
-
```
|
|
140
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
164
141
|
|
|
165
142
|
</dd>
|
|
166
143
|
</dl>
|
|
167
|
-
</dd>
|
|
168
|
-
</dl>
|
|
169
|
-
|
|
170
|
-
#### ⚙️ Parameters
|
|
171
|
-
|
|
172
|
-
<dl>
|
|
173
|
-
<dd>
|
|
174
144
|
|
|
175
145
|
<dl>
|
|
176
146
|
<dd>
|
|
177
147
|
|
|
178
|
-
**
|
|
148
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
179
149
|
|
|
180
150
|
</dd>
|
|
181
151
|
</dl>
|
|
@@ -183,7 +153,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
183
153
|
<dl>
|
|
184
154
|
<dd>
|
|
185
155
|
|
|
186
|
-
**requestOptions:** `
|
|
156
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
187
157
|
|
|
188
158
|
</dd>
|
|
189
159
|
</dl>
|
|
@@ -194,11 +164,11 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
194
164
|
</dl>
|
|
195
165
|
</details>
|
|
196
166
|
|
|
197
|
-
<details><summary><code>client.
|
|
167
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
198
168
|
<dl>
|
|
199
169
|
<dd>
|
|
200
170
|
|
|
201
|
-
####
|
|
171
|
+
#### 🔌 Usage
|
|
202
172
|
|
|
203
173
|
<dl>
|
|
204
174
|
<dd>
|
|
@@ -206,14 +176,22 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
206
176
|
<dl>
|
|
207
177
|
<dd>
|
|
208
178
|
|
|
209
|
-
|
|
179
|
+
```typescript
|
|
180
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
181
|
+
parameters:
|
|
182
|
+
'{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit", "kelvin"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
|
|
183
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
184
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
185
|
+
description: "This tool is for getting the current weather.",
|
|
186
|
+
});
|
|
187
|
+
```
|
|
210
188
|
|
|
211
189
|
</dd>
|
|
212
190
|
</dl>
|
|
213
191
|
</dd>
|
|
214
192
|
</dl>
|
|
215
193
|
|
|
216
|
-
####
|
|
194
|
+
#### ⚙️ Parameters
|
|
217
195
|
|
|
218
196
|
<dl>
|
|
219
197
|
<dd>
|
|
@@ -221,24 +199,15 @@ Get the JSON predictions of a completed inference job.
|
|
|
221
199
|
<dl>
|
|
222
200
|
<dd>
|
|
223
201
|
|
|
224
|
-
|
|
225
|
-
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
226
|
-
```
|
|
202
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
227
203
|
|
|
228
204
|
</dd>
|
|
229
205
|
</dl>
|
|
230
|
-
</dd>
|
|
231
|
-
</dl>
|
|
232
|
-
|
|
233
|
-
#### ⚙️ Parameters
|
|
234
206
|
|
|
235
207
|
<dl>
|
|
236
208
|
<dd>
|
|
237
209
|
|
|
238
|
-
|
|
239
|
-
<dd>
|
|
240
|
-
|
|
241
|
-
**id:** `string` — The unique identifier for the job.
|
|
210
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
242
211
|
|
|
243
212
|
</dd>
|
|
244
213
|
</dl>
|
|
@@ -246,7 +215,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
246
215
|
<dl>
|
|
247
216
|
<dd>
|
|
248
217
|
|
|
249
|
-
**requestOptions:** `
|
|
218
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
250
219
|
|
|
251
220
|
</dd>
|
|
252
221
|
</dl>
|
|
@@ -257,25 +226,10 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
257
226
|
</dl>
|
|
258
227
|
</details>
|
|
259
228
|
|
|
260
|
-
<details><summary><code>client.
|
|
261
|
-
<dl>
|
|
262
|
-
<dd>
|
|
263
|
-
|
|
264
|
-
#### 📝 Description
|
|
265
|
-
|
|
266
|
-
<dl>
|
|
267
|
-
<dd>
|
|
268
|
-
|
|
229
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
269
230
|
<dl>
|
|
270
231
|
<dd>
|
|
271
232
|
|
|
272
|
-
Get the artifacts ZIP of a completed inference job.
|
|
273
|
-
|
|
274
|
-
</dd>
|
|
275
|
-
</dl>
|
|
276
|
-
</dd>
|
|
277
|
-
</dl>
|
|
278
|
-
|
|
279
233
|
#### 🔌 Usage
|
|
280
234
|
|
|
281
235
|
<dl>
|
|
@@ -285,7 +239,7 @@ Get the artifacts ZIP of a completed inference job.
|
|
|
285
239
|
<dd>
|
|
286
240
|
|
|
287
241
|
```typescript
|
|
288
|
-
await client.
|
|
242
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
289
243
|
```
|
|
290
244
|
|
|
291
245
|
</dd>
|
|
@@ -301,7 +255,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
301
255
|
<dl>
|
|
302
256
|
<dd>
|
|
303
257
|
|
|
304
|
-
**id:** `string` —
|
|
258
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
305
259
|
|
|
306
260
|
</dd>
|
|
307
261
|
</dl>
|
|
@@ -309,7 +263,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
309
263
|
<dl>
|
|
310
264
|
<dd>
|
|
311
265
|
|
|
312
|
-
**requestOptions:** `
|
|
266
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
313
267
|
|
|
314
268
|
</dd>
|
|
315
269
|
</dl>
|
|
@@ -320,25 +274,10 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
320
274
|
</dl>
|
|
321
275
|
</details>
|
|
322
276
|
|
|
323
|
-
<details><summary><code>client.
|
|
324
|
-
<dl>
|
|
325
|
-
<dd>
|
|
326
|
-
|
|
327
|
-
#### 📝 Description
|
|
328
|
-
|
|
329
|
-
<dl>
|
|
330
|
-
<dd>
|
|
331
|
-
|
|
277
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
332
278
|
<dl>
|
|
333
279
|
<dd>
|
|
334
280
|
|
|
335
|
-
Start a new batch inference job.
|
|
336
|
-
|
|
337
|
-
</dd>
|
|
338
|
-
</dl>
|
|
339
|
-
</dd>
|
|
340
|
-
</dl>
|
|
341
|
-
|
|
342
281
|
#### 🔌 Usage
|
|
343
282
|
|
|
344
283
|
<dl>
|
|
@@ -348,10 +287,9 @@ Start a new batch inference job.
|
|
|
348
287
|
<dd>
|
|
349
288
|
|
|
350
289
|
```typescript
|
|
351
|
-
await client.
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
);
|
|
290
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
291
|
+
name: "get_current_temperature",
|
|
292
|
+
});
|
|
355
293
|
```
|
|
356
294
|
|
|
357
295
|
</dd>
|
|
@@ -367,7 +305,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
367
305
|
<dl>
|
|
368
306
|
<dd>
|
|
369
307
|
|
|
370
|
-
**
|
|
308
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
371
309
|
|
|
372
310
|
</dd>
|
|
373
311
|
</dl>
|
|
@@ -375,7 +313,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
375
313
|
<dl>
|
|
376
314
|
<dd>
|
|
377
315
|
|
|
378
|
-
**request:** `Hume.
|
|
316
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
379
317
|
|
|
380
318
|
</dd>
|
|
381
319
|
</dl>
|
|
@@ -383,7 +321,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
383
321
|
<dl>
|
|
384
322
|
<dd>
|
|
385
323
|
|
|
386
|
-
**requestOptions:** `
|
|
324
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
387
325
|
|
|
388
326
|
</dd>
|
|
389
327
|
</dl>
|
|
@@ -394,9 +332,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
394
332
|
</dl>
|
|
395
333
|
</details>
|
|
396
334
|
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
|
|
335
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
400
336
|
<dl>
|
|
401
337
|
<dd>
|
|
402
338
|
|
|
@@ -409,10 +345,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
409
345
|
<dd>
|
|
410
346
|
|
|
411
347
|
```typescript
|
|
412
|
-
await client.empathicVoice.tools.
|
|
413
|
-
pageNumber: 0,
|
|
414
|
-
pageSize: 2,
|
|
415
|
-
});
|
|
348
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
416
349
|
```
|
|
417
350
|
|
|
418
351
|
</dd>
|
|
@@ -428,7 +361,21 @@ await client.empathicVoice.tools.listTools({
|
|
|
428
361
|
<dl>
|
|
429
362
|
<dd>
|
|
430
363
|
|
|
431
|
-
**
|
|
364
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
365
|
+
|
|
366
|
+
</dd>
|
|
367
|
+
</dl>
|
|
368
|
+
|
|
369
|
+
<dl>
|
|
370
|
+
<dd>
|
|
371
|
+
|
|
372
|
+
**version:** `number`
|
|
373
|
+
|
|
374
|
+
Version number for a Tool.
|
|
375
|
+
|
|
376
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
377
|
+
|
|
378
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
432
379
|
|
|
433
380
|
</dd>
|
|
434
381
|
</dl>
|
|
@@ -447,7 +394,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
447
394
|
</dl>
|
|
448
395
|
</details>
|
|
449
396
|
|
|
450
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
397
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
451
398
|
<dl>
|
|
452
399
|
<dd>
|
|
453
400
|
|
|
@@ -460,14 +407,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
460
407
|
<dd>
|
|
461
408
|
|
|
462
409
|
```typescript
|
|
463
|
-
await client.empathicVoice.tools.
|
|
464
|
-
name: "get_current_weather",
|
|
465
|
-
parameters:
|
|
466
|
-
'{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
|
|
467
|
-
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
468
|
-
description: "This tool is for getting the current weather.",
|
|
469
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
470
|
-
});
|
|
410
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
471
411
|
```
|
|
472
412
|
|
|
473
413
|
</dd>
|
|
@@ -483,7 +423,21 @@ await client.empathicVoice.tools.createTool({
|
|
|
483
423
|
<dl>
|
|
484
424
|
<dd>
|
|
485
425
|
|
|
486
|
-
**
|
|
426
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
427
|
+
|
|
428
|
+
</dd>
|
|
429
|
+
</dl>
|
|
430
|
+
|
|
431
|
+
<dl>
|
|
432
|
+
<dd>
|
|
433
|
+
|
|
434
|
+
**version:** `number`
|
|
435
|
+
|
|
436
|
+
Version number for a Tool.
|
|
437
|
+
|
|
438
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
439
|
+
|
|
440
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
487
441
|
|
|
488
442
|
</dd>
|
|
489
443
|
</dl>
|
|
@@ -502,7 +456,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
502
456
|
</dl>
|
|
503
457
|
</details>
|
|
504
458
|
|
|
505
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
459
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
506
460
|
<dl>
|
|
507
461
|
<dd>
|
|
508
462
|
|
|
@@ -515,7 +469,10 @@ await client.empathicVoice.tools.createTool({
|
|
|
515
469
|
<dd>
|
|
516
470
|
|
|
517
471
|
```typescript
|
|
518
|
-
await client.empathicVoice.tools.
|
|
472
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
473
|
+
versionDescription:
|
|
474
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
475
|
+
});
|
|
519
476
|
```
|
|
520
477
|
|
|
521
478
|
</dd>
|
|
@@ -539,7 +496,21 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
539
496
|
<dl>
|
|
540
497
|
<dd>
|
|
541
498
|
|
|
542
|
-
**
|
|
499
|
+
**version:** `number`
|
|
500
|
+
|
|
501
|
+
Version number for a Tool.
|
|
502
|
+
|
|
503
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
504
|
+
|
|
505
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
506
|
+
|
|
507
|
+
</dd>
|
|
508
|
+
</dl>
|
|
509
|
+
|
|
510
|
+
<dl>
|
|
511
|
+
<dd>
|
|
512
|
+
|
|
513
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
543
514
|
|
|
544
515
|
</dd>
|
|
545
516
|
</dl>
|
|
@@ -558,7 +529,9 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
558
529
|
</dl>
|
|
559
530
|
</details>
|
|
560
531
|
|
|
561
|
-
|
|
532
|
+
## EmpathicVoice Prompts
|
|
533
|
+
|
|
534
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
562
535
|
<dl>
|
|
563
536
|
<dd>
|
|
564
537
|
|
|
@@ -571,12 +544,9 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
571
544
|
<dd>
|
|
572
545
|
|
|
573
546
|
```typescript
|
|
574
|
-
await client.empathicVoice.
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
578
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
579
|
-
description: "This tool is for getting the current weather.",
|
|
547
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
548
|
+
pageNumber: 0,
|
|
549
|
+
pageSize: 2,
|
|
580
550
|
});
|
|
581
551
|
```
|
|
582
552
|
|
|
@@ -593,15 +563,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
593
563
|
<dl>
|
|
594
564
|
<dd>
|
|
595
565
|
|
|
596
|
-
**
|
|
597
|
-
|
|
598
|
-
</dd>
|
|
599
|
-
</dl>
|
|
600
|
-
|
|
601
|
-
<dl>
|
|
602
|
-
<dd>
|
|
603
|
-
|
|
604
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
566
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
605
567
|
|
|
606
568
|
</dd>
|
|
607
569
|
</dl>
|
|
@@ -609,7 +571,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
609
571
|
<dl>
|
|
610
572
|
<dd>
|
|
611
573
|
|
|
612
|
-
**requestOptions:** `
|
|
574
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
613
575
|
|
|
614
576
|
</dd>
|
|
615
577
|
</dl>
|
|
@@ -620,7 +582,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
620
582
|
</dl>
|
|
621
583
|
</details>
|
|
622
584
|
|
|
623
|
-
<details><summary><code>client.empathicVoice.
|
|
585
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
624
586
|
<dl>
|
|
625
587
|
<dd>
|
|
626
588
|
|
|
@@ -633,7 +595,10 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
633
595
|
<dd>
|
|
634
596
|
|
|
635
597
|
```typescript
|
|
636
|
-
await client.empathicVoice.
|
|
598
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
599
|
+
name: "Weather Assistant Prompt",
|
|
600
|
+
text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
601
|
+
});
|
|
637
602
|
```
|
|
638
603
|
|
|
639
604
|
</dd>
|
|
@@ -649,7 +614,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
649
614
|
<dl>
|
|
650
615
|
<dd>
|
|
651
616
|
|
|
652
|
-
**
|
|
617
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
653
618
|
|
|
654
619
|
</dd>
|
|
655
620
|
</dl>
|
|
@@ -657,7 +622,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
657
622
|
<dl>
|
|
658
623
|
<dd>
|
|
659
624
|
|
|
660
|
-
**requestOptions:** `
|
|
625
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
661
626
|
|
|
662
627
|
</dd>
|
|
663
628
|
</dl>
|
|
@@ -668,7 +633,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
668
633
|
</dl>
|
|
669
634
|
</details>
|
|
670
635
|
|
|
671
|
-
<details><summary><code>client.empathicVoice.
|
|
636
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
|
|
672
637
|
<dl>
|
|
673
638
|
<dd>
|
|
674
639
|
|
|
@@ -681,9 +646,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
681
646
|
<dd>
|
|
682
647
|
|
|
683
648
|
```typescript
|
|
684
|
-
await client.empathicVoice.
|
|
685
|
-
name: "get_current_temperature",
|
|
686
|
-
});
|
|
649
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
687
650
|
```
|
|
688
651
|
|
|
689
652
|
</dd>
|
|
@@ -699,7 +662,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
699
662
|
<dl>
|
|
700
663
|
<dd>
|
|
701
664
|
|
|
702
|
-
**id:** `string` — Identifier for a
|
|
665
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
703
666
|
|
|
704
667
|
</dd>
|
|
705
668
|
</dl>
|
|
@@ -707,7 +670,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
707
670
|
<dl>
|
|
708
671
|
<dd>
|
|
709
672
|
|
|
710
|
-
**request:** `Hume.empathicVoice.
|
|
673
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
711
674
|
|
|
712
675
|
</dd>
|
|
713
676
|
</dl>
|
|
@@ -715,7 +678,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
715
678
|
<dl>
|
|
716
679
|
<dd>
|
|
717
680
|
|
|
718
|
-
**requestOptions:** `
|
|
681
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
719
682
|
|
|
720
683
|
</dd>
|
|
721
684
|
</dl>
|
|
@@ -726,7 +689,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
726
689
|
</dl>
|
|
727
690
|
</details>
|
|
728
691
|
|
|
729
|
-
<details><summary><code>client.empathicVoice.
|
|
692
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVerison</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
730
693
|
<dl>
|
|
731
694
|
<dd>
|
|
732
695
|
|
|
@@ -739,7 +702,10 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
739
702
|
<dd>
|
|
740
703
|
|
|
741
704
|
```typescript
|
|
742
|
-
await client.empathicVoice.
|
|
705
|
+
await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
706
|
+
text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
707
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
708
|
+
});
|
|
743
709
|
```
|
|
744
710
|
|
|
745
711
|
</dd>
|
|
@@ -755,7 +721,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
755
721
|
<dl>
|
|
756
722
|
<dd>
|
|
757
723
|
|
|
758
|
-
**id:** `string` — Identifier for a
|
|
724
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
759
725
|
|
|
760
726
|
</dd>
|
|
761
727
|
</dl>
|
|
@@ -763,13 +729,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
763
729
|
<dl>
|
|
764
730
|
<dd>
|
|
765
731
|
|
|
766
|
-
**
|
|
767
|
-
|
|
768
|
-
Version number for a Tool.
|
|
769
|
-
|
|
770
|
-
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
771
|
-
|
|
772
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
732
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
773
733
|
|
|
774
734
|
</dd>
|
|
775
735
|
</dl>
|
|
@@ -777,7 +737,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
777
737
|
<dl>
|
|
778
738
|
<dd>
|
|
779
739
|
|
|
780
|
-
**requestOptions:** `
|
|
740
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
781
741
|
|
|
782
742
|
</dd>
|
|
783
743
|
</dl>
|
|
@@ -788,7 +748,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
788
748
|
</dl>
|
|
789
749
|
</details>
|
|
790
750
|
|
|
791
|
-
<details><summary><code>client.empathicVoice.
|
|
751
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
792
752
|
<dl>
|
|
793
753
|
<dd>
|
|
794
754
|
|
|
@@ -801,7 +761,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
801
761
|
<dd>
|
|
802
762
|
|
|
803
763
|
```typescript
|
|
804
|
-
await client.empathicVoice.
|
|
764
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
805
765
|
```
|
|
806
766
|
|
|
807
767
|
</dd>
|
|
@@ -817,21 +777,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
817
777
|
<dl>
|
|
818
778
|
<dd>
|
|
819
779
|
|
|
820
|
-
**id:** `string` — Identifier for a
|
|
821
|
-
|
|
822
|
-
</dd>
|
|
823
|
-
</dl>
|
|
824
|
-
|
|
825
|
-
<dl>
|
|
826
|
-
<dd>
|
|
827
|
-
|
|
828
|
-
**version:** `number`
|
|
829
|
-
|
|
830
|
-
Version number for a Tool.
|
|
831
|
-
|
|
832
|
-
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
833
|
-
|
|
834
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
780
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
835
781
|
|
|
836
782
|
</dd>
|
|
837
783
|
</dl>
|
|
@@ -839,7 +785,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
839
785
|
<dl>
|
|
840
786
|
<dd>
|
|
841
787
|
|
|
842
|
-
**requestOptions:** `
|
|
788
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
843
789
|
|
|
844
790
|
</dd>
|
|
845
791
|
</dl>
|
|
@@ -850,7 +796,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
850
796
|
</dl>
|
|
851
797
|
</details>
|
|
852
798
|
|
|
853
|
-
<details><summary><code>client.empathicVoice.
|
|
799
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
854
800
|
<dl>
|
|
855
801
|
<dd>
|
|
856
802
|
|
|
@@ -863,9 +809,8 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
863
809
|
<dd>
|
|
864
810
|
|
|
865
811
|
```typescript
|
|
866
|
-
await client.empathicVoice.
|
|
867
|
-
|
|
868
|
-
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
812
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
813
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
869
814
|
});
|
|
870
815
|
```
|
|
871
816
|
|
|
@@ -882,21 +827,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
882
827
|
<dl>
|
|
883
828
|
<dd>
|
|
884
829
|
|
|
885
|
-
**id:** `string` — Identifier for a
|
|
886
|
-
|
|
887
|
-
</dd>
|
|
888
|
-
</dl>
|
|
889
|
-
|
|
890
|
-
<dl>
|
|
891
|
-
<dd>
|
|
892
|
-
|
|
893
|
-
**version:** `number`
|
|
894
|
-
|
|
895
|
-
Version number for a Tool.
|
|
896
|
-
|
|
897
|
-
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
898
|
-
|
|
899
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
830
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
900
831
|
|
|
901
832
|
</dd>
|
|
902
833
|
</dl>
|
|
@@ -904,7 +835,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
904
835
|
<dl>
|
|
905
836
|
<dd>
|
|
906
837
|
|
|
907
|
-
**request:** `Hume.empathicVoice.
|
|
838
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
908
839
|
|
|
909
840
|
</dd>
|
|
910
841
|
</dl>
|
|
@@ -912,7 +843,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
912
843
|
<dl>
|
|
913
844
|
<dd>
|
|
914
845
|
|
|
915
|
-
**requestOptions:** `
|
|
846
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
916
847
|
|
|
917
848
|
</dd>
|
|
918
849
|
</dl>
|
|
@@ -923,9 +854,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
923
854
|
</dl>
|
|
924
855
|
</details>
|
|
925
856
|
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
857
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
929
858
|
<dl>
|
|
930
859
|
<dd>
|
|
931
860
|
|
|
@@ -938,10 +867,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
938
867
|
<dd>
|
|
939
868
|
|
|
940
869
|
```typescript
|
|
941
|
-
await client.empathicVoice.prompts.
|
|
942
|
-
pageNumber: 0,
|
|
943
|
-
pageSize: 2,
|
|
944
|
-
});
|
|
870
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
945
871
|
```
|
|
946
872
|
|
|
947
873
|
</dd>
|
|
@@ -957,7 +883,21 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
957
883
|
<dl>
|
|
958
884
|
<dd>
|
|
959
885
|
|
|
960
|
-
**
|
|
886
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
887
|
+
|
|
888
|
+
</dd>
|
|
889
|
+
</dl>
|
|
890
|
+
|
|
891
|
+
<dl>
|
|
892
|
+
<dd>
|
|
893
|
+
|
|
894
|
+
**version:** `number`
|
|
895
|
+
|
|
896
|
+
Version number for a Prompt.
|
|
897
|
+
|
|
898
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
899
|
+
|
|
900
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
961
901
|
|
|
962
902
|
</dd>
|
|
963
903
|
</dl>
|
|
@@ -976,7 +916,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
976
916
|
</dl>
|
|
977
917
|
</details>
|
|
978
918
|
|
|
979
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
919
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
980
920
|
<dl>
|
|
981
921
|
<dd>
|
|
982
922
|
|
|
@@ -989,10 +929,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
989
929
|
<dd>
|
|
990
930
|
|
|
991
931
|
```typescript
|
|
992
|
-
await client.empathicVoice.prompts.
|
|
993
|
-
name: "Weather Assistant Prompt",
|
|
994
|
-
text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
995
|
-
});
|
|
932
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
996
933
|
```
|
|
997
934
|
|
|
998
935
|
</dd>
|
|
@@ -1008,7 +945,21 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1008
945
|
<dl>
|
|
1009
946
|
<dd>
|
|
1010
947
|
|
|
1011
|
-
**
|
|
948
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
949
|
+
|
|
950
|
+
</dd>
|
|
951
|
+
</dl>
|
|
952
|
+
|
|
953
|
+
<dl>
|
|
954
|
+
<dd>
|
|
955
|
+
|
|
956
|
+
**version:** `number`
|
|
957
|
+
|
|
958
|
+
Version number for a Prompt.
|
|
959
|
+
|
|
960
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
961
|
+
|
|
962
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1012
963
|
|
|
1013
964
|
</dd>
|
|
1014
965
|
</dl>
|
|
@@ -1027,7 +978,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1027
978
|
</dl>
|
|
1028
979
|
</details>
|
|
1029
980
|
|
|
1030
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
981
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
1031
982
|
<dl>
|
|
1032
983
|
<dd>
|
|
1033
984
|
|
|
@@ -1040,7 +991,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1040
991
|
<dd>
|
|
1041
992
|
|
|
1042
993
|
```typescript
|
|
1043
|
-
await client.empathicVoice.prompts.
|
|
994
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
995
|
+
versionDescription: "This is an updated version_description.",
|
|
996
|
+
});
|
|
1044
997
|
```
|
|
1045
998
|
|
|
1046
999
|
</dd>
|
|
@@ -1064,7 +1017,21 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1064
1017
|
<dl>
|
|
1065
1018
|
<dd>
|
|
1066
1019
|
|
|
1067
|
-
**
|
|
1020
|
+
**version:** `number`
|
|
1021
|
+
|
|
1022
|
+
Version number for a Prompt.
|
|
1023
|
+
|
|
1024
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1025
|
+
|
|
1026
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1027
|
+
|
|
1028
|
+
</dd>
|
|
1029
|
+
</dl>
|
|
1030
|
+
|
|
1031
|
+
<dl>
|
|
1032
|
+
<dd>
|
|
1033
|
+
|
|
1034
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1068
1035
|
|
|
1069
1036
|
</dd>
|
|
1070
1037
|
</dl>
|
|
@@ -1083,7 +1050,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1083
1050
|
</dl>
|
|
1084
1051
|
</details>
|
|
1085
1052
|
|
|
1086
|
-
|
|
1053
|
+
## EmpathicVoice Configs
|
|
1054
|
+
|
|
1055
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
1087
1056
|
<dl>
|
|
1088
1057
|
<dd>
|
|
1089
1058
|
|
|
@@ -1096,9 +1065,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1096
1065
|
<dd>
|
|
1097
1066
|
|
|
1098
1067
|
```typescript
|
|
1099
|
-
await client.empathicVoice.
|
|
1100
|
-
|
|
1101
|
-
|
|
1068
|
+
await client.empathicVoice.configs.listConfigs({
|
|
1069
|
+
pageNumber: 0,
|
|
1070
|
+
pageSize: 1,
|
|
1102
1071
|
});
|
|
1103
1072
|
```
|
|
1104
1073
|
|
|
@@ -1115,15 +1084,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
1115
1084
|
<dl>
|
|
1116
1085
|
<dd>
|
|
1117
1086
|
|
|
1118
|
-
**
|
|
1119
|
-
|
|
1120
|
-
</dd>
|
|
1121
|
-
</dl>
|
|
1122
|
-
|
|
1123
|
-
<dl>
|
|
1124
|
-
<dd>
|
|
1125
|
-
|
|
1126
|
-
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1087
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
1127
1088
|
|
|
1128
1089
|
</dd>
|
|
1129
1090
|
</dl>
|
|
@@ -1131,7 +1092,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
1131
1092
|
<dl>
|
|
1132
1093
|
<dd>
|
|
1133
1094
|
|
|
1134
|
-
**requestOptions:** `
|
|
1095
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1135
1096
|
|
|
1136
1097
|
</dd>
|
|
1137
1098
|
</dl>
|
|
@@ -1142,7 +1103,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
1142
1103
|
</dl>
|
|
1143
1104
|
</details>
|
|
1144
1105
|
|
|
1145
|
-
<details><summary><code>client.empathicVoice.
|
|
1106
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1146
1107
|
<dl>
|
|
1147
1108
|
<dd>
|
|
1148
1109
|
|
|
@@ -1155,7 +1116,36 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
1155
1116
|
<dd>
|
|
1156
1117
|
|
|
1157
1118
|
```typescript
|
|
1158
|
-
await client.empathicVoice.
|
|
1119
|
+
await client.empathicVoice.configs.createConfig({
|
|
1120
|
+
name: "Weather Assistant Config",
|
|
1121
|
+
prompt: {
|
|
1122
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1123
|
+
version: 0,
|
|
1124
|
+
},
|
|
1125
|
+
voice: {
|
|
1126
|
+
provider: "HUME_AI",
|
|
1127
|
+
name: Hume.PostedVoiceName.Kora,
|
|
1128
|
+
},
|
|
1129
|
+
languageModel: {
|
|
1130
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1131
|
+
modelResource: "claude-3-5-sonnet-20240620",
|
|
1132
|
+
temperature: 1,
|
|
1133
|
+
},
|
|
1134
|
+
eventMessages: {
|
|
1135
|
+
onNewChat: {
|
|
1136
|
+
enabled: false,
|
|
1137
|
+
text: "",
|
|
1138
|
+
},
|
|
1139
|
+
onInactivityTimeout: {
|
|
1140
|
+
enabled: false,
|
|
1141
|
+
text: "",
|
|
1142
|
+
},
|
|
1143
|
+
onMaxDurationTimeout: {
|
|
1144
|
+
enabled: false,
|
|
1145
|
+
text: "",
|
|
1146
|
+
},
|
|
1147
|
+
},
|
|
1148
|
+
});
|
|
1159
1149
|
```
|
|
1160
1150
|
|
|
1161
1151
|
</dd>
|
|
@@ -1171,7 +1161,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1171
1161
|
<dl>
|
|
1172
1162
|
<dd>
|
|
1173
1163
|
|
|
1174
|
-
**
|
|
1164
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
1175
1165
|
|
|
1176
1166
|
</dd>
|
|
1177
1167
|
</dl>
|
|
@@ -1179,7 +1169,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1179
1169
|
<dl>
|
|
1180
1170
|
<dd>
|
|
1181
1171
|
|
|
1182
|
-
**requestOptions:** `
|
|
1172
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1183
1173
|
|
|
1184
1174
|
</dd>
|
|
1185
1175
|
</dl>
|
|
@@ -1190,7 +1180,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1190
1180
|
</dl>
|
|
1191
1181
|
</details>
|
|
1192
1182
|
|
|
1193
|
-
<details><summary><code>client.empathicVoice.
|
|
1183
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
1194
1184
|
<dl>
|
|
1195
1185
|
<dd>
|
|
1196
1186
|
|
|
@@ -1203,9 +1193,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1203
1193
|
<dd>
|
|
1204
1194
|
|
|
1205
1195
|
```typescript
|
|
1206
|
-
await client.empathicVoice.
|
|
1207
|
-
name: "Updated Weather Assistant Prompt Name",
|
|
1208
|
-
});
|
|
1196
|
+
await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1209
1197
|
```
|
|
1210
1198
|
|
|
1211
1199
|
</dd>
|
|
@@ -1221,7 +1209,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1221
1209
|
<dl>
|
|
1222
1210
|
<dd>
|
|
1223
1211
|
|
|
1224
|
-
**id:** `string` — Identifier for a
|
|
1212
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1225
1213
|
|
|
1226
1214
|
</dd>
|
|
1227
1215
|
</dl>
|
|
@@ -1229,7 +1217,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1229
1217
|
<dl>
|
|
1230
1218
|
<dd>
|
|
1231
1219
|
|
|
1232
|
-
**request:** `Hume.empathicVoice.
|
|
1220
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
1233
1221
|
|
|
1234
1222
|
</dd>
|
|
1235
1223
|
</dl>
|
|
@@ -1237,7 +1225,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1237
1225
|
<dl>
|
|
1238
1226
|
<dd>
|
|
1239
1227
|
|
|
1240
|
-
**requestOptions:** `
|
|
1228
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1241
1229
|
|
|
1242
1230
|
</dd>
|
|
1243
1231
|
</dl>
|
|
@@ -1248,7 +1236,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1248
1236
|
</dl>
|
|
1249
1237
|
</details>
|
|
1250
1238
|
|
|
1251
|
-
<details><summary><code>client.empathicVoice.
|
|
1239
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1252
1240
|
<dl>
|
|
1253
1241
|
<dd>
|
|
1254
1242
|
|
|
@@ -1261,23 +1249,55 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1261
1249
|
<dd>
|
|
1262
1250
|
|
|
1263
1251
|
```typescript
|
|
1264
|
-
await client.empathicVoice.
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1252
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
1253
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
1254
|
+
prompt: {
|
|
1255
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1256
|
+
version: 0,
|
|
1257
|
+
},
|
|
1258
|
+
voice: {
|
|
1259
|
+
provider: "HUME_AI",
|
|
1260
|
+
name: Hume.PostedVoiceName.Ito,
|
|
1261
|
+
},
|
|
1262
|
+
languageModel: {
|
|
1263
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1264
|
+
modelResource: "claude-3-5-sonnet-20240620",
|
|
1265
|
+
temperature: 1,
|
|
1266
|
+
},
|
|
1267
|
+
ellmModel: {
|
|
1268
|
+
allowShortResponses: true,
|
|
1269
|
+
},
|
|
1270
|
+
eventMessages: {
|
|
1271
|
+
onNewChat: {
|
|
1272
|
+
enabled: false,
|
|
1273
|
+
text: "",
|
|
1274
|
+
},
|
|
1275
|
+
onInactivityTimeout: {
|
|
1276
|
+
enabled: false,
|
|
1277
|
+
text: "",
|
|
1278
|
+
},
|
|
1279
|
+
onMaxDurationTimeout: {
|
|
1280
|
+
enabled: false,
|
|
1281
|
+
text: "",
|
|
1282
|
+
},
|
|
1283
|
+
},
|
|
1284
|
+
});
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
</dd>
|
|
1288
|
+
</dl>
|
|
1289
|
+
</dd>
|
|
1290
|
+
</dl>
|
|
1291
|
+
|
|
1292
|
+
#### ⚙️ Parameters
|
|
1293
|
+
|
|
1274
1294
|
<dl>
|
|
1275
1295
|
<dd>
|
|
1276
1296
|
|
|
1277
1297
|
<dl>
|
|
1278
1298
|
<dd>
|
|
1279
1299
|
|
|
1280
|
-
**id:** `string` — Identifier for a
|
|
1300
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1281
1301
|
|
|
1282
1302
|
</dd>
|
|
1283
1303
|
</dl>
|
|
@@ -1285,13 +1305,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1285
1305
|
<dl>
|
|
1286
1306
|
<dd>
|
|
1287
1307
|
|
|
1288
|
-
**
|
|
1289
|
-
|
|
1290
|
-
Version number for a Prompt.
|
|
1291
|
-
|
|
1292
|
-
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1293
|
-
|
|
1294
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1308
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
1295
1309
|
|
|
1296
1310
|
</dd>
|
|
1297
1311
|
</dl>
|
|
@@ -1299,7 +1313,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1299
1313
|
<dl>
|
|
1300
1314
|
<dd>
|
|
1301
1315
|
|
|
1302
|
-
**requestOptions:** `
|
|
1316
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1303
1317
|
|
|
1304
1318
|
</dd>
|
|
1305
1319
|
</dl>
|
|
@@ -1310,7 +1324,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1310
1324
|
</dl>
|
|
1311
1325
|
</details>
|
|
1312
1326
|
|
|
1313
|
-
<details><summary><code>client.empathicVoice.
|
|
1327
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
1314
1328
|
<dl>
|
|
1315
1329
|
<dd>
|
|
1316
1330
|
|
|
@@ -1323,7 +1337,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1323
1337
|
<dd>
|
|
1324
1338
|
|
|
1325
1339
|
```typescript
|
|
1326
|
-
await client.empathicVoice.
|
|
1340
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1327
1341
|
```
|
|
1328
1342
|
|
|
1329
1343
|
</dd>
|
|
@@ -1339,21 +1353,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1339
1353
|
<dl>
|
|
1340
1354
|
<dd>
|
|
1341
1355
|
|
|
1342
|
-
**id:** `string` — Identifier for a
|
|
1343
|
-
|
|
1344
|
-
</dd>
|
|
1345
|
-
</dl>
|
|
1346
|
-
|
|
1347
|
-
<dl>
|
|
1348
|
-
<dd>
|
|
1349
|
-
|
|
1350
|
-
**version:** `number`
|
|
1351
|
-
|
|
1352
|
-
Version number for a Prompt.
|
|
1353
|
-
|
|
1354
|
-
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1355
|
-
|
|
1356
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1356
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1357
1357
|
|
|
1358
1358
|
</dd>
|
|
1359
1359
|
</dl>
|
|
@@ -1361,7 +1361,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1361
1361
|
<dl>
|
|
1362
1362
|
<dd>
|
|
1363
1363
|
|
|
1364
|
-
**requestOptions:** `
|
|
1364
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1365
1365
|
|
|
1366
1366
|
</dd>
|
|
1367
1367
|
</dl>
|
|
@@ -1372,7 +1372,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1372
1372
|
</dl>
|
|
1373
1373
|
</details>
|
|
1374
1374
|
|
|
1375
|
-
<details><summary><code>client.empathicVoice.
|
|
1375
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
1376
1376
|
<dl>
|
|
1377
1377
|
<dd>
|
|
1378
1378
|
|
|
@@ -1385,8 +1385,8 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1385
1385
|
<dd>
|
|
1386
1386
|
|
|
1387
1387
|
```typescript
|
|
1388
|
-
await client.empathicVoice.
|
|
1389
|
-
|
|
1388
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
1389
|
+
name: "Updated Weather Assistant Config Name",
|
|
1390
1390
|
});
|
|
1391
1391
|
```
|
|
1392
1392
|
|
|
@@ -1403,21 +1403,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1403
1403
|
<dl>
|
|
1404
1404
|
<dd>
|
|
1405
1405
|
|
|
1406
|
-
**id:** `string` — Identifier for a
|
|
1407
|
-
|
|
1408
|
-
</dd>
|
|
1409
|
-
</dl>
|
|
1410
|
-
|
|
1411
|
-
<dl>
|
|
1412
|
-
<dd>
|
|
1413
|
-
|
|
1414
|
-
**version:** `number`
|
|
1415
|
-
|
|
1416
|
-
Version number for a Prompt.
|
|
1417
|
-
|
|
1418
|
-
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1419
|
-
|
|
1420
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1406
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1421
1407
|
|
|
1422
1408
|
</dd>
|
|
1423
1409
|
</dl>
|
|
@@ -1425,7 +1411,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1425
1411
|
<dl>
|
|
1426
1412
|
<dd>
|
|
1427
1413
|
|
|
1428
|
-
**request:** `Hume.empathicVoice.
|
|
1414
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
1429
1415
|
|
|
1430
1416
|
</dd>
|
|
1431
1417
|
</dl>
|
|
@@ -1433,7 +1419,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1433
1419
|
<dl>
|
|
1434
1420
|
<dd>
|
|
1435
1421
|
|
|
1436
|
-
**requestOptions:** `
|
|
1422
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1437
1423
|
|
|
1438
1424
|
</dd>
|
|
1439
1425
|
</dl>
|
|
@@ -1444,9 +1430,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1444
1430
|
</dl>
|
|
1445
1431
|
</details>
|
|
1446
1432
|
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
1433
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
|
|
1450
1434
|
<dl>
|
|
1451
1435
|
<dd>
|
|
1452
1436
|
|
|
@@ -1459,10 +1443,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1459
1443
|
<dd>
|
|
1460
1444
|
|
|
1461
1445
|
```typescript
|
|
1462
|
-
await client.empathicVoice.configs.
|
|
1463
|
-
pageNumber: 0,
|
|
1464
|
-
pageSize: 1,
|
|
1465
|
-
});
|
|
1446
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
1466
1447
|
```
|
|
1467
1448
|
|
|
1468
1449
|
</dd>
|
|
@@ -1478,7 +1459,21 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1478
1459
|
<dl>
|
|
1479
1460
|
<dd>
|
|
1480
1461
|
|
|
1481
|
-
**
|
|
1462
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1463
|
+
|
|
1464
|
+
</dd>
|
|
1465
|
+
</dl>
|
|
1466
|
+
|
|
1467
|
+
<dl>
|
|
1468
|
+
<dd>
|
|
1469
|
+
|
|
1470
|
+
**version:** `number`
|
|
1471
|
+
|
|
1472
|
+
Version number for a Config.
|
|
1473
|
+
|
|
1474
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1475
|
+
|
|
1476
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1482
1477
|
|
|
1483
1478
|
</dd>
|
|
1484
1479
|
</dl>
|
|
@@ -1497,7 +1492,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1497
1492
|
</dl>
|
|
1498
1493
|
</details>
|
|
1499
1494
|
|
|
1500
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
1495
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
1501
1496
|
<dl>
|
|
1502
1497
|
<dd>
|
|
1503
1498
|
|
|
@@ -1510,36 +1505,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1510
1505
|
<dd>
|
|
1511
1506
|
|
|
1512
1507
|
```typescript
|
|
1513
|
-
await client.empathicVoice.configs.
|
|
1514
|
-
name: "Weather Assistant Config",
|
|
1515
|
-
prompt: {
|
|
1516
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1517
|
-
version: 0,
|
|
1518
|
-
},
|
|
1519
|
-
voice: {
|
|
1520
|
-
provider: "HUME_AI",
|
|
1521
|
-
name: Hume.PostedVoiceName.Kora,
|
|
1522
|
-
},
|
|
1523
|
-
languageModel: {
|
|
1524
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1525
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
1526
|
-
temperature: 1,
|
|
1527
|
-
},
|
|
1528
|
-
eventMessages: {
|
|
1529
|
-
onNewChat: {
|
|
1530
|
-
enabled: false,
|
|
1531
|
-
text: "",
|
|
1532
|
-
},
|
|
1533
|
-
onInactivityTimeout: {
|
|
1534
|
-
enabled: false,
|
|
1535
|
-
text: "",
|
|
1536
|
-
},
|
|
1537
|
-
onMaxDurationTimeout: {
|
|
1538
|
-
enabled: false,
|
|
1539
|
-
text: "",
|
|
1540
|
-
},
|
|
1541
|
-
},
|
|
1542
|
-
});
|
|
1508
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
1543
1509
|
```
|
|
1544
1510
|
|
|
1545
1511
|
</dd>
|
|
@@ -1555,7 +1521,21 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1555
1521
|
<dl>
|
|
1556
1522
|
<dd>
|
|
1557
1523
|
|
|
1558
|
-
**
|
|
1524
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1525
|
+
|
|
1526
|
+
</dd>
|
|
1527
|
+
</dl>
|
|
1528
|
+
|
|
1529
|
+
<dl>
|
|
1530
|
+
<dd>
|
|
1531
|
+
|
|
1532
|
+
**version:** `number`
|
|
1533
|
+
|
|
1534
|
+
Version number for a Config.
|
|
1535
|
+
|
|
1536
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1537
|
+
|
|
1538
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1559
1539
|
|
|
1560
1540
|
</dd>
|
|
1561
1541
|
</dl>
|
|
@@ -1574,7 +1554,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1574
1554
|
</dl>
|
|
1575
1555
|
</details>
|
|
1576
1556
|
|
|
1577
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
1557
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1578
1558
|
<dl>
|
|
1579
1559
|
<dd>
|
|
1580
1560
|
|
|
@@ -1587,7 +1567,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1587
1567
|
<dd>
|
|
1588
1568
|
|
|
1589
1569
|
```typescript
|
|
1590
|
-
await client.empathicVoice.configs.
|
|
1570
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
1571
|
+
versionDescription: "This is an updated version_description.",
|
|
1572
|
+
});
|
|
1591
1573
|
```
|
|
1592
1574
|
|
|
1593
1575
|
</dd>
|
|
@@ -1611,7 +1593,21 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1611
1593
|
<dl>
|
|
1612
1594
|
<dd>
|
|
1613
1595
|
|
|
1614
|
-
**
|
|
1596
|
+
**version:** `number`
|
|
1597
|
+
|
|
1598
|
+
Version number for a Config.
|
|
1599
|
+
|
|
1600
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1601
|
+
|
|
1602
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1603
|
+
|
|
1604
|
+
</dd>
|
|
1605
|
+
</dl>
|
|
1606
|
+
|
|
1607
|
+
<dl>
|
|
1608
|
+
<dd>
|
|
1609
|
+
|
|
1610
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
1615
1611
|
|
|
1616
1612
|
</dd>
|
|
1617
1613
|
</dl>
|
|
@@ -1630,7 +1626,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1630
1626
|
</dl>
|
|
1631
1627
|
</details>
|
|
1632
1628
|
|
|
1633
|
-
|
|
1629
|
+
## EmpathicVoice Chats
|
|
1630
|
+
|
|
1631
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
1634
1632
|
<dl>
|
|
1635
1633
|
<dd>
|
|
1636
1634
|
|
|
@@ -1643,38 +1641,10 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1643
1641
|
<dd>
|
|
1644
1642
|
|
|
1645
1643
|
```typescript
|
|
1646
|
-
await client.empathicVoice.
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
version: 0,
|
|
1651
|
-
},
|
|
1652
|
-
voice: {
|
|
1653
|
-
provider: "HUME_AI",
|
|
1654
|
-
name: Hume.PostedVoiceName.Ito,
|
|
1655
|
-
},
|
|
1656
|
-
languageModel: {
|
|
1657
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1658
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
1659
|
-
temperature: 1,
|
|
1660
|
-
},
|
|
1661
|
-
ellmModel: {
|
|
1662
|
-
allowShortResponses: true,
|
|
1663
|
-
},
|
|
1664
|
-
eventMessages: {
|
|
1665
|
-
onNewChat: {
|
|
1666
|
-
enabled: false,
|
|
1667
|
-
text: "",
|
|
1668
|
-
},
|
|
1669
|
-
onInactivityTimeout: {
|
|
1670
|
-
enabled: false,
|
|
1671
|
-
text: "",
|
|
1672
|
-
},
|
|
1673
|
-
onMaxDurationTimeout: {
|
|
1674
|
-
enabled: false,
|
|
1675
|
-
text: "",
|
|
1676
|
-
},
|
|
1677
|
-
},
|
|
1644
|
+
await client.empathicVoice.chats.listChats({
|
|
1645
|
+
pageNumber: 0,
|
|
1646
|
+
pageSize: 1,
|
|
1647
|
+
ascendingOrder: true,
|
|
1678
1648
|
});
|
|
1679
1649
|
```
|
|
1680
1650
|
|
|
@@ -1691,15 +1661,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1691
1661
|
<dl>
|
|
1692
1662
|
<dd>
|
|
1693
1663
|
|
|
1694
|
-
**
|
|
1695
|
-
|
|
1696
|
-
</dd>
|
|
1697
|
-
</dl>
|
|
1698
|
-
|
|
1699
|
-
<dl>
|
|
1700
|
-
<dd>
|
|
1701
|
-
|
|
1702
|
-
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
1664
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
1703
1665
|
|
|
1704
1666
|
</dd>
|
|
1705
1667
|
</dl>
|
|
@@ -1707,7 +1669,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1707
1669
|
<dl>
|
|
1708
1670
|
<dd>
|
|
1709
1671
|
|
|
1710
|
-
**requestOptions:** `
|
|
1672
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1711
1673
|
|
|
1712
1674
|
</dd>
|
|
1713
1675
|
</dl>
|
|
@@ -1718,7 +1680,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1718
1680
|
</dl>
|
|
1719
1681
|
</details>
|
|
1720
1682
|
|
|
1721
|
-
<details><summary><code>client.empathicVoice.
|
|
1683
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
|
|
1722
1684
|
<dl>
|
|
1723
1685
|
<dd>
|
|
1724
1686
|
|
|
@@ -1731,7 +1693,11 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1731
1693
|
<dd>
|
|
1732
1694
|
|
|
1733
1695
|
```typescript
|
|
1734
|
-
await client.empathicVoice.
|
|
1696
|
+
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
1697
|
+
pageNumber: 0,
|
|
1698
|
+
pageSize: 3,
|
|
1699
|
+
ascendingOrder: true,
|
|
1700
|
+
});
|
|
1735
1701
|
```
|
|
1736
1702
|
|
|
1737
1703
|
</dd>
|
|
@@ -1747,7 +1713,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1747
1713
|
<dl>
|
|
1748
1714
|
<dd>
|
|
1749
1715
|
|
|
1750
|
-
**id:** `string` — Identifier for a
|
|
1716
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
1751
1717
|
|
|
1752
1718
|
</dd>
|
|
1753
1719
|
</dl>
|
|
@@ -1755,7 +1721,15 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1755
1721
|
<dl>
|
|
1756
1722
|
<dd>
|
|
1757
1723
|
|
|
1758
|
-
**
|
|
1724
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
1725
|
+
|
|
1726
|
+
</dd>
|
|
1727
|
+
</dl>
|
|
1728
|
+
|
|
1729
|
+
<dl>
|
|
1730
|
+
<dd>
|
|
1731
|
+
|
|
1732
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1759
1733
|
|
|
1760
1734
|
</dd>
|
|
1761
1735
|
</dl>
|
|
@@ -1766,7 +1740,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1766
1740
|
</dl>
|
|
1767
1741
|
</details>
|
|
1768
1742
|
|
|
1769
|
-
|
|
1743
|
+
## EmpathicVoice ChatGroups
|
|
1744
|
+
|
|
1745
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
1770
1746
|
<dl>
|
|
1771
1747
|
<dd>
|
|
1772
1748
|
|
|
@@ -1779,8 +1755,11 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1779
1755
|
<dd>
|
|
1780
1756
|
|
|
1781
1757
|
```typescript
|
|
1782
|
-
await client.empathicVoice.
|
|
1783
|
-
|
|
1758
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
1759
|
+
pageNumber: 0,
|
|
1760
|
+
pageSize: 1,
|
|
1761
|
+
ascendingOrder: true,
|
|
1762
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
1784
1763
|
});
|
|
1785
1764
|
```
|
|
1786
1765
|
|
|
@@ -1797,15 +1776,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1797
1776
|
<dl>
|
|
1798
1777
|
<dd>
|
|
1799
1778
|
|
|
1800
|
-
**
|
|
1801
|
-
|
|
1802
|
-
</dd>
|
|
1803
|
-
</dl>
|
|
1804
|
-
|
|
1805
|
-
<dl>
|
|
1806
|
-
<dd>
|
|
1807
|
-
|
|
1808
|
-
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
1779
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
1809
1780
|
|
|
1810
1781
|
</dd>
|
|
1811
1782
|
</dl>
|
|
@@ -1813,7 +1784,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1813
1784
|
<dl>
|
|
1814
1785
|
<dd>
|
|
1815
1786
|
|
|
1816
|
-
**requestOptions:** `
|
|
1787
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
1817
1788
|
|
|
1818
1789
|
</dd>
|
|
1819
1790
|
</dl>
|
|
@@ -1824,7 +1795,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1824
1795
|
</dl>
|
|
1825
1796
|
</details>
|
|
1826
1797
|
|
|
1827
|
-
<details><summary><code>client.empathicVoice.
|
|
1798
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents</code></summary>
|
|
1828
1799
|
<dl>
|
|
1829
1800
|
<dd>
|
|
1830
1801
|
|
|
@@ -1837,7 +1808,11 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1837
1808
|
<dd>
|
|
1838
1809
|
|
|
1839
1810
|
```typescript
|
|
1840
|
-
await client.empathicVoice.
|
|
1811
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
1812
|
+
pageNumber: 0,
|
|
1813
|
+
pageSize: 3,
|
|
1814
|
+
ascendingOrder: true,
|
|
1815
|
+
});
|
|
1841
1816
|
```
|
|
1842
1817
|
|
|
1843
1818
|
</dd>
|
|
@@ -1853,7 +1828,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1853
1828
|
<dl>
|
|
1854
1829
|
<dd>
|
|
1855
1830
|
|
|
1856
|
-
**id:** `string` — Identifier for a
|
|
1831
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
1857
1832
|
|
|
1858
1833
|
</dd>
|
|
1859
1834
|
</dl>
|
|
@@ -1861,13 +1836,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1861
1836
|
<dl>
|
|
1862
1837
|
<dd>
|
|
1863
1838
|
|
|
1864
|
-
**
|
|
1865
|
-
|
|
1866
|
-
Version number for a Config.
|
|
1867
|
-
|
|
1868
|
-
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1869
|
-
|
|
1870
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1839
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
1871
1840
|
|
|
1872
1841
|
</dd>
|
|
1873
1842
|
</dl>
|
|
@@ -1875,7 +1844,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1875
1844
|
<dl>
|
|
1876
1845
|
<dd>
|
|
1877
1846
|
|
|
1878
|
-
**requestOptions:** `
|
|
1847
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
1879
1848
|
|
|
1880
1849
|
</dd>
|
|
1881
1850
|
</dl>
|
|
@@ -1886,11 +1855,13 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1886
1855
|
</dl>
|
|
1887
1856
|
</details>
|
|
1888
1857
|
|
|
1889
|
-
|
|
1858
|
+
## ExpressionMeasurement Batch
|
|
1859
|
+
|
|
1860
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
1890
1861
|
<dl>
|
|
1891
1862
|
<dd>
|
|
1892
1863
|
|
|
1893
|
-
####
|
|
1864
|
+
#### 📝 Description
|
|
1894
1865
|
|
|
1895
1866
|
<dl>
|
|
1896
1867
|
<dd>
|
|
@@ -1898,16 +1869,14 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1898
1869
|
<dl>
|
|
1899
1870
|
<dd>
|
|
1900
1871
|
|
|
1901
|
-
|
|
1902
|
-
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
1903
|
-
```
|
|
1872
|
+
Sort and filter jobs.
|
|
1904
1873
|
|
|
1905
1874
|
</dd>
|
|
1906
1875
|
</dl>
|
|
1907
1876
|
</dd>
|
|
1908
1877
|
</dl>
|
|
1909
1878
|
|
|
1910
|
-
####
|
|
1879
|
+
#### 🔌 Usage
|
|
1911
1880
|
|
|
1912
1881
|
<dl>
|
|
1913
1882
|
<dd>
|
|
@@ -1915,21 +1884,24 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1915
1884
|
<dl>
|
|
1916
1885
|
<dd>
|
|
1917
1886
|
|
|
1918
|
-
|
|
1887
|
+
```typescript
|
|
1888
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
1889
|
+
```
|
|
1919
1890
|
|
|
1920
1891
|
</dd>
|
|
1921
1892
|
</dl>
|
|
1893
|
+
</dd>
|
|
1894
|
+
</dl>
|
|
1895
|
+
|
|
1896
|
+
#### ⚙️ Parameters
|
|
1922
1897
|
|
|
1923
1898
|
<dl>
|
|
1924
1899
|
<dd>
|
|
1925
1900
|
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
Version number for a Config.
|
|
1929
|
-
|
|
1930
|
-
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1901
|
+
<dl>
|
|
1902
|
+
<dd>
|
|
1931
1903
|
|
|
1932
|
-
|
|
1904
|
+
**request:** `Hume.expressionMeasurement.BatchListJobsRequest`
|
|
1933
1905
|
|
|
1934
1906
|
</dd>
|
|
1935
1907
|
</dl>
|
|
@@ -1937,7 +1909,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1937
1909
|
<dl>
|
|
1938
1910
|
<dd>
|
|
1939
1911
|
|
|
1940
|
-
**requestOptions:** `
|
|
1912
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
1941
1913
|
|
|
1942
1914
|
</dd>
|
|
1943
1915
|
</dl>
|
|
@@ -1948,11 +1920,11 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1948
1920
|
</dl>
|
|
1949
1921
|
</details>
|
|
1950
1922
|
|
|
1951
|
-
<details><summary><code>client.
|
|
1923
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
|
|
1952
1924
|
<dl>
|
|
1953
1925
|
<dd>
|
|
1954
1926
|
|
|
1955
|
-
####
|
|
1927
|
+
#### 📝 Description
|
|
1956
1928
|
|
|
1957
1929
|
<dl>
|
|
1958
1930
|
<dd>
|
|
@@ -1960,18 +1932,14 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1960
1932
|
<dl>
|
|
1961
1933
|
<dd>
|
|
1962
1934
|
|
|
1963
|
-
|
|
1964
|
-
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
1965
|
-
versionDescription: "This is an updated version_description.",
|
|
1966
|
-
});
|
|
1967
|
-
```
|
|
1935
|
+
Start a new measurement inference job.
|
|
1968
1936
|
|
|
1969
1937
|
</dd>
|
|
1970
1938
|
</dl>
|
|
1971
1939
|
</dd>
|
|
1972
1940
|
</dl>
|
|
1973
1941
|
|
|
1974
|
-
####
|
|
1942
|
+
#### 🔌 Usage
|
|
1975
1943
|
|
|
1976
1944
|
<dl>
|
|
1977
1945
|
<dd>
|
|
@@ -1979,29 +1947,27 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
1979
1947
|
<dl>
|
|
1980
1948
|
<dd>
|
|
1981
1949
|
|
|
1982
|
-
|
|
1950
|
+
```typescript
|
|
1951
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
1952
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
1953
|
+
notify: true,
|
|
1954
|
+
});
|
|
1955
|
+
```
|
|
1983
1956
|
|
|
1984
1957
|
</dd>
|
|
1985
1958
|
</dl>
|
|
1959
|
+
</dd>
|
|
1960
|
+
</dl>
|
|
1961
|
+
|
|
1962
|
+
#### ⚙️ Parameters
|
|
1986
1963
|
|
|
1987
1964
|
<dl>
|
|
1988
1965
|
<dd>
|
|
1989
1966
|
|
|
1990
|
-
**version:** `number`
|
|
1991
|
-
|
|
1992
|
-
Version number for a Config.
|
|
1993
|
-
|
|
1994
|
-
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1995
|
-
|
|
1996
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1997
|
-
|
|
1998
|
-
</dd>
|
|
1999
|
-
</dl>
|
|
2000
|
-
|
|
2001
1967
|
<dl>
|
|
2002
1968
|
<dd>
|
|
2003
1969
|
|
|
2004
|
-
**request:** `Hume.
|
|
1970
|
+
**request:** `Hume.InferenceBaseRequest`
|
|
2005
1971
|
|
|
2006
1972
|
</dd>
|
|
2007
1973
|
</dl>
|
|
@@ -2009,7 +1975,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2009
1975
|
<dl>
|
|
2010
1976
|
<dd>
|
|
2011
1977
|
|
|
2012
|
-
**requestOptions:** `
|
|
1978
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
2013
1979
|
|
|
2014
1980
|
</dd>
|
|
2015
1981
|
</dl>
|
|
@@ -2020,12 +1986,25 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2020
1986
|
</dl>
|
|
2021
1987
|
</details>
|
|
2022
1988
|
|
|
2023
|
-
|
|
1989
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
|
|
1990
|
+
<dl>
|
|
1991
|
+
<dd>
|
|
1992
|
+
|
|
1993
|
+
#### 📝 Description
|
|
2024
1994
|
|
|
2025
|
-
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2026
1995
|
<dl>
|
|
2027
1996
|
<dd>
|
|
2028
1997
|
|
|
1998
|
+
<dl>
|
|
1999
|
+
<dd>
|
|
2000
|
+
|
|
2001
|
+
Get the request details and state of a given job.
|
|
2002
|
+
|
|
2003
|
+
</dd>
|
|
2004
|
+
</dl>
|
|
2005
|
+
</dd>
|
|
2006
|
+
</dl>
|
|
2007
|
+
|
|
2029
2008
|
#### 🔌 Usage
|
|
2030
2009
|
|
|
2031
2010
|
<dl>
|
|
@@ -2035,11 +2014,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2035
2014
|
<dd>
|
|
2036
2015
|
|
|
2037
2016
|
```typescript
|
|
2038
|
-
await client.
|
|
2039
|
-
pageNumber: 0,
|
|
2040
|
-
pageSize: 1,
|
|
2041
|
-
ascendingOrder: true,
|
|
2042
|
-
});
|
|
2017
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
2043
2018
|
```
|
|
2044
2019
|
|
|
2045
2020
|
</dd>
|
|
@@ -2055,7 +2030,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2055
2030
|
<dl>
|
|
2056
2031
|
<dd>
|
|
2057
2032
|
|
|
2058
|
-
**
|
|
2033
|
+
**id:** `string` — The unique identifier for the job.
|
|
2059
2034
|
|
|
2060
2035
|
</dd>
|
|
2061
2036
|
</dl>
|
|
@@ -2063,7 +2038,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2063
2038
|
<dl>
|
|
2064
2039
|
<dd>
|
|
2065
2040
|
|
|
2066
|
-
**requestOptions:** `
|
|
2041
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
2067
2042
|
|
|
2068
2043
|
</dd>
|
|
2069
2044
|
</dl>
|
|
@@ -2074,11 +2049,11 @@ await client.empathicVoice.chats.listChats({
|
|
|
2074
2049
|
</dl>
|
|
2075
2050
|
</details>
|
|
2076
2051
|
|
|
2077
|
-
<details><summary><code>client.
|
|
2052
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
|
|
2078
2053
|
<dl>
|
|
2079
2054
|
<dd>
|
|
2080
2055
|
|
|
2081
|
-
####
|
|
2056
|
+
#### 📝 Description
|
|
2082
2057
|
|
|
2083
2058
|
<dl>
|
|
2084
2059
|
<dd>
|
|
@@ -2086,20 +2061,14 @@ await client.empathicVoice.chats.listChats({
|
|
|
2086
2061
|
<dl>
|
|
2087
2062
|
<dd>
|
|
2088
2063
|
|
|
2089
|
-
|
|
2090
|
-
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2091
|
-
pageNumber: 0,
|
|
2092
|
-
pageSize: 3,
|
|
2093
|
-
ascendingOrder: true,
|
|
2094
|
-
});
|
|
2095
|
-
```
|
|
2064
|
+
Get the JSON predictions of a completed inference job.
|
|
2096
2065
|
|
|
2097
2066
|
</dd>
|
|
2098
2067
|
</dl>
|
|
2099
2068
|
</dd>
|
|
2100
2069
|
</dl>
|
|
2101
2070
|
|
|
2102
|
-
####
|
|
2071
|
+
#### 🔌 Usage
|
|
2103
2072
|
|
|
2104
2073
|
<dl>
|
|
2105
2074
|
<dd>
|
|
@@ -2107,15 +2076,24 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2107
2076
|
<dl>
|
|
2108
2077
|
<dd>
|
|
2109
2078
|
|
|
2110
|
-
|
|
2079
|
+
```typescript
|
|
2080
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
2081
|
+
```
|
|
2111
2082
|
|
|
2083
|
+
</dd>
|
|
2084
|
+
</dl>
|
|
2112
2085
|
</dd>
|
|
2113
2086
|
</dl>
|
|
2114
2087
|
|
|
2088
|
+
#### ⚙️ Parameters
|
|
2089
|
+
|
|
2115
2090
|
<dl>
|
|
2116
2091
|
<dd>
|
|
2117
2092
|
|
|
2118
|
-
|
|
2093
|
+
<dl>
|
|
2094
|
+
<dd>
|
|
2095
|
+
|
|
2096
|
+
**id:** `string` — The unique identifier for the job.
|
|
2119
2097
|
|
|
2120
2098
|
</dd>
|
|
2121
2099
|
</dl>
|
|
@@ -2123,7 +2101,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2123
2101
|
<dl>
|
|
2124
2102
|
<dd>
|
|
2125
2103
|
|
|
2126
|
-
**requestOptions:** `
|
|
2104
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
2127
2105
|
|
|
2128
2106
|
</dd>
|
|
2129
2107
|
</dl>
|
|
@@ -2134,12 +2112,25 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2134
2112
|
</dl>
|
|
2135
2113
|
</details>
|
|
2136
2114
|
|
|
2137
|
-
|
|
2115
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobArtifacts</a>(id) -> stream.Readable</code></summary>
|
|
2116
|
+
<dl>
|
|
2117
|
+
<dd>
|
|
2118
|
+
|
|
2119
|
+
#### 📝 Description
|
|
2120
|
+
|
|
2121
|
+
<dl>
|
|
2122
|
+
<dd>
|
|
2138
2123
|
|
|
2139
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
2140
2124
|
<dl>
|
|
2141
2125
|
<dd>
|
|
2142
2126
|
|
|
2127
|
+
Get the artifacts ZIP of a completed inference job.
|
|
2128
|
+
|
|
2129
|
+
</dd>
|
|
2130
|
+
</dl>
|
|
2131
|
+
</dd>
|
|
2132
|
+
</dl>
|
|
2133
|
+
|
|
2143
2134
|
#### 🔌 Usage
|
|
2144
2135
|
|
|
2145
2136
|
<dl>
|
|
@@ -2149,12 +2140,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2149
2140
|
<dd>
|
|
2150
2141
|
|
|
2151
2142
|
```typescript
|
|
2152
|
-
await client.
|
|
2153
|
-
pageNumber: 0,
|
|
2154
|
-
pageSize: 1,
|
|
2155
|
-
ascendingOrder: true,
|
|
2156
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2157
|
-
});
|
|
2143
|
+
await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
2158
2144
|
```
|
|
2159
2145
|
|
|
2160
2146
|
</dd>
|
|
@@ -2170,7 +2156,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2170
2156
|
<dl>
|
|
2171
2157
|
<dd>
|
|
2172
2158
|
|
|
2173
|
-
**
|
|
2159
|
+
**id:** `string` — The unique identifier for the job.
|
|
2174
2160
|
|
|
2175
2161
|
</dd>
|
|
2176
2162
|
</dl>
|
|
@@ -2178,7 +2164,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2178
2164
|
<dl>
|
|
2179
2165
|
<dd>
|
|
2180
2166
|
|
|
2181
|
-
**requestOptions:** `
|
|
2167
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
2182
2168
|
|
|
2183
2169
|
</dd>
|
|
2184
2170
|
</dl>
|
|
@@ -2189,10 +2175,25 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2189
2175
|
</dl>
|
|
2190
2176
|
</details>
|
|
2191
2177
|
|
|
2192
|
-
<details><summary><code>client.
|
|
2178
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
|
|
2179
|
+
<dl>
|
|
2180
|
+
<dd>
|
|
2181
|
+
|
|
2182
|
+
#### 📝 Description
|
|
2183
|
+
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2193
2187
|
<dl>
|
|
2194
2188
|
<dd>
|
|
2195
2189
|
|
|
2190
|
+
Start a new batch inference job.
|
|
2191
|
+
|
|
2192
|
+
</dd>
|
|
2193
|
+
</dl>
|
|
2194
|
+
</dd>
|
|
2195
|
+
</dl>
|
|
2196
|
+
|
|
2196
2197
|
#### 🔌 Usage
|
|
2197
2198
|
|
|
2198
2199
|
<dl>
|
|
@@ -2202,11 +2203,10 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2202
2203
|
<dd>
|
|
2203
2204
|
|
|
2204
2205
|
```typescript
|
|
2205
|
-
await client.
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
});
|
|
2206
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
2207
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
2208
|
+
{}
|
|
2209
|
+
);
|
|
2210
2210
|
```
|
|
2211
2211
|
|
|
2212
2212
|
</dd>
|
|
@@ -2222,7 +2222,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2222
2222
|
<dl>
|
|
2223
2223
|
<dd>
|
|
2224
2224
|
|
|
2225
|
-
**
|
|
2225
|
+
**file:** `File[] | fs.ReadStream[] | Blob[]`
|
|
2226
2226
|
|
|
2227
2227
|
</dd>
|
|
2228
2228
|
</dl>
|
|
@@ -2230,7 +2230,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2230
2230
|
<dl>
|
|
2231
2231
|
<dd>
|
|
2232
2232
|
|
|
2233
|
-
**request:** `Hume.
|
|
2233
|
+
**request:** `Hume.expressionMeasurement.BatchStartInferenceJobFromLocalFileRequest`
|
|
2234
2234
|
|
|
2235
2235
|
</dd>
|
|
2236
2236
|
</dl>
|
|
@@ -2238,7 +2238,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2238
2238
|
<dl>
|
|
2239
2239
|
<dd>
|
|
2240
2240
|
|
|
2241
|
-
**requestOptions:** `
|
|
2241
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
2242
2242
|
|
|
2243
2243
|
</dd>
|
|
2244
2244
|
</dl>
|