pulumi-gcp 8.30.1a1747132587__py3-none-any.whl → 8.31.0__py3-none-any.whl

pulumi_gcp/diagflow/cx_flow.py

@@ -27,6 +27,7 @@ class CxFlowArgs:
                  description: Optional[pulumi.Input[builtins.str]] = None,
                  event_handlers: Optional[pulumi.Input[Sequence[pulumi.Input['CxFlowEventHandlerArgs']]]] = None,
                  is_default_start_flow: Optional[pulumi.Input[builtins.bool]] = None,
+                 knowledge_connector_settings: Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']] = None,
                  language_code: Optional[pulumi.Input[builtins.str]] = None,
                  nlu_settings: Optional[pulumi.Input['CxFlowNluSettingsArgs']] = None,
                  parent: Optional[pulumi.Input[builtins.str]] = None,
@@ -51,6 +52,8 @@ class CxFlowArgs:
                The Default Start Flow cannot be deleted; deleting the `diagflow.CxFlow` resource does nothing to the underlying GCP resources.
                
                > Avoid having multiple `diagflow.CxFlow` resources linked to the same agent with `is_default_start_flow = true` because they will compete to control a single Default Start Flow resource in GCP.
+        :param pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs'] knowledge_connector_settings: Knowledge connector configuration.
+               Structure is documented below.
         :param pulumi.Input[builtins.str] language_code: The language of the following fields in flow:
                Flow.event_handlers.trigger_fulfillment.messages
                Flow.event_handlers.trigger_fulfillment.conditional_cases
@@ -83,6 +86,8 @@ class CxFlowArgs:
             pulumi.set(__self__, "event_handlers", event_handlers)
         if is_default_start_flow is not None:
             pulumi.set(__self__, "is_default_start_flow", is_default_start_flow)
+        if knowledge_connector_settings is not None:
+            pulumi.set(__self__, "knowledge_connector_settings", knowledge_connector_settings)
         if language_code is not None:
             pulumi.set(__self__, "language_code", language_code)
         if nlu_settings is not None:
@@ -166,6 +171,19 @@ class CxFlowArgs:
     def is_default_start_flow(self, value: Optional[pulumi.Input[builtins.bool]]):
         pulumi.set(self, "is_default_start_flow", value)
 
+    @property
+    @pulumi.getter(name="knowledgeConnectorSettings")
+    def knowledge_connector_settings(self) -> Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']]:
+        """
+        Knowledge connector configuration.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "knowledge_connector_settings")
+
+    @knowledge_connector_settings.setter
+    def knowledge_connector_settings(self, value: Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']]):
+        pulumi.set(self, "knowledge_connector_settings", value)
+
     @property
     @pulumi.getter(name="languageCode")
     def language_code(self) -> Optional[pulumi.Input[builtins.str]]:
@@ -252,6 +270,7 @@ class _CxFlowState:
                  display_name: Optional[pulumi.Input[builtins.str]] = None,
                  event_handlers: Optional[pulumi.Input[Sequence[pulumi.Input['CxFlowEventHandlerArgs']]]] = None,
                  is_default_start_flow: Optional[pulumi.Input[builtins.bool]] = None,
+                 knowledge_connector_settings: Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']] = None,
                  language_code: Optional[pulumi.Input[builtins.str]] = None,
                  name: Optional[pulumi.Input[builtins.str]] = None,
                  nlu_settings: Optional[pulumi.Input['CxFlowNluSettingsArgs']] = None,
@@ -277,6 +296,8 @@ class _CxFlowState:
                The Default Start Flow cannot be deleted; deleting the `diagflow.CxFlow` resource does nothing to the underlying GCP resources.
                
                > Avoid having multiple `diagflow.CxFlow` resources linked to the same agent with `is_default_start_flow = true` because they will compete to control a single Default Start Flow resource in GCP.
+        :param pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs'] knowledge_connector_settings: Knowledge connector configuration.
+               Structure is documented below.
         :param pulumi.Input[builtins.str] language_code: The language of the following fields in flow:
                Flow.event_handlers.trigger_fulfillment.messages
                Flow.event_handlers.trigger_fulfillment.conditional_cases
@@ -312,6 +333,8 @@ class _CxFlowState:
             pulumi.set(__self__, "event_handlers", event_handlers)
         if is_default_start_flow is not None:
             pulumi.set(__self__, "is_default_start_flow", is_default_start_flow)
+        if knowledge_connector_settings is not None:
+            pulumi.set(__self__, "knowledge_connector_settings", knowledge_connector_settings)
         if language_code is not None:
             pulumi.set(__self__, "language_code", language_code)
         if name is not None:
@@ -397,6 +420,19 @@ class _CxFlowState:
     def is_default_start_flow(self, value: Optional[pulumi.Input[builtins.bool]]):
         pulumi.set(self, "is_default_start_flow", value)
 
+    @property
+    @pulumi.getter(name="knowledgeConnectorSettings")
+    def knowledge_connector_settings(self) -> Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']]:
+        """
+        Knowledge connector configuration.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "knowledge_connector_settings")
+
+    @knowledge_connector_settings.setter
+    def knowledge_connector_settings(self, value: Optional[pulumi.Input['CxFlowKnowledgeConnectorSettingsArgs']]):
+        pulumi.set(self, "knowledge_connector_settings", value)
+
     @property
     @pulumi.getter(name="languageCode")
     def language_code(self) -> Optional[pulumi.Input[builtins.str]]:
