chore(contact-center-insights): migrate code from googleapis/python-contact-center-insights

contact-center-insights/snippets/create_analysis.py

@@ -0,0 +1,44 @@
+# 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
+#
+#     http://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.
+#
+# [START contactcenterinsights_create_analysis]
+from google.cloud import contact_center_insights_v1
+
+
+def create_analysis(conversation_name: str) -> contact_center_insights_v1.Analysis:
+    """Creates an analysis.
+
+    Args:
+        conversation_name:
+            The parent resource of the analysis.
+            Format is 'projects/{project_id}/locations/{location_id}/conversations/{conversation_id}'.
+            For example, 'projects/my-project/locations/us-central1/conversations/123456789'.
+
+    Returns:
+        An analysis.
+    """
+    # Construct an analysis.
+    analysis = contact_center_insights_v1.Analysis()
+
+    # Call the Insights client to create an analysis.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    analysis_operation = insights_client.create_analysis(
+        parent=conversation_name, analysis=analysis
+    )
+    analysis = analysis_operation.result(timeout=86400)
+    print(f"Created {analysis.name}")
+    return analysis
+
+
+# [END contactcenterinsights_create_analysis]

contact-center-insights/snippets/create_conversation.py

@@ -0,0 +1,64 @@
+# 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
+#
+#     http://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.
+#
+# [START contactcenterinsights_create_conversation]
+from google.cloud import contact_center_insights_v1
+
+
+def create_conversation(
+    project_id: str,
+    transcript_uri: str = "gs://cloud-samples-data/ccai/chat_sample.json",
+    audio_uri: str = "gs://cloud-samples-data/ccai/voice_6912.txt",
+) -> contact_center_insights_v1.Conversation:
+    """Creates a conversation.
+
+    Args:
+        project_id:
+            The project identifier. For example, 'my-project'.
+        transcript_uri:
+            The Cloud Storage URI that points to a file that contains the
+            conversation transcript. Format is 'gs://{bucket_name}/{file.json}'.
+            For example, 'gs://cloud-samples-data/ccai/chat_sample.json'.
+        audio_uri:
+            The Cloud Storage URI that points to a file that contains the
+            conversation audio. Format is 'gs://{bucket_name}/{file.json}'.
+            For example, 'gs://cloud-samples-data/ccai/voice_6912.txt'.
+
+    Returns:
+        A conversation.
+    """
+    # Construct a parent resource.
+    parent = (
+        contact_center_insights_v1.ContactCenterInsightsClient.common_location_path(
+            project_id, "us-central1"
+        )
+    )
+
+    # Construct a conversation.
+    conversation = contact_center_insights_v1.Conversation()
+    conversation.data_source.gcs_source.transcript_uri = transcript_uri
+    conversation.data_source.gcs_source.audio_uri = audio_uri
+    conversation.medium = contact_center_insights_v1.Conversation.Medium.CHAT
+
+    # Call the Insights client to create a conversation.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    conversation = insights_client.create_conversation(
+        parent=parent, conversation=conversation
+    )
+
+    print(f"Created {conversation.name}")
+    return conversation
+
+
+# [END contactcenterinsights_create_conversation]

contact-center-insights/snippets/create_conversation_with_ttl.py

