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.conversations.html">conversations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="contactcenterinsights_v1.projects.locations.conversations.analyses.html">analyses()</a></code> 79</p> 80<p class="firstline">Returns the analyses Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#calculateStats">calculateStats(location, filter=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Gets conversation 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, conversationId=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Creates a conversation.</p> 91<p class="toc_element"> 92 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Deletes a conversation.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets a conversation.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists conversations.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</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 a conversation.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="calculateStats">calculateStats(location, filter=None, x__xgafv=None)</code> 109 <pre>Gets conversation statistics. 110 111Args: 112 location: string, Required. The location of the conversations. (required) 113 filter: string, A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # The response for calculating conversation statistics. 123 "averageDuration": "A String", # The average duration of all conversations. The average is calculated using only conversations that have a time duration. 124 "averageTurnCount": 42, # The average number of turns per conversation. 125 "conversationCount": 42, # The total number of conversations. 126 "conversationCountTimeSeries": { # A time series representing conversations over time. # A time series representing the count of conversations created over time that match that requested filter criteria. 127 "intervalDuration": "A String", # The duration of each interval. 128 "points": [ # An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window. 129 { # A single interval in a time series. 130 "conversationCount": 42, # The number of conversations created in this interval. 131 "startTime": "A String", # The start time of this interval. 132 }, 133 ], 134 }, 135 "customHighlighterMatches": { # A map associating each custom highlighter resource name with its respective number of matches in the set of conversations. 136 "a_key": 42, 137 }, 138 "issueMatches": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead. 139 "a_key": 42, 140 }, 141 "issueMatchesStats": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` 142 "a_key": { # Aggregated statistics about an issue. 143 "displayName": "A String", # Display name of the issue. 144 "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 145 "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time. 146 }, 147 }, 148 "smartHighlighterMatches": { # A map associating each smart highlighter display name with its respective number of matches in the set of conversations. 149 "a_key": 42, 150 }, 151}</pre> 152</div> 153 154<div class="method"> 155 <code class="details" id="close">close()</code> 156 <pre>Close httplib2 connections.</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="create">create(parent, body=None, conversationId=None, x__xgafv=None)</code> 161 <pre>Creates a conversation. 162 163Args: 164 parent: string, Required. The parent resource of the conversation. (required) 165 body: object, The request body. 166 The object takes the form of: 167 168{ # The conversation resource. 169 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 170 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 171 "agentChannel": 42, # The audio channel that contains the agent. 172 "customerChannel": 42, # The audio channel that contains the customer. 173 }, 174 "createTime": "A String", # Output only. The time at which the conversation was created. 175 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 176 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 177 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 178 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 179 }, 180 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 181 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 182 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 183 }, 184 }, 185 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 186 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 187 "displayName": "A String", # The human-readable name of the intent. 188 }, 189 }, 190 "duration": "A String", # Output only. The duration of the conversation. 191 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 192 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 193 "a_key": "A String", 194 }, 195 "languageCode": "A String", # A user-specified language code for the conversation. 196 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 197 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 198 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 199 "annotations": [ # A list of call annotations that apply to this call. 200 { # A piece of metadata that applies to a window of a call. 201 "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. 202 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 203 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 204 }, 205 "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. 206 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 207 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 208 }, 209 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 210 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 211 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 212 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 213 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 214 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 215 }, 216 "type": "A String", # The type of the entity mention. 217 }, 218 "holdData": { # The data for a hold annotation. # Data specifying a hold. 219 }, 220 "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. 221 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 222 }, 223 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 224 }, 225 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 226 "displayName": "A String", # The human-readable name of the phrase matcher. 227 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 228 }, 229 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 230 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 231 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 232 }, 233 "silenceData": { # The data for a silence annotation. # Data specifying silence. 234 }, 235 }, 236 ], 237 "entities": { # All the entities in the call. 238 "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. 239 "displayName": "A String", # The representative name for the entity. 240 "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. 241 "a_key": "A String", 242 }, 243 "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. 244 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 245 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 246 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 247 }, 248 "type": "A String", # The entity type. 249 }, 250 }, 251 "intents": { # All the matched intents in the call. 252 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 253 "displayName": "A String", # The human-readable name of the intent. 254 "id": "A String", # The unique identifier of the intent. 255 }, 256 }, 257 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 258 "issueModel": "A String", # Issue model that generates the result. 259 "issues": [ # All the matched issues. 260 { # Information about the issue. 261 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 262 "issue": "A String", # Resource name of the assigned issue. 263 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 264 }, 265 ], 266 }, 267 "phraseMatchers": { # All the matched phrase matchers in the call. 268 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 269 "displayName": "A String", # The human-readable name of the phrase matcher. 270 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 271 }, 272 }, 273 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 274 { # One channel of conversation-level sentiment data. 275 "channelTag": 42, # The channel of the audio that the data applies to. 276 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 277 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 278 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 279 }, 280 }, 281 ], 282 }, 283 "endTime": "A String", # The time at which the analysis ended. 284 }, 285 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 286 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 287 "requestTime": "A String", # Output only. The time at which the analysis was requested. 288 }, 289 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 290 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 291 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 292 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 293 { # An annotation that was generated during the customer and agent interaction. 294 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 295 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 296 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 297 "correctnessLevel": "A String", # The correctness level of an answer. 298 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 299 }, 300 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 301 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 302 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 303 "a_key": "A String", 304 }, 305 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 306 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 307 "title": "A String", # Article title. 308 "uri": "A String", # Article URI. 309 }, 310 "createTime": "A String", # The time at which this annotation was created. 311 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 312 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 313 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 314 }, 315 "endBoundary": { # 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. 316 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 317 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 318 }, 319 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 320 "answer": "A String", # The piece of text from the `source` knowledge base document. 321 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 322 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 323 "a_key": "A String", 324 }, 325 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 326 "question": "A String", # The corresponding FAQ question. 327 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 328 }, 329 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 330 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 331 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 332 "a_key": "A String", 333 }, 334 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 335 "suggestion": "A String", # The content of the suggestion. 336 }, 337 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 338 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 339 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 340 "a_key": "A String", 341 }, 342 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 343 "reply": "A String", # The content of the reply. 344 }, 345 "startBoundary": { # 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. 346 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 347 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 348 }, 349 }, 350 ], 351 "startTime": "A String", # The time at which the conversation started. 352 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 353 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 354 { # A segment of a full transcript. 355 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 356 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 357 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 358 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 359 }, 360 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 361 "messageTime": "A String", # The time that the message occurred, if provided. 362 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 363 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 364 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 365 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 366 "role": "A String", # The role of the participant. 367 "userId": "A String", # A user-specified ID representing the participant. 368 }, 369 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 370 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 371 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 372 }, 373 "text": "A String", # The text of this segment. 374 "words": [ # A list of the word-specific information for each word in the segment. 375 { # Word-level info for words in a transcript. 376 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 377 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 378 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 379 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 380 }, 381 ], 382 }, 383 ], 384 }, 385 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 386 "turnCount": 42, # Output only. The number of turns in the conversation. 387 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 388} 389 390 conversationId: string, A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` 391 x__xgafv: string, V1 error format. 392 Allowed values 393 1 - v1 error format 394 2 - v2 error format 395 396Returns: 397 An object of the form: 398 399 { # The conversation resource. 400 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 401 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 402 "agentChannel": 42, # The audio channel that contains the agent. 403 "customerChannel": 42, # The audio channel that contains the customer. 404 }, 405 "createTime": "A String", # Output only. The time at which the conversation was created. 406 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 407 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 408 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 409 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 410 }, 411 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 412 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 413 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 414 }, 415 }, 416 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 417 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 418 "displayName": "A String", # The human-readable name of the intent. 419 }, 420 }, 421 "duration": "A String", # Output only. The duration of the conversation. 422 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 423 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 424 "a_key": "A String", 425 }, 426 "languageCode": "A String", # A user-specified language code for the conversation. 427 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 428 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 429 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 430 "annotations": [ # A list of call annotations that apply to this call. 431 { # A piece of metadata that applies to a window of a call. 432 "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. 433 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 434 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 435 }, 436 "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. 437 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 438 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 439 }, 440 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 441 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 442 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 443 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 444 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 445 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 446 }, 447 "type": "A String", # The type of the entity mention. 448 }, 449 "holdData": { # The data for a hold annotation. # Data specifying a hold. 450 }, 451 "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. 452 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 453 }, 454 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 455 }, 456 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 457 "displayName": "A String", # The human-readable name of the phrase matcher. 458 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 459 }, 460 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 461 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 462 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 463 }, 464 "silenceData": { # The data for a silence annotation. # Data specifying silence. 465 }, 466 }, 467 ], 468 "entities": { # All the entities in the call. 469 "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. 470 "displayName": "A String", # The representative name for the entity. 471 "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. 472 "a_key": "A String", 473 }, 474 "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. 475 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 476 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 477 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 478 }, 479 "type": "A String", # The entity type. 480 }, 481 }, 482 "intents": { # All the matched intents in the call. 483 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 484 "displayName": "A String", # The human-readable name of the intent. 485 "id": "A String", # The unique identifier of the intent. 486 }, 487 }, 488 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 489 "issueModel": "A String", # Issue model that generates the result. 490 "issues": [ # All the matched issues. 491 { # Information about the issue. 492 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 493 "issue": "A String", # Resource name of the assigned issue. 494 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 495 }, 496 ], 497 }, 498 "phraseMatchers": { # All the matched phrase matchers in the call. 499 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 500 "displayName": "A String", # The human-readable name of the phrase matcher. 501 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 502 }, 503 }, 504 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 505 { # One channel of conversation-level sentiment data. 506 "channelTag": 42, # The channel of the audio that the data applies to. 507 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 508 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 509 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 510 }, 511 }, 512 ], 513 }, 514 "endTime": "A String", # The time at which the analysis ended. 515 }, 516 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 517 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 518 "requestTime": "A String", # Output only. The time at which the analysis was requested. 519 }, 520 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 521 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 522 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 523 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 524 { # An annotation that was generated during the customer and agent interaction. 525 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 526 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 527 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 528 "correctnessLevel": "A String", # The correctness level of an answer. 529 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 530 }, 531 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 532 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 533 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 534 "a_key": "A String", 535 }, 536 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 537 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 538 "title": "A String", # Article title. 539 "uri": "A String", # Article URI. 540 }, 541 "createTime": "A String", # The time at which this annotation was created. 542 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 543 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 544 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 545 }, 546 "endBoundary": { # 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. 547 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 548 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 549 }, 550 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 551 "answer": "A String", # The piece of text from the `source` knowledge base document. 552 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 553 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 554 "a_key": "A String", 555 }, 556 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 557 "question": "A String", # The corresponding FAQ question. 558 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 559 }, 560 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 561 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 562 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 563 "a_key": "A String", 564 }, 565 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 566 "suggestion": "A String", # The content of the suggestion. 567 }, 568 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 569 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 570 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 571 "a_key": "A String", 572 }, 573 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 574 "reply": "A String", # The content of the reply. 575 }, 576 "startBoundary": { # 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. 577 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 578 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 579 }, 580 }, 581 ], 582 "startTime": "A String", # The time at which the conversation started. 583 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 584 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 585 { # A segment of a full transcript. 586 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 587 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 588 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 589 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 590 }, 591 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 592 "messageTime": "A String", # The time that the message occurred, if provided. 593 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 594 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 595 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 596 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 597 "role": "A String", # The role of the participant. 598 "userId": "A String", # A user-specified ID representing the participant. 599 }, 600 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 601 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 602 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 603 }, 604 "text": "A String", # The text of this segment. 605 "words": [ # A list of the word-specific information for each word in the segment. 606 { # Word-level info for words in a transcript. 607 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 608 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 609 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 610 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 611 }, 612 ], 613 }, 614 ], 615 }, 616 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 617 "turnCount": 42, # Output only. The number of turns in the conversation. 618 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 619}</pre> 620</div> 621 622<div class="method"> 623 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> 624 <pre>Deletes a conversation. 625 626Args: 627 name: string, Required. The name of the conversation to delete. (required) 628 force: boolean, If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. 629 x__xgafv: string, V1 error format. 630 Allowed values 631 1 - v1 error format 632 2 - v2 error format 633 634Returns: 635 An object of the form: 636 637 { # 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 `{}`. 638}</pre> 639</div> 640 641<div class="method"> 642 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> 643 <pre>Gets a conversation. 644 645Args: 646 name: string, Required. The name of the conversation to get. (required) 647 view: string, The level of details of the conversation. Default is `FULL`. 648 Allowed values 649 CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest. 650 BASIC - Transcript field is not populated in the response for Insights conversation. 651 FULL - All fields are populated for Insights conversation. 652 x__xgafv: string, V1 error format. 653 Allowed values 654 1 - v1 error format 655 2 - v2 error format 656 657Returns: 658 An object of the form: 659 660 { # The conversation resource. 661 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 662 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 663 "agentChannel": 42, # The audio channel that contains the agent. 664 "customerChannel": 42, # The audio channel that contains the customer. 665 }, 666 "createTime": "A String", # Output only. The time at which the conversation was created. 667 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 668 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 669 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 670 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 671 }, 672 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 673 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 674 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 675 }, 676 }, 677 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 678 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 679 "displayName": "A String", # The human-readable name of the intent. 680 }, 681 }, 682 "duration": "A String", # Output only. The duration of the conversation. 683 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 684 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 685 "a_key": "A String", 686 }, 687 "languageCode": "A String", # A user-specified language code for the conversation. 688 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 689 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 690 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 691 "annotations": [ # A list of call annotations that apply to this call. 692 { # A piece of metadata that applies to a window of a call. 693 "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. 694 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 695 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 696 }, 697 "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. 698 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 699 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 700 }, 701 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 702 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 703 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 704 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 705 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 706 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 707 }, 708 "type": "A String", # The type of the entity mention. 709 }, 710 "holdData": { # The data for a hold annotation. # Data specifying a hold. 711 }, 712 "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. 713 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 714 }, 715 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 716 }, 717 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 718 "displayName": "A String", # The human-readable name of the phrase matcher. 719 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 720 }, 721 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 722 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 723 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 724 }, 725 "silenceData": { # The data for a silence annotation. # Data specifying silence. 726 }, 727 }, 728 ], 729 "entities": { # All the entities in the call. 730 "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. 731 "displayName": "A String", # The representative name for the entity. 732 "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. 733 "a_key": "A String", 734 }, 735 "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. 736 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 737 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 738 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 739 }, 740 "type": "A String", # The entity type. 741 }, 742 }, 743 "intents": { # All the matched intents in the call. 744 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 745 "displayName": "A String", # The human-readable name of the intent. 746 "id": "A String", # The unique identifier of the intent. 747 }, 748 }, 749 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 750 "issueModel": "A String", # Issue model that generates the result. 751 "issues": [ # All the matched issues. 752 { # Information about the issue. 753 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 754 "issue": "A String", # Resource name of the assigned issue. 755 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 756 }, 757 ], 758 }, 759 "phraseMatchers": { # All the matched phrase matchers in the call. 760 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 761 "displayName": "A String", # The human-readable name of the phrase matcher. 762 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 763 }, 764 }, 765 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 766 { # One channel of conversation-level sentiment data. 767 "channelTag": 42, # The channel of the audio that the data applies to. 768 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 769 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 770 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 771 }, 772 }, 773 ], 774 }, 775 "endTime": "A String", # The time at which the analysis ended. 776 }, 777 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 778 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 779 "requestTime": "A String", # Output only. The time at which the analysis was requested. 780 }, 781 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 782 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 783 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 784 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 785 { # An annotation that was generated during the customer and agent interaction. 786 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 787 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 788 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 789 "correctnessLevel": "A String", # The correctness level of an answer. 790 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 791 }, 792 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 793 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 794 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 795 "a_key": "A String", 796 }, 797 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 798 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 799 "title": "A String", # Article title. 800 "uri": "A String", # Article URI. 801 }, 802 "createTime": "A String", # The time at which this annotation was created. 803 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 804 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 805 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 806 }, 807 "endBoundary": { # 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. 808 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 809 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 810 }, 811 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 812 "answer": "A String", # The piece of text from the `source` knowledge base document. 813 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 814 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 815 "a_key": "A String", 816 }, 817 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 818 "question": "A String", # The corresponding FAQ question. 819 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 820 }, 821 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 822 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 823 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 824 "a_key": "A String", 825 }, 826 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 827 "suggestion": "A String", # The content of the suggestion. 828 }, 829 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 830 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 831 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 832 "a_key": "A String", 833 }, 834 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 835 "reply": "A String", # The content of the reply. 836 }, 837 "startBoundary": { # 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. 838 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 839 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 840 }, 841 }, 842 ], 843 "startTime": "A String", # The time at which the conversation started. 844 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 845 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 846 { # A segment of a full transcript. 847 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 848 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 849 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 850 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 851 }, 852 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 853 "messageTime": "A String", # The time that the message occurred, if provided. 854 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 855 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 856 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 857 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 858 "role": "A String", # The role of the participant. 859 "userId": "A String", # A user-specified ID representing the participant. 860 }, 861 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 862 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 863 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 864 }, 865 "text": "A String", # The text of this segment. 866 "words": [ # A list of the word-specific information for each word in the segment. 867 { # Word-level info for words in a transcript. 868 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 869 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 870 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 871 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 872 }, 873 ], 874 }, 875 ], 876 }, 877 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 878 "turnCount": 42, # Output only. The number of turns in the conversation. 879 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 880}</pre> 881</div> 882 883<div class="method"> 884 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 885 <pre>Lists conversations. 886 887Args: 888 parent: string, Required. The parent resource of the conversation. (required) 889 filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. 890 pageSize: integer, The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. 891 pageToken: string, The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. 892 view: string, The level of details of the conversation. Default is `BASIC`. 893 Allowed values 894 CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest. 895 BASIC - Transcript field is not populated in the response for Insights conversation. 896 FULL - All fields are populated for Insights conversation. 897 x__xgafv: string, V1 error format. 898 Allowed values 899 1 - v1 error format 900 2 - v2 error format 901 902Returns: 903 An object of the form: 904 905 { # The response of listing conversations. 906 "conversations": [ # The conversations that match the request. 907 { # The conversation resource. 908 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 909 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 910 "agentChannel": 42, # The audio channel that contains the agent. 911 "customerChannel": 42, # The audio channel that contains the customer. 912 }, 913 "createTime": "A String", # Output only. The time at which the conversation was created. 914 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 915 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 916 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 917 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 918 }, 919 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 920 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 921 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 922 }, 923 }, 924 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 925 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 926 "displayName": "A String", # The human-readable name of the intent. 927 }, 928 }, 929 "duration": "A String", # Output only. The duration of the conversation. 930 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 931 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 932 "a_key": "A String", 933 }, 934 "languageCode": "A String", # A user-specified language code for the conversation. 935 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 936 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 937 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 938 "annotations": [ # A list of call annotations that apply to this call. 939 { # A piece of metadata that applies to a window of a call. 940 "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. 941 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 942 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 943 }, 944 "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. 945 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 946 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 947 }, 948 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 949 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 950 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 951 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 952 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 953 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 954 }, 955 "type": "A String", # The type of the entity mention. 956 }, 957 "holdData": { # The data for a hold annotation. # Data specifying a hold. 958 }, 959 "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. 960 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 961 }, 962 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 963 }, 964 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 965 "displayName": "A String", # The human-readable name of the phrase matcher. 966 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 967 }, 968 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 969 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 970 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 971 }, 972 "silenceData": { # The data for a silence annotation. # Data specifying silence. 973 }, 974 }, 975 ], 976 "entities": { # All the entities in the call. 977 "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. 978 "displayName": "A String", # The representative name for the entity. 979 "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. 980 "a_key": "A String", 981 }, 982 "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. 983 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 984 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 985 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 986 }, 987 "type": "A String", # The entity type. 988 }, 989 }, 990 "intents": { # All the matched intents in the call. 991 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 992 "displayName": "A String", # The human-readable name of the intent. 993 "id": "A String", # The unique identifier of the intent. 994 }, 995 }, 996 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 997 "issueModel": "A String", # Issue model that generates the result. 998 "issues": [ # All the matched issues. 999 { # Information about the issue. 1000 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 1001 "issue": "A String", # Resource name of the assigned issue. 1002 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 1003 }, 1004 ], 1005 }, 1006 "phraseMatchers": { # All the matched phrase matchers in the call. 1007 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 1008 "displayName": "A String", # The human-readable name of the phrase matcher. 1009 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 1010 }, 1011 }, 1012 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 1013 { # One channel of conversation-level sentiment data. 1014 "channelTag": 42, # The channel of the audio that the data applies to. 1015 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 1016 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1017 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1018 }, 1019 }, 1020 ], 1021 }, 1022 "endTime": "A String", # The time at which the analysis ended. 1023 }, 1024 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 1025 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 1026 "requestTime": "A String", # Output only. The time at which the analysis was requested. 1027 }, 1028 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 1029 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 1030 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 1031 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 1032 { # An annotation that was generated during the customer and agent interaction. 1033 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 1034 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 1035 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 1036 "correctnessLevel": "A String", # The correctness level of an answer. 1037 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 1038 }, 1039 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 1040 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1041 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 1042 "a_key": "A String", 1043 }, 1044 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1045 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 1046 "title": "A String", # Article title. 1047 "uri": "A String", # Article URI. 1048 }, 1049 "createTime": "A String", # The time at which this annotation was created. 1050 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 1051 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1052 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 1053 }, 1054 "endBoundary": { # 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. 1055 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1056 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1057 }, 1058 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 1059 "answer": "A String", # The piece of text from the `source` knowledge base document. 1060 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1061 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 1062 "a_key": "A String", 1063 }, 1064 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 1065 "question": "A String", # The corresponding FAQ question. 1066 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 1067 }, 1068 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 1069 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1070 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 1071 "a_key": "A String", 1072 }, 1073 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1074 "suggestion": "A String", # The content of the suggestion. 1075 }, 1076 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 1077 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1078 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 1079 "a_key": "A String", 1080 }, 1081 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1082 "reply": "A String", # The content of the reply. 1083 }, 1084 "startBoundary": { # 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. 1085 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1086 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1087 }, 1088 }, 1089 ], 1090 "startTime": "A String", # The time at which the conversation started. 1091 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 1092 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 1093 { # A segment of a full transcript. 1094 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 1095 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 1096 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 1097 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 1098 }, 1099 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 1100 "messageTime": "A String", # The time that the message occurred, if provided. 1101 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 1102 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1103 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1104 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 1105 "role": "A String", # The role of the participant. 1106 "userId": "A String", # A user-specified ID representing the participant. 1107 }, 1108 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 1109 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1110 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1111 }, 1112 "text": "A String", # The text of this segment. 1113 "words": [ # A list of the word-specific information for each word in the segment. 1114 { # Word-level info for words in a transcript. 1115 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 1116 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 1117 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 1118 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 1119 }, 1120 ], 1121 }, 1122 ], 1123 }, 1124 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 1125 "turnCount": 42, # Output only. The number of turns in the conversation. 1126 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 1127 }, 1128 ], 1129 "nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available. 1130}</pre> 1131</div> 1132 1133<div class="method"> 1134 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1135 <pre>Retrieves the next page of results. 1136 1137Args: 1138 previous_request: The request for the previous page. (required) 1139 previous_response: The response from the request for the previous page. (required) 1140 1141Returns: 1142 A request object that you can call 'execute()' on to request the next 1143 page. Returns None if there are no more items in the collection. 1144 </pre> 1145</div> 1146 1147<div class="method"> 1148 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 1149 <pre>Updates a conversation. 1150 1151Args: 1152 name: string, Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} (required) 1153 body: object, The request body. 1154 The object takes the form of: 1155 1156{ # The conversation resource. 1157 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 1158 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 1159 "agentChannel": 42, # The audio channel that contains the agent. 1160 "customerChannel": 42, # The audio channel that contains the customer. 1161 }, 1162 "createTime": "A String", # Output only. The time at which the conversation was created. 1163 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 1164 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 1165 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 1166 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 1167 }, 1168 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 1169 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 1170 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 1171 }, 1172 }, 1173 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 1174 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 1175 "displayName": "A String", # The human-readable name of the intent. 1176 }, 1177 }, 1178 "duration": "A String", # Output only. The duration of the conversation. 1179 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 1180 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 1181 "a_key": "A String", 1182 }, 1183 "languageCode": "A String", # A user-specified language code for the conversation. 1184 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 1185 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 1186 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 1187 "annotations": [ # A list of call annotations that apply to this call. 1188 { # A piece of metadata that applies to a window of a call. 1189 "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. 1190 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1191 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1192 }, 1193 "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. 1194 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1195 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1196 }, 1197 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 1198 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 1199 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 1200 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 1201 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1202 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1203 }, 1204 "type": "A String", # The type of the entity mention. 1205 }, 1206 "holdData": { # The data for a hold annotation. # Data specifying a hold. 1207 }, 1208 "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. 1209 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 1210 }, 1211 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 1212 }, 1213 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 1214 "displayName": "A String", # The human-readable name of the phrase matcher. 1215 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 1216 }, 1217 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 1218 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1219 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1220 }, 1221 "silenceData": { # The data for a silence annotation. # Data specifying silence. 1222 }, 1223 }, 1224 ], 1225 "entities": { # All the entities in the call. 1226 "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. 1227 "displayName": "A String", # The representative name for the entity. 1228 "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. 1229 "a_key": "A String", 1230 }, 1231 "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. 1232 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 1233 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1234 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1235 }, 1236 "type": "A String", # The entity type. 1237 }, 1238 }, 1239 "intents": { # All the matched intents in the call. 1240 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 1241 "displayName": "A String", # The human-readable name of the intent. 1242 "id": "A String", # The unique identifier of the intent. 1243 }, 1244 }, 1245 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 1246 "issueModel": "A String", # Issue model that generates the result. 1247 "issues": [ # All the matched issues. 1248 { # Information about the issue. 1249 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 1250 "issue": "A String", # Resource name of the assigned issue. 1251 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 1252 }, 1253 ], 1254 }, 1255 "phraseMatchers": { # All the matched phrase matchers in the call. 1256 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 1257 "displayName": "A String", # The human-readable name of the phrase matcher. 1258 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 1259 }, 1260 }, 1261 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 1262 { # One channel of conversation-level sentiment data. 1263 "channelTag": 42, # The channel of the audio that the data applies to. 1264 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 1265 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1266 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1267 }, 1268 }, 1269 ], 1270 }, 1271 "endTime": "A String", # The time at which the analysis ended. 1272 }, 1273 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 1274 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 1275 "requestTime": "A String", # Output only. The time at which the analysis was requested. 1276 }, 1277 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 1278 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 1279 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 1280 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 1281 { # An annotation that was generated during the customer and agent interaction. 1282 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 1283 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 1284 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 1285 "correctnessLevel": "A String", # The correctness level of an answer. 1286 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 1287 }, 1288 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 1289 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1290 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 1291 "a_key": "A String", 1292 }, 1293 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1294 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 1295 "title": "A String", # Article title. 1296 "uri": "A String", # Article URI. 1297 }, 1298 "createTime": "A String", # The time at which this annotation was created. 1299 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 1300 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1301 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 1302 }, 1303 "endBoundary": { # 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. 1304 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1305 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1306 }, 1307 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 1308 "answer": "A String", # The piece of text from the `source` knowledge base document. 1309 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1310 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 1311 "a_key": "A String", 1312 }, 1313 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 1314 "question": "A String", # The corresponding FAQ question. 1315 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 1316 }, 1317 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 1318 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1319 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 1320 "a_key": "A String", 1321 }, 1322 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1323 "suggestion": "A String", # The content of the suggestion. 1324 }, 1325 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 1326 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1327 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 1328 "a_key": "A String", 1329 }, 1330 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1331 "reply": "A String", # The content of the reply. 1332 }, 1333 "startBoundary": { # 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. 1334 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1335 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1336 }, 1337 }, 1338 ], 1339 "startTime": "A String", # The time at which the conversation started. 1340 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 1341 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 1342 { # A segment of a full transcript. 1343 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 1344 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 1345 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 1346 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 1347 }, 1348 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 1349 "messageTime": "A String", # The time that the message occurred, if provided. 1350 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 1351 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1352 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1353 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 1354 "role": "A String", # The role of the participant. 1355 "userId": "A String", # A user-specified ID representing the participant. 1356 }, 1357 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 1358 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1359 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1360 }, 1361 "text": "A String", # The text of this segment. 1362 "words": [ # A list of the word-specific information for each word in the segment. 1363 { # Word-level info for words in a transcript. 1364 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 1365 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 1366 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 1367 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 1368 }, 1369 ], 1370 }, 1371 ], 1372 }, 1373 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 1374 "turnCount": 42, # Output only. The number of turns in the conversation. 1375 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 1376} 1377 1378 updateMask: string, The list of fields to be updated. 1379 x__xgafv: string, V1 error format. 1380 Allowed values 1381 1 - v1 error format 1382 2 - v2 error format 1383 1384Returns: 1385 An object of the form: 1386 1387 { # The conversation resource. 1388 "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation. 1389 "callMetadata": { # Call-specific metadata. # Call-specific metadata. 1390 "agentChannel": 42, # The audio channel that contains the agent. 1391 "customerChannel": 42, # The audio channel that contains the customer. 1392 }, 1393 "createTime": "A String", # Output only. The time at which the conversation was created. 1394 "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation. 1395 "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow. 1396 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 1397 "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} 1398 }, 1399 "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript. 1400 "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio. 1401 "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. 1402 }, 1403 }, 1404 "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} 1405 "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. 1406 "displayName": "A String", # The human-readable name of the intent. 1407 }, 1408 }, 1409 "duration": "A String", # Output only. The duration of the conversation. 1410 "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. 1411 "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. 1412 "a_key": "A String", 1413 }, 1414 "languageCode": "A String", # A user-specified language code for the conversation. 1415 "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists. 1416 "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes. 1417 "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis. 1418 "annotations": [ # A list of call annotations that apply to this call. 1419 { # A piece of metadata that applies to a window of a call. 1420 "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. 1421 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1422 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1423 }, 1424 "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. 1425 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1426 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1427 }, 1428 "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. 1429 "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention. 1430 "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. 1431 "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity. 1432 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1433 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1434 }, 1435 "type": "A String", # The type of the entity mention. 1436 }, 1437 "holdData": { # The data for a hold annotation. # Data specifying a hold. 1438 }, 1439 "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. 1440 "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information. 1441 }, 1442 "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption. 1443 }, 1444 "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match. 1445 "displayName": "A String", # The human-readable name of the phrase matcher. 1446 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 1447 }, 1448 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 1449 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1450 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1451 }, 1452 "silenceData": { # The data for a silence annotation. # Data specifying silence. 1453 }, 1454 }, 1455 ], 1456 "entities": { # All the entities in the call. 1457 "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. 1458 "displayName": "A String", # The representative name for the entity. 1459 "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. 1460 "a_key": "A String", 1461 }, 1462 "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. 1463 "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation. 1464 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1465 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1466 }, 1467 "type": "A String", # The entity type. 1468 }, 1469 }, 1470 "intents": { # All the matched intents in the call. 1471 "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. 1472 "displayName": "A String", # The human-readable name of the intent. 1473 "id": "A String", # The unique identifier of the intent. 1474 }, 1475 }, 1476 "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result. 1477 "issueModel": "A String", # Issue model that generates the result. 1478 "issues": [ # All the matched issues. 1479 { # Information about the issue. 1480 "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. 1481 "issue": "A String", # Resource name of the assigned issue. 1482 "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. 1483 }, 1484 ], 1485 }, 1486 "phraseMatchers": { # All the matched phrase matchers in the call. 1487 "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. 1488 "displayName": "A String", # The human-readable name of the phrase matcher. 1489 "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. 1490 }, 1491 }, 1492 "sentiments": [ # Overall conversation-level sentiment for each channel of the call. 1493 { # One channel of conversation-level sentiment data. 1494 "channelTag": 42, # The channel of the audio that the data applies to. 1495 "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment. 1496 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1497 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1498 }, 1499 }, 1500 ], 1501 }, 1502 "endTime": "A String", # The time at which the analysis ended. 1503 }, 1504 "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. 1505 "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} 1506 "requestTime": "A String", # Output only. The time at which the analysis was requested. 1507 }, 1508 "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. 1509 "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} 1510 "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. 1511 "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. 1512 { # An annotation that was generated during the customer and agent interaction. 1513 "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} 1514 "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`. 1515 "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent. 1516 "correctnessLevel": "A String", # The correctness level of an answer. 1517 "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. 1518 }, 1519 "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data. 1520 "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1521 "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from. 1522 "a_key": "A String", 1523 }, 1524 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1525 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} 1526 "title": "A String", # Article title. 1527 "uri": "A String", # Article URI. 1528 }, 1529 "createTime": "A String", # The time at which this annotation was created. 1530 "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data. 1531 "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1532 "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} 1533 }, 1534 "endBoundary": { # 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. 1535 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1536 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1537 }, 1538 "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data. 1539 "answer": "A String", # The piece of text from the `source` knowledge base document. 1540 "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1541 "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from. 1542 "a_key": "A String", 1543 }, 1544 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}. 1545 "question": "A String", # The corresponding FAQ question. 1546 "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. 1547 }, 1548 "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data. 1549 "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1550 "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates. 1551 "a_key": "A String", 1552 }, 1553 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1554 "suggestion": "A String", # The content of the suggestion. 1555 }, 1556 "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data. 1557 "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). 1558 "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates. 1559 "a_key": "A String", 1560 }, 1561 "queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record} 1562 "reply": "A String", # The content of the reply. 1563 }, 1564 "startBoundary": { # 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. 1565 "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. 1566 "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. 1567 }, 1568 }, 1569 ], 1570 "startTime": "A String", # The time at which the conversation started. 1571 "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. 1572 "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. 1573 { # A segment of a full transcript. 1574 "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono. 1575 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. 1576 "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment. 1577 "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. 1578 }, 1579 "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". 1580 "messageTime": "A String", # The time that the message occurred, if provided. 1581 "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment. 1582 "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1583 "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} 1584 "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow. 1585 "role": "A String", # The role of the participant. 1586 "userId": "A String", # A user-specified ID representing the participant. 1587 }, 1588 "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment. 1589 "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. 1590 "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). 1591 }, 1592 "text": "A String", # The text of this segment. 1593 "words": [ # A list of the word-specific information for each word in the segment. 1594 { # Word-level info for words in a transcript. 1595 "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. 1596 "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation. 1597 "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation. 1598 "word": "A String", # The word itself. Includes punctuation marks that surround the word. 1599 }, 1600 ], 1601 }, 1602 ], 1603 }, 1604 "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. 1605 "turnCount": 42, # Output only. The number of turns in the conversation. 1606 "updateTime": "A String", # Output only. The most recent time at which the conversation was updated. 1607}</pre> 1608</div> 1609 1610</body></html>