@@ -499,6 +535,7 @@ class CxFlow(pulumi.CustomResource):
                  display_name: Optional[pulumi.Input[builtins.str]] = None,
                  event_handlers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CxFlowEventHandlerArgs', 'CxFlowEventHandlerArgsDict']]]]] = None,
                  is_default_start_flow: Optional[pulumi.Input[builtins.bool]] = None,
+                 knowledge_connector_settings: Optional[pulumi.Input[Union['CxFlowKnowledgeConnectorSettingsArgs', 'CxFlowKnowledgeConnectorSettingsArgsDict']]] = None,
                  language_code: Optional[pulumi.Input[builtins.str]] = None,
                  nlu_settings: Optional[pulumi.Input[Union['CxFlowNluSettingsArgs', 'CxFlowNluSettingsArgsDict']]] = None,
                  parent: Optional[pulumi.Input[builtins.str]] = None,
@@ -611,6 +648,20 @@ class CxFlow(pulumi.CustomResource):
             name="dialogflowcx-bucket",
             location="US",
             uniform_bucket_level_access=True)
+        my_datastore = gcp.discoveryengine.DataStore("my_datastore",
+            location="global",
+            data_store_id="datastore-flow-full",
+            display_name="datastore-flow-full",
+            industry_vertical="GENERIC",
+            content_config="NO_CONTENT",
+            solution_types=["SOLUTION_TYPE_CHAT"])
+        my_webhook = gcp.diagflow.CxWebhook("my_webhook",
+            parent=agent.id,
+            display_name="MyWebhook",
+            generic_web_service={
+                "uri": "https://example.com",
+            })
+        project = gcp.organizations.get_project()
         basic_flow = gcp.diagflow.CxFlow("basic_flow",
             parent=agent.id,
             display_name="MyFlow",
@@ -879,6 +930,117 @@ class CxFlow(pulumi.CustomResource):
                     "enable_interaction_logging": True,
                     "enable_consent_based_redaction": True,
                 },