@@ -0,0 +1,71 @@
+# 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
+#
+#     http://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.
+#
+# Create a conversation with a TTL.
+# [START contactcenterinsights_create_conversation_with_ttl]
+from google.cloud import contact_center_insights_v1
+from google.protobuf import duration_pb2
+
+
+def create_conversation_with_ttl(
+    project_id: str,
+    transcript_uri: str = "gs://cloud-samples-data/ccai/chat_sample.json",
+    audio_uri: str = "gs://cloud-samples-data/ccai/voice_6912.txt",
+) -> contact_center_insights_v1.Conversation:
+    """Creates a conversation with a TTL value.
+
+    Args:
+        project_id:
+            The project identifier. For example, 'my-project'.
+        transcript_uri:
+            The Cloud Storage URI that points to a file that contains the
+            conversation transcript. Format is 'gs://{bucket_name}/{file.json}'.
+            For example, 'gs://cloud-samples-data/ccai/chat_sample.json'.
+        audio_uri:
+            The Cloud Storage URI that points to a file that contains the
+            conversation audio. Format is 'gs://{bucket_name}/{file.json}'.
+            For example, 'gs://cloud-samples-data/ccai/voice_6912.txt'.
+
+    Returns:
+        A conversation.
+    """
+    # Construct a parent resource.
+    parent = (
+        contact_center_insights_v1.ContactCenterInsightsClient.common_location_path(
+            project_id, "us-central1"
+        )
+    )
+
+    # Construct a conversation.
+    conversation = contact_center_insights_v1.Conversation()
+    conversation.data_source.gcs_source.transcript_uri = transcript_uri
+    conversation.data_source.gcs_source.audio_uri = audio_uri
+    conversation.medium = contact_center_insights_v1.Conversation.Medium.CHAT
+
+    # Construct a TTL.
+    ttl = duration_pb2.Duration()
+    ttl.seconds = 86400
+    conversation.ttl = ttl
+
+    # Call the Insights client to create a conversation.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    conversation = insights_client.create_conversation(
+        parent=parent, conversation=conversation
+    )
+
+    print(f"Created {conversation.name}")
+    return conversation
+
+
+# [END contactcenterinsights_create_conversation_with_ttl]

contact-center-insights/snippets/create_issue_model.py

@@ -0,0 +1,52 @@
+# 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
+#
+#     http://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.
+#
+# [START contactcenterinsights_create_issue_model]
+from google.cloud import contact_center_insights_v1
+
+
+def create_issue_model(project_id: str) -> contact_center_insights_v1.IssueModel:
+    """Creates an issue model.
+
+    Args:
+        project_id:
+            The project identifier. For example, 'my-project'.
+
+    Returns:
+        An issue model.
+    """
+    # Construct a parent resource.
+    parent = (
+        contact_center_insights_v1.ContactCenterInsightsClient.common_location_path(
+            project_id, "us-central1"
+        )
+    )
+
+    # Construct an issue model.
+    issue_model = contact_center_insights_v1.IssueModel()
+    issue_model.display_name = "my-model"
+    issue_model.input_data_config.filter = 'medium="CHAT"'
+
+    # Call the Insights client to create an issue model.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    issue_model_operation = insights_client.create_issue_model(
+        parent=parent, issue_model=issue_model
+    )
+
+    issue_model = issue_model_operation.result(timeout=86400)
+    print(f"Created an issue model named {issue_model.name}")
+    return issue_model
+
+
+# [END contactcenterinsights_create_issue_model]

contact-center-insights/snippets/create_phrase_matcher_all_of.py

