Index
ContactCenterInsights
(interface)Analysis
(message)AnalysisResult
(message)AnalysisResult.CallAnalysisMetadata
(message)AnnotationBoundary
(message)AnnotatorSelector
(message)AnnotatorSelector.SummarizationConfig
(message)AnnotatorSelector.SummarizationConfig.SummarizationModel
(enum)AnswerFeedback
(message)AnswerFeedback.CorrectnessLevel
(enum)ArticleSuggestionData
(message)BulkAnalyzeConversationsMetadata
(message)BulkAnalyzeConversationsRequest
(message)BulkAnalyzeConversationsResponse
(message)BulkDeleteConversationsMetadata
(message)BulkDeleteConversationsRequest
(message)BulkDeleteConversationsResponse
(message)CalculateIssueModelStatsRequest
(message)CalculateIssueModelStatsResponse
(message)CalculateStatsRequest
(message)CalculateStatsResponse
(message)CalculateStatsResponse.TimeSeries
(message)CalculateStatsResponse.TimeSeries.Interval
(message)CallAnnotation
(message)Conversation
(message)Conversation.CallMetadata
(message)Conversation.Medium
(enum)Conversation.Transcript
(message)Conversation.Transcript.TranscriptSegment
(message)Conversation.Transcript.TranscriptSegment.DialogflowSegmentMetadata
(message)Conversation.Transcript.TranscriptSegment.WordInfo
(message)ConversationDataSource
(message)ConversationLevelSentiment
(message)ConversationParticipant
(message)ConversationParticipant.Role
(enum)ConversationSummarizationSuggestionData
(message)ConversationView
(enum)CreateAnalysisOperationMetadata
(message)CreateAnalysisRequest
(message)CreateConversationRequest
(message)CreateIssueModelMetadata
(message)CreateIssueModelRequest
(message)CreatePhraseMatcherRequest
(message)CreateViewRequest
(message)DeleteAnalysisRequest
(message)DeleteConversationRequest
(message)DeleteIssueModelMetadata
(message)DeleteIssueModelRequest
(message)DeleteIssueRequest
(message)DeletePhraseMatcherRequest
(message)DeleteViewRequest
(message)DeployIssueModelMetadata
(message)DeployIssueModelRequest
(message)DeployIssueModelResponse
(message)DialogflowIntent
(message)DialogflowInteractionData
(message)DialogflowSource
(message)Entity
(message)Entity.Type
(enum)EntityMentionData
(message)EntityMentionData.MentionType
(enum)ExactMatchConfig
(message)ExportInsightsDataMetadata
(message)ExportInsightsDataRequest
(message)ExportInsightsDataRequest.BigQueryDestination
(message)ExportInsightsDataRequest.WriteDisposition
(enum)ExportInsightsDataResponse
(message)FaqAnswerData
(message)GcsSource
(message)GetAnalysisRequest
(message)GetConversationRequest
(message)GetIssueModelRequest
(message)GetIssueRequest
(message)GetPhraseMatcherRequest
(message)GetSettingsRequest
(message)GetViewRequest
(message)HoldData
(message)IngestConversationsMetadata
(message)IngestConversationsMetadata.IngestConversationsStats
(message)IngestConversationsRequest
(message)IngestConversationsRequest.ConversationConfig
(message)IngestConversationsRequest.GcsSource
(message)IngestConversationsRequest.GcsSource.BucketObjectType
(enum)IngestConversationsRequest.TranscriptObjectConfig
(message)IngestConversationsResponse
(message)Intent
(message)IntentMatchData
(message)InterruptionData
(message)Issue
(message)IssueAssignment
(message)IssueMatchData
(message)IssueModel
(message)IssueModel.InputDataConfig
(message)IssueModel.ModelType
(enum)IssueModel.State
(enum)IssueModelLabelStats
(message)IssueModelLabelStats.IssueStats
(message)IssueModelResult
(message)ListAnalysesRequest
(message)ListAnalysesResponse
(message)ListConversationsRequest
(message)ListConversationsResponse
(message)ListIssueModelsRequest
(message)ListIssueModelsResponse
(message)ListIssuesRequest
(message)ListIssuesResponse
(message)ListPhraseMatchersRequest
(message)ListPhraseMatchersResponse
(message)ListViewsRequest
(message)ListViewsResponse
(message)PhraseMatchData
(message)PhraseMatchRule
(message)PhraseMatchRuleConfig
(message)PhraseMatchRuleGroup
(message)PhraseMatchRuleGroup.PhraseMatchRuleGroupType
(enum)PhraseMatcher
(message)PhraseMatcher.PhraseMatcherType
(enum)RedactionConfig
(message)RuntimeAnnotation
(message)SentimentData
(message)Settings
(message)Settings.AnalysisConfig
(message)SilenceData
(message)SmartComposeSuggestionData
(message)SmartReplyData
(message)SpeechConfig
(message)UndeployIssueModelMetadata
(message)UndeployIssueModelRequest
(message)UndeployIssueModelResponse
(message)UpdateConversationRequest
(message)UpdateIssueModelRequest
(message)UpdateIssueRequest
(message)UpdatePhraseMatcherRequest
(message)UpdateSettingsRequest
(message)UpdateViewRequest
(message)UploadConversationMetadata
(message)UploadConversationRequest
(message)View
(message)
ContactCenterInsights
An API that lets users analyze and explore their business conversation data.
BulkAnalyzeConversations |
---|
Analyzes multiple conversations in a single request.
|
BulkDeleteConversations |
---|
Deletes multiple conversations in a single request.
|
CalculateIssueModelStats |
---|
Gets an issue model's statistics.
|
CalculateStats |
---|
Gets conversation statistics.
|
CreateAnalysis |
---|
Creates an analysis. The long running operation is done when the analysis has completed.
|
CreateConversation |
---|
Creates a conversation.
|
CreateIssueModel |
---|
Creates an issue model.
|
CreatePhraseMatcher |
---|
Creates a phrase matcher.
|
CreateView |
---|
Creates a view.
|
DeleteAnalysis |
---|
Deletes an analysis.
|
DeleteConversation |
---|
Deletes a conversation.
|
DeleteIssue |
---|
Deletes an issue.
|
DeleteIssueModel |
---|
Deletes an issue model.
|
DeletePhraseMatcher |
---|
Deletes a phrase matcher.
|
DeleteView |
---|
Deletes a view.
|
DeployIssueModel |
---|
Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.
|
ExportInsightsData |
---|
Export insights data to a destination defined in the request body.
|
GetAnalysis |
---|
Gets an analysis.
|
GetConversation |
---|
Gets a conversation.
|
GetIssue |
---|
Gets an issue.
|
GetIssueModel |
---|
Gets an issue model.
|
GetPhraseMatcher |
---|
Gets a phrase matcher.
|
GetSettings |
---|
Gets project-level settings.
|
GetView |
---|
Gets a view.
|
IngestConversations |
---|
Imports conversations and processes them according to the user's configuration.
|
ListAnalyses |
---|
Lists analyses.
|
ListConversations |
---|
Lists conversations.
|
ListIssueModels |
---|
Lists issue models.
|
ListIssues |
---|
Lists issues.
|
ListPhraseMatchers |
---|
Lists phrase matchers.
|
ListViews |
---|
Lists views.
|
UndeployIssueModel |
---|
Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.
|
UpdateConversation |
---|
Updates a conversation.
|
UpdateIssue |
---|
Updates an issue.
|
UpdateIssueModel |
---|
Updates an issue model.
|
UpdatePhraseMatcher |
---|
Updates a phrase matcher.
|
UpdateSettings |
---|
Updates project-level settings.
|
UpdateView |
---|
Updates a view.
|
UploadConversation |
---|
Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.
|
Analysis
The analysis resource.
Fields | |
---|---|
name |
Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} |
request_time |
Output only. The time at which the analysis was requested. |
create_time |
Output only. The time at which the analysis was created, which occurs when the long-running operation completes. |
analysis_result |
Output only. The result of the analysis, which is populated when the analysis finishes. |
annotator_selector |
To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run. |
AnalysisResult
The result of an analysis.
Fields | |
---|---|
end_time |
The time at which the analysis ended. |
Union field metadata . Metadata discovered during analysis. metadata can be only one of the following: |
|
call_analysis_metadata |
Call-specific metadata created by the analysis. |
CallAnalysisMetadata
Call-specific metadata created during analysis.
Fields | |
---|---|
annotations[] |
A list of call annotations that apply to this call. |
entities |
All the entities in the call. |
sentiments[] |
Overall conversation-level sentiment for each channel of the call. |
intents |
All the matched intents in the call. |
phrase_matchers |
All the matched phrase matchers in the call. |
issue_model_result |
Overall conversation-level issue modeling result. |
AnnotationBoundary
A point in a conversation that marks the start or the end of an annotation.
Fields | |
---|---|
transcript_index |
The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. |
Union field detailed_boundary . A detailed boundary, which describes a more specific point. detailed_boundary can be only one of the following: |
|
word_index |
The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. |
AnnotatorSelector
Selector of all available annotators and phrase matchers to run.
Fields | |
---|---|
run_interruption_annotator |
Whether to run the interruption annotator. |
run_silence_annotator |
Whether to run the silence annotator. |
run_phrase_matcher_annotator |
Whether to run the active phrase matcher annotator(s). |
phrase_matchers[] |
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} |
run_sentiment_annotator |
Whether to run the sentiment annotator. |
run_entity_annotator |
Whether to run the entity annotator. |
run_intent_annotator |
Whether to run the intent annotator. |
run_issue_model_annotator |
Whether to run the issue model annotator. A model should have already been deployed for this to take effect. |
issue_models[] |
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. |
run_summarization_annotator |
Whether to run the summarization annotator. |
summarization_config |
Configuration for the summarization annotator. |
SummarizationConfig
Configuration for summarization.
Fields | |
---|---|
Union field model_source . Summarization must use either a preexisting conversation profile or one of the supported default models. model_source can be only one of the following: |
|
conversation_profile |
Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} |
summarization_model |
Default summarization model to be used. |
SummarizationModel
Summarization model to use, if conversation_profile
is not used.
Enums | |
---|---|
SUMMARIZATION_MODEL_UNSPECIFIED |
Unspecified summarization model. |
BASELINE_MODEL |
The CCAI baseline model. |
AnswerFeedback
The feedback that the customer has about a certain answer in the conversation.
Fields | |
---|---|
correctness_level |
The correctness level of an answer. |
clicked |
Indicates whether an answer or item was clicked by the human agent. |
displayed |
Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. |
CorrectnessLevel
The correctness level of an answer.
Enums | |
---|---|
CORRECTNESS_LEVEL_UNSPECIFIED |
Correctness level unspecified. |
NOT_CORRECT |
Answer is totally wrong. |
PARTIALLY_CORRECT |
Answer is partially correct. |
FULLY_CORRECT |
Answer is fully correct. |
ArticleSuggestionData
Agent Assist Article Suggestion data.
Fields | |
---|---|
title |
Article title. |
uri |
Article URI. |
confidence_score |
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. |
query_record |
The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} |
source |
The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} |
BulkAnalyzeConversationsMetadata
The metadata for a bulk analyze conversations operation.
Fields | |
---|---|
create_time |
The time the operation was created. |
end_time |
The time the operation finished running. |
request |
The original request for bulk analyze. |
completed_analyses_count |
The number of requested analyses that have completed successfully so far. |
failed_analyses_count |
The number of requested analyses that have failed so far. |
total_requested_analyses_count |
Total number of analyses requested. Computed by the number of conversations returned by |
partial_errors[] |
Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete. |
BulkAnalyzeConversationsRequest
The request to analyze conversations in bulk.
Fields | |
---|---|
parent |
Required. The parent resource to create analyses in. |
filter |
Required. Filter used to select the subset of conversations to analyze. |
analysis_percentage |
Required. Percentage of selected conversation to analyze, between [0, 100]. |
annotator_selector |
To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run. |
BulkAnalyzeConversationsResponse
The response for a bulk analyze conversations operation.
Fields | |
---|---|
successful_analysis_count |
Count of successful analyses. |
failed_analysis_count |
Count of failed analyses. |
BulkDeleteConversationsMetadata
The metadata for a bulk delete conversations operation.
Fields | |
---|---|
create_time |
The time the operation was created. |
end_time |
The time the operation finished running. |
request |
The original request for bulk delete. |
partial_errors[] |
Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete. |
BulkDeleteConversationsRequest
The request to delete conversations in bulk.
Fields | |
---|---|
parent |
Required. The parent resource to create analyses in. Format: projects/{project}/locations/{location} |
filter |
Filter used to select the subset of conversations to analyze. |
max_delete_count |
Maximum number of conversations to delete. The default is 1000. It can be changed by setting the |
force |
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. |
BulkDeleteConversationsResponse
This type has no fields.
The response for a bulk analyze conversations operation.
CalculateIssueModelStatsRequest
Request to get statistics of an issue model.
Fields | |
---|---|
issue_model |
Required. The resource name of the issue model to query against. |
CalculateIssueModelStatsResponse
Response of querying an issue model's statistics.
Fields | |
---|---|
current_stats |
The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment. |
CalculateStatsRequest
The request for calculating conversation statistics.
Fields | |
---|---|
location |
Required. The location of the conversations. |
filter |
A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. |
CalculateStatsResponse
The response for calculating conversation statistics.
Fields | |
---|---|
average_duration |
The average duration of all conversations. The average is calculated using only conversations that have a time duration. |
average_turn_count |
The average number of turns per conversation. |
conversation_count |
The total number of conversations. |
smart_highlighter_matches |
A map associating each smart highlighter display name with its respective number of matches in the set of conversations. |
custom_highlighter_matches |
A map associating each custom highlighter resource name with its respective number of matches in the set of conversations. |
issue_matches |
A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: |
issue_matches_stats |
A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: |
conversation_count_time_series |
A time series representing the count of conversations created over time that match that requested filter criteria. |
TimeSeries
A time series representing conversations over time.
Fields | |
---|---|
interval_duration |
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. |
Interval
A single interval in a time series.
Fields | |
---|---|
start_time |
The start time of this interval. |
conversation_count |
The number of conversations created in this interval. |
CallAnnotation
A piece of metadata that applies to a window of a call.
Fields | |
---|---|
channel_tag |
The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. |
annotation_start_boundary |
The boundary in the conversation where the annotation starts, inclusive. |
annotation_end_boundary |
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: |
|
interruption_data |
Data specifying an interruption. |
sentiment_data |
Data specifying sentiment. |
silence_data |
Data specifying silence. |
hold_data |
Data specifying a hold. |
entity_mention_data |
Data specifying an entity mention. |
intent_match_data |
Data specifying an intent match. |
phrase_match_data |
Data specifying a phrase match. |
issue_match_data |
Data specifying an issue match. |
Conversation
The conversation resource.
Fields | |
---|---|
name |
Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} |
data_source |
The source of the audio and transcription for the conversation. |
create_time |
Output only. The time at which the conversation was created. |
update_time |
Output only. The most recent time at which the conversation was updated. |
start_time |
The time at which the conversation started. |
language_code |
A user-specified language code for the conversation. |
agent_id |
An opaque, user-specified string representing the human agent who handled the conversation. |
labels |
A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. |
transcript |
Output only. The conversation transcript. |
medium |
Immutable. The conversation medium, if unspecified will default to PHONE_CALL. |
duration |
Output only. The duration of the conversation. |
turn_count |
Output only. The number of turns in the conversation. |
latest_analysis |
Output only. The conversation's latest analysis, if one exists. |
latest_summary |
Output only. Latest summary of the conversation. |
runtime_annotations[] |
Output only. The annotations that were generated during the customer and agent interaction. |
dialogflow_intents |
Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} |
obfuscated_user_id |
Obfuscated user ID which the customer sent to us. |
Union field metadata . Metadata that applies to the conversation. metadata can be only one of the following: |
|
call_metadata |
Call-specific metadata. |
Union field expiration . A time to live expiration setting, can be either a specified timestamp or a duration from the time that the conversation creation request was received. Conversations with an expiration set will be removed up to 24 hours after the specified time. expiration can be only one of the following: |
|
expire_time |
The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. |
ttl |
Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. |
CallMetadata
Call-specific metadata.
Fields | |
---|---|
customer_channel |
The audio channel that contains the customer. |
agent_channel |
The audio channel that contains the agent. |
Medium
Possible media for the conversation.
Enums | |
---|---|
MEDIUM_UNSPECIFIED |
Default value, if unspecified will default to PHONE_CALL. |
PHONE_CALL |
The format for conversations that took place over the phone. |
CHAT |
The format for conversations that took place over chat. |
Transcript
A message representing the transcript of a conversation.
Fields | |
---|---|
transcript_segments[] |
A list of sequential transcript segments that comprise the conversation. |
TranscriptSegment
A segment of a full transcript.
Fields | |
---|---|
message_time |
The time that the message occurred, if provided. |
text |
The text of this segment. |
confidence |
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. |
words[] |
A list of the word-specific information for each word in the segment. |
language_code |
The language code of this segment as a BCP-47 language tag. Example: "en-US". |
channel_tag |
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. |
segment_participant |
The participant of this segment. |
dialogflow_segment_metadata |
CCAI metadata relating to the current transcript segment. |
sentiment |
The sentiment for this transcript segment. |
DialogflowSegmentMetadata
Metadata from Dialogflow relating to the current transcript segment.
Fields | |
---|---|
smart_reply_allowlist_covered |
Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. |
WordInfo
Word-level info for words in a transcript.
Fields | |
---|---|
start_offset |
Time offset of the start of this word relative to the beginning of the total conversation. |
end_offset |
Time offset of the end of this word relative to the beginning of the total conversation. |
word |
The word itself. Includes punctuation marks that surround the word. |
confidence |
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. |
ConversationDataSource
The conversation source, which is a combination of transcript, audio, and metadata.
Fields | |
---|---|
Union field source . The source of the conversation. source can be only one of the following: |
|
gcs_source |
A Cloud Storage location specification for the audio and transcript. |
dialogflow_source |
The source when the conversation comes from Dialogflow. |
ConversationLevelSentiment
One channel of conversation-level sentiment data.
Fields | |
---|---|
channel_tag |
The channel of the audio that the data applies to. |
sentiment_data |
Data specifying sentiment. |
ConversationParticipant
The call participant speaking for a given utterance.
Fields | |
---|---|
dialogflow_participant |
Deprecated. Use |
obfuscated_external_user_id |
Obfuscated user ID from Dialogflow. |
role |
The role of the participant. |
Union field
|
|
dialogflow_participant_name |
The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} |
user_id |
A user-specified ID representing the participant. |
Role
The role of the participant.
Enums | |
---|---|
ROLE_UNSPECIFIED |
Participant's role is not set. |
HUMAN_AGENT |
Participant is a human agent. |
AUTOMATED_AGENT |
Participant is an automated agent. |
END_USER |
Participant is an end user who conversed with the contact center. |
ANY_AGENT |
Participant is either a human or automated agent. |
ConversationSummarizationSuggestionData
Conversation summarization suggestion data.
Fields | |
---|---|
text |
The summarization content that is concatenated into one string. |
text_sections |
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. |
confidence |
The confidence score of the summarization. |
metadata |
A map that contains metadata about the summarization and the document from which it originates. |
answer_record |
The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} |
conversation_model |
The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model} |
ConversationView
Represents the options for viewing a conversation.
Enums | |
---|---|
CONVERSATION_VIEW_UNSPECIFIED |
The conversation view is not specified.
|
FULL |
Populates all fields in the conversation. |
BASIC |
Populates all fields in the conversation except the transcript. |
CreateAnalysisOperationMetadata
Metadata for a create analysis operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
conversation |
Output only. The Conversation that this Analysis Operation belongs to. |
annotator_selector |
Output only. The annotator selector used for the analysis (if any). |
CreateAnalysisRequest
The request to create an analysis.
Fields | |
---|---|
parent |
Required. The parent resource of the analysis. |
analysis |
Required. The analysis to create. |
CreateConversationRequest
Request to create a conversation.
Fields | |
---|---|
parent |
Required. The parent resource of the conversation. |
conversation |
Required. The conversation resource to create. |
conversation_id |
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 |
CreateIssueModelMetadata
Metadata for creating an issue model.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
The original request for creation. |
CreateIssueModelRequest
The request to create an issue model.
Fields | |
---|---|
parent |
Required. The parent resource of the issue model. |
issue_model |
Required. The issue model to create. |
CreatePhraseMatcherRequest
Request to create a phrase matcher.
Fields | |
---|---|
parent |
Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: |
phrase_matcher |
Required. The phrase matcher resource to create. |
CreateViewRequest
The request to create a view.
Fields | |
---|---|
parent |
Required. The parent resource of the view. Required. The location to create a view for. Format: |
view |
Required. The view resource to create. |
DeleteAnalysisRequest
The request to delete an analysis.
Fields | |
---|---|
name |
Required. The name of the analysis to delete. |
DeleteConversationRequest
The request to delete a conversation.
Fields | |
---|---|
name |
Required. The name of the conversation to delete. |
force |
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. |
DeleteIssueModelMetadata
Metadata for deleting an issue model.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
The original request for deletion. |
DeleteIssueModelRequest
The request to delete an issue model.
Fields | |
---|---|
name |
Required. The name of the issue model to delete. |
DeleteIssueRequest
The request to delete an issue.
Fields | |
---|---|
name |
Required. The name of the issue to delete. |
DeletePhraseMatcherRequest
The request to delete a phrase matcher.
Fields | |
---|---|
name |
Required. The name of the phrase matcher to delete. |
DeleteViewRequest
The request to delete a view.
Fields | |
---|---|
name |
Required. The name of the view to delete. |
DeployIssueModelMetadata
Metadata for deploying an issue model.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
The original request for deployment. |
DeployIssueModelRequest
The request to deploy an issue model.
Fields | |
---|---|
name |
Required. The issue model to deploy. |
DeployIssueModelResponse
This type has no fields.
The response to deploy an issue model.
DialogflowIntent
The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
Fields | |
---|---|
display_name |
The human-readable name of the intent. |
DialogflowInteractionData
Dialogflow interaction data.
Fields | |
---|---|
dialogflow_intent_id |
The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} |
confidence |
The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). |
DialogflowSource
A Dialogflow source of conversation data.
Fields | |
---|---|
dialogflow_conversation |
Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} |
audio_uri |
Cloud Storage URI that points to a file that contains the conversation audio. |
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.
Fields | |
---|---|
display_name |
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 ( |
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 |
EntityMentionData
The data for an entity mention annotation. This represents a mention of an Entity
in the conversation.
Fields | |
---|---|
entity_unique_id |
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). |
ExactMatchConfig
Exact match configuration.
Fields | |
---|---|
case_sensitive |
Whether to consider case sensitivity when performing an exact match. |
ExportInsightsDataMetadata
Metadata for an export insights operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
The original request for export. |
partial_errors[] |
Partial errors during export operation that might cause the operation output to be incomplete. |
ExportInsightsDataRequest
The request to export insights.
Fields | |
---|---|
parent |
Required. The parent resource to export data from. |
filter |
A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties. |
kms_key |
A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} |
<