Index
ContactCenterInsights(interface)Analysis(message)AnalysisResult(message)AnalysisResult.CallAnalysisMetadata(message)AnalysisRule(message)AnnotationBoundary(message)AnnotatorSelector(message)AnnotatorSelector.QaConfig(message)AnnotatorSelector.QaConfig.ScorecardList(message)AnnotatorSelector.SummarizationConfig(message)AnnotatorSelector.SummarizationConfig.SummarizationModel(enum)AnswerFeedback(message)AnswerFeedback.CorrectnessLevel(enum)AppealAssessmentRequest(message)ArticleSuggestionData(message)Assessment(message)Assessment.State(enum)AssessmentRule(message)AuthorizedView(message)AuthorizedViewSet(message)BulkAnalyzeConversationsMetadata(message)BulkAnalyzeConversationsRequest(message)BulkAnalyzeConversationsResponse(message)BulkDeleteConversationsMetadata(message)BulkDeleteConversationsRequest(message)BulkDeleteConversationsResponse(message)BulkDeleteFeedbackLabelsMetadata(message)BulkDeleteFeedbackLabelsRequest(message)BulkDeleteFeedbackLabelsResponse(message)BulkDownloadFeedbackLabelsMetadata(message)BulkDownloadFeedbackLabelsMetadata.DownloadStats(message)BulkDownloadFeedbackLabelsRequest(message)BulkDownloadFeedbackLabelsRequest.FeedbackLabelType(enum)BulkDownloadFeedbackLabelsRequest.GcsDestination(message)BulkDownloadFeedbackLabelsRequest.GcsDestination.Format(enum)BulkDownloadFeedbackLabelsRequest.SheetsDestination(message)BulkDownloadFeedbackLabelsResponse(message)BulkUploadFeedbackLabelsMetadata(message)BulkUploadFeedbackLabelsMetadata.UploadStats(message)BulkUploadFeedbackLabelsRequest(message)BulkUploadFeedbackLabelsRequest.GcsSource(message)BulkUploadFeedbackLabelsRequest.GcsSource.Format(enum)BulkUploadFeedbackLabelsRequest.SheetsSource(message)BulkUploadFeedbackLabelsResponse(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.QualityMetadata(message)Conversation.QualityMetadata.AgentInfo(message)Conversation.Transcript(message)Conversation.Transcript.TranscriptSegment(message)Conversation.Transcript.TranscriptSegment.DialogflowSegmentMetadata(message)Conversation.Transcript.TranscriptSegment.WordInfo(message)ConversationDataSource(message)ConversationLevelSentiment(message)ConversationLevelSilence(message)ConversationParticipant(message)ConversationParticipant.Role(enum)ConversationSummarizationSuggestionData(message)ConversationView(enum)CreateAnalysisOperationMetadata(message)CreateAnalysisRequest(message)CreateAnalysisRuleRequest(message)CreateAssessmentRequest(message)CreateAssessmentRuleRequest(message)CreateAuthorizedViewRequest(message)CreateAuthorizedViewSetRequest(message)CreateConversationRequest(message)CreateFeedbackLabelRequest(message)CreateIssueMetadata(message)CreateIssueModelMetadata(message)CreateIssueModelRequest(message)CreateIssueRequest(message)CreateNoteRequest(message)CreatePhraseMatcherRequest(message)CreateQaQuestionRequest(message)CreateQaQuestionTagRequest(message)CreateQaScorecardRequest(message)CreateQaScorecardRevisionRequest(message)CreateViewRequest(message)Dataset(message)Dataset.Type(enum)DatasetValidationWarning(enum)DeleteAnalysisRequest(message)DeleteAnalysisRuleRequest(message)DeleteAssessmentRequest(message)DeleteAssessmentRuleRequest(message)DeleteAuthorizedViewRequest(message)DeleteAuthorizedViewSetRequest(message)DeleteConversationRequest(message)DeleteFeedbackLabelRequest(message)DeleteIssueModelMetadata(message)DeleteIssueModelRequest(message)DeleteIssueRequest(message)DeleteNoteRequest(message)DeletePhraseMatcherRequest(message)DeleteQaQuestionRequest(message)DeleteQaQuestionTagMetadata(message)DeleteQaQuestionTagRequest(message)DeleteQaScorecardRequest(message)DeleteQaScorecardRevisionRequest(message)DeleteViewRequest(message)DeployIssueModelMetadata(message)DeployIssueModelRequest(message)DeployIssueModelResponse(message)DeployQaScorecardRevisionRequest(message)DialogflowIntent(message)DialogflowInteractionData(message)DialogflowSource(message)Dimension(message)Dimension.AgentDimensionMetadata(message)Dimension.DimensionKey(enum)Dimension.IssueDimensionMetadata(message)Dimension.QaQuestionAnswerDimensionMetadata(message)Dimension.QaQuestionDimensionMetadata(message)EncryptionSpec(message)Entity(message)Entity.Type(enum)EntityMentionData(message)EntityMentionData.MentionType(enum)ExactMatchConfig(message)ExportInsightsDataMetadata(message)ExportInsightsDataRequest(message)ExportInsightsDataRequest.BigQueryDestination(message)ExportInsightsDataRequest.ExportSchemaVersion(enum)ExportInsightsDataRequest.WriteDisposition(enum)ExportInsightsDataResponse(message)ExportIssueModelMetadata(message)ExportIssueModelRequest(message)ExportIssueModelRequest.GcsDestination(message)ExportIssueModelResponse(message)FaqAnswerData(message)FeedbackLabel(message)FinalizeAssessmentRequest(message)GcsSource(message)GetAnalysisRequest(message)GetAnalysisRuleRequest(message)GetAssessmentRequest(message)GetAssessmentRuleRequest(message)GetAuthorizedViewRequest(message)GetAuthorizedViewSetRequest(message)GetConversationRequest(message)GetEncryptionSpecRequest(message)GetFeedbackLabelRequest(message)GetIssueModelRequest(message)GetIssueRequest(message)GetPhraseMatcherRequest(message)GetQaQuestionRequest(message)GetQaQuestionTagRequest(message)GetQaScorecardRequest(message)GetQaScorecardRevisionRequest(message)GetSettingsRequest(message)GetViewRequest(message)HoldData(message)ImportIssueModelMetadata(message)ImportIssueModelRequest(message)ImportIssueModelRequest.GcsSource(message)ImportIssueModelResponse(message)IngestConversationsMetadata(message)IngestConversationsMetadata.IngestConversationsStats(message)IngestConversationsRequest(message)IngestConversationsRequest.ConversationConfig(message)IngestConversationsRequest.GcsSource(message)IngestConversationsRequest.GcsSource.BucketObjectType(enum)IngestConversationsRequest.TranscriptObjectConfig(message)IngestConversationsResponse(message)InitializeEncryptionSpecMetadata(message)InitializeEncryptionSpecRequest(message)InitializeEncryptionSpecResponse(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)ListAllFeedbackLabelsRequest(message)ListAllFeedbackLabelsResponse(message)ListAnalysesRequest(message)ListAnalysesResponse(message)ListAnalysisRulesRequest(message)ListAnalysisRulesResponse(message)ListAssessmentRulesRequest(message)ListAssessmentRulesResponse(message)ListAssessmentsRequest(message)ListAssessmentsResponse(message)ListAuthorizedViewSetsRequest(message)ListAuthorizedViewSetsResponse(message)ListAuthorizedViewsRequest(message)ListAuthorizedViewsResponse(message)ListConversationsRequest(message)ListConversationsResponse(message)ListFeedbackLabelsRequest(message)ListFeedbackLabelsResponse(message)ListIssueModelsRequest(message)ListIssueModelsResponse(message)ListIssuesRequest(message)ListIssuesResponse(message)ListNotesRequest(message)ListNotesResponse(message)ListPhraseMatchersRequest(message)ListPhraseMatchersResponse(message)ListQaQuestionTagsRequest(message)ListQaQuestionTagsResponse(message)ListQaQuestionsRequest(message)ListQaQuestionsResponse(message)ListQaScorecardRevisionsRequest(message)ListQaScorecardRevisionsResponse(message)ListQaScorecardsRequest(message)ListQaScorecardsResponse(message)ListViewsRequest(message)ListViewsResponse(message)Note(message)Note.AssessmentNote(message)Note.ConversationTurnNote(message)Note.QaQuestionNote(message)PhraseMatchData(message)PhraseMatchRule(message)PhraseMatchRuleConfig(message)PhraseMatchRuleGroup(message)PhraseMatchRuleGroup.PhraseMatchRuleGroupType(enum)PhraseMatcher(message)PhraseMatcher.PhraseMatcherType(enum)PublishAssessmentRequest(message)QaAnswer(message)QaAnswer.AnswerSource(message)QaAnswer.AnswerSource.SourceType(enum)QaAnswer.AnswerValue(message)QaQuestion(message)QaQuestion.AnswerChoice(message)QaQuestion.Metrics(message)QaQuestion.PredefinedQuestionConfig(message)QaQuestion.PredefinedQuestionConfig.PredefinedQuestionType(enum)QaQuestion.QaQuestionType(enum)QaQuestion.TuningMetadata(message)QaQuestionTag(message)QaScorecard(message)QaScorecardResult(message)QaScorecardResult.QaTagResult(message)QaScorecardResult.ScoreSource(message)QaScorecardResult.ScoreSource.SourceType(enum)QaScorecardRevision(message)QaScorecardRevision.State(enum)QueryInterval(message)QueryMetricsMetadata(message)QueryMetricsRequest(message)QueryMetricsRequest.TimeGranularity(enum)QueryMetricsResponse(message)QueryMetricsResponse.Slice(message)QueryMetricsResponse.Slice.DataPoint(message)QueryMetricsResponse.Slice.DataPoint.ConversationMeasure(message)QueryMetricsResponse.Slice.DataPoint.ConversationMeasure.QaTagScore(message)QueryMetricsResponse.Slice.TimeSeries(message)QueryPerformanceOverviewMetadata(message)QueryPerformanceOverviewRequest(message)QueryPerformanceOverviewRequest.AgentSource(message)QueryPerformanceOverviewResponse(message)RedactionConfig(message)RuntimeAnnotation(message)RuntimeAnnotation.UserInput(message)RuntimeAnnotation.UserInput.QuerySource(enum)SampleConversationsMetadata(message)SampleConversationsMetadata.SampleConversationsStats(message)SampleConversationsRequest(message)SampleConversationsResponse(message)SampleRule(message)ScheduleInfo(message)SearchAuthorizedViewsRequest(message)SearchAuthorizedViewsResponse(message)SentimentData(message)Settings(message)Settings.AnalysisConfig(message)SilenceData(message)SmartComposeSuggestionData(message)SmartReplyData(message)SpeechConfig(message)TuneQaScorecardRevisionMetadata(message)TuneQaScorecardRevisionMetadata.QaQuestionDatasetTuningMetrics(message)TuneQaScorecardRevisionMetadata.QaQuestionDatasetTuningMetrics.Metrics(message)TuneQaScorecardRevisionMetadata.QaQuestionDatasetValidationResult(message)TuneQaScorecardRevisionRequest(message)TuneQaScorecardRevisionResponse(message)UndeployIssueModelMetadata(message)UndeployIssueModelRequest(message)UndeployIssueModelResponse(message)UndeployQaScorecardRevisionRequest(message)UpdateAnalysisRuleRequest(message)UpdateAssessmentRuleRequest(message)UpdateAuthorizedViewRequest(message)UpdateAuthorizedViewSetRequest(message)UpdateConversationRequest(message)UpdateFeedbackLabelRequest(message)UpdateIssueModelRequest(message)UpdateIssueRequest(message)UpdateNoteRequest(message)UpdatePhraseMatcherRequest(message)UpdateQaQuestionRequest(message)UpdateQaQuestionTagMetadata(message)UpdateQaQuestionTagRequest(message)UpdateQaScorecardRequest(message)UpdateSettingsRequest(message)UpdateViewRequest(message)UploadConversationMetadata(message)UploadConversationRequest(message)UserInfo(message)View(message)
ContactCenterInsights
An API that lets users analyze and explore their business conversation data.
| AppealAssessment |
|---|
|
Appeal an Assessment.
|
| BulkAnalyzeConversations |
|---|
|
Analyzes multiple conversations in a single request.
|
| BulkDeleteConversations |
|---|
|
Deletes multiple conversations in a single request.
|
| BulkDeleteFeedbackLabels |
|---|
|
Delete feedback labels in bulk using a filter.
|
| BulkDownloadFeedbackLabels |
|---|
|
Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.
|
| BulkUploadFeedbackLabels |
|---|
|
Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.
|
| 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.
|
| CreateAnalysisRule |
|---|
|
Creates a analysis rule.
|
| CreateAssessment |
|---|
|
Create Assessment.
|
| CreateAssessmentRule |
|---|
|
Creates an assessment rule.
|
| CreateAuthorizedView |
|---|
|
Create AuthorizedView
|
| CreateAuthorizedViewSet |
|---|
|
Create AuthorizedViewSet
|
| CreateConversation |
|---|
|
Creates a conversation. Note that this method does not support audio transcription or redaction. Use
|
| CreateFeedbackLabel |
|---|
|
Create feedback label.
|
| CreateIssue |
|---|
|
Creates an issue.
|
| CreateIssueModel |
|---|
|
Creates an issue model.
|
| CreateNote |
|---|
|
Create Note.
|
| CreatePhraseMatcher |
|---|
|
Creates a phrase matcher.
|
| CreateQaQuestion |
|---|
|
Create a QaQuestion.
|
| CreateQaQuestionTag |
|---|
|
Creates a QaQuestionTag.
|
| CreateQaScorecard |
|---|
|
Create a QaScorecard.
|
| CreateQaScorecardRevision |
|---|
|
Creates a QaScorecardRevision.
|
| CreateView |
|---|
|
Creates a view.
|
| DeleteAnalysis |
|---|
|
Deletes an analysis.
|
| DeleteAnalysisRule |
|---|
|
Deletes a analysis rule.
|
| DeleteAssessment |
|---|
|
Delete an Assessment.
|
| DeleteAssessmentRule |
|---|
|
Deletes an assessment rule.
|
| DeleteAuthorizedView |
|---|
|
Deletes an AuthorizedView.
|
| DeleteAuthorizedViewSet |
|---|
|
Deletes an AuthorizedViewSet.
|
| DeleteConversation |
|---|
|
Deletes a conversation.
|
| DeleteFeedbackLabel |
|---|
|
Delete feedback label.
|
| DeleteIssue |
|---|
|
Deletes an issue.
|
| DeleteIssueModel |
|---|
|
Deletes an issue model.
|
| DeleteNote |
|---|
|
Deletes a Note.
|
| DeletePhraseMatcher |
|---|
|
Deletes a phrase matcher.
|
| DeleteQaQuestion |
|---|
|
Deletes a QaQuestion.
|
| DeleteQaQuestionTag |
|---|
|
Deletes a QaQuestionTag.
|
| DeleteQaScorecard |
|---|
|
Deletes a QaScorecard.
|
| DeleteQaScorecardRevision |
|---|
|
Deletes a QaScorecardRevision.
|
| 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.
|
| DeployQaScorecardRevision |
|---|
|
Deploy a QaScorecardRevision.
|
| ExportInsightsData |
|---|
|
Export insights data to a destination defined in the request body.
|
| ExportIssueModel |
|---|
|
Exports an issue model to the provided destination.
|
| FinalizeAssessment |
|---|
|
Finalize an Assessment.
|
| GetAnalysis |
|---|
|
Gets an analysis.
|
| GetAnalysisRule |
|---|
|
Get a analysis rule.
|
| GetAssessment |
|---|
|
Get Assessment.
|
| GetAssessmentRule |
|---|
|
Get an assessment rule.
|
| GetAuthorizedView |
|---|
|
Get AuthorizedView
|
| GetAuthorizedViewSet |
|---|
|
Get AuthorizedViewSet
|
| GetConversation |
|---|
|
Gets a conversation.
|
| GetEncryptionSpec |
|---|
|
Gets location-level encryption key specification.
|
| GetFeedbackLabel |
|---|
|
Get feedback label.
|
| GetIssue |
|---|
|
Gets an issue.
|
| GetIssueModel |
|---|
|
Gets an issue model.
|
| GetPhraseMatcher |
|---|
|
Gets a phrase matcher.
|
| GetQaQuestion |
|---|
|
Gets a QaQuestion.
|
| GetQaQuestionTag |
|---|
|
Gets a QaQuestionTag.
|
| GetQaScorecard |
|---|
|
Gets a QaScorecard.
|
| GetQaScorecardRevision |
|---|
|
Gets a QaScorecardRevision.
|
| GetSettings |
|---|
|
Gets project-level settings.
|
| GetView |
|---|
|
Gets a view.
|
| ImportIssueModel |
|---|
|
Imports an issue model from a Cloud Storage bucket.
|
| IngestConversations |
|---|
|
Imports conversations and processes them according to the user's configuration.
|
| InitializeEncryptionSpec |
|---|
|
Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
|
| ListAllFeedbackLabels |
|---|
|
List all feedback labels by project number.
|
| ListAnalyses |
|---|
|
Lists analyses.
|
| ListAnalysisRules |
|---|
|
Lists analysis rules.
|
| ListAssessmentRules |
|---|
|
Lists assessment rules.
|
| ListAssessments |
|---|
|
List Assessments.
|
| ListAuthorizedViewSets |
|---|
|
List AuthorizedViewSets
|
| ListAuthorizedViews |
|---|
|
List AuthorizedViewSets
|
| ListConversations |
|---|
|
Lists conversations.
|
| ListFeedbackLabels |
|---|
|
List feedback labels.
|
| ListIssueModels |
|---|
|
Lists issue models.
|
| ListIssues |
|---|
|
Lists issues.
|
| ListNotes |
|---|
|
List Notes.
|
| ListPhraseMatchers |
|---|
|
Lists phrase matchers.
|
| ListQaQuestionTags |
|---|
|
Lists the question tags.
|
| ListQaQuestions |
|---|
|
Lists QaQuestions.
|
| ListQaScorecardRevisions |
|---|
|
Lists all revisions under the parent QaScorecard.
|
| ListQaScorecards |
|---|
|
Lists QaScorecards.
|
| ListViews |
|---|
|
Lists views.
|
| PublishAssessment |
|---|
|
Publish an Assessment.
|
| QueryMetrics |
|---|
|
Query metrics.
|
| QueryPerformanceOverview |
|---|
|
Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.
|
| SearchAuthorizedViews |
|---|
|
SearchAuthorizedViewSets
|
| TuneQaScorecardRevision |
|---|
|
Fine tune one or more QaModels.
|
| UndeployIssueModel |
|---|
|
Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.
|
| UndeployQaScorecardRevision |
|---|
|
Undeploy a QaScorecardRevision.
|
| UpdateAnalysisRule |
|---|
|
Updates a analysis rule.
|
| UpdateAssessmentRule |
|---|
|
Updates an assessment rule.
|
| UpdateAuthorizedView |
|---|
|
Updates an AuthorizedView.
|
| UpdateAuthorizedViewSet |
|---|
|
Updates an AuthorizedViewSet.
|
| UpdateConversation |
|---|
|
Updates a conversation.
|
| UpdateFeedbackLabel |
|---|
|
Update feedback label.
|
| UpdateIssue |
|---|
|
Updates an issue.
|
| UpdateIssueModel |
|---|
|
Updates an issue model.
|
| UpdateNote |
|---|
|
Update Note.
|
| UpdatePhraseMatcher |
|---|
|
Updates a phrase matcher.
|
| UpdateQaQuestion |
|---|
|
Updates a QaQuestion.
|
| UpdateQaQuestionTag |
|---|
|
Updates a QaQuestionTag.
|
| UpdateQaScorecard |
|---|
|
Updates a QaScorecard.
|
| UpdateSettings |
|---|
|
Updates project-level settings.
|
| UpdateView |
|---|
|
Updates a view.
|
| UploadConversation |
|---|
|
Create a long-running conversation upload operation. This method differs from
|
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. |
silence |
Overall conversation-level silence during 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. |
qa_scorecard_results[] |
Results of scoring QaScorecards. |
AnalysisRule
The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
| Fields | |
|---|---|
name |
Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} |
create_time |
Output only. The time at which this analysis rule was created. |
update_time |
Output only. The most recent time at which this analysis rule was updated. |
conversation_filter |
Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details. |
annotator_selector |
Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run. |
analysis_percentage |
Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation. |
active |
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft. |
display_name |
Display Name of the analysis rule. |
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. |
run_qa_annotator |
Whether to run the QA annotator. |
qa_config |
Configuration for the QA annotator. |
QaConfig
Configuration for the QA feature.
| Fields | |
|---|---|
Union field scorecard_source. Which scorecards should be scored. scorecard_source can be only one of the following: |
|
scorecard_list |
A manual list of scorecards to score. |
ScorecardList
Container for a list of scorecards.
| Fields | |
|---|---|
qa_scorecard_revisions[] |
List of QaScorecardRevisions. |
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. |
generator |
The resource name of the existing created generator. Format: projects/ |
SummarizationModel
Summarization model to use, if conversation_profile is not used.
| Enums | |
|---|---|
SUMMARIZATION_MODEL_UNSPECIFIED |
Unspecified summarization model. |
BASELINE_MODEL |
The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using |
BASELINE_MODEL_V2_0 |
The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using |
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. |
AppealAssessmentRequest
The message to appeal an assessment.
| Fields | |
|---|---|
name |
Required. The name of the assessment to appeal. |
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} |
Assessment
The assessment resource.
| Fields | |
|---|---|
name |
Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} |
create_time |
Output only. The time at which the assessment was created. |
update_time |
Output only. The time at which the assessment was last updated. |
state |
Output only. The state of the assessment. |
agent_info |
Information about the agent the assessment is for. |
State
The state of the assessment. Defaults to DRAFT.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
The state is unspecified. This value should not be used. |
DRAFT |
The default state of all new assessments. |
PUBLISHED |
The assessment has been published. |
APPEALED |
The assessment has been appealed. |
FINALIZED |
The assessment has been finalized. |
AssessmentRule
The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
| Fields | |
|---|---|
name |
Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule} |
create_time |
Output only. The time at which this assessment rule was created. |
update_time |
Output only. The most recent time at which this assessment rule was updated. |
active |
If true, apply this rule to conversations. Otherwise, this rule is inactive. |
sample_rule |
The sample rule for the assessment rule. |
schedule_info |
Schedule info for the assessment rule. |
display_name |
Display Name of the assessment rule. |
AuthorizedView
An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
| Fields | |
|---|---|
name |
Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} |
display_name |
Display Name. Limit 64 characters. |
conversation_filter |
A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having authorizedViews.get access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has. |
create_time |
Output only. The time at which the authorized view was created. |
update_time |
Output only. The most recent time at which the authorized view was updated. |
AuthorizedViewSet
An AuthorizedViewSet contains a set of AuthorizedView resources.
| Fields | |
|---|---|
name |
Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} |
create_time |
Output only. Create time. |
update_time |
Output only. Update time. |
display_name |
Display Name. Limit 64 characters. |
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 delete conversations from. Format: projects/{project}/locations/{location} |
filter |
Filter used to select the subset of conversations to delete. |
max_delete_count |
Maximum number of conversations 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. |
BulkDeleteConversationsResponse
This type has no fields.
The response for a bulk delete conversations operation.
BulkDeleteFeedbackLabelsMetadata
Metadata for the BulkDeleteFeedbackLabels endpoint.
| Fields | |
|---|---|
request |
Output only. The original request for delete. |
partial_errors[] |
Partial errors during deletion operation that might cause the operation output to be incomplete. |
BulkDeleteFeedbackLabelsRequest
Request for the BulkDeleteFeedbackLabels endpoint.
| Fields | |
|---|---|
parent |
Required. The parent resource for new feedback labels. |
filter |
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields:
|
BulkDeleteFeedbackLabelsResponse
This type has no fields.
Response for the BulkDeleteFeedbackLabels endpoint.
BulkDownloadFeedbackLabelsMetadata
Metadata for the BulkDownloadFeedbackLabel endpoint.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request for download. |
partial_errors[] |
Partial errors during ingest operation that might cause the operation output to be incomplete. |
download_stats |
Output only. Statistics for BulkDownloadFeedbackLabels operation. |
DownloadStats
Statistics for BulkDownloadFeedbackLabels operation.
| Fields | |
|---|---|
processed_object_count |
The number of objects processed during the download operation. |
successful_download_count |
The number of new feedback labels downloaded during this operation. Different from "processed" because some labels might not be downloaded because an error. |
total_files_written |
Total number of files written to the provided Cloud Storage bucket. |
file_names[] |
Output only. Full name of the files written to Cloud storage. |
BulkDownloadFeedbackLabelsRequest
Request for the BulkDownloadFeedbackLabel endpoint.
| Fields | |
|---|---|
parent |
Required. The parent resource for new feedback labels. |
filter |
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields:
|
max_download_count |
Optional. Limits the maximum number of feedback labels that will be downloaded. The first |
feedback_label_type |
Optional. The type of feedback labels that will be downloaded. |
conversation_filter |
Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If |
template_qa_scorecard_id[] |
Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label |
Union field destination. Configuration for an external data store to which the feedback labels will be written to. destination can be only one of the following: |
|
gcs_destination |
A cloud storage bucket destination. |
sheets_destination |
A sheets document destination. |
FeedbackLabelType
Possible feedback label types that will be downloaded.
| Enums | |
|---|---|
FEEDBACK_LABEL_TYPE_UNSPECIFIED |
Unspecified format |
QUALITY_AI |
Downloaded file will contain all Quality AI labels from the latest scorecard revision. |
TOPIC_MODELING |
Downloaded file will contain only Topic Modeling labels. |
AGENT_ASSIST_SUMMARY |
Agent Assist Summarization labels. |
GcsDestination
Google Cloud Storage Object details to write the feedback labels to.
| Fields | |
|---|---|
format |
Required. File format in which the labels will be exported. |
object_uri |
Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. |
add_whitespace |
Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format. |
always_print_empty_fields |
Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format. |
records_per_file_count |
Optional. The number of records per file. Applicable for either format. |
Format
All permissible file formats. See records_per_file_count to override the default number of records per file.
| Enums | |
|---|---|
FORMAT_UNSPECIFIED |
Unspecified format. |
CSV |
CSV format. 1,000 labels are stored per CSV file by default. |
JSON |
JSON format. 1 label stored per JSON file by default. |
SheetsDestination
Google Sheets document details to write the feedback labels to.
| Fields | |
|---|---|
spreadsheet_uri |
Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. |
sheet_title |
Optional. The title of the new sheet to write the feedback labels to. |
BulkDownloadFeedbackLabelsResponse
This type has no fields.
Response for the BulkDownloadFeedbackLabel endpoint.
BulkUploadFeedbackLabelsMetadata
Metadata for the Bulk Upload Feedback Labels API.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request for ingest. |
partial_errors[] |
Partial errors during ingest operation that might cause the operation output to be incomplete. |
upload_stats |
Output only. Statistics for BulkUploadFeedbackLabels operation. |
UploadStats
Statistics for BulkUploadFeedbackLabels operation.
| Fields | |
|---|---|
processed_object_count |
The number of objects processed during the upload operation. |
failed_validation_count |
The number of objects skipped because of failed validation |
successful_upload_count |
The number of new feedback labels added during this ingest operation. |
BulkUploadFeedbackLabelsRequest
The request for bulk uploading feedback labels.
| Fields | |
|---|---|
parent |
Required. The parent resource for new feedback labels. |
validate_only |
Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete. |
Union field source. Configuration for an external data store containing objects that will be converted to FeedbackLabels. source can be only one of the following: |
|
gcs_source |
A cloud storage bucket source. |
sheets_source |
A sheets document source. |
GcsSource
Google Cloud Storage Object details to get the feedback label file from.
| Fields | |
|---|---|
format |
Required. File format which will be ingested. |
object_uri |
Required. The Google Cloud Storage URI of the file to import. Format: |
Format
All permissible file formats.
| Enums | |
|---|---|
FORMAT_UNSPECIFIED |
Unspecified format. |
CSV |
CSV format. |
JSON |
JSON format. |
SheetsSource
Google Sheets document details to get the feedback label file from.
| Fields | |
|---|---|
spreadsheet_uri |
Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. |
BulkUploadFeedbackLabelsResponse
This type has no fields.
Response for the Bulk Upload Feedback Labels API.
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 100 labels per conversation is allowed, with a maximum of 256 characters per entry. |
quality_metadata |
Conversation metadata related to quality management. |
metadata_json |
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. |
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. |
QualityMetadata
Conversation metadata related to quality management.
| Fields | |
|---|---|
customer_satisfaction_rating |
An arbitrary integer value indicating the customer's satisfaction rating. |
wait_duration |
The amount of time the customer waited to connect with an agent. |
menu_path |
An arbitrary string value specifying the menu path the customer took. |
agent_info[] |
Information about agents involved in the call. |
AgentInfo
Information about an agent involved in the conversation.
| Fields | |
|---|---|
agent_id |
A user-specified string representing the agent. |
display_name |
The agent's name. |
team |
A user-specified string representing the agent's team. Deprecated in favor of the |
teams[] |
User-specified strings representing the agent's teams. |
disposition_code |
A user-provided string indicating the outcome of the agent's segment of the call. |
agent_type |
The agent type, e.g. HUMAN_AGENT. |
location |
The agent's location. |
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 and audio.
| Fields | |
|---|---|
metadata_uri |
Cloud Storage URI that points to a file that contains the conversation metadata. |
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. |
ConversationLevelSilence
Conversation-level silence data.
| Fields | |
|---|---|
silence_duration |
Amount of time calculated to be in silence. |
silence_percentage |
Percentage of the total conversation spent in silence. |
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} |
generator_id |
Agent Assist generator ID. |
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. |
CreateAnalysisRuleRequest
The request to create a analysis rule. analysis_rule_id will be generated by the server.
| Fields | |
|---|---|
parent |
Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: |
analysis_rule |
Required. The analysis rule resource to create. |
CreateAssessmentRequest
The request to create an assessment.
| Fields | |
|---|---|
parent |
Required. The parent resource of the assessment. |
assessment |
Required. The assessment to create. |
CreateAssessmentRuleRequest
The request to create an assessment rule.
| Fields | |
|---|---|
parent |
Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: |
assessment_rule |
Required. The assessment rule resource to create. |
assessment_rule_id |
Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule'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 |
CreateAuthorizedViewRequest
The request for creating a AuthorizedView.
| Fields | |
|---|---|
parent |
Required. The parent resource of the AuthorizedView. |
authorized_view |
Required. The AuthorizedView to create. |
authorized_view_id |
Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView'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 |
CreateAuthorizedViewSetRequest
The request for creating a AuthorizedViewSet.
| Fields | |
|---|---|
parent |
Required. The parent resource of the AuthorizedViewSet. |
authorized_view_set |
Required. The AuthorizedViewSet to create. |
authorized_view_set_id |
Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet'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 |
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 |
CreateFeedbackLabelRequest
The request for creating a feedback label.
| Fields | |
|---|---|
parent |
Required. The parent resource of the feedback label. |
feedback_label_id |
Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. |
feedback_label |
Required. The feedback label to create. |
CreateIssueMetadata
Metadata for creating an issue.
| 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. |
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. |
CreateIssueRequest
The request to create an issue.
| Fields | |
|---|---|
parent |
Required. The parent resource of the issue. |
issue |
Required. The values for the new issue. |
CreateNoteRequest
The message to create a note.
| Fields | |
|---|---|
parent |
Required. The parent resource of the note. |
note |
Required. The note resource 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. |
CreateQaQuestionRequest
The request for creating a QaQuestion.
| Fields | |
|---|---|
parent |
Required. The parent resource of the QaQuestion. |
qa_question |
Required. The QaQuestion to create. |
qa_question_id |
Optional. A unique ID for the new question. This ID will become the final component of the question'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 |
CreateQaQuestionTagRequest
The request for creating a QaQuestionTag.
| Fields | |
|---|---|
parent |
Required. The parent resource of the QaQuestionTag. |
qa_question_tag |
Required. The QaQuestionTag to create. |
qa_question_tag_id |
Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag'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 |
CreateQaScorecardRequest
The request for creating a QaScorecard.
| Fields | |
|---|---|
parent |
Required. The parent resource of the QaScorecard. |
qa_scorecard |
Required. The QaScorecard to create. |
qa_scorecard_id |
Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard'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 |
CreateQaScorecardRevisionRequest
The request for creating a QaScorecardRevision.
| Fields | |
|---|---|
parent |
Required. The parent resource of the QaScorecardRevision. |
qa_scorecard_revision |
Required. The QaScorecardRevision to create. |
qa_scorecard_revision_id |
Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision'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 |
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. |
Dataset
Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)
| Fields | |
|---|---|
name |
Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} |
display_name |
Display name for the dataaset |
description |
Dataset description. |
type |
Dataset usage type. |
ttl |
Optional. Option TTL for the dataset. |
create_time |
Output only. Dataset create time. |
update_time |
Output only. Dataset update time. |
Type
Type of datasat: For evals or sampled from live traffic.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default value for unspecified. |
EVAL |
For evals only. |
LIVE |
Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer) |
DatasetValidationWarning
Enum for the different types of issues a tuning dataset can have. These warnings are currentlyraised when trying to validate a dataset for tuning a scorecard.
| Enums | |
|---|---|
DATASET_VALIDATION_WARNING_UNSPECIFIED |
Unspecified data validation warning. |
TOO_MANY_INVALID_FEEDBACK_LABELS |
A non-trivial percentage of the feedback labels are invalid. |
INSUFFICIENT_FEEDBACK_LABELS |
The quantity of valid feedback labels provided is less than the recommended minimum. |
INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER |
One or more of the answers have less than the recommended minimum of feedback labels. |
ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER |
All the labels in the dataset come from a single answer choice. |
DeleteAnalysisRequest
The request to delete an analysis.
| Fields | |
|---|---|
name |
Required. The name of the analysis to delete. |
DeleteAnalysisRuleRequest
The request to delete a analysis rule.
| Fields | |
|---|---|
name |
Required. The name of the analysis rule to delete. |
DeleteAssessmentRequest
The request to delete an assessment.
| Fields | |
|---|---|
name |
Required. The name of the assessment to delete. |
force |
Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. |
DeleteAssessmentRuleRequest
The request to delete an assessment rule.
| Fields | |
|---|---|
name |
Required. The name of the assessment rule to delete. |
DeleteAuthorizedViewRequest
The request for deleting an authorized view.
| Fields | |
|---|---|
name |
Required. The name of the AuthorizedView to delete. |
DeleteAuthorizedViewSetRequest
The request for deleting a AuthorizedViewSet.
| Fields | |
|---|---|
name |
Required. The name of the AuthorizedViewSet to delete. |
force |
Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none. |
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. |
DeleteFeedbackLabelRequest
The request for deleting a feedback label.
| Fields | |
|---|---|
name |
Required. The name of the feedback label to delete. |
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. |
DeleteNoteRequest
The request to delete a note.
| Fields | |
|---|---|
name |
Required. The name of the note to delete. |
DeletePhraseMatcherRequest
The request to delete a phrase matcher.
| Fields | |
|---|---|
name |
Required. The name of the phrase matcher to delete. |
DeleteQaQuestionRequest
The request for deleting a QaQuestion.
| Fields | |
|---|---|
name |
Required. The name of the QaQuestion to delete. |
DeleteQaQuestionTagMetadata
The metadata for deleting a QaQuestionTag Resource.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request. |
DeleteQaQuestionTagRequest
The request for deleting a QaQuestionTag.
| Fields | |
|---|---|
name |
Required. The name of the QaQuestionTag to delete. |
DeleteQaScorecardRequest
The request for deleting a QaScorecard.
| Fields | |
|---|---|
name |
Required. The name of the QaScorecard to delete. |
force |
Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none. |
DeleteQaScorecardRevisionRequest
The request to delete a QaScorecardRevision.
| Fields | |
|---|---|
name |
Required. The name of the QaScorecardRevision to delete. |
force |
Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none. |
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.
DeployQaScorecardRevisionRequest
The request to deploy a QaScorecardRevision
| Fields | |
|---|---|
name |
Required. The name of the QaScorecardRevision to deploy. |
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. |
Dimension
A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.
| Fields | |
|---|---|
dimension_key |
The key of the dimension. |
Union field dimension_metadata. Output-only metadata about the dimension. dimension_metadata can be only one of the following: |
|
issue_dimension_metadata |
Output only. Metadata about the issue dimension. |
agent_dimension_metadata |
Output only. Metadata about the agent dimension. |
qa_question_dimension_metadata |
Output only. Metadata about the QA question dimension. |
qa_question_answer_dimension_metadata |
Output only. Metadata about the QA question-answer dimension. |
AgentDimensionMetadata
Metadata about the agent dimension.
| Fields | |
|---|---|
agent_id |
Optional. A user-specified string representing the agent. |
agent_display_name |
Optional. The agent's name |
agent_team |
Optional. A user-specified string representing the agent's team. |
DimensionKey
The key of the dimension.
| Enums | |
|---|---|
DIMENSION_KEY_UNSPECIFIED |
The key of the dimension is unspecified. |
ISSUE |
The dimension is keyed by issues. |
ISSUE_NAME |
The dimension is keyed by issue names. |
AGENT |
The dimension is keyed by agents. |
AGENT_TEAM |
The dimension is keyed by agent teams. |
QA_QUESTION_ID |
The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions. |
QA_QUESTION_ANSWER_VALUE |
The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions. |
CONVERSATION_PROFILE_ID |
The dimension is keyed by the conversation profile ID. |
MEDIUM |
The dimension is keyed by the conversation medium. |
IssueDimensionMetadata
Metadata about the issue dimension.
| Fields | |
|---|---|
issue_id |
The issue ID. |
issue_display_name |
The issue display name. |
issue_model_id |
The parent issue model ID. |
QaQuestionAnswerDimensionMetadata
Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.
| Fields | |
|---|---|
qa_scorecard_id |
Optional. The QA scorecard ID. |
qa_question_id |
Optional. The QA question ID. |
question_body |
Optional. The full body of the question. |
answer_value |
Optional. The full body of the question. |
QaQuestionDimensionMetadata
Metadata about the QA question dimension.
| Fields | |
|---|---|
qa_scorecard_id |
Optional. The QA scorecard ID. |
qa_question_id |
Optional. The QA question ID. |
question_body |
Optional. The full body of the question. |
EncryptionSpec
A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
| Fields | |
|---|---|
name |
Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec |
kms_key |
Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: |
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. |
completed_export_count |
The number of conversations that were exported successfully. |
failed_export_count |
The number of conversations that failed to be exported. |
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} |
write_disposition |
Options for what to do if the destination table already exists. |
export_schema_version |
Optional. Version of the export schema. |
Union field destination. Exporter destination. destination can be only one of the following: |
|
big_query_destination |
Specified if sink is a BigQuery table. |
BigQueryDestination
A BigQuery Table Reference.
| Fields | |
|---|---|
project_id |
A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used. |
dataset |
Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error. |
table |
The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error. |
ExportSchemaVersion
Version of the export schema, default to version 3 if not specified.
| Enums | |
|---|---|
EXPORT_SCHEMA_VERSION_UNSPECIFIED |
Unspecified. Defaults to EXPORT_V3. |
EXPORT_V1 |
Export schema version 1. |
EXPORT_V2 |
Export schema version 2. |
EXPORT_V3 |
Export schema version 3. |
EXPORT_V4 |
Export schema version 4. |
EXPORT_V5 |
Export schema version 5. |
EXPORT_V6 |
Export schema version 6. |
EXPORT_V7 |
Export schema version 7. |
EXPORT_VERSION_LATEST_AVAILABLE |
Export schema version latest available. |
WriteDisposition
Specifies the action that occurs if the destination table already exists.
| Enums | |
|---|---|
WRITE_DISPOSITION_UNSPECIFIED |
Write disposition is not specified. Defaults to WRITE_TRUNCATE. |
WRITE_TRUNCATE |
If the table already exists, BigQuery will overwrite the table data and use the schema from the load. |
WRITE_APPEND |
If the table already exists, BigQuery will append data to the table. |
ExportInsightsDataResponse
This type has no fields.
Response for an export insights operation.
ExportIssueModelMetadata
Metadata used for export issue model.
| Fields | |
|---|---|
create_time |
The time the operation was created. |
end_time |
The time the operation finished running. |
request |
The original export request. |
ExportIssueModelRequest
Request to export an issue model.
| Fields | |
|---|---|
name |
Required. The issue model to export. |
Union field
|
|
gcs_destination |
Google Cloud Storage URI to export the issue model to. |
GcsDestination
Google Cloud Storage Object URI to save the issue model to.
| Fields | |
|---|---|
object_uri |
Required. Format: |
ExportIssueModelResponse
This type has no fields.
Response from export issue model
FaqAnswerData
Agent Assist frequently-asked-question answer data.
| Fields | |
|---|---|
answer |
The piece of text from the |
confidence_score |
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). |
question |
The corresponding FAQ question. |
metadata |
Map that contains metadata about the FAQ answer 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}. |
FeedbackLabel
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.
| Fields | |
|---|---|
name |
Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} |
labeled_resource |
Name of the resource to be labeled. Supported resources are:
|
create_time |
Output only. Create time of the label. |
update_time |
Output only. Update time of the label. |
Union field label_type. Label type. label_type can be only one of the following: |
|
label |
String label used for Topic Modeling. |
qa_answer_label |
QaAnswer label used for Quality AI example conversations. |
FinalizeAssessmentRequest
The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.
| Fields | |
|---|---|
name |
Required. The name of the assessment to finalize. |
GcsSource
A Cloud Storage source of conversation data.
| Fields | |
|---|---|
audio_uri |
Cloud Storage URI that points to a file that contains the conversation audio. |
transcript_uri |
Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. |
GetAnalysisRequest
The request to get an analysis.
| Fields | |
|---|---|
name |
Required. The name of the analysis to get. |
GetAnalysisRuleRequest
The request for getting a analysis rule.
| Fields | |
|---|---|
name |
Required. The name of the AnalysisRule to get. |
GetAssessmentRequest
The request to get an assessment.
| Fields | |
|---|---|
name |
Required. The name of the assessment to get. |
GetAssessmentRuleRequest
The request for getting an assessment rule.
| Fields | |
|---|---|
name |
Required. The name of the assessment rule to get. |
GetAuthorizedViewRequest
The request for getting a AuthorizedView.
| Fields | |
|---|---|
name |
Required. The name of the AuthorizedView to get. |
GetAuthorizedViewSetRequest
The request for getting a AuthorizedViewSet.
| Fields | |
|---|---|
name |
Required. The name of the AuthorizedViewSet to get. |
GetConversationRequest
The request to get a conversation.
| Fields | |
|---|---|
name |
Required. The name of the conversation to get. |
view |
The level of details of the conversation. Default is |
GetEncryptionSpecRequest
The request to get location-level encryption specification.
| Fields | |
|---|---|
name |
Required. The name of the encryption spec resource to get. |
GetFeedbackLabelRequest
The request for getting a feedback label.
| Fields | |
|---|---|
name |
Required. The name of the feedback label to get. |
GetIssueModelRequest
The request to get an issue model.
| Fields | |
|---|---|
name |
Required. The name of the issue model to get. |
GetIssueRequest
The request to get an issue.
| Fields | |
|---|---|
name |
Required. The name of the issue to get. |
GetPhraseMatcherRequest
The request to get a a phrase matcher.
| Fields | |
|---|---|
name |
Required. The name of the phrase matcher to get. |
GetQaQuestionRequest
The request for a QaQuestion.
| Fields | |
|---|---|
name |
Required. The name of the QaQuestion to get. |
GetQaQuestionTagRequest
The request for a QaQuestionTag.
| Fields | |
|---|---|
name |
Required. The name of the QaQuestionTag to get. |
GetQaScorecardRequest
The request for a QaScorecard. By default, returns the latest revision.
| Fields | |
|---|---|
name |
Required. The name of the QaScorecard to get. |
GetQaScorecardRevisionRequest
The request for a QaScorecardRevision.
| Fields | |
|---|---|
name |
Required. The name of the QaScorecardRevision to get. |
GetSettingsRequest
The request to get project-level settings.
| Fields | |
|---|---|
name |
Required. The name of the settings resource to get. |
GetViewRequest
The request to get a view.
| Fields | |
|---|---|
name |
Required. The name of the view to get. |
HoldData
This type has no fields.
The data for a hold annotation.
ImportIssueModelMetadata
Metadata used for import issue model.
| Fields | |
|---|---|
create_time |
The time the operation was created. |
end_time |
The time the operation finished running. |
request |
The original import request. |
ImportIssueModelRequest
Request to import an issue model.
| Fields | |
|---|---|
parent |
Required. The parent resource of the issue model. |
create_new_model |
Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file. |
Union field
|
|
gcs_source |
Google Cloud Storage source message. |
GcsSource
Google Cloud Storage Object URI to get the issue model file from.
| Fields | |
|---|---|
object_uri |
Required. Format: |
ImportIssueModelResponse
Response from import issue model
| Fields | |
|---|---|
issue_model |
The issue model that was imported. |
IngestConversationsMetadata
The metadata for an IngestConversations operation.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request for ingest. |
partial_errors[] |
Output only. Partial errors during ingest operation that might cause the operation output to be incomplete. |
ingest_conversations_stats |
Output only. Statistics for IngestConversations operation. |
IngestConversationsStats
Statistics for IngestConversations operation.
| Fields | |
|---|---|
processed_object_count |
Output only. The number of objects processed during the ingest operation. |
duplicates_skipped_count |
Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested. |
successful_ingest_count |
Output only. The number of new conversations added during this ingest operation. |
failed_ingest_count |
Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field. |
IngestConversationsRequest
The request to ingest conversations.
| Fields | |
|---|---|
parent |
Required. The parent resource for new conversations. |
conversation_config |
Configuration that applies to all conversations. |
redaction_config |
Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. |
speech_config |
Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings. |
Union field source. Configuration for an external data store containing objects that will be converted to conversations. source can be only one of the following: |
|
gcs_source |
A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication. |
Union field object_config. Configuration for converting individual source objects to conversations. object_config can be only one of the following: |
|
transcript_object_config |
Configuration for when |
sample_size |
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. |
ConversationConfig
Configuration that applies to all conversations.
| Fields | |
|---|---|
agent_id |
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 |
agent_channel |
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. |
customer_channel |
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.
| Fields | |
|---|---|
bucket_uri |
Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of |
bucket_object_type |
Optional. Specifies the type of the objects in |
custom_metadata_keys[] |
Optional. Custom keys to extract as conversation labels from metadata files in |
transcript_bucket_uri |
Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. |
audio_bucket_uri |
Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. |
metadata_bucket_uri |
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 / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. |
BucketObjectType
| Enums | |
|---|---|
BUCKET_OBJECT_TYPE_UNSPECIFIED |
The object type is unspecified and will default to TRANSCRIPT. |
TRANSCRIPT |
The object is a transcript. |
AUDIO |
The object is an audio file. |
TranscriptObjectConfig
Configuration for processing transcript objects.
| Fields | |
|---|---|
medium |
Required. The medium transcript objects represent. |
IngestConversationsResponse
This type has no fields.
The response to an IngestConversations operation.
InitializeEncryptionSpecMetadata
Metadata for initializing a location-level encryption specification.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request for initialization. |
partial_errors[] |
Partial errors during initializing operation that might cause the operation output to be incomplete. |
InitializeEncryptionSpecRequest
The request to initialize a location-level encryption specification.
| Fields | |
|---|---|
encryption_spec |
Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the |
InitializeEncryptionSpecResponse
This type has no fields.
The response to initialize a location-level encryption specification.
Intent
The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
| Fields | |
|---|---|
id |
The unique identifier of the intent. |
display_name |
The human-readable name of the intent. |
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.
| Fields | |
|---|---|
intent_unique_id |
The id of the matched intent. Can be used to retrieve the corresponding intent information. |
InterruptionData
This type has no fields.
The data for an interruption annotation.
Issue
The issue resource.
| Fields | |
|---|---|
name |
Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} |
display_name |
The representative name for the issue. |
create_time |
Output only. The time at which this issue was created. |
update_time |
Output only. The most recent time that this issue was updated. |
sample_utterances[] |
Output only. Resource names of the sample representative utterances that match to this issue. |
display_description |
Representative description of the issue. |
IssueAssignment
Information about the issue.
| Fields | |
|---|---|
issue |
Resource name of the assigned issue. |
score |
Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. |
display_name |
Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. |
IssueMatchData
The data for an issue match annotation.
| Fields | |
|---|---|
issue_assignment |
Information about the issue's assignment. |
IssueModel
The issue model resource.
| Fields | |
|---|---|
name |
Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} |
display_name |
The representative name for the issue model. |
create_time |
Output only. The time at which this issue model was created. |
update_time |
Output only. The most recent time at which the issue model was updated. |
issue_count |
Output only. Number of issues in this issue model. |
state |
Output only. State of the model. |
input_data_config |
Configs for the input data that used to create the issue model. |
training_stats |
Output only. Immutable. The issue model's label statistics on its training data. |
model_type |
Type of the model. |
language_code |
Language of the model. |
InputDataConfig
Configs for the input data used to create the issue model.
| Fields | |
|---|---|
medium |
Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the |
training_conversations_count |
Output only. Number of conversations used in training. Output only. |
filter |
A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details. |
ModelType
Type of the model.
| Enums | |
|---|---|
MODEL_TYPE_UNSPECIFIED |
Unspecified model type. |
TYPE_V1 |
Type V1. |
TYPE_V2 |
Type V2. |
State
State of the model.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Unspecified. |
UNDEPLOYED |
Model is not deployed but is ready to deploy. |
DEPLOYING |
Model is being deployed. |
DEPLOYED |
Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state. |
UNDEPLOYING |
Model is being undeployed. |
DELETING |
Model is being deleted. |
IssueModelLabelStats
Aggregated statistics about an issue model.
| Fields | |
|---|---|
analyzed_conversations_count |
Number of conversations the issue model has analyzed at this point in time. |
unclassified_conversations_count |
Number of analyzed conversations for which no issue was applicable at this point in time. |
issue_stats |
Statistics on each issue. Key is the issue's resource name. |
IssueStats
Aggregated statistics about an issue.
| Fields | |
|---|---|
issue |
Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} |
labeled_conversations_count |
Number of conversations attached to the issue at this point in time. |
display_name |
Display name of the issue. |
IssueModelResult
Issue Modeling result on a conversation.
| Fields | |
|---|---|
issue_model |
Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} |
issues[] |
All the matched issues. |
ListAllFeedbackLabelsRequest
The request for listing all feedback labels.
| Fields | |
|---|---|
parent |
Required. The parent resource of all feedback labels per project. |
page_size |
Optional. The maximum number of feedback labels 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. |
page_token |
Optional. The value returned by the last |
filter |
Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields:
|
ListAllFeedbackLabelsResponse
The response for listing all feedback labels.
| Fields | |
|---|---|
feedback_labels[] |
The feedback labels that match the request. |
next_page_token |
A token, which can be sent as |
ListAnalysesRequest
The request to list analyses.
| Fields | |
|---|---|
parent |
Required. The parent resource of the analyses. |
page_size |
The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
The value returned by the last |
filter |
A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. |
ListAnalysesResponse
The response to list analyses.
| Fields | |
|---|---|
analyses[] |
The analyses that match the request. |
next_page_token |
A token, which can be sent as |
ListAnalysisRulesRequest
The request to list analysis rules.
| Fields | |
|---|---|
parent |
Required. The parent resource of the analysis rules. |
page_size |
Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
ListAnalysisRulesResponse
The response of listing views.
| Fields | |
|---|---|
analysis_rules[] |
The analysis_rule that match the request. |
next_page_token |
A token, which can be sent as |
ListAssessmentRulesRequest
The request to list assessment rules.
| Fields | |
|---|---|
parent |
Required. The parent resource of the assessment rules. |
page_token |
Optional. The value returned by the last |
page_size |
Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty |
ListAssessmentRulesResponse
The response of listing assessment rules.
| Fields | |
|---|---|
assessment_rules[] |
The assessment rules that match the request. |
next_page_token |
A token, which can be sent as |
ListAssessmentsRequest
The request to list assessments.
| Fields | |
|---|---|
parent |
Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. |
page_token |
Optional. The value returned by the last |
filter |
Optional. A filter to reduce results to a specific subset. Supported filters include:
|
page_size |
The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty |
ListAssessmentsResponse
The response of listing assessments.
| Fields | |
|---|---|
assessments[] |
The assessments that match the request. |
next_page_token |
A token, which can be sent as |
ListAuthorizedViewSetsRequest
The request for listing AuthorizedViewSets.
| Fields | |
|---|---|
parent |
Required. The parent resource of the AuthorizedViewSets. |
page_size |
Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
filter |
Optional. The filter expression to filter authorized view sets listed in the response. |
order_by |
Optional. The order by expression to order authorized view sets listed in the response. |
ListAuthorizedViewSetsResponse
The response from a ListAuthorizedViewSet request.
| Fields | |
|---|---|
authorized_view_sets[] |
The AuthorizedViewSets under the parent. |
next_page_token |
A token, which can be sent as |
ListAuthorizedViewsRequest
The request for listing AuthorizedViews.
| Fields | |
|---|---|
parent |
Required. The parent resource of the AuthorizedViews. If the parent is set to |
page_size |
Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
filter |
Optional. The filter expression to filter authorized views listed in the response. |
order_by |
Optional. The order by expression to order authorized views listed in the response. |
ListAuthorizedViewsResponse
The response from a ListAuthorizedViews request.
| Fields | |
|---|---|
authorized_views[] |
The AuthorizedViews under the parent. |
next_page_token |
A token, which can be sent as |
ListConversationsRequest
Request to list conversations.
| Fields | |
|---|---|
parent |
Required. The parent resource of the conversation. |
page_size |
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. |
page_token |
The value returned by the last |
filter |
A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. |
order_by |
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:
The default sort order is ascending. To specify order, append |
view |
The level of details of the conversation. Default is |
ListConversationsResponse
The response of listing conversations.
| Fields | |
|---|---|
conversations[] |
The conversations that match the request. |
next_page_token |
A token which can be sent as |
ListFeedbackLabelsRequest
The request for listing feedback labels.
| Fields | |
|---|---|
parent |
Required. The parent resource of the feedback labels. |
filter |
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields:
|
page_size |
Optional. The maximum number of feedback labels 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. |
page_token |
Optional. The value returned by the last |
ListFeedbackLabelsResponse
The response for listing feedback labels.
| Fields | |
|---|---|
feedback_labels[] |
The feedback labels that match the request. |
next_page_token |
The next page token. |
ListIssueModelsRequest
Request to list issue models.
| Fields | |
|---|---|
parent |
Required. The parent resource of the issue model. |
ListIssueModelsResponse
The response of listing issue models.
| Fields | |
|---|---|
issue_models[] |
The issue models that match the request. |
ListIssuesRequest
Request to list issues.
| Fields | |
|---|---|
parent |
Required. The parent resource of the issue. |
ListIssuesResponse
The response of listing issues.
| Fields | |
|---|---|
issues[] |
The issues that match the request. |
ListNotesRequest
The message to list notes.
| Fields | |
|---|---|
parent |
Required. The parent resource of the notes. |
page_size |
Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
ListNotesResponse
The response of listing notes.
| Fields | |
|---|---|
notes[] |
The notes that match the request. |
next_page_token |
A token, which can be sent as |
ListPhraseMatchersRequest
Request to list phrase matchers.
| Fields | |
|---|---|
parent |
Required. The parent resource of the phrase matcher. |
page_size |
The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
The value returned by the last |
filter |
A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties. |
ListPhraseMatchersResponse
The response of listing phrase matchers.
| Fields | |
|---|---|
phrase_matchers[] |
The phrase matchers that match the request. |
next_page_token |
A token, which can be sent as |
ListQaQuestionTagsRequest
Request to list QaQuestionsTags.
| Fields | |
|---|---|
parent |
Required. The parent resource of the QaQuestionTags. |
filter |
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields include the following:
|
ListQaQuestionTagsResponse
The response from a ListQaQuestionTags request.
| Fields | |
|---|---|
qa_question_tags[] |
The parent resource of the questions. |
next_page_token |
A token, which can be sent as |
ListQaQuestionsRequest
Request to list QaQuestions.
| Fields | |
|---|---|
parent |
Required. The parent resource of the questions. |
page_size |
Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
ListQaQuestionsResponse
The response from a ListQaQuestions request.
| Fields | |
|---|---|
qa_questions[] |
The QaQuestions under the parent. |
next_page_token |
A token, which can be sent as |
ListQaScorecardRevisionsRequest
Request to list QaScorecardRevisions
| Fields | |
|---|---|
parent |
Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character. |
page_size |
Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
filter |
Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties. |
ListQaScorecardRevisionsResponse
The response from a ListQaScorecardRevisions request.
| Fields | |
|---|---|
qa_scorecard_revisions[] |
The QaScorecards under the parent. |
next_page_token |
A token, which can be sent as |
ListQaScorecardsRequest
Request to list QaScorecards.
| Fields | |
|---|---|
parent |
Required. The parent resource of the scorecards. |
page_size |
Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
ListQaScorecardsResponse
The response from a ListQaScorecards request.
| Fields | |
|---|---|
qa_scorecards[] |
The QaScorecards under the parent. |
next_page_token |
A token, which can be sent as |
ListViewsRequest
The request to list views.
| Fields | |
|---|---|
parent |
Required. The parent resource of the views. |
page_size |
The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty |
page_token |
The value returned by the last |
ListViewsResponse
The response of listing views.
| Fields | |
|---|---|
views[] |
The views that match the request. |
next_page_token |
A token, which can be sent as |
Note
The conversation assessment note resource.
| Fields | |
|---|---|
name |
Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note} |
create_time |
Output only. The time at which the note was created. |
update_time |
Output only. The time at which the note was last updated. |
note_creator |
Output only. The user that created the note. |
Union field note_type. The type of the note. note_type can be only one of the following: |
|
conversation_turn_note |
The note is associated with a conversation turn. |
qa_question_note |
The note is associated with a QA question in one of the conversation's scorecard results. |
assessment_note |
The note is associated to the entire parent assessment. |
content |
The note content. |
AssessmentNote
This type has no fields.
A note about the entire parent assessment.
ConversationTurnNote
A note about a conversation turn.
| Fields | |
|---|---|
turn_index |
The conversation turn index that the note is associated with. |
QaQuestionNote
A note about a QA question.
| Fields | |
|---|---|
qa_question |
The question resource that the note is associated with. |
PhraseMatchData
The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
| Fields | |
|---|---|
phrase_matcher |
The unique identifier (the resource name) of the phrase matcher. |
display_name |
The human-readable name of the phrase matcher. |
PhraseMatchRule
The data for a phrase match rule.
| Fields | |
|---|---|
query |
Required. The phrase to be matched. |
negated |
Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
config |
Provides additional information about the rule that specifies how to apply the rule. |
PhraseMatchRuleConfig
Configuration information of a phrase match rule.
| Fields | |
|---|---|
Union field config. The configuration of the phrase match rule. config can be only one of the following: |
|
exact_match_config |
The configuration for the exact match rule. |
PhraseMatchRuleGroup
A message representing a rule in the phrase matcher.
| Fields | |
|---|---|
type |
Required. The type of this phrase match rule group. |
phrase_match_rules[] |
A list of phrase match rules that are included in this group. |
PhraseMatchRuleGroupType
Specifies how to combine each phrase match rule for whether there is a match.
| Enums | |
|---|---|
PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED |
Unspecified. |
ALL_OF |
Must meet all phrase match rules or there is no match. |
ANY_OF |
If any of the phrase match rules are met, there is a match. |
PhraseMatcher
The phrase matcher resource.
| Fields | |
|---|---|
name |
The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} |
revision_id |
Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567 |
version_tag |
The customized version tag to use for the phrase matcher. If not specified, it will default to |
revision_create_time |
Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added. |
display_name |
The human-readable name of the phrase matcher. |
type |
Required. The type of this phrase matcher. |
active |
Applies the phrase matcher only when it is active. |
phrase_match_rule_groups[] |
A list of phase match rule groups that are included in this matcher. |
activation_update_time |
Output only. The most recent time at which the activation status was updated. |
role_match |
The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript. |
update_time |
Output only. The most recent time at which the phrase matcher was updated. |
PhraseMatcherType
Specifies how to combine each phrase match rule group to determine whether there is a match.
| Enums | |
|---|---|
PHRASE_MATCHER_TYPE_UNSPECIFIED |
Unspecified. |
ALL_OF |
Must meet all phrase match rule groups or there is no match. |
ANY_OF |
If any of the phrase match rule groups are met, there is a match. |
PublishAssessmentRequest
The message to publish an assessment. Draft and appealed assessments can be published. Publishing simply changes the state of the assessment to published, allowing the console and authorized views to filter on the state.
| Fields | |
|---|---|
name |
Required. The name of the assessment to publish. |
QaAnswer
An answer to a QaQuestion.
| Fields | |
|---|---|
qa_question |
The QaQuestion answered by this answer. |
conversation |
The conversation the answer applies to. |
question_body |
Question text. E.g., "Did the agent greet the customer?" |
answer_value |
The main answer value, incorporating any manual edits if they exist. |
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. |
answer_sources[] |
List of all individual answers given to the question. |
AnswerSource
A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
| Fields | |
|---|---|
source_type |
What created the answer. |
answer_value |
The answer value from this source. |
SourceType
What created the answer.
| Enums | |
|---|---|
SOURCE_TYPE_UNSPECIFIED |
Source type is unspecified. |
SYSTEM_GENERATED |
Answer was system-generated; created during an Insights analysis. |
MANUAL_EDIT |
Answer was created by a human via manual edit. |
AnswerValue
Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.
| Fields | |
|---|---|
key |
A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. |
Union field value. The answer value may be one of a few different types. value can be only one of the following: |
|
str_value |
String value. |
num_value |
Numerical value. |
bool_value |
Boolean value. |
na_value |
A value of "Not Applicable (N/A)". Should only ever be |
score |
Output only. Numerical score of the answer. |
potential_score |
Output only. The maximum potential score of the question. |
normalized_score |
Output only. Normalized score of the questions. Calculated as score / potential_score. |
QaQuestion
A single question to be scored by the Insights QA feature.
| Fields | |
|---|---|
name |
Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question} |
abbreviation |
Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting". |
create_time |
Output only. The time at which this question was created. |
update_time |
Output only. The most recent time at which the question was updated. |
question_type |
The type of question. |
predefined_question_config |
The configuration of the predefined question. This field will only be set if the Question Type is predefined. |
question_body |
Question text. E.g., "Did the agent greet the customer?" |
answer_instructions |
Instructions describing how to determine the answer. |
answer_choices[] |
A list of valid answers to the question, which the LLM must choose from. |
tags[] |
Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. |
order |
Defines the order of the question within its parent scorecard revision. |
metrics |
Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned. |
tuning_metadata |
Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned. |
AnswerChoice
Message representing a possible answer to the question.
| Fields | |
|---|---|
key |
A short string used as an identifier. |
Union field value. The answer value may be one of a few different types. value can be only one of the following: |
|
str_value |
String value. |
num_value |
Numerical value. |
bool_value |
Boolean value. |
na_value |
A value of "Not Applicable (N/A)". If provided, this field may only be set to |
score |
Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused. |
Metrics
A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.
| Fields | |
|---|---|
accuracy |
Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set. |
PredefinedQuestionConfig
Configuration for a predefined question. This field will only be set if the Question Type is predefined.
| Fields | |
|---|---|
type |
The type of the predefined question. |
PredefinedQuestionType
Enum representing the type of the predefined question.
| Enums | |
|---|---|
PREDEFINED_QUESTION_TYPE_UNSPECIFIED |
The type of the predefined question is unspecified. |
CONVERSATION_OUTCOME |
A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not. |
CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE |
A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent. |
QaQuestionType
Enum representing the type of the question.
| Enums | |
|---|---|
QA_QUESTION_TYPE_UNSPECIFIED |
The type of the question is unspecified. |
CUSTOMIZABLE |
The default question type. The question is fully customizable by the user. |
PREDEFINED |
The question type is using a predefined model provided by CCAI teams. Users are not allowed to edit the question_body, answer_choices, upload feedback labels for the question nor fine-tune the question. However, users may edit other fields like question tags, question order, etc. |
TuningMetadata
Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.
| Fields | |
|---|---|
total_valid_label_count |
Total number of valid labels provided for the question at the time of tuining. |
dataset_validation_warnings[] |
A list of any applicable data validation warnings about the question's feedback labels. |
tuning_error |
Error status of the tuning operation for the question. Will only be set if the tuning operation failed. |
QaQuestionTag
A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., "Customer Satisfaction","Billing", etc.
| Fields | |
|---|---|
name |
Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource. |
display_name |
Required. A user-specified display name for the tag. |
qa_question_ids[] |
Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. |
create_time |
Output only. The time at which the question tag was created. |
update_time |
Output only. The most recent time at which the question tag was updated. |
QaScorecard
A QaScorecard represents a collection of questions to be scored during analysis.
| Fields | |
|---|---|
name |
Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} |
display_name |
The user-specified display name of the scorecard. |
description |
A text description explaining the intent of the scorecard. |
create_time |
Output only. The time at which this scorecard was created. |
update_time |
Output only. The most recent time at which the scorecard was updated. |
is_default |
Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. |
QaScorecardResult
The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
| Fields | |
|---|---|
name |
Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} |
qa_scorecard_revision |
The QaScorecardRevision scored by this result. |
conversation |
The conversation scored by this result. |
create_time |
Output only. The timestamp that the revision was created. |
agent_id |
ID of the agent that handled the conversation. |
qa_answers[] |
Set of QaAnswers represented in the result. |
qa_tag_results[] |
Collection of tags and their scores. |
score_sources[] |
List of all individual score sets. |
score |
The overall numerical score of the result, incorporating any manual edits if they exist. |
potential_score |
The maximum potential overall score of the scorecard. Any questions answered using |
normalized_score |
The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. |
QaTagResult
Tags and their corresponding results.
| Fields | |
|---|---|
tag |
The tag the score applies to. |
score |
The score the tag applies to. |
potential_score |
The potential score the tag applies to. |
normalized_score |
The normalized score the tag applies to. |
ScoreSource
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.
| Fields | |
|---|---|
source_type |
What created the score. |
qa_tag_results[] |
Collection of tags and their scores. |
score |
The overall numerical score of the result. |
potential_score |
The maximum potential overall score of the scorecard. Any questions answered using |
normalized_score |
The normalized score, which is the score divided by the potential score. |
SourceType
What created the score.
| Enums | |
|---|---|
SOURCE_TYPE_UNSPECIFIED |
Source type is unspecified. |
SYSTEM_GENERATED_ONLY |
Score is derived only from system-generated answers. |
INCLUDES_MANUAL_EDITS |
Score is derived from both system-generated answers, and includes any manual edits if they exist. |
QaScorecardRevision
A revision of a QaScorecard.
Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
| Fields | |
|---|---|
name |
Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} |
snapshot |
The snapshot of the scorecard at the time of this revision's creation. |
create_time |
Output only. The timestamp that the revision was created. |
alternate_ids[] |
Output only. Alternative IDs for this revision of the scorecard, e.g., |
state |
Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis. |
State
Enum representing the set of states a scorecard revision may be in.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Unspecified. |
EDITABLE |
The scorecard revision can be edited. |
TRAINING |
Scorecard model training is in progress. |
TRAINING_FAILED |
Scorecard revision model training failed. |
READY |
The revision can be used in analysis. |
DELETING |
Scorecard is being deleted. |
TRAINING_CANCELLED |
Scorecard model training was explicitly cancelled by the user. |
QueryInterval
A time window for querying conversations.
| Fields | |
|---|---|
start_time |
Required. The start time of the time window. |
end_time |
Required. The end time of the time window. |
QueryMetricsMetadata
The metadata from querying metrics.
| Fields | |
|---|---|
result_is_truncated |
Whether the result rows were truncated because the result row size is too large to materialize. |
QueryMetricsRequest
The request for querying metrics.
| Fields | |
|---|---|
location |
Required. The location of the data. "projects/{project}/locations/{location}" |
filter |
Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). |
time_granularity |
The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified. |
dimensions[] |
The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now. |
measure_mask |
Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the |
TimeGranularity
A time granularity divides the time line into discrete time periods. This is useful for defining buckets over which filtering and aggregation should be performed.
| Enums | |
|---|---|
TIME_GRANULARITY_UNSPECIFIED |
The time granularity is unspecified and will default to NONE. |
NONE |
No time granularity. The response won't contain a time series. This is the default value if no time granularity is specified. |
DAILY |
Data points in the time series will aggregate at a daily granularity. 1 day means [midnight to midnight). |
HOURLY |
Data points in the time series will aggregate at a daily granularity. 1 HOUR means [01:00 to 02:00). |
PER_MINUTE |
Data points in the time series will aggregate at a daily granularity. PER_MINUTE means [01:00 to 01:01). |
PER_5_MINUTES |
Data points in the time series will aggregate at a 1 minute granularity. PER_5_MINUTES means [01:00 to 01:05). |
MONTHLY |
Data points in the time series will aggregate at a monthly granularity. 1 MONTH means [01st of the month to 1st of the next month). |
QueryMetricsResponse
The response for querying metrics.
| Fields | |
|---|---|
location |
Required. The location of the data. "projects/{project}/locations/{location}" |
update_time |
The metrics last update time. |
slices[] |
A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. |
macro_average_slice |
The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension. |
Slice
A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.
For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices:
- Slice 1 -> dimensions=[Issue 1]
- Slice 2 -> dimensions=[Issue 2]
| Fields | |
|---|---|
dimensions[] |
A unique combination of dimensions that this slice represents. |
total |
The total metric value. The interval of this data point is [starting create time, ending create time) from the request. |
time_series |
A time series of metric values. This is only populated if the request specifies a time granularity other than NONE. |
DataPoint
A data point contains the metric values mapped to an interval.
| Fields | |
|---|---|
interval |
The interval that this data point represents.
|
Union field measure. The measure included in this data point. measure can be only one of the following: |
|
conversation_measure |
The measure related to conversations. |
ConversationMeasure
The measure related to conversations.
| Fields | |
|---|---|
qa_tag_scores[] |
Average QA normalized score for all the tags. |
conversation_count |
The conversation count. |
average_silence_percentage |
The average silence percentage. |
average_duration |
The average duration. |
average_turn_count |
The average turn count. |
average_agent_sentiment_score |
The average agent's sentiment score. |
average_client_sentiment_score |
The average client's sentiment score. |
average_customer_satisfaction_rating |
The average customer satisfaction rating. |
average_qa_normalized_score |
Average QA normalized score. Will exclude 0's in average calculation. |
average_qa_question_normalized_score |
Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID. |
QaTagScore
Average QA normalized score for the tag.
| Fields | |
|---|---|
tag |
Tag name. |
average_tag_normalized_score |
Average tag normalized score per tag. |
TimeSeries
A time series of metric values.
| Fields | |
|---|---|
data_points[] |
The data points that make up the time series . |
QueryPerformanceOverviewMetadata
This type has no fields.
The metadata for querying performance overview.
QueryPerformanceOverviewRequest
The request for summarizing performance according to different metrics for conversations over a specified time window.
| Fields | |
|---|---|
parent |
Required. The parent resource of the conversations to derive performance stats from. "projects/{project}/locations/{location}" |
filter |
Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here. |
query_interval |
Required. The time window of the conversations to derive performance stats from. |
Union field source. The type of source of conversations to derive performance from. source can be only one of the following: |
|
agent_performance_source |
Conversations are from a single agent. |
comparison_query_interval |
The time window of the conversations to compare the performance to. |
AgentSource
The entity whose performance is being queried is a single agent.
| Fields | |
|---|---|
agent_id |
Required. Agent id to query performance overview for. |
QueryPerformanceOverviewResponse
The response for querying performance overview.
| Fields | |
|---|---|
summary_text |
The summary text of the performance. |
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.
| Fields | |
|---|---|
deidentify_template |
The fully-qualified DLP deidentify template resource name. Format: |
inspect_template |
The fully-qualified DLP inspect template resource name. Format: |
RuntimeAnnotation
An annotation that was generated during the customer and agent interaction.
| Fields | |
|---|---|
annotation_id |
The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} |
create_time |
The time at which this annotation was created. |
start_boundary |
The boundary in the conversation where the annotation starts, inclusive. |
end_boundary |
The boundary in the conversation where the annotation ends, inclusive. |
answer_feedback |
The feedback that the customer has about the answer in |
user_input |
Explicit input used for generating the answer |
Union field data. The data in the annotation. data can be only one of the following: |
|
article_suggestion |
Agent Assist Article Suggestion data. |
faq_answer |
Agent Assist FAQ answer data. |
smart_reply |
Agent Assist Smart Reply data. |
smart_compose_suggestion |
Agent Assist Smart Compose suggestion data. |
dialogflow_interaction |
Dialogflow interaction data. |
conversation_summarization_suggestion |
Conversation summarization suggestion data. |
UserInput
Explicit input used for generating the answer
| Fields | |
|---|---|
query |
Query text. Article Search uses this to store the input query used to generate the search results. |
generator_name |
The resource name of associated generator. Format: |
query_source |
Query source for the answer. |
QuerySource
The source of the query.
| Enums | |
|---|---|
QUERY_SOURCE_UNSPECIFIED |
Unknown query source. |
AGENT_QUERY |
The query is from agents. |
SUGGESTED_QUERY |
The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response. |
SampleConversationsMetadata
The metadata for an SampleConversations operation.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request for sample conversations to dataset. |
partial_errors[] |
Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete. |
sample_conversations_stats |
Output only. Statistics for SampleConversations operation. |
SampleConversationsStats
Statistics for SampleConversations operation.
| Fields | |
|---|---|
successful_sample_count |
Output only. The number of new conversations added during this sample operation. |
failed_sample_count |
Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field. |
SampleConversationsRequest
The request to sample conversations to a dataset.
| Fields | |
|---|---|
parent |
Required. The parent resource of the dataset. |
sample_rule |
Optional. The sample rule used for sampling conversations. |
Union field destination. The destination of the sampled conversations. destination can be only one of the following: |
|
destination_dataset |
The dataset resource to copy the sampled conversations to. |
SampleConversationsResponse
This type has no fields.
The response to an SampleConversations operation.
SampleRule
Message for sampling conversations.
| Fields | |
|---|---|
dimension |
Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'. |
conversation_filter |
To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations. |
Union field SampleVolume. Determines how the conversations are selected. SampleVolume can be only one of the following: |
|
sample_percentage |
Percentage of conversations that we should sample based on the dimension between [0, 100]. |
sample_row |
Number of the conversations that we should sample based on the dimension. |
ScheduleInfo
Message for schedule info.
| Fields | |
|---|---|
start_time |
Start time of the schedule. If not specified, will start as soon as the schedule is created. |
end_time |
End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. |
schedule |
The groc expression. Format: |
time_zone |
The timezone to use for the groc expression. If not specified, defaults to UTC. |
SearchAuthorizedViewsRequest
The request for listing AuthorizedViews.
| Fields | |
|---|---|
parent |
Required. The parent resource of the AuthorizedViews. If the parent is set to |
page_size |
Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty |
page_token |
Optional. The value returned by the last |
query |
Optional. The query expression to search authorized views. |
order_by |
Optional. The order by expression to order authorized views listed in the response. |
SearchAuthorizedViewsResponse
The response from a ListAuthorizedViews request.
| Fields | |
|---|---|
authorized_views[] |
The AuthorizedViews under the parent. |
next_page_token |
A token, which can be sent as |
SentimentData
The data for a sentiment annotation.
| Fields | |
|---|---|
magnitude |
A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. |
score |
The sentiment score between -1.0 (negative) and 1.0 (positive). |
Settings
The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with getsettings and change the settings with updateSettings.
| Fields | |
|---|---|
name |
Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings |
create_time |
Output only. The time at which the settings was created. |
update_time |
Output only. The time at which the settings were last updated. |
language_code |
A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. |
conversation_ttl |
The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. |
pubsub_notification_settings |
A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are:
Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} |
analysis_config |
Default analysis settings. |
redaction_config |
Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the |
speech_config |
Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the |
AnalysisConfig
Default configuration when creating Analyses in Insights.
| Fields | |
|---|---|
runtime_integration_analysis_percentage |
Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100]. |
upload_conversation_analysis_percentage |
Percentage of conversations created using the UploadConversation endpoint to analyze automatically, 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. |
SilenceData
This type has no fields.
The data for a silence annotation.
SmartComposeSuggestionData
Agent Assist Smart Compose suggestion data.
| Fields | |
|---|---|
suggestion |
The content of the suggestion. |
confidence_score |
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. |
query_record |
The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} |
SmartReplyData
Agent Assist Smart Reply data.
| Fields | |
|---|---|
reply |
The content of the reply. |
confidence_score |
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. |
query_record |
The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} |
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.
| Fields | |
|---|---|
speech_recognizer |
The fully-qualified Speech Recognizer resource name. Format: |
TuneQaScorecardRevisionMetadata
Metadata for TuneQaScorecardRevision endpoint.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request. |
qa_question_dataset_validation_results[] |
Output only. The results of data validation per question in the request. |
qa_question_dataset_tuning_metrics[] |
Output only. The metrics for each QaQuestion in the TuneScorecardRevision request. |
tuning_completion_ratio |
Output only. The percentage of the tuning job that has completed. Always between 0 and 1 where 0 indicates the job has not started i.e. 0% and 1 indicates the job has completed i.e. 100%. |
QaQuestionDatasetTuningMetrics
Contains performance metrics for each QaQuestion in the TuneScorecardRevision request.
| Fields | |
|---|---|
question |
Output only. The resource path of the question whose dataset was evaluated for tuning. |
metrics |
Output only. The metrics for the question's dataset. |
Metrics
Performance metrics for the question's dataset calculated over the tuned model.
| Fields | |
|---|---|
accuracy |
Accuracy of the question's dataset. |
QaQuestionDatasetValidationResult
Contains validation results for a question in the tuning request.
| Fields | |
|---|---|
question |
Output only. The resource path of the question whose dataset was evaluated for tuning. |
dataset_validation_warnings[] |
A list of any applicable data validation warnings about the question's feedback labels. |
valid_feedback_labels_count |
The number of valid feedback labels in the question's dataset. |
TuneQaScorecardRevisionRequest
Request for TuneQaScorecardRevision endpoint.
| Fields | |
|---|---|
parent |
Required. The parent resource for new fine tuning job instance. |
filter |
Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc. |
validate_only |
Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable. |
TuneQaScorecardRevisionResponse
This type has no fields.
Response for TuneQaScorecardRevision endpoint.
UndeployIssueModelMetadata
Metadata for undeploying 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 undeployment. |
UndeployIssueModelRequest
The request to undeploy an issue model.
| Fields | |
|---|---|
name |
Required. The issue model to undeploy. |
UndeployIssueModelResponse
This type has no fields.
The response to undeploy an issue model.
UndeployQaScorecardRevisionRequest
The request to undeploy a QaScorecardRevision
| Fields | |
|---|---|
name |
Required. The name of the QaScorecardRevision to undeploy. |
UpdateAnalysisRuleRequest
The request to update a analysis rule.
| Fields | |
|---|---|
analysis_rule |
Required. The new analysis rule. |
update_mask |
Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields. |
UpdateAssessmentRuleRequest
The request to update an assessment rule.
| Fields | |
|---|---|
assessment_rule |
Required. The new assessment rule. |
update_mask |
Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields. |
UpdateAuthorizedViewRequest
The request for updating an AuthorizedView.
| Fields | |
|---|---|
authorized_view |
Required. The AuthorizedView to update. |
update_mask |
Optional. The list of fields to be updated. All possible fields can be updated by passing
|
UpdateAuthorizedViewSetRequest
The request for updating an AuthorizedViewSet.
| Fields | |
|---|---|
authorized_view_set |
Required. The AuthorizedViewSet to update. |
update_mask |
Optional. The list of fields to be updated. All possible fields can be updated by passing
|
UpdateConversationRequest
The request to update a conversation.
| Fields | |
|---|---|
conversation |
Required. The new values for the conversation. |
update_mask |
The list of fields to be updated. All possible fields can be updated by passing
|
allow_missing |
Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, |
UpdateFeedbackLabelRequest
The request for updating a feedback label.
| Fields | |
|---|---|
feedback_label |
Required. The feedback label to update. |
update_mask |
Required. The list of fields to be updated. |
UpdateIssueModelRequest
The request to update an issue model.
| Fields | |
|---|---|
issue_model |
Required. The new values for the issue model. |
update_mask |
The list of fields to be updated. |
UpdateIssueRequest
The request to update an issue.
| Fields | |
|---|---|
issue |
Required. The new values for the issue. |
update_mask |
The list of fields to be updated. |
UpdateNoteRequest
The request to update a note.
| Fields | |
|---|---|
note |
Required. The note to update. |
update_mask |
Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * |
UpdatePhraseMatcherRequest
The request to update a phrase matcher.
| Fields | |
|---|---|
phrase_matcher |
Required. The new values for the phrase matcher. |
update_mask |
The list of fields to be updated. |
UpdateQaQuestionRequest
The request for updating a QaQuestion.
| Fields | |
|---|---|
qa_question |
Required. The QaQuestion to update. |
update_mask |
Required. The list of fields to be updated. All possible fields can be updated by passing
|
UpdateQaQuestionTagMetadata
The metadata for updating a QaQuestionTag Resource.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request. |
UpdateQaQuestionTagRequest
The request for updating a QaQuestionTag.
| Fields | |
|---|---|
qa_question_tag |
Required. The QaQuestionTag to update. |
update_mask |
Optional. The list of fields to be updated. All possible fields can be updated by passing
|
UpdateQaScorecardRequest
The request for updating a QaScorecard.
| Fields | |
|---|---|
qa_scorecard |
Required. The QaScorecard to update. |
update_mask |
Required. The list of fields to be updated. All possible fields can be updated by passing
|
UpdateSettingsRequest
The request to update project-level settings.
| Fields | |
|---|---|
settings |
Required. The new settings values. |
update_mask |
Required. The list of fields to be updated. |
UpdateViewRequest
The request to update a view.
| Fields | |
|---|---|
view |
Required. The new view. |
update_mask |
The list of fields to be updated. |
UploadConversationMetadata
The metadata for an UploadConversation operation.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
request |
Output only. The original request. |
analysis_operation |
Output only. The operation name for a successfully created analysis operation, if any. |
applied_redaction_config |
Output only. The redaction config applied to the uploaded conversation. |
UploadConversationRequest
Request to upload a conversation.
| Fields | |
|---|---|
parent |
Required. The parent resource of the conversation. |
conversation |
Required. The conversation resource to create. |
conversation_id |
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 |
redaction_config |
Optional. DLP settings for transcript redaction. Will default to the config specified in Settings. |
speech_config |
Optional. Speech-to-Text configuration. Will default to the config specified in Settings. |
UserInfo
Information about a user.
| Fields | |
|---|---|
username |
The user's username. |
View
The View resource.
| Fields | |
|---|---|
name |
Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view} |
display_name |
The human-readable display name of the view. |
create_time |
Output only. The time at which this view was created. |
update_time |
Output only. The most recent time at which the view was updated. |
value |
A filter to reduce conversation results to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details. |