+            },
+            knowledge_connector_settings={
+                "enabled": True,
+                "trigger_fulfillment": {
+                    "messages": [
+                        {
+                            "channel": "some-channel",
+                            "text": {
+                                "texts": ["information completed, navigating to page 2"],
+                            },
+                        },
+                        {
+                            "payload": "          {\\"some-key\\": \\"some-value\\", \\"other-key\\": [\\"other-value\\"]}\\n",
+                        },
+                        {
+                            "conversation_success": {
+                                "metadata": "            {\\"some-metadata-key\\": \\"some-value\\", \\"other-metadata-key\\": 1234}\\n",
+                            },
+                        },
+                        {
+                            "output_audio_text": {
+                                "text": "some output text",
+                            },
+                        },
+                        {
+                            "output_audio_text": {
+                                "ssml": "            <speak>Some example <say-as interpret-as=\\"characters\\">SSML XML</say-as></speak>\\n",
+                            },
+                        },
+                        {
+                            "live_agent_handoff": {
+                                "metadata": "            {\\"some-metadata-key\\": \\"some-value\\", \\"other-metadata-key\\": 1234}\\n",
+                            },
+                        },
+                        {
+                            "play_audio": {
+                                "audio_uri": "http://example.com/some-audio-file.mp3",
+                            },
+                        },
+                        {
+                            "telephony_transfer_call": {
+                                "phone_number": "1-234-567-8902",
+                            },
+                        },
+                    ],
+                    "webhook": my_webhook.id,
+                    "return_partial_responses": True,
+                    "tag": "some-tag",
+                    "set_parameter_actions": [{
+                        "parameter": "some-param",
+                        "value": "123.45",
+                    }],
+                    "conditional_cases": [{
+                        "cases": json.dumps([
+                            {
+                                "condition": "$sys.func.RAND() < 0.5",
+                                "caseContent": [{
+                                    "message": {
+                                        "text": {
+                                            "text": ["First case"],
+                                        },
+                                    },
+                                }],
+                            },
+                            {
+                                "caseContent": [{
+                                    "message": {
+                                        "text": {
+                                            "text": ["Final case"],
+                                        },
+                                    },
+                                }],
+                            },
+                        ]),
+                    }],
+                    "advanced_settings": {
+                        "speech_settings": {
+                            "endpointer_sensitivity": 30,
+                            "no_speech_timeout": "3.500s",
+                            "use_timeout_based_endpointing": True,
+                            "models": {
+                                "name": "wrench",
+                                "mass": "1.3kg",
+                                "count": "3",
+                            },
+                        },
+                        "dtmf_settings": {
+                            "enabled": True,
+                            "max_digits": 1,
+                            "finish_digit": "#",
+                            "interdigit_timeout_duration": "3.500s",
+                            "endpointing_timeout_duration": "3.500s",
+                        },
+                        "logging_settings": {
+                            "enable_stackdriver_logging": True,
+                            "enable_interaction_logging": True,
+                            "enable_consent_based_redaction": True,
+                        },
+                    },
+                    "enable_generative_fallback": True,
+                },
+                "data_store_connections": [{
+                    "data_store_type": "UNSTRUCTURED",
+                    "data_store": pulumi.Output.all(
+                        location=agent.location,
+                        data_store_id=my_datastore.data_store_id
+        ).apply(lambda resolved_outputs: f"projects/{project.number}/locations/{resolved_outputs['location']}/collections/default_collection/dataStores/{resolved_outputs['data_store_id']}")
+        ,
+                    "document_processing_mode": "DOCUMENTS",
+                }],
+                "target_flow": agent.start_flow,
             })
         ```
 
@@ -919,6 +1081,8 @@ class CxFlow(pulumi.CustomResource):
                The Default Start Flow cannot be deleted; deleting the `diagflow.CxFlow` resource does nothing to the underlying GCP resources.
                
                > Avoid having multiple `diagflow.CxFlow` resources linked to the same agent with `is_default_start_flow = true` because they will compete to control a single Default Start Flow resource in GCP.
+        :param pulumi.Input[Union['CxFlowKnowledgeConnectorSettingsArgs', 'CxFlowKnowledgeConnectorSettingsArgsDict']] knowledge_connector_settings: Knowledge connector configuration.
+               Structure is documented below.
         :param pulumi.Input[builtins.str] language_code: The language of the following fields in flow:
                Flow.event_handlers.trigger_fulfillment.messages
                Flow.event_handlers.trigger_fulfillment.conditional_cases
@@ -1054,6 +1218,20 @@ class CxFlow(pulumi.CustomResource):
             name="dialogflowcx-bucket",
             location="US",
             uniform_bucket_level_access=True)
+        my_datastore = gcp.discoveryengine.DataStore("my_datastore",
+            location="global",
+            data_store_id="datastore-flow-full",
+            display_name="datastore-flow-full",
+            industry_vertical="GENERIC",
+            content_config="NO_CONTENT",
+            solution_types=["SOLUTION_TYPE_CHAT"])
+        my_webhook = gcp.diagflow.CxWebhook("my_webhook",
+            parent=agent.id,
+            display_name="MyWebhook",
+            generic_web_service={
+                "uri": "https://example.com",
+            })
+        project = gcp.organizations.get_project()
         basic_flow = gcp.diagflow.CxFlow("basic_flow",
             parent=agent.id,
             display_name="MyFlow",
@@ -1322,6 +1500,117 @@ class CxFlow(pulumi.CustomResource):
                     "enable_interaction_logging": True,
                     "enable_consent_based_redaction": True,
                 },
+            },
+            knowledge_connector_settings={
+                "enabled": True,
+                "trigger_fulfillment": {
+                    "messages": [
+                        {
+                            "channel": "some-channel",
+                            "text": {
+                                "texts": ["information completed, navigating to page 2"],
+                            },
+                        },
+                        {
+                            "payload": "          {\\"some-key\\": \\"some-value\\", \\"other-key\\": [\\"other-value\\"]}\\n",
+                        },
+                        {
+                            "conversation_success": {
+                                "metadata": "            {\\"some-metadata-key\\": \\"some-value\\", \\"other-metadata-key\\": 1234}\\n",
+                            },
+                        },
+                        {
+                            "output_audio_text": {
+                                "text": "some output text",
+                            },
+                        },
+                        {
+                            "output_audio_text": {
+                                "ssml": "            <speak>Some example <say-as interpret-as=\\"characters\\">SSML XML</say-as></speak>\\n",
+                            },
+                        },
+                        {
+                            "live_agent_handoff": {
+                                "metadata": "            {\\"some-metadata-key\\": \\"some-value\\", \\"other-metadata-key\\": 1234}\\n",
+                            },
+                        },
+                        {
+                            "play_audio": {
+                                "audio_uri": "http://example.com/some-audio-file.mp3",
+                            },
+                        },
+                        {
+                            "telephony_transfer_call": {
+                                "phone_number": "1-234-567-8902",
+                            },
+                        },
+                    ],
+                    "webhook": my_webhook.id,
+                    "return_partial_responses": True,
+                    "tag": "some-tag",
+                    "set_parameter_actions": [{
+                        "parameter": "some-param",
+                        "value": "123.45",
+                    }],
+                    "conditional_cases": [{
+                        "cases": json.dumps([
+                            {
+                                "condition": "$sys.func.RAND() < 0.5",
+                                "caseContent": [{
+                                    "message": {
+                                        "text": {
+                                            "text": ["First case"],
+                                        },
+                                    },
+                                }],
+                            },
+                            {
+                                "caseContent": [{
+                                    "message": {
+                                        "text": {
+                                            "text": ["Final case"],
+                                        },
+                                    },
+                                }],
+                            },
+                        ]),
+                    }],
+                    "advanced_settings": {
+                        "speech_settings": {
+                            "endpointer_sensitivity": 30,
+                            "no_speech_timeout": "3.500s",
+                            "use_timeout_based_endpointing": True,
+                            "models": {
+                                "name": "wrench",
+                                "mass": "1.3kg",
+                                "count": "3",
+                            },
+                        },
+                        "dtmf_settings": {
+                            "enabled": True,
+                            "max_digits": 1,
+                            "finish_digit": "#",
+                            "interdigit_timeout_duration": "3.500s",
+                            "endpointing_timeout_duration": "3.500s",
+                        },
+                        "logging_settings": {
+                            "enable_stackdriver_logging": True,
+                            "enable_interaction_logging": True,
+                            "enable_consent_based_redaction": True,
+                        },
+                    },
+                    "enable_generative_fallback": True,
+                },
+                "data_store_connections": [{
+                    "data_store_type": "UNSTRUCTURED",
+                    "data_store": pulumi.Output.all(
+                        location=agent.location,
+                        data_store_id=my_datastore.data_store_id
+        ).apply(lambda resolved_outputs: f"projects/{project.number}/locations/{resolved_outputs['location']}/collections/default_collection/dataStores/{resolved_outputs['data_store_id']}")
+        ,
+                    "document_processing_mode": "DOCUMENTS",
+                }],
+                "target_flow": agent.start_flow,
             })
         ```
 
