feat: support for generating summaries during conversation analysis

google/cloud/contact_center_insights/__init__.py

@@ -99,6 +99,7 @@
     ConversationDataSource,
     ConversationLevelSentiment,
     ConversationParticipant,
+    ConversationSummarizationSuggestionData,
     DialogflowIntent,
     DialogflowInteractionData,
     DialogflowSource,
@@ -207,6 +208,7 @@
     "ConversationDataSource",
     "ConversationLevelSentiment",
     "ConversationParticipant",
+    "ConversationSummarizationSuggestionData",
     "DialogflowIntent",
     "DialogflowInteractionData",
     "DialogflowSource",

google/cloud/contact_center_insights_v1/__init__.py

@@ -97,6 +97,7 @@
     ConversationDataSource,
     ConversationLevelSentiment,
     ConversationParticipant,
+    ConversationSummarizationSuggestionData,
     DialogflowIntent,
     DialogflowInteractionData,
     DialogflowSource,
@@ -151,6 +152,7 @@
     "ConversationDataSource",
     "ConversationLevelSentiment",
     "ConversationParticipant",
+    "ConversationSummarizationSuggestionData",
     "ConversationView",
     "CreateAnalysisOperationMetadata",
     "CreateAnalysisRequest",

google/cloud/contact_center_insights_v1/services/contact_center_insights/async_client.py

@@ -79,6 +79,12 @@ class ContactCenterInsightsAsyncClient:
     parse_conversation_path = staticmethod(
         ContactCenterInsightsClient.parse_conversation_path
     )
+    conversation_profile_path = staticmethod(
+        ContactCenterInsightsClient.conversation_profile_path
+    )
+    parse_conversation_profile_path = staticmethod(
+        ContactCenterInsightsClient.parse_conversation_profile_path
+    )
     issue_path = staticmethod(ContactCenterInsightsClient.issue_path)
     parse_issue_path = staticmethod(ContactCenterInsightsClient.parse_issue_path)
     issue_model_path = staticmethod(ContactCenterInsightsClient.issue_model_path)

google/cloud/contact_center_insights_v1/services/contact_center_insights/client.py

@@ -238,6 +238,28 @@ def parse_conversation_path(path: str) -> Dict[str, str]:
         )
         return m.groupdict() if m else {}
 
+    @staticmethod
+    def conversation_profile_path(
+        project: str,
+        location: str,
+        conversation_profile: str,
+    ) -> str:
+        """Returns a fully-qualified conversation_profile string."""
+        return "projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}".format(
+            project=project,
+            location=location,
+            conversation_profile=conversation_profile,
+        )
+
+    @staticmethod
+    def parse_conversation_profile_path(path: str) -> Dict[str, str]:
+        """Parses a conversation_profile path into its component segments."""
+        m = re.match(
+            r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/conversationProfiles/(?P<conversation_profile>.+?)$",
+            path,
+        )
+        return m.groupdict() if m else {}
+
     @staticmethod
     def issue_path(
         project: str,

google/cloud/contact_center_insights_v1/types/__init__.py

@@ -88,6 +88,7 @@
     ConversationDataSource,
     ConversationLevelSentiment,
     ConversationParticipant,
+    ConversationSummarizationSuggestionData,
     DialogflowIntent,
     DialogflowInteractionData,
     DialogflowSource,
@@ -194,6 +195,7 @@
     "ConversationDataSource",
     "ConversationLevelSentiment",
     "ConversationParticipant",
+    "ConversationSummarizationSuggestionData",
     "DialogflowIntent",
     "DialogflowInteractionData",
     "DialogflowSource",

google/cloud/contact_center_insights_v1/types/resources.py

@@ -63,6 +63,7 @@
         "SmartReplyData",
         "SmartComposeSuggestionData",
         "DialogflowInteractionData",
+        "ConversationSummarizationSuggestionData",
         "ConversationParticipant",
         "View",
         "AnnotatorSelector",
@@ -137,6 +138,9 @@ class Conversation(proto.Message):
         latest_analysis (google.cloud.contact_center_insights_v1.types.Analysis):
             Output only. The conversation's latest
             analysis, if one exists.
+        latest_summary (google.cloud.contact_center_insights_v1.types.ConversationSummarizationSuggestionData):
+            Output only. Latest summary of the
+            conversation.
         runtime_annotations (MutableSequence[google.cloud.contact_center_insights_v1.types.RuntimeAnnotation]):
             Output only. The annotations that were
             generated during the customer and agent
@@ -418,6 +422,11 @@ class DialogflowSegmentMetadata(proto.Message):
         number=12,
         message="Analysis",
     )
