/
contactcenterinsights_v1.projects.locations.conversations.analyses.html
572 lines (535 loc) 路 42.9 KB
/
contactcenterinsights_v1.projects.locations.conversations.analyses.html
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.analyses.html">analyses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an analysis. The long running operation is done when the analysis has completed.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an analysis.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an analysis.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists analyses.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates an analysis. The long running operation is done when the analysis has completed.
Args:
parent: string, Required. The parent resource of the analysis. (required)
body: object, The request body.
The object takes the form of:
{ # The analysis resource.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
"displayName": "A String", # The representative name for the entity.
"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
"a_key": "A String",
},
"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an analysis.
Args:
name: string, Required. The name of the analysis to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an analysis.
Args:
name: string, Required. The name of the analysis to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The analysis resource.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
"displayName": "A String", # The representative name for the entity.
"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
"a_key": "A String",
},
"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists analyses.
Args:
parent: string, Required. The parent resource of the analyses. (required)
filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
pageSize: integer, The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
pageToken: string, The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to list analyses.
"analyses": [ # The analyses that match the request.
{ # The analysis resource.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
"displayName": "A String", # The representative name for the entity.
"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
"a_key": "A String",
},
"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>