Blame - docs/dyn/contactcenterinsights_v1.projects.locations.issueModels.html - platform/external/python/google-api-python-client

<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

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

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

86

<code><a href="#close">close()</a></code></p>

87

<p class="firstline">Close httplib2 connections.</p>

88

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

92

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

93

<p class="firstline">Deletes an issue model.</p>

94

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

98

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

99

<p class="firstline">Gets an issue model.</p>

100

101

<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>

102

<p class="firstline">Lists issue models.</p>

103

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

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

111

<code class="details" id="calculateIssueModelStats">calculateIssueModelStats(issueModel, x__xgafv=None)</code>

112

<pre>Gets an issue model's statistics.

113

114

Args:

115

issueModel: string, Required. The resource name of the issue model to query against. (required)

116

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

130

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

131

},

132

},

133

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

},

}</pre>

</div>

<code class="details" id="close">close()</code>

140

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

145

<pre>Creates an issue model.

146

147

Args:

148

parent: string, Required. The parent resource of the issue model. (required)

149

body: object, The request body.

150

The object takes the form of:

151

152

{ # The issue model resource.

153

"createTime": "A String", # Output only. The time at which this issue model was created.

154

"displayName": "A String", # The representative name for the issue model.

155

"inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model.

156

"medium": "A String", # Required. Medium of conversations used in training data.

157

"trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only.

158

},

159

"name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

160

"state": "A String", # Output only. State of the model.

161

"trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data.

162

"analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time.

163

"issueStats": { # Statistics on each issue. Key is the issue's resource name.

164

"a_key": { # Aggregated statistics about an issue.

165

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

166

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

167

},

168

},

169

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

170

},

171

"updateTime": "A String", # Output only. The most recent time at which the issue model was updated.

172

}

173

174

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

181

182

{ # This resource represents a long-running operation that is the result of a network API call.

183

"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.

184

"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.

185

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

186

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

187

{

188

"a_key": "", # Properties of the object. Contains field @type with type URL.

189

},

190

],

191

"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.

192

},

193

"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.

194

"a_key": "", # Properties of the object. Contains field @type with type URL.

195

},

196

"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}`.

197

"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`.

198

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

205

<pre>Deletes an issue model.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

216

217

{ # This resource represents a long-running operation that is the result of a network API call.

218

"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.

219

"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.

220

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

221

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

222

{

223

"a_key": "", # Properties of the object. Contains field @type with type URL.

224

},

225

],

226

"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.

227

},

228

"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.

229

"a_key": "", # Properties of the object. Contains field @type with type URL.

230

},

231

"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}`.

232

"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`.

233

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="deploy">deploy(name, body=None, x__xgafv=None)</code>

240

<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.

Args:

body: object, The request body.

245

The object takes the form of:

246

247

{ # The request to deploy an issue model.

248

"name": "A String", # Required. The issue model to deploy.

249

}

250

251

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

258

259

{ # This resource represents a long-running operation that is the result of a network API call.

260

"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.

261

"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.

262

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

263

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

264

{

265

"a_key": "", # Properties of the object. Contains field @type with type URL.

266

},

267

],

268

"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.

269

},

270

"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.

271

"a_key": "", # Properties of the object. Contains field @type with type URL.

272

},

273

"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}`.

274

"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`.

275

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

282

<pre>Gets an issue model.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

293

294

{ # The issue model resource.

295

"createTime": "A String", # Output only. The time at which this issue model was created.

296

"displayName": "A String", # The representative name for the issue model.

297

"inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model.

298

"medium": "A String", # Required. Medium of conversations used in training data.

299

"trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only.

300

},

301

"name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

302

"state": "A String", # Output only. State of the model.

303

"trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data.

304

"analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time.

305

"issueStats": { # Statistics on each issue. Key is the issue's resource name.

306

"a_key": { # Aggregated statistics about an issue.

307

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

308

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

309

},

310

},

311

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

