Blame - docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.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.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.analyses.html">analyses</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">Creates an analysis. The long running operation is done when the analysis has completed.</p>

83

84

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

85

<p class="firstline">Deletes an analysis.</p>

86

87

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

88

<p class="firstline">Gets an analysis.</p>

89

90

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

91

<p class="firstline">Lists analyses.</p>

92

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

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

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

103

<pre>Creates an analysis. The long running operation is done when the analysis has completed.

104

105

Args:

106

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

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # The analysis resource.

111

"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.

112

"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.

113

"annotations": [ # A list of call annotations that apply to this call.

114

{ # A piece of metadata that applies to a window of a call.

115

"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.

116

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

117

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

118

},

119

"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.

120

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

121

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

122

},

123

"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.

124

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.

125

"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.

126

"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.

127

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

128

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

129

},

130

"type": "A String", # The type of the entity mention.

131

},

132

"holdData": { # The data for a hold annotation. # Data specifying a hold.

133

},

134

"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.

135

"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.

136

},

137

"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.

138

},

139

"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.

140

"displayName": "A String", # The human-readable name of the phrase matcher.

141

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

142

},

143

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

144

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

145

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

146

},

147

"silenceData": { # The data for a silence annotation. # Data specifying silence.

},

},

],

"entities": { # All the entities in the call.

152

"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.

153

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

154

"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.

155

"a_key": "A String",

156

},

157

"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.

158

"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.

159

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

160

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

161

},

162

"type": "A String", # The entity type.

163

},

164

},

165

"intents": { # All the matched intents in the call.

166

"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.

167

"displayName": "A String", # The human-readable name of the intent.

168

"id": "A String", # The unique identifier of the intent.

169

},

170

},

171

"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.

172

"issueModel": "A String", # Issue model that generates the result.

173

"issues": [ # All the matched issues.

174

{ # Information about the issue.

175

"issue": "A String", # Resource name of the assigned issue.

176

"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].

},

],

},

"phraseMatchers": { # All the matched phrase matchers in the call.

181

"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.

182

"displayName": "A String", # The human-readable name of the phrase matcher.

183

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

184

},

185

},

186

"sentiments": [ # Overall conversation-level sentiment for each channel of the call.

187

{ # One channel of conversation-level sentiment data.

188

"channelTag": 42, # The channel of the audio that the data applies to.

189

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

190

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

191

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

},

},

],

},

"endTime": "A String", # The time at which the analysis ended.

197

},

198

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

199

"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

200

"requestTime": "A String", # Output only. The time at which the analysis was requested.

201

}

202

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

211

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

212

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

213

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

214

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

215

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

216

{

217

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

218

},

219

],

220

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

221

},

222

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

223

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

224

},

225

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

226

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

227

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

234

<pre>Deletes an analysis.

235

236

Args:

237

name: string, Required. The name of the analysis to delete. (required)

238

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

245

246

{ # 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 `{}`.

}</pre>

</div>

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

252

<pre>Gets an analysis.

253

254

Args:

255

name: string, Required. The name of the analysis to get. (required)

256

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

263

264

{ # The analysis resource.

265

"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.

266

"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.

267

"annotations": [ # A list of call annotations that apply to this call.

268

{ # A piece of metadata that applies to a window of a call.

269

"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.

270

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

271

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

272

},

273

"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.

274

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

275

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

276

},

277

"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.

278

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.

279

"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.

280

"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.

281

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

282

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

283

},

284

"type": "A String", # The type of the entity mention.

285

},

286

"holdData": { # The data for a hold annotation. # Data specifying a hold.

287

},

288

"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.

289

"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.

290

},

291

"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.

292

},

293

"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.

294

"displayName": "A String", # The human-readable name of the phrase matcher.

295

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

296

},

297

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

298

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

299

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

300

},

301

"silenceData": { # The data for a silence annotation. # Data specifying silence.

},

},

],

"entities": { # All the entities in the call.

306

"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.

307

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

308

"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.

309

"a_key": "A String",

310

},

311

"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.

312

"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.

313

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

314

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

315

},

316

"type": "A String", # The entity type.

317

},

318

},

319

"intents": { # All the matched intents in the call.

320

"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.

321

"displayName": "A String", # The human-readable name of the intent.

322

"id": "A String", # The unique identifier of the intent.

323

},

324

},

325

"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.

326

"issueModel": "A String", # Issue model that generates the result.

327

"issues": [ # All the matched issues.

328

{ # Information about the issue.

329

"issue": "A String", # Resource name of the assigned issue.

330

"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].

},

],

},

"phraseMatchers": { # All the matched phrase matchers in the call.

335

"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.

336

"displayName": "A String", # The human-readable name of the phrase matcher.

337

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

338

},

339

},

340

"sentiments": [ # Overall conversation-level sentiment for each channel of the call.

341

{ # One channel of conversation-level sentiment data.

342

"channelTag": 42, # The channel of the audio that the data applies to.

343

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

344

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

345

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

},

},

],

},

"endTime": "A String", # The time at which the analysis ended.

351

},

352

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

353

"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

354

"requestTime": "A String", # Output only. The time at which the analysis was requested.

}</pre>

</div>

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

<pre>Lists analyses.

Args:

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

364

filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

365

pageSize: integer, The maximum number of analyses 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.

366

pageToken: string, The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.

367

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

374

375

{ # The response to list analyses.

376

"analyses": [ # The analyses that match the request.

377

{ # The analysis resource.

378

"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.

379

"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.

380

"annotations": [ # A list of call annotations that apply to this call.

381

{ # A piece of metadata that applies to a window of a call.

382

"annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.

383

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

384

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

385

},

386

"annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.

387

"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.

388

"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.

389

},

390

"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.

391

"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.

392

"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.

393

"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.

394

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

395

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

396

},

397

"type": "A String", # The type of the entity mention.

398

},

399

"holdData": { # The data for a hold annotation. # Data specifying a hold.

400

},

401

"intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.

402

"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.

403

},

404

"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.

405

},

406

"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.

407

"displayName": "A String", # The human-readable name of the phrase matcher.

408

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

409

},

410

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

411

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

412

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

413

},

414

"silenceData": { # The data for a silence annotation. # Data specifying silence.

},

},

],

"entities": { # All the entities in the call.

419

"a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.

420

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

421

"metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.

422

"a_key": "A String",

423

},

424

"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.

425

"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.

426

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

427

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

428

},

429

"type": "A String", # The entity type.

430

},

431

},

432

"intents": { # All the matched intents in the call.

433

"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.

434

"displayName": "A String", # The human-readable name of the intent.

435

"id": "A String", # The unique identifier of the intent.

436

},

437

},

438

"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.

439

"issueModel": "A String", # Issue model that generates the result.

440

"issues": [ # All the matched issues.

441

{ # Information about the issue.

442

"issue": "A String", # Resource name of the assigned issue.

443

"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].

},

],

},

"phraseMatchers": { # All the matched phrase matchers in the call.

448

"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.

449

"displayName": "A String", # The human-readable name of the phrase matcher.

450

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.

451

},

452

},

453

"sentiments": [ # Overall conversation-level sentiment for each channel of the call.

454

{ # One channel of conversation-level sentiment data.

455

"channelTag": 42, # The channel of the audio that the data applies to.

456

"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.

457

"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.

458

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).

},

},

],

},

"endTime": "A String", # The time at which the analysis ended.

464

},

465

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

466

"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

467

"requestTime": "A String", # Output only. The time at which the analysis was requested.

468

},

469

],

470

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

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

476

<pre>Retrieves the next page of results.

477

478