# frozen_string_literal: true # Copyright 2021 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! module Google module Cloud module ContactCenterInsights module V1 # The conversation resource. # @!attribute [rw] call_metadata # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata] # Call-specific metadata. # @!attribute [rw] expire_time # @return [::Google::Protobuf::Timestamp] # The time at which this conversation should expire. After this time, the # conversation data and any associated analyses will be deleted. # @!attribute [rw] ttl # @return [::Google::Protobuf::Duration] # Input only. The TTL for this resource. If specified, then this TTL will # be used to calculate the expire time. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the conversation. # Format: # projects/\\{project}/locations/\\{location}/conversations/\\{conversation} # @!attribute [rw] data_source # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource] # The source of the audio and transcription for the conversation. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which the conversation was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time at which the conversation was updated. # @!attribute [rw] start_time # @return [::Google::Protobuf::Timestamp] # The time at which the conversation started. # @!attribute [rw] language_code # @return [::String] # A user-specified language code for the conversation. # @!attribute [rw] agent_id # @return [::String] # An opaque, user-specified string representing the human agent who handled # the conversation. # @!attribute [rw] labels # @return [::Google::Protobuf::Map{::String => ::String}] # A map for the user to specify any custom fields. A maximum of 20 labels per # conversation is allowed, with a maximum of 256 characters per entry. # @!attribute [r] transcript # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript] # Output only. The conversation transcript. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. # @!attribute [r] duration # @return [::Google::Protobuf::Duration] # Output only. The duration of the conversation. # @!attribute [r] turn_count # @return [::Integer] # Output only. The number of turns in the conversation. # @!attribute [r] latest_analysis # @return [::Google::Cloud::ContactCenterInsights::V1::Analysis] # Output only. The conversation's latest analysis, if one exists. # @!attribute [r] runtime_annotations # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation>] # Output only. The annotations that were generated during the customer and agent # interaction. # @!attribute [r] dialogflow_intents # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent}] # Output only. All the matched Dialogflow intents in the call. The key corresponds to a # Dialogflow intent, format: # projects/\\{project}/agent/\\{agent}/intents/\\{intent} # @!attribute [rw] obfuscated_user_id # @return [::String] # Obfuscated user ID which the customer sent to us. class Conversation include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Call-specific metadata. # @!attribute [rw] customer_channel # @return [::Integer] # The audio channel that contains the customer. # @!attribute [rw] agent_channel # @return [::Integer] # The audio channel that contains the agent. class CallMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A message representing the transcript of a conversation. # @!attribute [rw] transcript_segments # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment>] # A list of sequential transcript segments that comprise the conversation. class Transcript include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A segment of a full transcript. # @!attribute [rw] message_time # @return [::Google::Protobuf::Timestamp] # The time that the message occurred, if provided. # @!attribute [rw] text # @return [::String] # The text of this segment. # @!attribute [rw] confidence # @return [::Float] # 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. # @!attribute [rw] words # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment::WordInfo>] # A list of the word-specific information for each word in the segment. # @!attribute [rw] language_code # @return [::String] # The language code of this segment as a # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. # Example: "en-US". # @!attribute [rw] channel_tag # @return [::Integer] # 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. # @!attribute [rw] segment_participant # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant] # The participant of this segment. # @!attribute [rw] dialogflow_segment_metadata # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment::DialogflowSegmentMetadata] # CCAI metadata relating to the current transcript segment. # @!attribute [rw] sentiment # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData] # The sentiment for this transcript segment. class TranscriptSegment include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Word-level info for words in a transcript. # @!attribute [rw] start_offset # @return [::Google::Protobuf::Duration] # Time offset of the start of this word relative to the beginning of # the total conversation. # @!attribute [rw] end_offset # @return [::Google::Protobuf::Duration] # Time offset of the end of this word relative to the beginning of the # total conversation. # @!attribute [rw] word # @return [::String] # The word itself. Includes punctuation marks that surround the word. # @!attribute [rw] confidence # @return [::Float] # 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. class WordInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metadata from Dialogflow relating to the current transcript segment. # @!attribute [rw] smart_reply_allowlist_covered # @return [::Boolean] # Whether the transcript segment was covered under the configured smart # reply allowlist in Agent Assist. class DialogflowSegmentMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent] class DialogflowIntentsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible media for the conversation. module Medium # Default value, if unspecified will default to PHONE_CALL. MEDIUM_UNSPECIFIED = 0 # The format for conversations that took place over the phone. PHONE_CALL = 1 # The format for conversations that took place over chat. CHAT = 2 end end # The analysis resource. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the analysis. # Format: # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/analyses/\\{analysis} # @!attribute [r] request_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which the analysis was requested. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which the analysis was created, which occurs when the # long-running operation completes. # @!attribute [r] analysis_result # @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisResult] # Output only. The result of the analysis, which is populated when the analysis # finishes. # @!attribute [rw] annotator_selector # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector] # To select the annotators to run and the phrase matchers to use # (if any). If not specified, all annotators will be run. class Analysis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The conversation source, which is a combination of transcript and audio. # @!attribute [rw] gcs_source # @return [::Google::Cloud::ContactCenterInsights::V1::GcsSource] # A Cloud Storage location specification for the audio and transcript. # @!attribute [rw] dialogflow_source # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowSource] # The source when the conversation comes from Dialogflow. class ConversationDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A Cloud Storage source of conversation data. # @!attribute [rw] audio_uri # @return [::String] # Cloud Storage URI that points to a file that contains the conversation # audio. # @!attribute [rw] transcript_uri # @return [::String] # Immutable. Cloud Storage URI that points to a file that contains the conversation # transcript. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A Dialogflow source of conversation data. # @!attribute [r] dialogflow_conversation # @return [::String] # Output only. The name of the Dialogflow conversation that this conversation # resource is derived from. Format: # projects/\\{project}/locations/\\{location}/conversations/\\{conversation} # @!attribute [rw] audio_uri # @return [::String] # Cloud Storage URI that points to a file that contains the conversation # audio. class DialogflowSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The result of an analysis. # @!attribute [rw] call_analysis_metadata # @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisResult::CallAnalysisMetadata] # Call-specific metadata created by the analysis. # @!attribute [rw] end_time # @return [::Google::Protobuf::Timestamp] # The time at which the analysis ended. class AnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Call-specific metadata created during analysis. # @!attribute [rw] annotations # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::CallAnnotation>] # A list of call annotations that apply to this call. # @!attribute [rw] entities # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::Entity}] # All the entities in the call. # @!attribute [rw] sentiments # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::ConversationLevelSentiment>] # Overall conversation-level sentiment for each channel of the call. # @!attribute [rw] intents # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::Intent}] # All the matched intents in the call. # @!attribute [rw] phrase_matchers # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData}] # All the matched phrase matchers in the call. # @!attribute [rw] issue_model_result # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelResult] # Overall conversation-level issue modeling result. class CallAnalysisMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::ContactCenterInsights::V1::Entity] class EntitiesEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::ContactCenterInsights::V1::Intent] class IntentsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData] class PhraseMatchersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Issue Modeling result on a conversation. # @!attribute [rw] issue_model # @return [::String] # Issue model that generates the result. # Format: projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model} # @!attribute [rw] issues # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::IssueAssignment>] # All the matched issues. class IssueModelResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # One channel of conversation-level sentiment data. # @!attribute [rw] channel_tag # @return [::Integer] # The channel of the audio that the data applies to. # @!attribute [rw] sentiment_data # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData] # Data specifying sentiment. class ConversationLevelSentiment include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Information about the issue. # @!attribute [rw] issue # @return [::String] # Resource name of the assigned issue. # @!attribute [rw] score # @return [::Float] # Score indicating the likelihood of the issue assignment. # currently bounded on [0,1]. # @!attribute [rw] display_name # @return [::String] # Immutable. Display name of the assigned issue. This field is set at time of analyis # and immutable since then. class IssueAssignment include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A piece of metadata that applies to a window of a call. # @!attribute [rw] interruption_data # @return [::Google::Cloud::ContactCenterInsights::V1::InterruptionData] # Data specifying an interruption. # @!attribute [rw] sentiment_data # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData] # Data specifying sentiment. # @!attribute [rw] silence_data # @return [::Google::Cloud::ContactCenterInsights::V1::SilenceData] # Data specifying silence. # @!attribute [rw] hold_data # @return [::Google::Cloud::ContactCenterInsights::V1::HoldData] # Data specifying a hold. # @!attribute [rw] entity_mention_data # @return [::Google::Cloud::ContactCenterInsights::V1::EntityMentionData] # Data specifying an entity mention. # @!attribute [rw] intent_match_data # @return [::Google::Cloud::ContactCenterInsights::V1::IntentMatchData] # Data specifying an intent match. # @!attribute [rw] phrase_match_data # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData] # Data specifying a phrase match. # @!attribute [rw] issue_match_data # @return [::Google::Cloud::ContactCenterInsights::V1::IssueMatchData] # Data specifying an issue match. # @!attribute [rw] channel_tag # @return [::Integer] # The channel of the audio where the annotation occurs. For single-channel # audio, this field is not populated. # @!attribute [rw] annotation_start_boundary # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary] # The boundary in the conversation where the annotation starts, inclusive. # @!attribute [rw] annotation_end_boundary # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary] # The boundary in the conversation where the annotation ends, inclusive. class CallAnnotation include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A point in a conversation that marks the start or the end of an annotation. # @!attribute [rw] word_index # @return [::Integer] # The word index of this boundary with respect to the first word in the # transcript piece. This index starts at zero. # @!attribute [rw] transcript_index # @return [::Integer] # The index in the sequence of transcribed pieces of the conversation where # the boundary is located. This index starts at zero. class AnnotationBoundary include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. # @!attribute [rw] display_name # @return [::String] # The representative name for the entity. # @!attribute [rw] type # @return [::Google::Cloud::ContactCenterInsights::V1::Entity::Type] # The entity type. # @!attribute [rw] metadata # @return [::Google::Protobuf::Map{::String => ::String}] # Metadata associated with the entity. # # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) # and Knowledge Graph MID (`mid`), if they are available. For the metadata # associated with other entity types, see the Type table below. # @!attribute [rw] salience # @return [::Float] # 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. # @!attribute [rw] sentiment # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData] # The aggregate sentiment expressed for this entity in the conversation. class Entity include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class MetadataEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. module Type # Unspecified. TYPE_UNSPECIFIED = 0 # Person. PERSON = 1 # Location. LOCATION = 2 # Organization. ORGANIZATION = 3 # Event. EVENT = 4 # Artwork. WORK_OF_ART = 5 # Consumer product. CONSUMER_GOOD = 6 # Other types of entities. OTHER = 7 # Phone number. # # The metadata lists the phone number (formatted according to local # convention), plus whichever additional elements appear in the text: # # * `number` - The actual number, broken down into sections according to # local convention. # * `national_prefix` - Country code, if detected. # * `area_code` - Region or area code, if detected. # * `extension` - Phone extension (to be dialed after connection), if # detected. PHONE_NUMBER = 9 # Address. # # The metadata identifies the street number and locality plus whichever # additional elements appear in the text: # # * `street_number` - Street number. # * `locality` - City or town. # * `street_name` - Street/route name, if detected. # * `postal_code` - Postal code, if detected. # * `country` - Country, if detected. # * `broad_region` - Administrative area, such as the state, if detected. # * `narrow_region` - Smaller administrative area, such as county, if # detected. # * `sublocality` - Used in Asian addresses to demark a district within a # city, if detected. ADDRESS = 10 # Date. # # The metadata identifies the components of the date: # # * `year` - Four digit year, if detected. # * `month` - Two digit month number, if detected. # * `day` - Two digit day number, if detected. DATE = 11 # Number. # # The metadata is the number itself. NUMBER = 12 # Price. # # The metadata identifies the `value` and `currency`. PRICE = 13 end end # The data for an intent. # Represents a detected intent in the conversation, for example MAKES_PROMISE. # @!attribute [rw] id # @return [::String] # The unique identifier of the intent. # @!attribute [rw] display_name # @return [::String] # The human-readable name of the intent. class Intent include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for a matched phrase matcher. # Represents information identifying a phrase matcher for a given match. # @!attribute [rw] phrase_matcher # @return [::String] # The unique identifier (the resource name) of the phrase matcher. # @!attribute [rw] display_name # @return [::String] # The human-readable name of the phrase matcher. class PhraseMatchData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for a Dialogflow intent. # Represents a detected intent in the conversation, e.g. MAKES_PROMISE. # @!attribute [rw] display_name # @return [::String] # The human-readable name of the intent. class DialogflowIntent include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for an interruption annotation. class InterruptionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for a silence annotation. class SilenceData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for a hold annotation. class HoldData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for an entity mention annotation. # This represents a mention of an `Entity` in the conversation. # @!attribute [rw] entity_unique_id # @return [::String] # The key of this entity in conversation entities. # Can be used to retrieve the exact `Entity` this mention is attached to. # @!attribute [rw] type # @return [::Google::Cloud::ContactCenterInsights::V1::EntityMentionData::MentionType] # The type of the entity mention. # @!attribute [rw] sentiment # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData] # Sentiment expressed for this mention of the entity. class EntityMentionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The supported types of mentions. module MentionType # Unspecified. MENTION_TYPE_UNSPECIFIED = 0 # Proper noun. PROPER = 1 # Common noun (or noun compound). COMMON = 2 end end # 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. # @!attribute [rw] intent_unique_id # @return [::String] # The id of the matched intent. # Can be used to retrieve the corresponding intent information. class IntentMatchData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for a sentiment annotation. # @!attribute [rw] magnitude # @return [::Float] # A non-negative number from 0 to infinity which represents the abolute # magnitude of sentiment regardless of score. # @!attribute [rw] score # @return [::Float] # The sentiment score between -1.0 (negative) and 1.0 (positive). class SentimentData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The data for an issue match annotation. # @!attribute [rw] issue_assignment # @return [::Google::Cloud::ContactCenterInsights::V1::IssueAssignment] # Information about the issue's assignment. class IssueMatchData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The issue model resource. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the issue model. # Format: # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model} # @!attribute [rw] display_name # @return [::String] # The representative name for the issue model. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which this issue model was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time at which the issue model was updated. # @!attribute [r] state # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel::State] # Output only. State of the model. # @!attribute [rw] input_data_config # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel::InputDataConfig] # Configs for the input data that used to create the issue model. # @!attribute [r] training_stats # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats] # Output only. Immutable. The issue model's label statistics on its training data. class IssueModel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configs for the input data used to create the issue model. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::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 `medium` field on `filter`. # @!attribute [r] training_conversations_count # @return [::Integer] # Output only. Number of conversations used in training. Output only. # @!attribute [rw] filter # @return [::String] # A filter to reduce the conversations used for training the model to a # specific subset. class InputDataConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State of the model. module State # Unspecified. STATE_UNSPECIFIED = 0 # Model is not deployed but is ready to deploy. UNDEPLOYED = 1 # Model is being deployed. DEPLOYING = 2 # Model is deployed and is ready to be used. A model can only be used in # analysis if it's in this state. DEPLOYED = 3 # Model is being undeployed. UNDEPLOYING = 4 # Model is being deleted. DELETING = 5 end end # The issue resource. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the issue. # Format: # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}/issues/\\{issue} # @!attribute [rw] display_name # @return [::String] # The representative name for the issue. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which this issue was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time that this issue was updated. # @!attribute [r] sample_utterances # @return [::Array<::String>] # Output only. Resource names of the sample representative utterances that match to this # issue. class Issue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Aggregated statistics about an issue model. # @!attribute [rw] analyzed_conversations_count # @return [::Integer] # Number of conversations the issue model has analyzed at this point in time. # @!attribute [rw] unclassified_conversations_count # @return [::Integer] # Number of analyzed conversations for which no issue was applicable at this # point in time. # @!attribute [rw] issue_stats # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats}] # Statistics on each issue. Key is the issue's resource name. class IssueModelLabelStats include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Aggregated statistics about an issue. # @!attribute [rw] issue # @return [::String] # Issue resource. # Format: # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}/issues/\\{issue} # @!attribute [rw] labeled_conversations_count # @return [::Integer] # Number of conversations attached to the issue at this point in time. # @!attribute [rw] display_name # @return [::String] # Display name of the issue. class IssueStats include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats] class IssueStatsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # The phrase matcher resource. # @!attribute [rw] name # @return [::String] # The resource name of the phrase matcher. # Format: # projects/\\{project}/locations/\\{location}/phraseMatchers/\\{phrase_matcher} # @!attribute [r] revision_id # @return [::String] # 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 # @!attribute [rw] version_tag # @return [::String] # The customized version tag to use for the phrase matcher. If not specified, # it will default to `revision_id`. # @!attribute [r] revision_create_time # @return [::Google::Protobuf::Timestamp] # Output only. The timestamp of when the revision was created. It is also the create time # when a new matcher is added. # @!attribute [rw] display_name # @return [::String] # The human-readable name of the phrase matcher. # @!attribute [rw] type # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType] # Required. The type of this phrase matcher. # @!attribute [rw] active # @return [::Boolean] # Applies the phrase matcher only when it is active. # @!attribute [rw] phrase_match_rule_groups # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup>] # A list of phase match rule groups that are included in this matcher. # @!attribute [r] activation_update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time at which the activation status was updated. # @!attribute [rw] role_match # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role] # 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. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time at which the phrase matcher was updated. class PhraseMatcher include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Specifies how to combine each phrase match rule group to determine whether # there is a match. module PhraseMatcherType # Unspecified. PHRASE_MATCHER_TYPE_UNSPECIFIED = 0 # Must meet all phrase match rule groups or there is no match. ALL_OF = 1 # If any of the phrase match rule groups are met, there is a match. ANY_OF = 2 end end # A message representing a rule in the phrase matcher. # @!attribute [rw] type # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup::PhraseMatchRuleGroupType] # Required. The type of this phrase match rule group. # @!attribute [rw] phrase_match_rules # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRule>] # A list of phase match rules that are included in this group. class PhraseMatchRuleGroup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Specifies how to combine each phrase match rule for whether there is a # match. module PhraseMatchRuleGroupType # Unspecified. PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED = 0 # Must meet all phrase match rules or there is no match. ALL_OF = 1 # If any of the phrase match rules are met, there is a match. ANY_OF = 2 end end # The data for a phrase match rule. # @!attribute [rw] query # @return [::String] # Required. The phrase to be matched. # @!attribute [rw] negated # @return [::Boolean] # Specifies whether the phrase must be missing from the transcript segment or # present in the transcript segment. # @!attribute [rw] config # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleConfig] # Provides additional information about the rule that specifies how to apply # the rule. class PhraseMatchRule include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration information of a phrase match rule. # @!attribute [rw] exact_match_config # @return [::Google::Cloud::ContactCenterInsights::V1::ExactMatchConfig] # The configuration for the exact match rule. class PhraseMatchRuleConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Exact match configuration. # @!attribute [rw] case_sensitive # @return [::Boolean] # Whether to consider case sensitivity when performing an exact match. class ExactMatchConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The settings resource. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the settings resource. # Format: # projects/\\{project}/locations/\\{location}/settings # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which the settings was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which the settings were last updated. # @!attribute [rw] language_code # @return [::String] # 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. # @!attribute [rw] conversation_ttl # @return [::Google::Protobuf::Duration] # 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. # @!attribute [rw] pubsub_notification_settings # @return [::Google::Protobuf::Map{::String => ::String}] # 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: # # * "all-triggers": Notify each time any of the supported triggers occurs. # * "create-analysis": Notify each time an analysis is created. # * "create-conversation": Notify each time a conversation is created. # * "export-insights-data": Notify each time an export is complete. # * "update-conversation": Notify each time a conversation is updated via # UpdateConversation. # # Values are Pub/Sub topics. The format of each Pub/Sub topic is: # projects/\\{project}/topics/\\{topic} # @!attribute [rw] analysis_config # @return [::Google::Cloud::ContactCenterInsights::V1::Settings::AnalysisConfig] # Default analysis settings. class Settings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default configuration when creating Analyses in Insights. # @!attribute [rw] runtime_integration_analysis_percentage # @return [::Float] # Percentage of conversations created using Dialogflow runtime integration # to analyze automatically, between [0, 100]. # @!attribute [rw] annotator_selector # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector] # To select the annotators to run and the phrase matchers to use # (if any). If not specified, all annotators will be run. class AnalysisConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class PubsubNotificationSettingsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # An annotation that was generated during the customer and agent interaction. # @!attribute [rw] article_suggestion # @return [::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData] # Agent Assist Article Suggestion data. # @!attribute [rw] faq_answer # @return [::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData] # Agent Assist FAQ answer data. # @!attribute [rw] smart_reply # @return [::Google::Cloud::ContactCenterInsights::V1::SmartReplyData] # Agent Assist Smart Reply data. # @!attribute [rw] smart_compose_suggestion # @return [::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData] # Agent Assist Smart Compose suggestion data. # @!attribute [rw] dialogflow_interaction # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData] # Dialogflow interaction data. # @!attribute [rw] annotation_id # @return [::String] # The unique identifier of the annotation. # Format: # projects/\\{project}/locations/\\{location}/conversationDatasets/\\{dataset}/conversationDataItems/\\{data_item}/conversationAnnotations/\\{annotation} # @!attribute [rw] create_time # @return [::Google::Protobuf::Timestamp] # The time at which this annotation was created. # @!attribute [rw] start_boundary # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary] # The boundary in the conversation where the annotation starts, inclusive. # @!attribute [rw] end_boundary # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary] # The boundary in the conversation where the annotation ends, inclusive. # @!attribute [rw] answer_feedback # @return [::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback] # The feedback that the customer has about the answer in `data`. class RuntimeAnnotation include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The feedback that the customer has about a certain answer in the # conversation. # @!attribute [rw] correctness_level # @return [::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback::CorrectnessLevel] # The correctness level of an answer. # @!attribute [rw] clicked # @return [::Boolean] # Indicates whether an answer or item was clicked by the human agent. # @!attribute [rw] displayed # @return [::Boolean] # Indicates whether an answer or item was displayed to the human agent in the # agent desktop UI. class AnswerFeedback include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The correctness level of an answer. module CorrectnessLevel # Correctness level unspecified. CORRECTNESS_LEVEL_UNSPECIFIED = 0 # Answer is totally wrong. NOT_CORRECT = 1 # Answer is partially correct. PARTIALLY_CORRECT = 2 # Answer is fully correct. FULLY_CORRECT = 3 end end # Agent Assist Article Suggestion data. # @!attribute [rw] title # @return [::String] # Article title. # @!attribute [rw] uri # @return [::String] # Article URI. # @!attribute [rw] confidence_score # @return [::Float] # 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). # @!attribute [rw] metadata # @return [::Google::Protobuf::Map{::String => ::String}] # Map that contains metadata about the Article Suggestion and the document # that it originates from. # @!attribute [rw] query_record # @return [::String] # The name of the answer record. # Format: # projects/\\{project}/locations/\\{location}/answerRecords/\\{answer_record} # @!attribute [rw] source # @return [::String] # The knowledge document that this answer was extracted from. # Format: # projects/\\{project}/knowledgeBases/\\{knowledge_base}/documents/\\{document} class ArticleSuggestionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class MetadataEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Agent Assist frequently-asked-question answer data. # @!attribute [rw] answer # @return [::String] # The piece of text from the `source` knowledge base document. # @!attribute [rw] confidence_score # @return [::Float] # 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). # @!attribute [rw] question # @return [::String] # The corresponding FAQ question. # @!attribute [rw] metadata # @return [::Google::Protobuf::Map{::String => ::String}] # Map that contains metadata about the FAQ answer and the document that # it originates from. # @!attribute [rw] query_record # @return [::String] # The name of the answer record. # Format: # projects/\\{project}/locations/\\{location}/answerRecords/\\{answer_record} # @!attribute [rw] source # @return [::String] # The knowledge document that this answer was extracted from. # Format: # projects/\\{project}/knowledgeBases/\\{knowledge_base}/documents/\\{document}. class FaqAnswerData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class MetadataEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Agent Assist Smart Reply data. # @!attribute [rw] reply # @return [::String] # The content of the reply. # @!attribute [rw] confidence_score # @return [::Float] # 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). # @!attribute [rw] metadata # @return [::Google::Protobuf::Map{::String => ::String}] # Map that contains metadata about the Smart Reply and the document from # which it originates. # @!attribute [rw] query_record # @return [::String] # The name of the answer record. # Format: # projects/\\{project}/locations/\\{location}/answerRecords/\\{answer_record} class SmartReplyData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class MetadataEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Agent Assist Smart Compose suggestion data. # @!attribute [rw] suggestion # @return [::String] # The content of the suggestion. # @!attribute [rw] confidence_score # @return [::Float] # 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). # @!attribute [rw] metadata # @return [::Google::Protobuf::Map{::String => ::String}] # Map that contains metadata about the Smart Compose suggestion and the # document from which it originates. # @!attribute [rw] query_record # @return [::String] # The name of the answer record. # Format: # projects/\\{project}/locations/\\{location}/answerRecords/\\{answer_record} class SmartComposeSuggestionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class MetadataEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Dialogflow interaction data. # @!attribute [rw] dialogflow_intent_id # @return [::String] # The Dialogflow intent resource path. Format: # projects/\\{project}/agent/\\{agent}/intents/\\{intent} # @!attribute [rw] confidence # @return [::Float] # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 # (completely certain). class DialogflowInteractionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The call participant speaking for a given utterance. # @!attribute [rw] dialogflow_participant_name # @return [::String] # The name of the participant provided by Dialogflow. Format: # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/participants/\\{participant} # @!attribute [rw] user_id # @return [::String] # A user-specified ID representing the participant. # @!attribute [rw] dialogflow_participant # @return [::String] # Deprecated. Use `dialogflow_participant_name` instead. # The name of the Dialogflow participant. Format: # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/participants/\\{participant} # @!attribute [rw] obfuscated_external_user_id # @return [::String] # Obfuscated user ID from Dialogflow. # @!attribute [rw] role # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role] # The role of the participant. class ConversationParticipant include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The role of the participant. module Role # Participant's role is not set. ROLE_UNSPECIFIED = 0 # Participant is a human agent. HUMAN_AGENT = 1 # Participant is an automated agent. AUTOMATED_AGENT = 2 # Participant is an end user who conversed with the contact center. END_USER = 3 # Participant is either a human or automated agent. ANY_AGENT = 4 end end # The View resource. # @!attribute [rw] name # @return [::String] # Immutable. The resource name of the view. # Format: # projects/\\{project}/locations/\\{location}/views/\\{view} # @!attribute [rw] display_name # @return [::String] # The human-readable display name of the view. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time at which this view was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The most recent time at which the view was updated. # @!attribute [rw] value # @return [::String] # String with specific view properties. class View include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Selector of all available annotators and phrase matchers to run. # @!attribute [rw] run_interruption_annotator # @return [::Boolean] # Whether to run the interruption annotator. # @!attribute [rw] run_silence_annotator # @return [::Boolean] # Whether to run the silence annotator. # @!attribute [rw] run_phrase_matcher_annotator # @return [::Boolean] # Whether to run the active phrase matcher annotator(s). # @!attribute [rw] phrase_matchers # @return [::Array<::String>] # 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} # @!attribute [rw] run_sentiment_annotator # @return [::Boolean] # Whether to run the sentiment annotator. # @!attribute [rw] run_entity_annotator # @return [::Boolean] # Whether to run the entity annotator. # @!attribute [rw] run_intent_annotator # @return [::Boolean] # Whether to run the intent annotator. # @!attribute [rw] run_issue_model_annotator # @return [::Boolean] # Whether to run the issue model annotator. A model should have already been # deployed for this to take effect. # @!attribute [rw] issue_models # @return [::Array<::String>] # 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. class AnnotatorSelector include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end