@@ -0,0 +1,85 @@
+# 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
+#
+#     http://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.
+#
+# [START contactcenterinsights_create_phrase_matcher_all_of]
+from google.cloud import contact_center_insights_v1
+
+
+def create_phrase_matcher_all_of(
+    project_id: str,
+) -> contact_center_insights_v1.PhraseMatcher:
+    """Creates a phrase matcher that matches all specified queries.
+
+    Args:
+        project_id:
+            The project identifier. For example, 'my-project'.
+
+    Returns:
+        A phrase matcher.
+    """
+    # Construct a parent resource.
+    parent = (
+        contact_center_insights_v1.ContactCenterInsightsClient.common_location_path(
+            project_id, "us-central1"
+        )
+    )
+
+    # Construct a phrase matcher that matches all of its rule groups.
+    phrase_matcher = contact_center_insights_v1.PhraseMatcher()
+    phrase_matcher.display_name = "NON_SHIPPING_PHONE_SERVICE"
+    phrase_matcher.type_ = (
+        contact_center_insights_v1.PhraseMatcher.PhraseMatcherType.ALL_OF
+    )
+    phrase_matcher.active = True
+
+    # Construct a rule group to match the word "PHONE" or "CELLPHONE", ignoring case sensitivity.
+    rule_group_phone_or_cellphone = contact_center_insights_v1.PhraseMatchRuleGroup()
+    rule_group_phone_or_cellphone.type_ = (
+        contact_center_insights_v1.PhraseMatchRuleGroup.PhraseMatchRuleGroupType.ANY_OF
+    )
+
+    for word in ["PHONE", "CELLPHONE"]:
+        rule = contact_center_insights_v1.PhraseMatchRule()
+        rule.query = word
+        rule.config.exact_match_config = contact_center_insights_v1.ExactMatchConfig()
+        rule_group_phone_or_cellphone.phrase_match_rules.append(rule)
+    phrase_matcher.phrase_match_rule_groups.append(rule_group_phone_or_cellphone)
+
+    # Construct another rule group to not match the word "SHIPPING" or "DELIVERY", ignoring case sensitivity.
+    rule_group_not_shipping_or_delivery = (
+        contact_center_insights_v1.PhraseMatchRuleGroup()
+    )
+    rule_group_not_shipping_or_delivery.type_ = (
+        contact_center_insights_v1.PhraseMatchRuleGroup.PhraseMatchRuleGroupType.ALL_OF
+    )
+
+    for word in ["SHIPPING", "DELIVERY"]:
+        rule = contact_center_insights_v1.PhraseMatchRule()
+        rule.query = word
+        rule.negated = True
+        rule.config.exact_match_config = contact_center_insights_v1.ExactMatchConfig()
+        rule_group_not_shipping_or_delivery.phrase_match_rules.append(rule)
+    phrase_matcher.phrase_match_rule_groups.append(rule_group_not_shipping_or_delivery)
+
+    # Call the Insights client to create a phrase matcher.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    phrase_matcher = insights_client.create_phrase_matcher(
+        parent=parent, phrase_matcher=phrase_matcher
+    )
+
+    print(f"Created {phrase_matcher.name}")
+    return phrase_matcher
+
+
+# [END contactcenterinsights_create_phrase_matcher_all_of]

contact-center-insights/snippets/create_phrase_matcher_any_of.py

@@ -0,0 +1,69 @@
+# 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
+#
+#     http://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.
+#
+# [START contactcenterinsights_create_phrase_matcher_any_of]
+from google.cloud import contact_center_insights_v1
+
+
+def create_phrase_matcher_any_of(
+    project_id: str,
+) -> contact_center_insights_v1.PhraseMatcher:
+    """Creates a phrase matcher that matches any of the specified queries.
+
+    Args:
+        project_id:
+            The project identifier. For example, 'my-project'.
+
+    Returns:
+        A phrase matcher.
+    """
+    # Construct a parent resource.
+    parent = (
+        contact_center_insights_v1.ContactCenterInsightsClient.common_location_path(
+            project_id, "us-central1"
+        )
+    )
+
+    # Construct a phrase matcher that matches any of its rule groups.
+    phrase_matcher = contact_center_insights_v1.PhraseMatcher()
+    phrase_matcher.display_name = "PHONE_SERVICE"
+    phrase_matcher.type_ = (
+        contact_center_insights_v1.PhraseMatcher.PhraseMatcherType.ANY_OF
+    )
+    phrase_matcher.active = True
+
+    # Construct a rule group to match the word "PHONE" or "CELLPHONE", ignoring case sensitivity.
+    rule_group = contact_center_insights_v1.PhraseMatchRuleGroup()
+    rule_group.type_ = (
+        contact_center_insights_v1.PhraseMatchRuleGroup.PhraseMatchRuleGroupType.ANY_OF
+    )
+
+    for word in ["PHONE", "CELLPHONE"]:
+        rule = contact_center_insights_v1.PhraseMatchRule()
+        rule.query = word
+        rule.config.exact_match_config = contact_center_insights_v1.ExactMatchConfig()
+        rule_group.phrase_match_rules.append(rule)
+    phrase_matcher.phrase_match_rule_groups.append(rule_group)
+
+    # Call the Insights client to create a phrase matcher.
+    insights_client = contact_center_insights_v1.ContactCenterInsightsClient()
+    phrase_matcher = insights_client.create_phrase_matcher(
+        parent=parent, phrase_matcher=phrase_matcher
+    )
+
+    print(f"Created {phrase_matcher.name}")
+    return phrase_matcher
+
+
+# [END contactcenterinsights_create_phrase_matcher_any_of]