blob: e628ee01a7642467718a4a19c06a035b0602b0d4 [file] [log] [blame]
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -07001<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.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.analyses.html">analyses</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 an analysis. The long running operation is done when the analysis has completed.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an analysis.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets an analysis.</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 analyses.</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 an analysis. The long running operation is done when the analysis has completed.
104
105Args:
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 &quot;analysisResult&quot;: { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
112 &quot;callAnalysisMetadata&quot;: { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
113 &quot;annotations&quot;: [ # A list of call annotations that apply to this call.
114 { # A piece of metadata that applies to a window of a call.
115 &quot;annotationEndBoundary&quot;: { # 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 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
117 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
118 },
119 &quot;annotationStartBoundary&quot;: { # 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 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
121 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
122 },
123 &quot;channelTag&quot;: 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
124 &quot;entityMentionData&quot;: { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
125 &quot;entityUniqueId&quot;: &quot;A String&quot;, # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
126 &quot;sentiment&quot;: { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
127 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
128 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
129 },
130 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
131 },
132 &quot;holdData&quot;: { # The data for a hold annotation. # Data specifying a hold.
133 },
134 &quot;intentMatchData&quot;: { # 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 &quot;intentUniqueId&quot;: &quot;A String&quot;, # The id of the matched intent. Can be used to retrieve the corresponding intent information.
136 },
137 &quot;interruptionData&quot;: { # The data for an interruption annotation. # Data specifying an interruption.
138 },
139 &quot;phraseMatchData&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
140 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
141 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
142 },
143 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
144 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
145 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
146 },
147 &quot;silenceData&quot;: { # The data for a silence annotation. # Data specifying silence.
148 },
149 },
150 ],
151 &quot;entities&quot;: { # All the entities in the call.
152 &quot;a_key&quot;: { # 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 &quot;displayName&quot;: &quot;A String&quot;, # The representative name for the entity.
154 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;A String&quot;,
156 },
157 &quot;salience&quot;: 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 &quot;sentiment&quot;: { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
159 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
160 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
161 },
162 &quot;type&quot;: &quot;A String&quot;, # The entity type.
163 },
164 },
165 &quot;intents&quot;: { # All the matched intents in the call.
166 &quot;a_key&quot;: { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
167 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the intent.
168 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of the intent.
169 },
170 },
171 &quot;issueModelResult&quot;: { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
172 &quot;issueModel&quot;: &quot;A String&quot;, # Issue model that generates the result.
173 &quot;issues&quot;: [ # All the matched issues.
174 { # Information about the issue.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700175 &quot;displayName&quot;: &quot;A String&quot;, # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700176 &quot;issue&quot;: &quot;A String&quot;, # Resource name of the assigned issue.
177 &quot;score&quot;: 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
178 },
179 ],
180 },
181 &quot;phraseMatchers&quot;: { # All the matched phrase matchers in the call.
182 &quot;a_key&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
183 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
184 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
185 },
186 },
187 &quot;sentiments&quot;: [ # Overall conversation-level sentiment for each channel of the call.
188 { # One channel of conversation-level sentiment data.
189 &quot;channelTag&quot;: 42, # The channel of the audio that the data applies to.
190 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
191 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
192 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
193 },
194 },
195 ],
196 },
197 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the analysis ended.
198 },
199 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
200 &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
201 &quot;requestTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was requested.
202}
203
204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
212 { # This resource represents a long-running operation that is the result of a network API call.
213 &quot;done&quot;: 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.
214 &quot;error&quot;: { # 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.
215 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
216 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
217 {
218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
219 },
220 ],
221 &quot;message&quot;: &quot;A String&quot;, # 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.
222 },
223 &quot;metadata&quot;: { # 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.
224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
225 },
226 &quot;name&quot;: &quot;A String&quot;, # 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}`.
227 &quot;response&quot;: { # 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`.
228 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
229 },
230}</pre>
231</div>
232
233<div class="method">
234 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
235 <pre>Deletes an analysis.
236
237Args:
238 name: string, Required. The name of the analysis to delete. (required)
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # 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 `{}`.
248}</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="get">get(name, x__xgafv=None)</code>
253 <pre>Gets an analysis.
254
255Args:
256 name: string, Required. The name of the analysis to get. (required)
257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
265 { # The analysis resource.
266 &quot;analysisResult&quot;: { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
267 &quot;callAnalysisMetadata&quot;: { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
268 &quot;annotations&quot;: [ # A list of call annotations that apply to this call.
269 { # A piece of metadata that applies to a window of a call.
270 &quot;annotationEndBoundary&quot;: { # 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.
271 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
272 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
273 },
274 &quot;annotationStartBoundary&quot;: { # 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.
275 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
276 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
277 },
278 &quot;channelTag&quot;: 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
279 &quot;entityMentionData&quot;: { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
280 &quot;entityUniqueId&quot;: &quot;A String&quot;, # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
281 &quot;sentiment&quot;: { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
282 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
283 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
284 },
285 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
286 },
287 &quot;holdData&quot;: { # The data for a hold annotation. # Data specifying a hold.
288 },
289 &quot;intentMatchData&quot;: { # 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.
290 &quot;intentUniqueId&quot;: &quot;A String&quot;, # The id of the matched intent. Can be used to retrieve the corresponding intent information.
291 },
292 &quot;interruptionData&quot;: { # The data for an interruption annotation. # Data specifying an interruption.
293 },
294 &quot;phraseMatchData&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
295 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
296 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
297 },
298 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
299 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
300 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
301 },
302 &quot;silenceData&quot;: { # The data for a silence annotation. # Data specifying silence.
303 },
304 },
305 ],
306 &quot;entities&quot;: { # All the entities in the call.
307 &quot;a_key&quot;: { # 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.
308 &quot;displayName&quot;: &quot;A String&quot;, # The representative name for the entity.
309 &quot;metadata&quot;: { # 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.
310 &quot;a_key&quot;: &quot;A String&quot;,
311 },
312 &quot;salience&quot;: 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.
313 &quot;sentiment&quot;: { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
314 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
315 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
316 },
317 &quot;type&quot;: &quot;A String&quot;, # The entity type.
318 },
319 },
320 &quot;intents&quot;: { # All the matched intents in the call.
321 &quot;a_key&quot;: { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
322 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the intent.
323 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of the intent.
324 },
325 },
326 &quot;issueModelResult&quot;: { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
327 &quot;issueModel&quot;: &quot;A String&quot;, # Issue model that generates the result.
328 &quot;issues&quot;: [ # All the matched issues.
329 { # Information about the issue.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700330 &quot;displayName&quot;: &quot;A String&quot;, # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700331 &quot;issue&quot;: &quot;A String&quot;, # Resource name of the assigned issue.
332 &quot;score&quot;: 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
333 },
334 ],
335 },
336 &quot;phraseMatchers&quot;: { # All the matched phrase matchers in the call.
337 &quot;a_key&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
338 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
339 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
340 },
341 },
342 &quot;sentiments&quot;: [ # Overall conversation-level sentiment for each channel of the call.
343 { # One channel of conversation-level sentiment data.
344 &quot;channelTag&quot;: 42, # The channel of the audio that the data applies to.
345 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
346 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
347 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
348 },
349 },
350 ],
351 },
352 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the analysis ended.
353 },
354 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
355 &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
356 &quot;requestTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was requested.
357}</pre>
358</div>
359
360<div class="method">
361 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
362 <pre>Lists analyses.
363
364Args:
365 parent: string, Required. The parent resource of the analyses. (required)
366 filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
367 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.
368 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.
369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
373
374Returns:
375 An object of the form:
376
377 { # The response to list analyses.
378 &quot;analyses&quot;: [ # The analyses that match the request.
379 { # The analysis resource.
380 &quot;analysisResult&quot;: { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
381 &quot;callAnalysisMetadata&quot;: { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
382 &quot;annotations&quot;: [ # A list of call annotations that apply to this call.
383 { # A piece of metadata that applies to a window of a call.
384 &quot;annotationEndBoundary&quot;: { # 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.
385 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
386 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
387 },
388 &quot;annotationStartBoundary&quot;: { # 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.
389 &quot;transcriptIndex&quot;: 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
390 &quot;wordIndex&quot;: 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
391 },
392 &quot;channelTag&quot;: 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
393 &quot;entityMentionData&quot;: { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
394 &quot;entityUniqueId&quot;: &quot;A String&quot;, # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
395 &quot;sentiment&quot;: { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
396 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
397 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
398 },
399 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
400 },
401 &quot;holdData&quot;: { # The data for a hold annotation. # Data specifying a hold.
402 },
403 &quot;intentMatchData&quot;: { # 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.
404 &quot;intentUniqueId&quot;: &quot;A String&quot;, # The id of the matched intent. Can be used to retrieve the corresponding intent information.
405 },
406 &quot;interruptionData&quot;: { # The data for an interruption annotation. # Data specifying an interruption.
407 },
408 &quot;phraseMatchData&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
409 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
410 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
411 },
412 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
413 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
414 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
415 },
416 &quot;silenceData&quot;: { # The data for a silence annotation. # Data specifying silence.
417 },
418 },
419 ],
420 &quot;entities&quot;: { # All the entities in the call.
421 &quot;a_key&quot;: { # 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.
422 &quot;displayName&quot;: &quot;A String&quot;, # The representative name for the entity.
423 &quot;metadata&quot;: { # 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.
424 &quot;a_key&quot;: &quot;A String&quot;,
425 },
426 &quot;salience&quot;: 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.
427 &quot;sentiment&quot;: { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
428 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
429 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
430 },
431 &quot;type&quot;: &quot;A String&quot;, # The entity type.
432 },
433 },
434 &quot;intents&quot;: { # All the matched intents in the call.
435 &quot;a_key&quot;: { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
436 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the intent.
437 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of the intent.
438 },
439 },
440 &quot;issueModelResult&quot;: { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
441 &quot;issueModel&quot;: &quot;A String&quot;, # Issue model that generates the result.
442 &quot;issues&quot;: [ # All the matched issues.
443 { # Information about the issue.
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700444 &quot;displayName&quot;: &quot;A String&quot;, # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700445 &quot;issue&quot;: &quot;A String&quot;, # Resource name of the assigned issue.
446 &quot;score&quot;: 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
447 },
448 ],
449 },
450 &quot;phraseMatchers&quot;: { # All the matched phrase matchers in the call.
451 &quot;a_key&quot;: { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
452 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
453 &quot;phraseMatcher&quot;: &quot;A String&quot;, # The unique identifier (the resource name) of the phrase matcher.
454 },
455 },
456 &quot;sentiments&quot;: [ # Overall conversation-level sentiment for each channel of the call.
457 { # One channel of conversation-level sentiment data.
458 &quot;channelTag&quot;: 42, # The channel of the audio that the data applies to.
459 &quot;sentimentData&quot;: { # The data for a sentiment annotation. # Data specifying sentiment.
460 &quot;magnitude&quot;: 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
461 &quot;score&quot;: 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
462 },
463 },
464 ],
465 },
466 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the analysis ended.
467 },
468 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
469 &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
470 &quot;requestTime&quot;: &quot;A String&quot;, # Output only. The time at which the analysis was requested.
471 },
472 ],
473 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
474}</pre>
475</div>
476
477<div class="method">
478 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
479 <pre>Retrieves the next page of results.
480
481Args:
482 previous_request: The request for the previous page. (required)
483 previous_response: The response from the request for the previous page. (required)
484
485Returns:
486 A request object that you can call &#x27;execute()&#x27; on to request the next
487 page. Returns None if there are no more items in the collection.
488 </pre>
489</div>
490
491</body></html>