@@ -1363,6 +1652,7 @@ class CxFlow(pulumi.CustomResource):
                  display_name: Optional[pulumi.Input[builtins.str]] = None,
                  event_handlers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CxFlowEventHandlerArgs', 'CxFlowEventHandlerArgsDict']]]]] = None,
                  is_default_start_flow: Optional[pulumi.Input[builtins.bool]] = None,
+                 knowledge_connector_settings: Optional[pulumi.Input[Union['CxFlowKnowledgeConnectorSettingsArgs', 'CxFlowKnowledgeConnectorSettingsArgsDict']]] = None,
                  language_code: Optional[pulumi.Input[builtins.str]] = None,
                  nlu_settings: Optional[pulumi.Input[Union['CxFlowNluSettingsArgs', 'CxFlowNluSettingsArgsDict']]] = None,
                  parent: Optional[pulumi.Input[builtins.str]] = None,
@@ -1384,6 +1674,7 @@ class CxFlow(pulumi.CustomResource):
             __props__.__dict__["display_name"] = display_name
             __props__.__dict__["event_handlers"] = event_handlers
             __props__.__dict__["is_default_start_flow"] = is_default_start_flow
+            __props__.__dict__["knowledge_connector_settings"] = knowledge_connector_settings
             __props__.__dict__["language_code"] = language_code
             __props__.__dict__["nlu_settings"] = nlu_settings
             __props__.__dict__["parent"] = parent