+    latest_summary: "ConversationSummarizationSuggestionData" = proto.Field(
+        proto.MESSAGE,
+        number=20,
+        message="ConversationSummarizationSuggestionData",
+    )
     runtime_annotations: MutableSequence["RuntimeAnnotation"] = proto.RepeatedField(
         proto.MESSAGE,
         number=13,
@@ -1540,8 +1549,8 @@ class PhraseMatchRuleGroup(proto.Message):
             Required. The type of this phrase match rule
             group.
         phrase_match_rules (MutableSequence[google.cloud.contact_center_insights_v1.types.PhraseMatchRule]):
-            A list of phase match rules that are included
-            in this group.
+            A list of phrase match rules that are
+            included in this group.
     """
 
     class PhraseMatchRuleGroupType(proto.Enum):
@@ -1820,6 +1829,10 @@ class RuntimeAnnotation(proto.Message):
         dialogflow_interaction (google.cloud.contact_center_insights_v1.types.DialogflowInteractionData):
             Dialogflow interaction data.
 
+            This field is a member of `oneof`_ ``data``.
+        conversation_summarization_suggestion (google.cloud.contact_center_insights_v1.types.ConversationSummarizationSuggestionData):
+            Conversation summarization suggestion data.
+
             This field is a member of `oneof`_ ``data``.
         annotation_id (str):
             The unique identifier of the annotation. Format:
@@ -1868,6 +1881,14 @@ class RuntimeAnnotation(proto.Message):
         oneof="data",
         message="DialogflowInteractionData",
     )
+    conversation_summarization_suggestion: "ConversationSummarizationSuggestionData" = (
+        proto.Field(
+            proto.MESSAGE,
+            number=12,
+            oneof="data",
+            message="ConversationSummarizationSuggestionData",
+        )
+    )
     annotation_id: str = proto.Field(
         proto.STRING,
         number=1,
@@ -2149,6 +2170,60 @@ class DialogflowInteractionData(proto.Message):
     )
 
 
+class ConversationSummarizationSuggestionData(proto.Message):
+    r"""Conversation summarization suggestion data.
+
+    Attributes:
+        text (str):
+            The summarization content that is
+            concatenated into one string.
+        text_sections (MutableMapping[str, str]):
+            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 (float):
+            The confidence score of the summarization.
+        metadata (MutableMapping[str, str]):
+            A map that contains metadata about the
+            summarization and the document from which it
+            originates.
+        answer_record (str):
+            The name of the answer record. Format:
+            projects/{project}/locations/{location}/answerRecords/{answer_record}
+        conversation_model (str):
+            The name of the model that generates this summary. Format:
+            projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    """
+
+    text: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    text_sections: MutableMapping[str, str] = proto.MapField(
+        proto.STRING,
+        proto.STRING,
+        number=5,
+    )
+    confidence: float = proto.Field(
+        proto.FLOAT,
+        number=2,
+    )
+    metadata: MutableMapping[str, str] = proto.MapField(
+        proto.STRING,
+        proto.STRING,
+        number=3,
+    )
+    answer_record: str = proto.Field(
+        proto.STRING,
+        number=4,
+    )
+    conversation_model: str = proto.Field(
+        proto.STRING,
+        number=6,
+    )
+
+
 class ConversationParticipant(proto.Message):
     r"""The call participant speaking for a given utterance.
 
@@ -2310,8 +2385,60 @@ class AnnotatorSelector(proto.Message):
             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 (bool):
+            Whether to run the summarization annotator.
+        summarization_config (google.cloud.contact_center_insights_v1.types.AnnotatorSelector.SummarizationConfig):
+            Configuration for the summarization
+            annotator.
     """
 
+    class SummarizationConfig(proto.Message):
+        r"""Configuration for summarization.
+
+        This message has `oneof`_ fields (mutually exclusive fields).
+        For each oneof, at most one member field can be set at the same time.
+        Setting any member of the oneof automatically clears all other
+        members.
+
+        .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+        Attributes:
+            conversation_profile (str):
+                Resource name of the Dialogflow conversation profile.
+                Format:
+                projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+
+                This field is a member of `oneof`_ ``model_source``.
+            summarization_model (google.cloud.contact_center_insights_v1.types.AnnotatorSelector.SummarizationConfig.SummarizationModel):
+                Default summarization model to be used.
+
+                This field is a member of `oneof`_ ``model_source``.
+        """
+
+        class SummarizationModel(proto.Enum):
+            r"""Summarization model to use, if ``conversation_profile`` is not used.
+
+            Values:
+                SUMMARIZATION_MODEL_UNSPECIFIED (0):
+                    Unspecified summarization model.
+                BASELINE_MODEL (1):
+                    The Insights baseline model.
+            """
+            SUMMARIZATION_MODEL_UNSPECIFIED = 0
+            BASELINE_MODEL = 1
+
+        conversation_profile: str = proto.Field(
+            proto.STRING,
+            number=1,
+            oneof="model_source",
+        )
+        summarization_model: "AnnotatorSelector.SummarizationConfig.SummarizationModel" = proto.Field(
+            proto.ENUM,
+            number=2,
+            oneof="model_source",
+            enum="AnnotatorSelector.SummarizationConfig.SummarizationModel",
+        )
+
     run_interruption_annotator: bool = proto.Field(
         proto.BOOL,
         number=1,
@@ -2348,6 +2475,15 @@ class AnnotatorSelector(proto.Message):
         proto.STRING,
         number=10,
     )
+    run_summarization_annotator: bool = proto.Field(
+        proto.BOOL,
+        number=9,
+    )
+    summarization_config: SummarizationConfig = proto.Field(
+        proto.MESSAGE,
+        number=11,
+        message=SummarizationConfig,
+    )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))

samples/generated_samples/snippet_metadata_google.cloud.contactcenterinsights.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-contact-center-insights",
-    "version": "1.10.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {