- Resource: Analysis
- Methods
Resource: Analysis
The analysis resource.
JSON representation |
---|
{
"name": string,
"requestTime": string,
"createTime": string,
"analysisResult": {
object ( |
Fields | |
---|---|
name |
Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} |
requestTime |
Output only. The time at which the analysis was requested. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
createTime |
Output only. The time at which the analysis was created, which occurs when the long-running operation completes. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
analysisResult |
Output only. The result of the analysis, which is populated when the analysis finishes. |
AnalysisResult
The result of an analysis.
JSON representation |
---|
{
"endTime": string,
"callAnalysisMetadata": {
object ( |
Fields | |
---|---|
endTime |
The time at which the analysis ended. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
callAnalysisMetadata |
Call-specific metadata created by the analysis. |
CallAnalysisMetadata
Call-specific metadata created during analysis.
JSON representation |
---|
{ "annotations": [ { object ( |
Fields | |
---|---|
annotations[] |
A list of call annotations that apply to this call. |
entities |
All the entities in the call. An object containing a list of |
sentiments[] |
Overall conversation-level sentiment for each channel of the call. |
intents |
All the matched intents in the call. An object containing a list of |
phraseMatchers |
All the matched phrase matchers in the call. An object containing a list of |
issueModelResult |
Overall conversation-level issue modeling result. |
CallAnnotation
A piece of metadata that applies to a window of a call.
JSON representation |
---|
{ "channelTag": integer, "annotationStartBoundary": { object ( |
Fields | |
---|---|
channelTag |
The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. |
annotationStartBoundary |
The boundary in the conversation where the annotation starts, inclusive. |
annotationEndBoundary |
The boundary in the conversation where the annotation ends, inclusive. |
Union field data . The data in the annotation. data can be only one of the following: |
|
interruptionData |
Data specifying an interruption. |
sentimentData |
Data specifying sentiment. |
silenceData |
Data specifying silence. |
holdData |
Data specifying a hold. |
entityMentionData |
Data specifying an entity mention. |
intentMatchData |
Data specifying an intent match. |
phraseMatchData |
Data specifying a phrase match. |
InterruptionData
The data for an interruption annotation.
SilenceData
The data for a silence annotation.
HoldData
The data for a hold annotation.
EntityMentionData
The data for an entity mention annotation. This represents a mention of an Entity
in the conversation.
JSON representation |
---|
{ "entityUniqueId": string, "type": enum ( |
Fields | |
---|---|
entityUniqueId |
The key of this entity in conversation entities. Can be used to retrieve the exact |
type |
The type of the entity mention. |
sentiment |
Sentiment expressed for this mention of the entity. |
MentionType
The supported types of mentions.
Enums | |
---|---|
MENTION_TYPE_UNSPECIFIED |
Unspecified. |
PROPER |
Proper noun. |
COMMON |
Common noun (or noun compound). |
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.
JSON representation |
---|
{ "intentUniqueId": string } |
Fields | |
---|---|
intentUniqueId |
The id of the matched intent. Can be used to retrieve the corresponding intent information. |
PhraseMatchData
The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
JSON representation |
---|
{ "phraseMatcher": string, "displayName": string } |
Fields | |
---|---|
phraseMatcher |
The unique identifier (the resource name) of the phrase matcher. |
displayName |
The human-readable name of the phrase matcher. |
Entity
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.
JSON representation |
---|
{ "displayName": string, "type": enum ( |
Fields | |
---|---|
displayName |
The representative name for the entity. |
type |
The entity type. |
metadata |
Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL ( An object containing a list of |
salience |
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 aggregate sentiment expressed for this entity in the conversation. |
Type
The type of the entity. For most entity types, the associated metadata is a Wikipedia URL (wikipedia_url
) and Knowledge Graph MID (mid
). The table below lists the associated fields for entities that have different metadata.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
PERSON |
Person. |
LOCATION |
Location. |
ORGANIZATION |
Organization. |
EVENT |
Event. |
WORK_OF_ART |
Artwork. |
CONSUMER_GOOD |
Consumer product. |
OTHER |
Other types of entities. |
PHONE_NUMBER |
Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text:
|
ADDRESS |
Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text:
|
DATE |
Date. The metadata identifies the components of the date:
|
NUMBER |
Number. The metadata is the number itself. |
PRICE |
Price. The metadata identifies the |
ConversationLevelSentiment
One channel of conversation-level sentiment data.
JSON representation |
---|
{
"channelTag": integer,
"sentimentData": {
object ( |
Fields | |
---|---|
channelTag |
The channel of the audio that the data applies to. |
sentimentData |
Data specifying sentiment. |
Intent
The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
JSON representation |
---|
{ "id": string, "displayName": string } |
Fields | |
---|---|
id |
The unique identifier of the intent. |
displayName |
The human-readable name of the intent. |
IssueModelResult
Issue Modeling result on a conversation.
JSON representation |
---|
{
"issueModel": string,
"issues": [
{
object ( |
Fields | |
---|---|
issueModel |
Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issueModel} |
issues[] |
All the matched issues. |
IssueAssignment
Information about the issue.
JSON representation |
---|
{ "issue": string, "score": number, "displayName": string } |
Fields | |
---|---|
issue |
Resource name of the assigned issue. |
score |
Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. |
displayName |
Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. |
Methods |
|
---|---|
|
Creates an analysis. |
|
Deletes an analysis. |
|
Gets an analysis. |
|
Lists analyses. |