1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a phrase matcher.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a phrase matcher.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a phrase matcher.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists phrase matchers.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a phrase matcher.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates a phrase matcher. 107 108Args: 109 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) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # The phrase matcher resource. 114 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 115 "active": True or False, # Applies the phrase matcher only when it is active. 116 "displayName": "A String", # The human-readable name of the phrase matcher. 117 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 118 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 119 { # A message representing a rule in the phrase matcher. 120 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 121 { # The data for a phrase match rule. 122 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 123 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 124 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 125 }, 126 }, 127 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 128 "query": "A String", # Required. The phrase to be matched. 129 }, 130 ], 131 "type": "A String", # Required. The type of this phrase match rule group. 132 }, 133 ], 134 "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. 135 "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 136 "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. 137 "type": "A String", # Required. The type of this phrase matcher. 138 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 139 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 140} 141 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # The phrase matcher resource. 151 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 152 "active": True or False, # Applies the phrase matcher only when it is active. 153 "displayName": "A String", # The human-readable name of the phrase matcher. 154 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 155 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 156 { # A message representing a rule in the phrase matcher. 157 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 158 { # The data for a phrase match rule. 159 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 160 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 161 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 162 }, 163 }, 164 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 165 "query": "A String", # Required. The phrase to be matched. 166 }, 167 ], 168 "type": "A String", # Required. The type of this phrase match rule group. 169 }, 170 ], 171 "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. 172 "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 173 "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. 174 "type": "A String", # Required. The type of this phrase matcher. 175 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 176 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 177}</pre> 178</div> 179 180<div class="method"> 181 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 182 <pre>Deletes a phrase matcher. 183 184Args: 185 name: string, Required. The name of the phrase matcher to delete. (required) 186 x__xgafv: string, V1 error format. 187 Allowed values 188 1 - v1 error format 189 2 - v2 error format 190 191Returns: 192 An object of the form: 193 194 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="get">get(name, x__xgafv=None)</code> 200 <pre>Gets a phrase matcher. 201 202Args: 203 name: string, Required. The name of the phrase matcher to get. (required) 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # The phrase matcher resource. 213 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 214 "active": True or False, # Applies the phrase matcher only when it is active. 215 "displayName": "A String", # The human-readable name of the phrase matcher. 216 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 217 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 218 { # A message representing a rule in the phrase matcher. 219 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 220 { # The data for a phrase match rule. 221 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 222 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 223 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 224 }, 225 }, 226 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 227 "query": "A String", # Required. The phrase to be matched. 228 }, 229 ], 230 "type": "A String", # Required. The type of this phrase match rule group. 231 }, 232 ], 233 "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. 234 "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 235 "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. 236 "type": "A String", # Required. The type of this phrase matcher. 237 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 238 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 239}</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 244 <pre>Lists phrase matchers. 245 246Args: 247 parent: string, Required. The parent resource of the phrase matcher. (required) 248 filter: string, A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties. 249 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. 250 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. 251 x__xgafv: string, V1 error format. 252 Allowed values 253 1 - v1 error format 254 2 - v2 error format 255 256Returns: 257 An object of the form: 258 259 { # The response of listing phrase matchers. 260 "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. 261 "phraseMatchers": [ # The phrase matchers that match the request. 262 { # The phrase matcher resource. 263 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 264 "active": True or False, # Applies the phrase matcher only when it is active. 265 "displayName": "A String", # The human-readable name of the phrase matcher. 266 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 267 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 268 { # A message representing a rule in the phrase matcher. 269 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 270 { # The data for a phrase match rule. 271 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 272 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 273 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 274 }, 275 }, 276 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 277 "query": "A String", # Required. The phrase to be matched. 278 }, 279 ], 280 "type": "A String", # Required. The type of this phrase match rule group. 281 }, 282 ], 283 "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. 284 "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 285 "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. 286 "type": "A String", # Required. The type of this phrase matcher. 287 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 288 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 289 }, 290 ], 291}</pre> 292</div> 293 294<div class="method"> 295 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 296 <pre>Retrieves the next page of results. 297 298Args: 299 previous_request: The request for the previous page. (required) 300 previous_response: The response from the request for the previous page. (required) 301 302Returns: 303 A request object that you can call 'execute()' on to request the next 304 page. Returns None if there are no more items in the collection. 305 </pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 310 <pre>Updates a phrase matcher. 311 312Args: 313 name: string, The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} (required) 314 body: object, The request body. 315 The object takes the form of: 316 317{ # The phrase matcher resource. 318 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 319 "active": True or False, # Applies the phrase matcher only when it is active. 320 "displayName": "A String", # The human-readable name of the phrase matcher. 321 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 322 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 323 { # A message representing a rule in the phrase matcher. 324 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 325 { # The data for a phrase match rule. 326 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 327 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 328 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 329 }, 330 }, 331 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 332 "query": "A String", # Required. The phrase to be matched. 333 }, 334 ], 335 "type": "A String", # Required. The type of this phrase match rule group. 336 }, 337 ], 338 "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. 339 "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 340 "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. 341 "type": "A String", # Required. The type of this phrase matcher. 342 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 343 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 344} 345 346 updateMask: string, The list of fields to be updated. 347 x__xgafv: string, V1 error format. 348 Allowed values 349 1 - v1 error format 350 2 - v2 error format 351 352Returns: 353 An object of the form: 354 355 { # The phrase matcher resource. 356 "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. 357 "active": True or False, # Applies the phrase matcher only when it is active. 358 "displayName": "A String", # The human-readable name of the phrase matcher. 359 "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} 360 "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. 361 { # A message representing a rule in the phrase matcher. 362 "phraseMatchRules": [ # A list of phase match rules that are included in this group. 363 { # The data for a phrase match rule. 364 "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. 365 "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. 366 "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. 367 }, 368 }, 369 "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. 370 "query": "A String", # Required. The phrase to be matched. 371 }, 372 ], 373 "type": "A String", # Required. The type of this phrase match rule group. 374 }, 375 ], 376 "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. 377 "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 378 "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. 379 "type": "A String", # Required. The type of this phrase matcher. 380 "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. 381 "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. 382}</pre> 383</div> 384 385</body></html>