Returns the analyses Resource.
Returns the feedbackLabels Resource.
bulkAnalyze(parent, body=None, x__xgafv=None)
Analyzes multiple conversations in a single request.
bulkDelete(parent, body=None, x__xgafv=None)
Deletes multiple conversations in a single request.
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. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
delete(name, force=None, x__xgafv=None)
Deletes a conversation.
get(name, view=None, x__xgafv=None)
Gets a conversation.
ingest(parent, body=None, x__xgafv=None)
Imports conversations and processes them according to the user's configuration.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists conversations.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a conversation.
upload(parent, body=None, x__xgafv=None)
Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
bulkAnalyze(parent, body=None, x__xgafv=None)
Analyzes multiple conversations in a single request.
Args:
parent: string, Required. The parent resource to create analyses in. (required)
body: object, The request body.
The object takes the form of:
{ # The request to analyze conversations in bulk.
"analysisPercentage": 3.14, # Required. Percentage of selected conversation to analyze, between [0, 100].
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"filter": "A String", # Required. Filter used to select the subset of conversations to analyze.
"parent": "A String", # Required. The parent resource to create analyses in.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
bulkDelete(parent, body=None, x__xgafv=None)
Deletes multiple conversations in a single request.
Args:
parent: string, Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
{ # The request to delete conversations in bulk.
"filter": "A String", # Filter used to select the subset of conversations to delete.
"force": True or False, # 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.
"maxDeleteCount": 42, # Maximum number of conversations to delete.
"parent": "A String", # Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
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. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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); }
}
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 - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
FULL - Populates all fields in the conversation.
BASIC - Populates all fields in the conversation except the transcript.
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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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.
}
ingest(parent, body=None, x__xgafv=None)
Imports conversations and processes them according to the user's configuration.
Args:
parent: string, Required. The parent resource for new conversations. (required)
body: object, The request body.
The object takes the form of:
{ # The request to ingest conversations.
"conversationConfig": { # Configuration that applies to all conversations. # Configuration that applies to all conversations.
"agentChannel": 42, # Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
"agentId": "A String", # Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.
"customerChannel": 42, # Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
},
"gcsSource": { # Configuration for Cloud Storage bucket sources. # A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
"bucketObjectType": "A String", # Optional. Specifies the type of the objects in `bucket_uri`.
"bucketUri": "A String", # Required. The Cloud Storage bucket containing source objects.
"customMetadataKeys": [ # Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.
"A String",
],
"metadataBucketUri": "A String", # Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.
},
"parent": "A String", # Required. The parent resource for new conversations.
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
"inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
},
"sampleSize": 42, # Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.
"speechConfig": { # Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. # Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.
"speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
},
"transcriptObjectConfig": { # Configuration for processing transcript objects. # Configuration for when `source` contains conversation transcripts.
"medium": "A String", # Required. The medium transcript objects represent.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
list(parent, filter=None, orderBy=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.
orderBy: string, Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
pageSize: integer, The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,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 - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
FULL - Populates all fields in the conversation.
BASIC - Populates all fields in the conversation except the transcript.
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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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()
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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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.
}
upload(parent, body=None, x__xgafv=None)
Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
Args:
parent: string, Required. The parent resource of the conversation. (required)
body: object, The request body.
The object takes the form of:
{ # Request to upload a conversation.
"conversation": { # The conversation resource. # Required. The conversation resource to create.
"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 100 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.
},
"issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
"issueAssignment": { # Information about the issue. # Information about the issue's assignment.
"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].
},
},
"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. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
"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.
},
},
"qaScorecardResults": [ # Results of scoring QaScorecards.
{ # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
"agentId": "A String", # ID of the agent that handled the conversation.
"conversation": "A String", # The conversation scored by this result.
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaAnswers": [ # Set of QaAnswers represented in the result.
{ # An answer to a QaQuestion.
"answerSources": [ # List of all individual answers given to the question.
{ # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"sourceType": "A String", # What created the answer.
},
],
"answerValue": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
"boolValue": True or False, # Boolean value.
"key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
"naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
"numValue": 3.14, # Numerical value.
"potentialScore": 3.14, # Output only. The maximum potential score of the question.
"score": 3.14, # Output only. Numerical score of the answer.
"strValue": "A String", # String value.
},
"conversation": "A String", # The conversation the answer applies to.
"qaQuestion": "A String", # The QaQuestion answered by this answer.
"questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
"tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
"A String",
],
},
],
"qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
"scoreSources": [ # List of all individual score sets.
{ # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
"normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
"potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
"qaTagResults": [ # Collection of tags and their scores.
{ # Tags and their corresponding results.
"normalizedScore": 3.14, # The normalized score the tag applies to.
"potentialScore": 3.14, # The potential score the tag applies to.
"score": 3.14, # The score the tag applies to.
"tag": "A String", # The tag the score applies to.
},
],
"score": 3.14, # The overall numerical score of the result.
"sourceType": "A String", # What created the score.
},
],
},
],
"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).
},
},
],
"silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
"silenceDuration": "A String", # Amount of time calculated to be in silence.
"silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
},
},
"endTime": "A String", # The time at which the analysis ended.
},
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
"scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
"qaScorecardRevisions": [ # List of QaScorecardRevisions.
"A String",
],
},
},
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runQaAnnotator": True or False, # Whether to run the QA annotator.
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"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.
},
"latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
"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.
"qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
"agentInfo": [ # Information about agents involved in the call.
{ # Information about an agent involved in the conversation.
"agentId": "A String", # A user-specified string representing the agent.
"agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
"A String",
],
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
"waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
"answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
"confidence": 3.14, # The confidence score of the summarization.
"conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
"metadata": { # A map that contains metadata about the summarization and the document from which it originates.
"a_key": "A String",
},
"text": "A String", # The summarization content that is concatenated into one string.
"textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
"a_key": "A String",
},
},
"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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_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.
},
"userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
"generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
"query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
"querySource": "A String", # Query source for the answer.
},
},
],
"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": "A String", # Optional. 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-`
"parent": "A String", # Required. The parent resource of the conversation.
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.
"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
"inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
},
"speechConfig": { # Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. # Optional. Speech-to-Text configuration. Will default to the config specified in Settings.
"speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}