| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 103 | <pre>Creates a phrase matcher. |
| 104 | |
| 105 | Args: |
| 106 | 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) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { # The phrase matcher resource. |
| 111 | "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. |
| 112 | "active": True or False, # Applies the phrase matcher only when it is active. |
| 113 | "displayName": "A String", # The human-readable name of the phrase matcher. |
| 114 | "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} |
| 115 | "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. |
| 116 | { # A message representing a rule in the phrase matcher. |
| 117 | "phraseMatchRules": [ # A list of phase match rules that are included in this group. |
| 118 | { # The data for a phrase match rule. |
| 119 | "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. |
| 120 | "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. |
| 121 | "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. |
| 122 | }, |
| 123 | }, |
| 124 | "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
| 125 | "query": "A String", # Required. The phrase to be matched. |
| 126 | }, |
| 127 | ], |
| 128 | "type": "A String", # Required. The type of this phrase match rule group. |
| 129 | }, |
| 130 | ], |
| 131 | "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. |
| 132 | "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 |
| 133 | "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. |
| 134 | "type": "A String", # Required. The type of this phrase matcher. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 135 | "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 136 | "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. |
| 137 | } |
| 138 | |
| 139 | x__xgafv: string, V1 error format. |
| 140 | Allowed values |
| 141 | 1 - v1 error format |
| 142 | 2 - v2 error format |
| 143 | |
| 144 | Returns: |
| 145 | An object of the form: |
| 146 | |
| 147 | { # The phrase matcher resource. |
| 148 | "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. |
| 149 | "active": True or False, # Applies the phrase matcher only when it is active. |
| 150 | "displayName": "A String", # The human-readable name of the phrase matcher. |
| 151 | "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} |
| 152 | "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. |
| 153 | { # A message representing a rule in the phrase matcher. |
| 154 | "phraseMatchRules": [ # A list of phase match rules that are included in this group. |
| 155 | { # The data for a phrase match rule. |
| 156 | "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. |
| 157 | "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. |
| 158 | "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. |
| 159 | }, |
| 160 | }, |
| 161 | "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
| 162 | "query": "A String", # Required. The phrase to be matched. |
| 163 | }, |
| 164 | ], |
| 165 | "type": "A String", # Required. The type of this phrase match rule group. |
| 166 | }, |
| 167 | ], |
| 168 | "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. |
| 169 | "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 |
| 170 | "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. |
| 171 | "type": "A String", # Required. The type of this phrase matcher. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 172 | "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 173 | "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. |
| 174 | }</pre> |
| 175 | </div> |
| 176 | |
| 177 | <div class="method"> |
| 178 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 179 | <pre>Deletes a phrase matcher. |
| 180 | |
| 181 | Args: |
| 182 | name: string, Required. The name of the phrase matcher to delete. (required) |
| 183 | x__xgafv: string, V1 error format. |
| 184 | Allowed values |
| 185 | 1 - v1 error format |
| 186 | 2 - v2 error format |
| 187 | |
| 188 | Returns: |
| 189 | An object of the form: |
| 190 | |
| 191 | { # 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 `{}`. |
| 192 | }</pre> |
| 193 | </div> |
| 194 | |
| 195 | <div class="method"> |
| 196 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 197 | <pre>Gets a phrase matcher. |
| 198 | |
| 199 | Args: |
| 200 | name: string, Required. The name of the phrase matcher to get. (required) |
| 201 | x__xgafv: string, V1 error format. |
| 202 | Allowed values |
| 203 | 1 - v1 error format |
| 204 | 2 - v2 error format |
| 205 | |
| 206 | Returns: |
| 207 | An object of the form: |
| 208 | |
| 209 | { # The phrase matcher resource. |
| 210 | "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. |
| 211 | "active": True or False, # Applies the phrase matcher only when it is active. |
| 212 | "displayName": "A String", # The human-readable name of the phrase matcher. |
| 213 | "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} |
| 214 | "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. |
| 215 | { # A message representing a rule in the phrase matcher. |
| 216 | "phraseMatchRules": [ # A list of phase match rules that are included in this group. |
| 217 | { # The data for a phrase match rule. |
| 218 | "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. |
| 219 | "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. |
| 220 | "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. |
| 221 | }, |
| 222 | }, |
| 223 | "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
| 224 | "query": "A String", # Required. The phrase to be matched. |
| 225 | }, |
| 226 | ], |
| 227 | "type": "A String", # Required. The type of this phrase match rule group. |
| 228 | }, |
| 229 | ], |
| 230 | "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. |
| 231 | "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 |
| 232 | "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. |
| 233 | "type": "A String", # Required. The type of this phrase matcher. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 234 | "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 235 | "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. |
| 236 | }</pre> |
| 237 | </div> |
| 238 | |
| 239 | <div class="method"> |
| 240 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 241 | <pre>Lists phrase matchers. |
| 242 | |
| 243 | Args: |
| 244 | parent: string, Required. The parent resource of the phrase matcher. (required) |
| 245 | filter: string, A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties. |
| 246 | 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. |
| 247 | 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. |
| 248 | x__xgafv: string, V1 error format. |
| 249 | Allowed values |
| 250 | 1 - v1 error format |
| 251 | 2 - v2 error format |
| 252 | |
| 253 | Returns: |
| 254 | An object of the form: |
| 255 | |
| 256 | { # The response of listing phrase matchers. |
| 257 | "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. |
| 258 | "phraseMatchers": [ # The phrase matchers that match the request. |
| 259 | { # The phrase matcher resource. |
| 260 | "activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated. |
| 261 | "active": True or False, # Applies the phrase matcher only when it is active. |
| 262 | "displayName": "A String", # The human-readable name of the phrase matcher. |
| 263 | "name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} |
| 264 | "phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher. |
| 265 | { # A message representing a rule in the phrase matcher. |
| 266 | "phraseMatchRules": [ # A list of phase match rules that are included in this group. |
| 267 | { # The data for a phrase match rule. |
| 268 | "config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule. |
| 269 | "exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule. |
| 270 | "caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match. |
| 271 | }, |
| 272 | }, |
| 273 | "negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
| 274 | "query": "A String", # Required. The phrase to be matched. |
| 275 | }, |
| 276 | ], |
| 277 | "type": "A String", # Required. The type of this phrase match rule group. |
| 278 | }, |
| 279 | ], |
| 280 | "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. |
| 281 | "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 |
| 282 | "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. |
| 283 | "type": "A String", # Required. The type of this phrase matcher. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 284 | "updateTime": "A String", # Output only. The most recent time at which the phrase matcher was updated. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 285 | "versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. |
| 286 | }, |
| 287 | ], |
| 288 | }</pre> |
| 289 | </div> |
| 290 | |
| 291 | <div class="method"> |
| 292 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 293 | <pre>Retrieves the next page of results. |
| 294 | |
| 295 | Args: |
| 296 | previous_request: The request for the previous page. (required) |
| 297 | previous_response: The response from the request for the previous page. (required) |
| 298 | |
| 299 | Returns: |
| 300 | A request object that you can call 'execute()' on to request the next |
| 301 | page. Returns None if there are no more items in the collection. |
| 302 | </pre> |
| 303 | </div> |
| 304 | |
| 305 | </body></html> |