google-api-python-client 2.86.0__py2.py3-none-any.whl → 2.87.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v3.json

@@ -3820,7 +3820,7 @@
       }
     }
   },
-  "revision": "20230407",
+  "revision": "20230516",
   "rootUrl": "https://dialogflow.googleapis.com/",
   "schemas": {
     "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -4952,7 +4952,7 @@
           "type": "string"
         },
         "agentUri": {
-          "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.",
+          "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.",
           "type": "string"
         }
       },
@@ -5324,7 +5324,7 @@
       "id": "GoogleCloudDialogflowCxV3GcsDestination",
       "properties": {
         "uri": {
-          "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: gs://bucket/object-name-or-prefix Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.",
+          "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.",
           "type": "string"
         }
       },
@@ -5536,7 +5536,7 @@
       "type": "object"
     },
     "GoogleCloudDialogflowCxV3Intent": {
-      "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. Next ID: 15",
+      "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.",
       "id": "GoogleCloudDialogflowCxV3Intent",
       "properties": {
         "description": {
@@ -5608,7 +5608,7 @@
       "id": "GoogleCloudDialogflowCxV3IntentCoverageIntent",
       "properties": {
         "covered": {
-          "description": "Whether or not the intent is covered by at least one of the agent's test cases.",
+          "description": "Whether the intent is covered by at least one of the agent's test cases.",
           "type": "boolean"
         },
         "intent": {
@@ -6325,7 +6325,7 @@
       "type": "object"
     },
     "GoogleCloudDialogflowCxV3QueryInput": {
-      "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ",
+      "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value.",
       "id": "GoogleCloudDialogflowCxV3QueryInput",
       "properties": {
         "audio": {
@@ -7289,14 +7289,16 @@
             "INTENT",
             "PAGE",
             "PARAMETERS",
-            "UTTERANCE"
+            "UTTERANCE",
+            "FLOW"
           ],
           "enumDescriptions": [
             "Should never be used.",
             "The intent.",
             "The page.",
             "The parameters.",
-            "The message utterance."
+            "The message utterance.",
+            "The flow."
           ],
           "type": "string"
         }
@@ -7315,14 +7317,14 @@
       "type": "object"
     },
     "GoogleCloudDialogflowCxV3TextToSpeechSettings": {
-      "description": "Settings related to speech generating.",
+      "description": "Settings related to speech synthesizing.",
       "id": "GoogleCloudDialogflowCxV3TextToSpeechSettings",
       "properties": {
         "synthesizeSpeechConfigs": {
           "additionalProperties": {
             "$ref": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig"
           },
-          "description": "Configuration of how speech should be synthesized, mapping from language (https://dialogflow.com/docs/reference/language) to SynthesizeSpeechConfig.",
+          "description": "Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway). - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.",
           "type": "object"
         }
       },
@@ -7358,7 +7360,7 @@
       "id": "GoogleCloudDialogflowCxV3TransitionCoverageTransition",
       "properties": {
         "covered": {
-          "description": "Whether or not the transition is covered by at least one of the agent's test cases.",
+          "description": "Whether the transition is covered by at least one of the agent's test cases.",
           "type": "boolean"
         },
         "eventHandler": {
@@ -7501,7 +7503,7 @@
       "id": "GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverageTransition",
       "properties": {
         "covered": {
-          "description": "Whether or not the transition route is covered by at least one of the agent's test cases.",
+          "description": "Whether the transition route is covered by at least one of the agent's test cases.",
           "type": "boolean"
         },
         "transitionRoute": {
@@ -7552,6 +7554,16 @@
           "description": "Whether turn resulted in End Session page.",
           "type": "boolean"
         },
+        "sentimentMagnitude": {
+          "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
+        "sentimentScore": {
+          "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
         "userEscalated": {
           "description": "Whether user was specifically asking for a live agent.",
           "type": "boolean"
@@ -7844,10 +7856,45 @@
           },
           "type": "array"
         },
+        "httpMethod": {
+          "description": "Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.",
+          "enum": [
+            "HTTP_METHOD_UNSPECIFIED",
+            "POST",
+            "GET",
+            "HEAD",
+            "PUT",
+            "DELETE",
+            "PATCH",
+            "OPTIONS"
+          ],
+          "enumDescriptions": [
+            "HTTP method not specified.",
+            "HTTP POST Method.",
+            "HTTP GET Method.",
+            "HTTP HEAD Method.",
+            "HTTP PUT Method.",
+            "HTTP DELETE Method.",
+            "HTTP PATCH Method.",
+            "HTTP OPTIONS Method."
+          ],
+          "type": "string"
+        },
+        "parameterMapping": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response",
+          "type": "object"
+        },
         "password": {
           "description": "The password for HTTP Basic authentication.",
           "type": "string"
         },
+        "requestBody": {
+          "description": "Optional. Defines a custom JSON object as request body to send to flexible webhook.",
+          "type": "string"
+        },
         "requestHeaders": {
           "additionalProperties": {
             "type": "string"
@@ -7862,6 +7909,20 @@
         "username": {
           "description": "The user name for HTTP Basic authentication.",
           "type": "string"
+        },
+        "webhookType": {
+          "description": "Optional. Type of the webhook.",
+          "enum": [
+            "WEBHOOK_TYPE_UNSPECIFIED",
+            "STANDARD",
+            "FLEXIBLE"
+          ],
+          "enumDescriptions": [
+            "Default value. This value is unused.",
+            "Represents a standard webhook.",
+            "Represents a flexible webhook."
+          ],
+          "type": "string"
         }
       },
       "type": "object"
@@ -8481,7 +8542,7 @@
           "type": "string"
         },
         "agentUri": {
-          "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.",
+          "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.",
           "type": "string"
         }
       },
@@ -8937,7 +8998,7 @@
       "type": "object"
     },
     "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase": {
-      "description": "Represents an example that the agent is trained on to identify the intent. Next ID: 15",
+      "description": "Represents an example that the agent is trained on to identify the intent.",
       "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase",
       "properties": {
         "id": {
@@ -9091,7 +9152,7 @@
       "type": "object"
     },
     "GoogleCloudDialogflowCxV3beta1QueryInput": {
-      "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ",
+      "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value.",
       "id": "GoogleCloudDialogflowCxV3beta1QueryInput",
       "properties": {
         "audio": {
@@ -9542,14 +9603,16 @@
             "INTENT",
             "PAGE",
             "PARAMETERS",
-            "UTTERANCE"
+            "UTTERANCE",
+            "FLOW"
           ],
           "enumDescriptions": [
             "Should never be used.",
             "The intent.",
             "The page.",
             "The parameters.",
-            "The message utterance."
+            "The message utterance.",
+            "The flow."
           ],
           "type": "string"
         }
@@ -9640,6 +9703,16 @@
           "description": "Whether turn resulted in End Session page.",
           "type": "boolean"
         },
+        "sentimentMagnitude": {
+          "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
+        "sentimentScore": {
+          "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
         "userEscalated": {
           "description": "Whether user was specifically asking for a live agent.",
           "type": "boolean"
@@ -9709,10 +9782,45 @@
           },
           "type": "array"
         },
+        "httpMethod": {
+          "description": "Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.",
+          "enum": [
+            "HTTP_METHOD_UNSPECIFIED",
+            "POST",
+            "GET",
+            "HEAD",
+            "PUT",
+            "DELETE",
+            "PATCH",
+            "OPTIONS"
+          ],
+          "enumDescriptions": [
+            "HTTP method not specified.",
+            "HTTP POST Method.",
+            "HTTP GET Method.",
+            "HTTP HEAD Method.",
+            "HTTP PUT Method.",
+            "HTTP DELETE Method.",
+            "HTTP PATCH Method.",
+            "HTTP OPTIONS Method."
+          ],
+          "type": "string"
+        },
+        "parameterMapping": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response",
+          "type": "object"
+        },
         "password": {
           "description": "The password for HTTP Basic authentication.",
           "type": "string"
         },
+        "requestBody": {
+          "description": "Optional. Defines a custom JSON object as request body to send to flexible webhook.",
+          "type": "string"
+        },
         "requestHeaders": {
           "additionalProperties": {
             "type": "string"
@@ -9727,6 +9835,20 @@
         "username": {
           "description": "The user name for HTTP Basic authentication.",
           "type": "string"
+        },
+        "webhookType": {
+          "description": "Optional. Type of the webhook.",
+          "enum": [
+            "WEBHOOK_TYPE_UNSPECIFIED",
+            "STANDARD",
+            "FLEXIBLE"
+          ],
+          "enumDescriptions": [
+            "Default value. This value is unused.",
+            "Represents a standard webhook.",
+            "Represents a flexible webhook."
+          ],
+          "type": "string"
         }
       },
       "type": "object"
@@ -12195,6 +12317,7 @@
             "ARTICLE_SUGGESTION",
             "FAQ",
             "SMART_REPLY",
+            "DIALOGFLOW_ASSIST",
             "CONVERSATION_SUMMARIZATION"
           ],
           "enumDescriptions": [
@@ -12202,6 +12325,7 @@
             "Run article suggestion model for chat.",
             "Run FAQ model.",
             "Run smart reply model for chat.",
+            "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.",
             "Run conversation summarization model for chat."
           ],
           "type": "string"
@@ -12272,6 +12396,25 @@
       },
       "type": "object"
     },
+    "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": {
+      "description": "Represents a Dialogflow assist answer.",
+      "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer",
+      "properties": {
+        "answerRecord": {
+          "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"",
+          "type": "string"
+        },
+        "intentSuggestion": {
+          "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion",
+          "description": "An intent suggestion generated from conversation."
+        },
+        "queryResult": {
+          "$ref": "GoogleCloudDialogflowV2beta1QueryResult",
+          "description": "Result from v2 agent."
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudDialogflowV2beta1EntityType": {
       "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).",
       "id": "GoogleCloudDialogflowV2beta1EntityType",
@@ -13622,6 +13765,25 @@
       },
       "type": "object"
     },
+    "GoogleCloudDialogflowV2beta1IntentSuggestion": {
+      "description": "Represents an intent suggestion.",
+      "id": "GoogleCloudDialogflowV2beta1IntentSuggestion",
+      "properties": {
+        "description": {
+          "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.",
+          "type": "string"
+        },
+        "displayName": {
+          "description": "The display name of the intent.",
+          "type": "string"
+        },
+        "intentV2": {
+          "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": {
       "description": "Represents an example that the agent is trained on.",
       "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase",
@@ -14062,6 +14224,7 @@
             "ARTICLE_SUGGESTION",
             "FAQ",
             "SMART_REPLY",
+            "DIALOGFLOW_ASSIST",
             "CONVERSATION_SUMMARIZATION"
           ],
           "enumDescriptions": [
@@ -14069,6 +14232,7 @@
             "Run article suggestion model for chat.",
             "Run FAQ model.",
             "Run smart reply model for chat.",
+            "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.",
             "Run conversation summarization model for chat."
           ],
           "type": "string"
@@ -14119,6 +14283,29 @@
       },
       "type": "object"
     },
+    "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": {
+      "description": "The response message for Participants.SuggestDialogflowAssists.",
+      "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse",
+      "properties": {
+        "contextSize": {
+          "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "dialogflowAssistAnswers": {
+          "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.",
+          "items": {
+            "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer"
+          },
+          "type": "array"
+        },
+        "latestMessage": {
+          "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse": {
       "description": "The request message for Participants.SuggestFaqAnswers.",
       "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse",
@@ -14177,6 +14364,10 @@
           "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse",
           "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION."
         },
+        "suggestDialogflowAssistsResponse": {
+          "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse",
+          "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST."
+        },
         "suggestFaqAnswersResponse": {
           "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse",
           "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER."
@@ -14408,6 +14599,16 @@
           "description": "Whether turn resulted in End Session page.",
           "type": "boolean"
         },
+        "sentimentMagnitude": {
+          "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
+        "sentimentScore": {
+          "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.",
+          "format": "float",
+          "type": "number"
+        },
         "triggeredAbandonmentEvent": {
           "description": "Whether agent has triggered the event corresponding to user abandoning the conversation.",
           "type": "boolean"
@@ -14456,7 +14657,7 @@
       "type": "object"
     },
     "GoogleCloudLocationLocation": {
-      "description": "A resource that represents Google Cloud Platform location.",
+      "description": "A resource that represents a Google Cloud location.",
       "id": "GoogleCloudLocationLocation",
       "properties": {
         "displayName": {