-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathspeech.yaml
438 lines (438 loc) · 16.5 KB
/
speech.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
openapi: 3.0.0
info:
title: Speech API
version: 1.0.0
description:
The Medallia Speech API enables processing of audio recordings within
Medallia Experience Cloud, including transcription and text analytics.
termsOfService: https://medallia.com/about/legal/terms/api
servers:
- url: 'https://{api-gateway-hostname}'
variables:
api-gateway-hostname:
default: instance-tenant.apis.medallia.com
description:
The Medallia Experience Cloud hostname used to access
Medallia Reporting
paths:
/speech/v0/bulk-ingest:
post:
tags:
- Speech
description: Queues recordings for processing
operationId: speechV0BulkInjest
requestBody:
description: A list of the recordings to process, up to 1,000 per request
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RecordingMetadata'
responses:
201:
description: Processing status of the submitted job request
headers:
X-RateLimit-Limit-day:
$ref: '#/components/headers/X-RateLimit-Limit-day'
X-RateLimit-Remaining-day:
$ref: '#/components/headers/X-RateLimit-Remaining-day'
X-RateLimit-Limit-second:
$ref: '#/components/headers/X-RateLimit-Limit-second'
X-RateLimit-Remaining-second:
$ref: '#/components/headers/X-RateLimit-Remaining-second'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
X-Medallia-Rpc-Request-Id:
$ref: '#/components/headers/X-Medallia-Rpc-Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingResponse'
400:
description: Invalid request
headers:
X-RateLimit-Limit-day:
$ref: '#/components/headers/X-RateLimit-Limit-day'
X-RateLimit-Remaining-day:
$ref: '#/components/headers/X-RateLimit-Remaining-day'
X-RateLimit-Limit-second:
$ref: '#/components/headers/X-RateLimit-Limit-second'
X-RateLimit-Remaining-second:
$ref: '#/components/headers/X-RateLimit-Remaining-second'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
X-Medallia-Rpc-Request-Id:
$ref: '#/components/headers/X-Medallia-Rpc-Request-Id'
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Object not found
headers:
X-RateLimit-Limit-day:
$ref: '#/components/headers/X-RateLimit-Limit-day'
X-RateLimit-Remaining-day:
$ref: '#/components/headers/X-RateLimit-Remaining-day'
X-RateLimit-Limit-second:
$ref: '#/components/headers/X-RateLimit-Limit-second'
X-RateLimit-Remaining-second:
$ref: '#/components/headers/X-RateLimit-Remaining-second'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
X-Medallia-Rpc-Request-Id:
$ref: '#/components/headers/X-Medallia-Rpc-Request-Id'
406:
description: Not acceptable
headers:
X-RateLimit-Limit-day:
$ref: '#/components/headers/X-RateLimit-Limit-day'
X-RateLimit-Remaining-day:
$ref: '#/components/headers/X-RateLimit-Remaining-day'
X-RateLimit-Limit-second:
$ref: '#/components/headers/X-RateLimit-Limit-second'
X-RateLimit-Remaining-second:
$ref: '#/components/headers/X-RateLimit-Remaining-second'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
X-Medallia-Rpc-Request-Id:
$ref: '#/components/headers/X-Medallia-Rpc-Request-Id'
409:
description: Request conflict with current state of the server
412:
description: Precondition failed
415:
description: Not supported
500:
description: Internal server error
security:
- mecOauth: []
components:
headers:
X-RateLimit-Limit-day:
description: The number of requests allowed in total in a 24-hour period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Limit.
schema:
type: integer
example: 10000
deprecated: true
X-RateLimit-Remaining-day:
description: The number of requests available to make in a 24-hour period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Remaining.
schema:
type: integer
example: 10000
deprecated: true
X-RateLimit-Limit-second:
description: The number of requests allowed in total in a 1-second period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Limit.
schema:
type: integer
example: 10
deprecated: true
X-RateLimit-Remaining-second:
description: The number of requests available to make in a 1-second period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Remaining.
schema:
type: integer
example: 10
deprecated: true
X-RateLimit-Limit:
description:
Indicates the request quota closest to reaching its limit
amongst all available quotas. Follows the semantics of
[IETF draft-polli-ratelimit-headers](https://datatracker.ietf.org/doc/html/draft-polli-ratelimit-headers).
schema:
type: string
example: 10, 10;w=1, 100;w=86400
X-RateLimit-Remaining:
description:
Indicates the number of requests remaining in the quota that is
closest to expiring (as indicated by `X-RateLimit-Limit`).
Follows the semantics of
[IETF draft-polli-ratelimit-headers](https://datatracker.ietf.org/doc/html/draft-polli-ratelimit-headers).
schema:
type: integer
example: 10
X-RateLimit-Reset:
description:
Indicates the number of seconds remaining until the quota
resets. Follows the semantics of
[IETF draft-polli-ratelimit-headers](https://datatracker.ietf.org/doc/html/draft-polli-ratelimit-headers).
schema:
type: integer
example: 10
X-Medallia-Rpc-Request-Id:
description: The request ID, used by Medallia support for troubleshooting
schema:
type: string
format: identifier
example: 94615edd-d9d0-4921-8b3e-60615b3d3431
schemas:
RecordingMetadata:
type: object
description: The metadata associated with a single recording
required:
- call_date_and_time
- call_identifier
- speech_file_name
- unit_identifier
properties:
call_identifier:
type: string
description: Unique record identifier, typically the Universal Call ID (UCID)
maxLength: 10240
speech_file_name:
type: string
description:
The name of the recording file as uploaded to
Medallia Managed File Transfer
maxLength: 10240
unit_identifier:
type: string
description:
ID of the agent that handled the call (typically the last agent the
customer is transferred to if there are multiple agents). This must
match the ID that is included in the organizational hierarchy for
the agent. If no value is provided, either a default unit or "Unit
Pending" will be used for the record.
maxLength: 10240
call_date_and_time:
type: string
format: date-time
description:
Interaction datetime in ISO-8601 format `yyyy-MM-DD'T'HH:mm:ssZZ`
(e.g. 2021-03-22T11:30:00-08:00)
call_recording_url:
type: string
format: uri
description:
URL of the call interaction recording, referencing an external
system for linkage purposes (not used for call transcription
processing)
maxLength: 10240
vertical_model:
type: string
description: Specific speech vertical model to use
default: Call Center
enum:
- Call Center
- Financial Services
- Healthcare
- Voicemail
- Survey
- Large Vocab
- General
locale:
type: string
description:
Primary language spoken during the call, specified in a format
compliant with [IETF BCP 47](https://tools.ietf.org/html/bcp47).
This value is applied to both the agent and customer channels.
(See `agent_locale` for further details.) The `engine` selected
may or may not leverage this setting during its processing;
please check with your Medallia specialist as per the `engine`
configuration.
default: en-US
maxLength: 10240
agent_locale:
type: string
description:
The language of the agent spoken during the call, specified in a
format compliant with [IETF BCP 47](https://tools.ietf.org/html/bcp47).
If this is omitted, the `locale` language is used for the agent. If
this is set, the `agent_locale` is used instead. This is only used
when `engine` is set to "Engine 1".
maxLength: 10240
apply_diarization:
type: string
description:
Applies diarization (channel assignment based on vocal audio
properties) to single-channel recordings
default: No
enum:
- Yes
- No
agent_channel:
type: string
description:
The audio channel (when recorded in stereo) associated with
the agent
default: '0'
enum:
- '0'
- '1'
substitutions:
type: object
additionalProperties:
type: string
description:
A set of substitutions to apply to the transcribed text,
in key/value format, where the key will be replaced
by the value in transcription.
default: {}
oov:
type: object
additionalProperties:
type: string
description:
A set of custom vocabulary terms with optional soundouts.
Accepts JSON dictionary and list formats, or a comma-
delineated string of text. Custom vocabulary improves
transcription for accuracy words that are not in the
language model's standard vocabulary.
default: {}
example: { "Matias": ["Marisa", "Mateeas"], "other": [], "Juampa": ["Juanpa", "Juan Pablo"] }
apply_redaction:
type: string
description: Applies redaction to the audio and transcribed text
default: No
enum:
- Yes
- No
first_name:
type: string
description: The first name of the customer.
maxLength: 10240
last_name:
type: string
description: The last name of the customer.
maxLength: 10240
email:
type: string
format: email
description: The email address of the customer.
phone_number:
type: string
description:
The phone number of the customer, typically from
ANI (Automatic Number Identification).
maxLength: 10240
connection_id:
deprecated: true
type: string
description:
The unique identifier of a specific connection profile. This value
does not typically need to be set. Please consult with your Medallia
Speech specialist to determine if a value is required. This field has
been deprecated since Medallia Experience Cloud version 22CR3.0, please
use `connector_id` instead.
maxLength: 10240
profile_uuid:
deprecated: true
type: string
description:
This field has been deprecated since Medallia Experience Cloud
version 21CR3.0, please use `connection_id` instead.
maxLength: 10240
engine:
type: string
description:
The Medallia Speech engine to use to perform the
transcription processing. The value to use is determined by
your Medallia Speech specialist during the initial audio
analysis process while onboarding to Medallia Speech.
default: "Engine 1"
enum:
- "Engine 1"
- "Engine 2"
- "Engine 3"
connector_id:
type: string
format: uuid
description:
The unique identifier of a specific Speech Connector API as configured
in Medallia Admin Suite. If set, the Speech data in the API request is
routed through the Connector for processing, including for extra
metadata available in `speech_additional_info`. This field was
introduced with Medallia Experience Cloud 22CR3.0.
speech_additional_info:
type: object
description:
Additional metadata to add to the Medallia Speech record. Mapping this
data to the record is performed in setting up the Medallia Speech API
Connector in Admin Suite. Use of this field requires setting a
`connector_id`.
additionalProperties:
$ref: '#/components/schemas/AnyValue'
example:
FirstName: "Jo"
LastName: "Smith"
AddressInfo: { "City": "San Francisco", "State": "CA", "Country": "USA" }
CallSegmentData: [ 0.3, 5.8, 8.9 ]
VIP: true
ProcessingResponse:
type: object
description: Result of a processing request
properties:
job_id:
type: string
format: uuid
description: The job identifier generated by Medallia
status:
type: string
description:
The job processing status, either ACCEPTED or REJECTED (to
indicate that all recordings were processed with the same
result) or PARTIALLY_ACCEPTED (to indicate a mixed result)
enum:
- ACCEPTED
- PARTIALLY_ACCEPTED
- REJECTED
details:
type: array
description: Details per metadata, when the status is PARTIALLY_ACCEPTED
items:
type: object
required:
- call_identifier
- speech_file_name
- status
properties:
call_identifier:
type: string
description: Unique record identifier
maxLength: 10240
speech_file_name:
type: string
description:
The name of the recording file as uploaded to
Medallia Managed File Transfer
maxLength: 10240
status:
type: string
description: The processing status for the recording
enum:
- ACCEPTED
- REJECTED
error_message:
type: string
description: Details about the processing failure
maxLength: 10240
AnyValue:
nullable: true
description:
Any valid JSON data type, including `null`.
securitySchemes:
mecOauth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://{reporting-hostname}/oauth/{company}/token
scopes: {}
security:
- mecOauth: []