312

},

313

"updateTime": "A String", # Output only. The most recent time at which the issue model was updated.

}</pre>

</div>

<code class="details" id="list">list(parent, x__xgafv=None)</code>

319

<pre>Lists issue models.

320

321

Args:

322

parent: string, Required. The parent resource of the issue model. (required)

323

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

330

331

{ # The response of listing issue models.

332

"issueModels": [ # The issue models that match the request.

333

{ # The issue model resource.

334

"createTime": "A String", # Output only. The time at which this issue model was created.

335

"displayName": "A String", # The representative name for the issue model.

336

"inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model.

337

"medium": "A String", # Required. Medium of conversations used in training data.

338

"trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only.

339

},

340

"name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

341

"state": "A String", # Output only. State of the model.

342

"trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data.

343

"analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time.

344

"issueStats": { # Statistics on each issue. Key is the issue's resource name.

345

"a_key": { # Aggregated statistics about an issue.

346

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

347

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

348

},

349

},

350

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

351

},

352

"updateTime": "A String", # Output only. The most recent time at which the issue model was updated.

},

],

}</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

360

<pre>Updates an issue model.

361

362

Args:

363

name: string, Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} (required)

364

body: object, The request body.

365

The object takes the form of:

366

367

{ # The issue model resource.

368

"createTime": "A String", # Output only. The time at which this issue model was created.

369

"displayName": "A String", # The representative name for the issue model.

370

"inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model.

371

"medium": "A String", # Required. Medium of conversations used in training data.

372

"trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only.

373

},

374

"name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

375

"state": "A String", # Output only. State of the model.

376

"trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data.

377

"analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time.

378

"issueStats": { # Statistics on each issue. Key is the issue's resource name.

379

"a_key": { # Aggregated statistics about an issue.

380

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

381

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

382

},

383

},

384

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

385

},

386

"updateTime": "A String", # Output only. The most recent time at which the issue model was updated.

387

}

388

389

updateMask: string, The list of fields to be updated.

390

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

397

398

{ # The issue model resource.

399

"createTime": "A String", # Output only. The time at which this issue model was created.

400

"displayName": "A String", # The representative name for the issue model.

401

"inputDataConfig": { # Configs for the input data used to create the issue model. # Configs for the input data that used to create the issue model.

402

"medium": "A String", # Required. Medium of conversations used in training data.

403

"trainingConversationsCount": "A String", # Output only. Number of conversations used in training. Output only.

404

},

405

"name": "A String", # Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

406

"state": "A String", # Output only. State of the model.

407

"trainingStats": { # Aggregated statistics about an issue model. # Output only. Immutable. The issue model's label statistics on its training data.

408

"analyzedConversationsCount": "A String", # Number of conversations the issue model has analyzed at this point in time.

409

"issueStats": { # Statistics on each issue. Key is the issue's resource name.

410

"a_key": { # Aggregated statistics about an issue.

411

"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

412

"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.

413

},

414

},

415

"unclassifiedConversationsCount": "A String", # Number of analyzed conversations for which no issue was applicable at this point in time.

416

},

417

"updateTime": "A String", # Output only. The most recent time at which the issue model was updated.

}</pre>

</div>

<code class="details" id="undeploy">undeploy(name, body=None, x__xgafv=None)</code>

423

<pre>Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.

Args:

body: object, The request body.

428

The object takes the form of:

429

430

{ # The request to undeploy an issue model.

431

"name": "A String", # Required. The issue model to undeploy.

432

}

433

434

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

441

442

{ # This resource represents a long-running operation that is the result of a network API call.

443

"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.

444

"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.

445

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

446

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

447

{

448

"a_key": "", # Properties of the object. Contains field @type with type URL.

449

},

450

],

451

"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.

452

},

453

"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.

454

"a_key": "", # Properties of the object. Contains field @type with type URL.

455

},

456

"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}`.

457

"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`.

458

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

</body></html>