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.issueModels.html">issueModels</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="contactcenterinsights_v1.projects.locations.issueModels.issues.html">issues()</a></code> 79</p> 80<p class="firstline">Returns the issues Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#calculateIssueModelStats">calculateIssueModelStats(issueModel, x__xgafv=None)</a></code></p> 84<p class="firstline">Gets an issue model's statistics.</p> 85<p class="toc_element"> 86 <code><a href="#close">close()</a></code></p> 87<p class="firstline">Close httplib2 connections.</p> 88<p class="toc_element"> 89 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Creates an issue model.</p> 91<p class="toc_element"> 92 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Deletes an issue model.</p> 94<p class="toc_element"> 95 <code><a href="#deploy">deploy(name, body=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.</p> 97<p class="toc_element"> 98 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 99<p class="firstline">Gets an issue model.</p> 100<p class="toc_element"> 101 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 102<p class="firstline">Lists issue models.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates an issue model.</p> 106<p class="toc_element"> 107 <code><a href="#undeploy">undeploy(name, body=None, x__xgafv=None)</a></code></p> 108<p class="firstline">Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.</p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="calculateIssueModelStats">calculateIssueModelStats(issueModel, x__xgafv=None)</code> 112 <pre>Gets an issue model's statistics. 113 114Args: 115 issueModel: string, Required. The resource name of the issue model to query against. (required) 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # Response of querying an issue model's statistics. 125 "currentStats": { # Aggregated statistics about an issue model. # The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment. 126 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 127 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 128 "a_key": { # Aggregated statistics about an issue. 129 "displayName": "A String", # Display name of the issue. 130 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 131 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 132 }, 133 }, 134 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 135 }, 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="close">close()</code> 141 <pre>Close httplib2 connections.</pre> 142</div> 143 144<div class="method"> 145 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 146 <pre>Creates an issue model. 147 148Args: 149 parent: string, Required. The parent resource of the issue model. (required) 150 body: object, The request body. 151 The object takes the form of: 152 153{ # The issue model resource. 154 "createTime": "A String", # Output only. The time at which this issue model was created. 155 "displayName": "A String", # The representative name for the issue model. 156 "inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model. 157 "filter": "A String", # A filter to reduce the conversations used for training the model to a specific subset. 158 "medium": "A String", # Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`. 159 "trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only. 160 }, 161 "name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} 162 "state": "A String", # Output only. State of the model. 163 "trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data. 164 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 165 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 166 "a_key": { # Aggregated statistics about an issue. 167 "displayName": "A String", # Display name of the issue. 168 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 169 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 170 }, 171 }, 172 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 173 }, 174 "updateTime": "A String", # Output only. The most recent time at which the issue model was updated. 175} 176 177 x__xgafv: string, V1 error format. 178 Allowed values 179 1 - v1 error format 180 2 - v2 error format 181 182Returns: 183 An object of the form: 184 185 { # This resource represents a long-running operation that is the result of a network API call. 186 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 187 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 188 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 189 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 190 { 191 "a_key": "", # Properties of the object. Contains field @type with type URL. 192 }, 193 ], 194 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 195 }, 196 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 197 "a_key": "", # Properties of the object. Contains field @type with type URL. 198 }, 199 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 200 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 201 "a_key": "", # Properties of the object. Contains field @type with type URL. 202 }, 203}</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 208 <pre>Deletes an issue model. 209 210Args: 211 name: string, Required. The name of the issue model to delete. (required) 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { # This resource represents a long-running operation that is the result of a network API call. 221 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 222 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 223 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 224 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 225 { 226 "a_key": "", # Properties of the object. Contains field @type with type URL. 227 }, 228 ], 229 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 230 }, 231 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 232 "a_key": "", # Properties of the object. Contains field @type with type URL. 233 }, 234 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 235 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 236 "a_key": "", # Properties of the object. Contains field @type with type URL. 237 }, 238}</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="deploy">deploy(name, body=None, x__xgafv=None)</code> 243 <pre>Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed. 244 245Args: 246 name: string, Required. The issue model to deploy. (required) 247 body: object, The request body. 248 The object takes the form of: 249 250{ # The request to deploy an issue model. 251 "name": "A String", # Required. The issue model to deploy. 252} 253 254 x__xgafv: string, V1 error format. 255 Allowed values 256 1 - v1 error format 257 2 - v2 error format 258 259Returns: 260 An object of the form: 261 262 { # This resource represents a long-running operation that is the result of a network API call. 263 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 264 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 265 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 266 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 267 { 268 "a_key": "", # Properties of the object. Contains field @type with type URL. 269 }, 270 ], 271 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 272 }, 273 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 274 "a_key": "", # Properties of the object. Contains field @type with type URL. 275 }, 276 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 277 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 278 "a_key": "", # Properties of the object. Contains field @type with type URL. 279 }, 280}</pre> 281</div> 282 283<div class="method"> 284 <code class="details" id="get">get(name, x__xgafv=None)</code> 285 <pre>Gets an issue model. 286 287Args: 288 name: string, Required. The name of the issue model to get. (required) 289 x__xgafv: string, V1 error format. 290 Allowed values 291 1 - v1 error format 292 2 - v2 error format 293 294Returns: 295 An object of the form: 296 297 { # The issue model resource. 298 "createTime": "A String", # Output only. The time at which this issue model was created. 299 "displayName": "A String", # The representative name for the issue model. 300 "inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model. 301 "filter": "A String", # A filter to reduce the conversations used for training the model to a specific subset. 302 "medium": "A String", # Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`. 303 "trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only. 304 }, 305 "name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} 306 "state": "A String", # Output only. State of the model. 307 "trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data. 308 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 309 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 310 "a_key": { # Aggregated statistics about an issue. 311 "displayName": "A String", # Display name of the issue. 312 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 313 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 314 }, 315 }, 316 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 317 }, 318 "updateTime": "A String", # Output only. The most recent time at which the issue model was updated. 319}</pre> 320</div> 321 322<div class="method"> 323 <code class="details" id="list">list(parent, x__xgafv=None)</code> 324 <pre>Lists issue models. 325 326Args: 327 parent: string, Required. The parent resource of the issue model. (required) 328 x__xgafv: string, V1 error format. 329 Allowed values 330 1 - v1 error format 331 2 - v2 error format 332 333Returns: 334 An object of the form: 335 336 { # The response of listing issue models. 337 "issueModels": [ # The issue models that match the request. 338 { # The issue model resource. 339 "createTime": "A String", # Output only. The time at which this issue model was created. 340 "displayName": "A String", # The representative name for the issue model. 341 "inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model. 342 "filter": "A String", # A filter to reduce the conversations used for training the model to a specific subset. 343 "medium": "A String", # Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`. 344 "trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only. 345 }, 346 "name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} 347 "state": "A String", # Output only. State of the model. 348 "trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data. 349 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 350 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 351 "a_key": { # Aggregated statistics about an issue. 352 "displayName": "A String", # Display name of the issue. 353 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 354 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 355 }, 356 }, 357 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 358 }, 359 "updateTime": "A String", # Output only. The most recent time at which the issue model was updated. 360 }, 361 ], 362}</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 367 <pre>Updates an issue model. 368 369Args: 370 name: string, Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} (required) 371 body: object, The request body. 372 The object takes the form of: 373 374{ # The issue model resource. 375 "createTime": "A String", # Output only. The time at which this issue model was created. 376 "displayName": "A String", # The representative name for the issue model. 377 "inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model. 378 "filter": "A String", # A filter to reduce the conversations used for training the model to a specific subset. 379 "medium": "A String", # Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`. 380 "trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only. 381 }, 382 "name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} 383 "state": "A String", # Output only. State of the model. 384 "trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data. 385 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 386 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 387 "a_key": { # Aggregated statistics about an issue. 388 "displayName": "A String", # Display name of the issue. 389 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 390 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 391 }, 392 }, 393 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 394 }, 395 "updateTime": "A String", # Output only. The most recent time at which the issue model was updated. 396} 397 398 updateMask: string, The list of fields to be updated. 399 x__xgafv: string, V1 error format. 400 Allowed values 401 1 - v1 error format 402 2 - v2 error format 403 404Returns: 405 An object of the form: 406 407 { # The issue model resource. 408 "createTime": "A String", # Output only. The time at which this issue model was created. 409 "displayName": "A String", # The representative name for the issue model. 410 "inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model. 411 "filter": "A String", # A filter to reduce the conversations used for training the model to a specific subset. 412 "medium": "A String", # Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`. 413 "trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only. 414 }, 415 "name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} 416 "state": "A String", # Output only. State of the model. 417 "trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data. 418 "analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time. 419 "issueStats": { # Statistics on each issue. Key is the issue's resource name. 420 "a_key": { # Aggregated statistics about an issue. 421 "displayName": "A String", # Display name of the issue. 422 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 423 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 424 }, 425 }, 426 "unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time. 427 }, 428 "updateTime": "A String", # Output only. The most recent time at which the issue model was updated. 429}</pre> 430</div> 431 432<div class="method"> 433 <code class="details" id="undeploy">undeploy(name, body=None, x__xgafv=None)</code> 434 <pre>Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed. 435 436Args: 437 name: string, Required. The issue model to undeploy. (required) 438 body: object, The request body. 439 The object takes the form of: 440 441{ # The request to undeploy an issue model. 442 "name": "A String", # Required. The issue model to undeploy. 443} 444 445 x__xgafv: string, V1 error format. 446 Allowed values 447 1 - v1 error format 448 2 - v2 error format 449 450Returns: 451 An object of the form: 452 453 { # This resource represents a long-running operation that is the result of a network API call. 454 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 455 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 456 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 457 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 458 { 459 "a_key": "", # Properties of the object. Contains field @type with type URL. 460 }, 461 ], 462 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 463 }, 464 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 465 "a_key": "", # Properties of the object. Contains field @type with type URL. 466 }, 467 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 468 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 469 "a_key": "", # Properties of the object. Contains field @type with type URL. 470 }, 471}</pre> 472</div> 473 474</body></html>