Close httplib2 connections.
create(parent, autoLabelingRuleId=None, body=None, x__xgafv=None)
Creates an auto labeling rule.
Deletes an auto labeling rule.
Gets an auto labeling rule.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists auto labeling rules.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an auto labeling rule.
test(parent, body=None, x__xgafv=None)
Tests auto labeling rules against a conversation.
close()
Close httplib2 connections.
create(parent, autoLabelingRuleId=None, body=None, x__xgafv=None)
Creates an auto labeling rule.
Args:
parent: string, Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
}
autoLabelingRuleId: string, Required. The ID to use for the auto labeling rule, which will become the final component of the auto labeling rule's resource name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
}
delete(name, x__xgafv=None)
Deletes an auto labeling rule.
Args:
name: string, Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule} (required)
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, x__xgafv=None)
Gets an auto labeling rule.
Args:
name: string, Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists auto labeling rules.
Args:
parent: string, Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location} (required)
pageSize: integer, Optional. The maximum number of auto labeling rules to return in a single response. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for listing auto labeling rules.
"autoLabelingRules": [ # The auto labeling rules.
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
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 an auto labeling rule.
Args:
name: string, Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule} (required)
body: object, The request body.
The object takes the form of:
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
}
updateMask: string, Optional. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Rule for auto-labeling conversations.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
}
test(parent, body=None, x__xgafv=None)
Tests auto labeling rules against a conversation.
Args:
parent: string, Required. The parent project and location. Format: projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
{ # The request message for testing auto labeling rules.
"autoLabelingRule": { # Rule for auto-labeling conversations. # Required. The auto labeling rule to test.
"active": True or False, # Whether the rule is active.
"conditions": [ # Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.
{ # Condition for auto-labeling conversations.
"condition": "A String", # A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
"value": "A String", # CEL expression to be evaluated as the value.
},
],
"createTime": "A String", # Output only. The time at which this rule was created.
"description": "A String", # The description of the rule.
"displayName": "A String", # The user-provided display name of the rule.
"labelKey": "A String", # The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.
"labelKeyType": "A String", # The type of the label key.
"name": "A String", # Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
"updateTime": "A String", # Output only. The most recent time at which the rule was updated.
},
"conversation": { # The conversation resource. # Required. Conversation data to test rules against.
"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.
},
"correlationInfo": { # Info for correlating across conversations. # Output only. Info for correlating across conversations.
"correlationTypes": [ # Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.
"A String",
],
"fullConversationCorrelationId": "A String", # Output only. The full conversation correlation id this conversation is a segment of.
"mergedFullConversationCorrelationId": "A String", # Output only. The full conversation correlation id this conversation is a merged conversation of.
},
"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.
},
"metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata.
},
"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 absolute 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 analysis 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 absolute 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 absolute 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 analysis 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": [ # Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.
{ # 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. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.
"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.
"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.
"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 answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.
"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.
"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.
"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 absolute 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}
"generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
"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}
"generatorId": "A String", # Agent Assist generator ID.
"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.
"metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony 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.
"deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents.
"deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents.
"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",
],
"versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents.
"versionId": "A String", # The agent's version ID. Only applicable to automated agents.
},
],
"customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
"feedbackLabels": [ # Input only. The feedback labels associated with the conversation.
{ # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.
"createTime": "A String", # Output only. Create time of the label.
"label": "A String", # String label used for Topic Modeling.
"labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`
"name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
"qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations.
"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.
"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.
"strValue": "A String", # String value.
},
"updateTime": "A String", # Output only. Update time of the label.
},
],
"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}
"generatorId": "A String", # Agent Assist generator ID.
"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 absolute 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.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for testing auto labeling rules.
"labelResult": "A String", # The result of the test auto labeling rule.
}