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
|
<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.phraseMatchers.html">phraseMatchers</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 phrase matcher.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a phrase matcher.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a phrase matcher.</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 phrase matchers.</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 phrase matcher.</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 phrase matcher.
Args:
parent: string, Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/` (required)
body: object, The request body.
The object takes the form of:
{ # The phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a phrase matcher.
Args:
name: string, Required. The name of the phrase matcher 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 a phrase matcher.
Args:
name: string, Required. The name of the phrase matcher 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 phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists phrase matchers.
Args:
parent: string, Required. The parent resource of the phrase matcher. (required)
filter: string, A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.
pageSize: integer, The maximum number of phrase matchers 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 `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that 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 phrase matchers.
"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.
"phraseMatchers": [ # The phrase matchers that match the request.
{ # The phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
},
],
}</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 phrase matcher.
Args:
name: string, The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} (required)
body: object, The request body.
The object takes the form of:
{ # The phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}
updateMask: string, The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The phrase matcher resource.
"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.
"active": True or False, # Applies the phrase matcher only when it is active.
"displayName": "A String", # The human-readable name of the phrase matcher.
"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.
{ # A message representing a rule in the phrase matcher.
"phraseMatchRules": [ # A list of phrase match rules that are included in this group.
{ # The data for a phrase match rule.
"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.
"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.
},
},
"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
"query": "A String", # Required. The phrase to be matched.
},
],
"type": "A String", # Required. The type of this phrase match rule group.
},
],
"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
"type": "A String", # Required. The type of this phrase matcher.
"updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated.
"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>
</body></html>
|
