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
|
<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.analysisRules.html">analysisRules</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 a analysis rule.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a analysis rule.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a analysis rule.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists analysis rules.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a analysis rule.</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 a analysis rule.
Args:
parent: string, Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/` (required)
body: object, The request body.
The object takes the form of:
{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a analysis rule.
Args:
name: string, Required. The name of the analysis rule 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>Get a analysis rule.
Args:
name: string, Required. The name of the AnalysisRule 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 CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists analysis rules.
Args:
parent: string, Required. The parent resource of the analysis rules. (required)
pageSize: integer, Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
pageToken: string, Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` 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 of listing views.
"analysisRules": [ # The analysis_rule that match the request.
{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
},
],
"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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a analysis rule.
Args:
name: string, Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} (required)
body: object, The request body.
The object takes the form of:
{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
}
updateMask: string, Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
"active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
"analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO 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",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"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).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
"createTime": "A String", # Output only. The time at which this analysis rule was created.
"displayName": "A String", # Display Name of the analysis rule.
"name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
"updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
}</pre>
</div>
</body></html>
|
