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