Returns the analyses Resource.
calculateStats(location, filter=None, x__xgafv=None)
Gets conversation statistics.
Close httplib2 connections.
create(parent, body=None, conversationId=None, x__xgafv=None)
Creates a conversation.
delete(name, force=None, x__xgafv=None)
Deletes a conversation.
get(name, view=None, x__xgafv=None)
Gets a conversation.
list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists conversations.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a conversation.
calculateStats(location, filter=None, x__xgafv=None)
Gets conversation statistics.
Args:
location: string, Required. The location of the conversations. (required)
filter: string, A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for calculating conversation statistics.
"averageDuration": "A String", # The average duration of all conversations. The average is calculated using only conversations that have a time duration.
"averageTurnCount": 42, # The average number of turns per conversation.
"conversationCount": 42, # The total number of conversations.
"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.
"intervalDuration": "A String", # The duration of each interval.
"points": [ # An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window.
{ # A single interval in a time series.
"conversationCount": 42, # The number of conversations created in this interval.
"startTime": "A String", # The start time of this interval.
},
],
},
"customHighlighterMatches": { # A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.
"a_key": 42,
},
"issueMatches": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.
"a_key": 42,
},
"issueMatchesStats": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`
"a_key": { # Aggregated statistics about an issue.
"displayName": "A String", # Display name of the issue.
"issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}
"labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.
},
},
"smartHighlighterMatches": { # A map associating each smart highlighter display name with its respective number of matches in the set of conversations.
"a_key": 42,
},
}
close()
Close httplib2 connections.
create(parent, body=None, conversationId=None, x__xgafv=None)
Creates a conversation.
Args:
parent: string, Required. The parent resource of the conversation. (required)
body: object, The request body.
The object takes the form of:
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}
conversationId: string, A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}
delete(name, force=None, x__xgafv=None)
Deletes a conversation.
Args:
name: string, Required. The name of the conversation to delete. (required)
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}
get(name, view=None, x__xgafv=None)
Gets a conversation.
Args:
name: string, Required. The name of the conversation to get. (required)
view: string, The level of details of the conversation. Default is `FULL`.
Allowed values
CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest.
BASIC - Transcript field is not populated in the response for Insights conversation.
FULL - All fields are populated for Insights conversation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}
list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists conversations.
Args:
parent: string, Required. The parent resource of the conversation. (required)
filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
pageSize: integer, The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
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.
view: string, The level of details of the conversation. Default is `BASIC`.
Allowed values
CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest.
BASIC - Transcript field is not populated in the response for Insights conversation.
FULL - All fields are populated for Insights conversation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response of listing conversations.
"conversations": [ # The conversations that match the request.
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
},
],
"nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a conversation.
Args:
name: string, Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} (required)
body: object, The request body.
The object takes the form of:
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}
updateMask: string, The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The conversation resource.
"agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
"callMetadata": { # Call-specific metadata. # Call-specific metadata.
"agentChannel": 42, # The audio channel that contains the agent.
"customerChannel": 42, # The audio channel that contains the customer.
},
"createTime": "A String", # Output only. The time at which the conversation was created.
"dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
"dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"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}
},
"gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
"audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
},
},
"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}
"a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
},
},
"duration": "A String", # Output only. The duration of the conversation.
"expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
"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.
"a_key": "A String",
},
"languageCode": "A String", # A user-specified language code for the conversation.
"latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
"analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
"callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
"annotations": [ # A list of call annotations that apply to this call.
{ # A piece of metadata that applies to a window of a call.
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
"entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
"entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
"sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The type of the entity mention.
},
"holdData": { # The data for a hold annotation. # Data specifying a hold.
},
"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.
"intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
},
"interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
},
"phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"silenceData": { # The data for a silence annotation. # Data specifying silence.
},
},
],
"entities": { # All the entities in the call.
"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.
"displayName": "A String", # The representative name for the entity.
"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.
"a_key": "A String",
},
"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.
"sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"type": "A String", # The entity type.
},
},
"intents": { # All the matched intents in the call.
"a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
"displayName": "A String", # The human-readable name of the intent.
"id": "A String", # The unique identifier of the intent.
},
},
"issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
"issueModel": "A String", # Issue model that generates the result.
"issues": [ # All the matched issues.
{ # Information about the issue.
"displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
"issue": "A String", # Resource name of the assigned issue.
"score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
},
],
},
"phraseMatchers": { # All the matched phrase matchers in the call.
"a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
"displayName": "A String", # The human-readable name of the phrase matcher.
"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
},
},
"sentiments": [ # Overall conversation-level sentiment for each channel of the call.
{ # One channel of conversation-level sentiment data.
"channelTag": 42, # The channel of the audio that the data applies to.
"sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
},
],
},
"endTime": "A String", # The time at which the analysis ended.
},
"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
"requestTime": "A String", # Output only. The time at which the analysis was requested.
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
"obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
"runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
{ # An annotation that was generated during the customer and agent interaction.
"annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
"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`.
"clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
"correctnessLevel": "A String", # The correctness level of an answer.
"displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
},
"articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
"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).
"metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
"title": "A String", # Article title.
"uri": "A String", # Article URI.
},
"createTime": "A String", # The time at which this annotation was created.
"dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
"confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
"dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
"faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
"answer": "A String", # The piece of text from the `source` knowledge base document.
"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).
"metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}.
"question": "A String", # The corresponding FAQ question.
"source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
},
"smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
"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).
"metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"suggestion": "A String", # The content of the suggestion.
},
"smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
"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).
"metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
"a_key": "A String",
},
"queryRecord": "A String", # Name of the query record. Format: projects/{project}/locations/{location}/queryRecords/{query_record}
"reply": "A String", # The content of the reply.
},
"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.
"transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
"wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
},
},
],
"startTime": "A String", # The time at which the conversation started.
"transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
"transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
{ # A segment of a full transcript.
"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.
"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.
"dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
"smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
},
"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".
"messageTime": "A String", # The time that the message occurred, if provided.
"segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
"dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
"obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
"role": "A String", # The role of the participant.
"userId": "A String", # A user-specified ID representing the participant.
},
"sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
"magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
},
"text": "A String", # The text of this segment.
"words": [ # A list of the word-specific information for each word in the segment.
{ # Word-level info for words in a transcript.
"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.
"endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
"startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
"word": "A String", # The word itself. Includes punctuation marks that surround the word.
},
],
},
],
},
"ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
"turnCount": 42, # Output only. The number of turns in the conversation.
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}