@@ -1405,6 +1696,7 @@ class CxFlow(pulumi.CustomResource):
             display_name: Optional[pulumi.Input[builtins.str]] = None,
             event_handlers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CxFlowEventHandlerArgs', 'CxFlowEventHandlerArgsDict']]]]] = None,
             is_default_start_flow: Optional[pulumi.Input[builtins.bool]] = None,
+            knowledge_connector_settings: Optional[pulumi.Input[Union['CxFlowKnowledgeConnectorSettingsArgs', 'CxFlowKnowledgeConnectorSettingsArgsDict']]] = None,
             language_code: Optional[pulumi.Input[builtins.str]] = None,
             name: Optional[pulumi.Input[builtins.str]] = None,
             nlu_settings: Optional[pulumi.Input[Union['CxFlowNluSettingsArgs', 'CxFlowNluSettingsArgsDict']]] = None,
@@ -1435,6 +1727,8 @@ class CxFlow(pulumi.CustomResource):
                The Default Start Flow cannot be deleted; deleting the `diagflow.CxFlow` resource does nothing to the underlying GCP resources.
                
                > Avoid having multiple `diagflow.CxFlow` resources linked to the same agent with `is_default_start_flow = true` because they will compete to control a single Default Start Flow resource in GCP.
+        :param pulumi.Input[Union['CxFlowKnowledgeConnectorSettingsArgs', 'CxFlowKnowledgeConnectorSettingsArgsDict']] knowledge_connector_settings: Knowledge connector configuration.
+               Structure is documented below.
         :param pulumi.Input[builtins.str] language_code: The language of the following fields in flow:
                Flow.event_handlers.trigger_fulfillment.messages
                Flow.event_handlers.trigger_fulfillment.conditional_cases
@@ -1469,6 +1763,7 @@ class CxFlow(pulumi.CustomResource):
         __props__.__dict__["display_name"] = display_name
         __props__.__dict__["event_handlers"] = event_handlers
         __props__.__dict__["is_default_start_flow"] = is_default_start_flow
+        __props__.__dict__["knowledge_connector_settings"] = knowledge_connector_settings
         __props__.__dict__["language_code"] = language_code
         __props__.__dict__["name"] = name
         __props__.__dict__["nlu_settings"] = nlu_settings
@@ -1529,6 +1824,15 @@ class CxFlow(pulumi.CustomResource):
         """
         return pulumi.get(self, "is_default_start_flow")
 
+    @property
+    @pulumi.getter(name="knowledgeConnectorSettings")
+    def knowledge_connector_settings(self) -> pulumi.Output[Optional['outputs.CxFlowKnowledgeConnectorSettings']]:
+        """
+        Knowledge connector configuration.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "knowledge_connector_settings")
+
     @property
     @pulumi.getter(name="languageCode")
     def language_code(self) -> pulumi.Output[Optional[builtins.str]]: