diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 2f4cc9d6c0..d3341e1255 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4343,6 +4343,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2/projects/{projectsId}/locations", @@ -7717,6 +7743,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8655,7 +8714,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8715,12 +8774,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -9034,7 +9097,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -9112,7 +9175,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -9167,6 +9230,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -10383,7 +10450,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -10442,7 +10509,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -10472,11 +10539,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -11105,12 +11172,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -11424,7 +11495,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -11502,7 +11573,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -11557,6 +11628,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -12765,7 +12840,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -12824,7 +12899,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12854,11 +12929,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -15013,6 +15088,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "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": "GoogleCloudDialogflowV2EntityType", @@ -16217,6 +16307,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -18581,10 +18694,47 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2SpeechToTextConfig", "properties": { + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ @@ -19551,6 +19701,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "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", @@ -19755,6 +19920,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -21214,6 +21402,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -21363,6 +21558,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index cef253fd7d..a423480fa1 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4108,6 +4108,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta1/projects/{projectsId}/locations", @@ -7109,6 +7135,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8023,7 +8082,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8083,12 +8142,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -8402,7 +8465,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -8480,7 +8543,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -8535,6 +8598,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -9751,7 +9818,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -9810,7 +9877,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -9840,11 +9907,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -10473,12 +10540,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -10792,7 +10863,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -10870,7 +10941,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -10925,6 +10996,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -12133,7 +12208,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -12192,7 +12267,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12222,11 +12297,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13274,6 +13349,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "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": "GoogleCloudDialogflowV2EntityType", @@ -13517,6 +13607,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15603,7 +15716,7 @@ "id": "GoogleCloudDialogflowV2beta1AudioInput", "properties": { "audio": { - "description": "Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", + "description": "Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", "format": "byte", "type": "string" }, @@ -16512,6 +16625,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "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", @@ -17606,6 +17734,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", @@ -19499,6 +19650,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -20363,10 +20521,47 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2beta1SpeechToTextConfig", "properties": { + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 63873b0e28..f9cacc979e 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -902,7 +902,7 @@ ], "parameters": { "environment": { - "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1110,7 +1110,7 @@ "type": "string" }, "parent": { - "description": "Required. The environment to list results for. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to list results for. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1325,7 +1325,7 @@ ], "parameters": { "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", "required": true, @@ -2396,7 +2396,7 @@ ], "parameters": { "baseVersion": { - "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`.", + "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3382,7 +3382,7 @@ ], "parameters": { "parent": { - "description": "Required. Agent name. Format: `projects//locations//agents/ `.", + "description": "Required. Agent name. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -3619,7 +3619,7 @@ ], "parameters": { "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -3654,7 +3654,7 @@ ], "parameters": { "name": { - "description": "Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -3729,7 +3729,7 @@ "type": "string" }, "parent": { - "description": "Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4513,12 +4513,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -4824,7 +4828,7 @@ "id": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest", "properties": { "names": { - "description": "Required. Format of test case names: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case names: `projects//locations//agents//testCases/`.", "items": { "type": "string" }, @@ -5273,6 +5277,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5364,6 +5372,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5465,7 +5477,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowRequest", "properties": { "flowVersion": { - "description": "Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`.", + "description": "Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } }, @@ -5476,7 +5488,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -5772,7 +5784,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -5827,6 +5839,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -5882,7 +5898,7 @@ "type": "string" }, "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "type": "string" }, "result": { @@ -6394,6 +6410,10 @@ "$ref": "GoogleCloudDialogflowCxV3KnowledgeConnectorSettings", "description": "Optional. Knowledge connector configuration." }, + "locked": { + "description": "Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.", + "type": "boolean" + }, "multiLanguageSettings": { "$ref": "GoogleCloudDialogflowCxV3FlowMultiLanguageSettings", "description": "Optional. Multi-lingual agent settings for this flow." @@ -6407,7 +6427,7 @@ "description": "NLU related settings of the flow." }, "transitionRouteGroups": { - "description": "A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", + "description": "A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", "items": { "type": "string" }, @@ -7864,6 +7884,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -7874,6 +7895,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -9147,7 +9169,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -9206,7 +9228,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -9236,11 +9258,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -10260,12 +10282,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -10579,7 +10605,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -10657,7 +10683,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -10712,6 +10738,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11920,7 +11950,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -11979,7 +12009,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12009,11 +12039,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13061,6 +13091,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "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": "GoogleCloudDialogflowV2EntityType", @@ -13304,6 +13349,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15125,6 +15193,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "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", @@ -15329,6 +15412,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -16788,6 +16894,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -16937,6 +17050,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index e8e5e5c148..e021ed8782 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -1000,7 +1000,7 @@ ], "parameters": { "environment": { - "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1208,7 +1208,7 @@ "type": "string" }, "parent": { - "description": "Required. The environment to list results for. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to list results for. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1423,7 +1423,7 @@ ], "parameters": { "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", "required": true, @@ -2494,7 +2494,7 @@ ], "parameters": { "baseVersion": { - "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`.", + "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3923,7 +3923,7 @@ ], "parameters": { "parent": { - "description": "Required. Agent name. Format: `projects//locations//agents/ `.", + "description": "Required. Agent name. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -4160,7 +4160,7 @@ ], "parameters": { "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4195,7 +4195,7 @@ ], "parameters": { "name": { - "description": "Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4270,7 +4270,7 @@ "type": "string" }, "parent": { - "description": "Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -5185,7 +5185,7 @@ } } }, - "revision": "20240614", + "revision": "20240731", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5245,12 +5245,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -5564,7 +5568,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -5642,7 +5646,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -5697,6 +5701,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -6913,7 +6921,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -6972,7 +6980,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -7002,11 +7010,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -7662,12 +7670,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -7988,7 +8000,7 @@ "id": "GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest", "properties": { "names": { - "description": "Required. Format of test case names: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case names: `projects//locations//agents//testCases/`.", "items": { "type": "string" }, @@ -8699,6 +8711,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8790,6 +8806,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8891,7 +8911,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowRequest", "properties": { "flowVersion": { - "description": "Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`.", + "description": "Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } }, @@ -8902,7 +8922,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -9202,7 +9222,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -9257,6 +9277,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -9388,7 +9412,7 @@ "type": "string" }, "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "type": "string" }, "result": { @@ -9936,6 +9960,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings", "description": "Optional. Knowledge connector configuration." }, + "locked": { + "description": "Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.", + "type": "boolean" + }, "multiLanguageSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings", "description": "Optional. Multi-lingual agent settings for this flow." @@ -9997,7 +10025,7 @@ "id": "GoogleCloudDialogflowCxV3beta1FlowInvocation", "properties": { "flow": { - "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents/`.", + "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", "type": "string" }, "flowState": { @@ -10803,6 +10831,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineSchema": { + "description": "A type schema object that's specified inline.", + "id": "GoogleCloudDialogflowCxV3beta1InlineSchema", + "properties": { + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "description": "Schema of the elements if this is an ARRAY type." + }, + "type": { + "description": "Data type of the schema.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "BOOLEAN", + "ARRAY" + ], + "enumDescriptions": [ + "Not specified.", + "Represents any string value.", + "Represents any number value.", + "Represents a boolean value.", + "Represents a repeated value." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InlineSource": { "description": "Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.", "id": "GoogleCloudDialogflowCxV3beta1InlineSource", @@ -11584,6 +11641,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -11594,6 +11652,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -11883,7 +11942,8 @@ "type": "string" }, "type": { - "description": "Required. Type of parameter.", + "deprecated": true, + "description": "Type of parameter.", "enum": [ "PARAMETER_TYPE_UNSPECIFIED", "STRING", @@ -11903,6 +11963,10 @@ "Represents a repeated value." ], "type": "string" + }, + "typeSchema": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "description": "Optional. Type schema of parameter." } }, "type": "object" @@ -13166,7 +13230,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -13225,7 +13289,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -13255,11 +13319,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13610,6 +13674,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthentication", "description": "Optional. Authentication information required by the API." }, + "serviceDirectoryConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", + "description": "Optional. Service Directory configuration." + }, "textSchema": { "description": "Required. The OpenAPI schema specified as a text.", "type": "string" @@ -13621,6 +13689,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig": { + "description": "Configuration for tools using Service Directory.", + "id": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", + "properties": { + "service": { + "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ToolTLSConfig": { "description": "The TLS configuration.", "id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfig", @@ -13934,6 +14013,36 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1TypeSchema": { + "description": "Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition.", + "id": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "properties": { + "inlineSchema": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineSchema", + "description": "Set if this is an inline schema definition." + }, + "schemaReference": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference", + "description": "Set if this is a schema reference." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference": { + "description": "A reference to the schema of an existing tool.", + "id": "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference", + "properties": { + "schema": { + "description": "The name of the schema.", + "type": "string" + }, + "tool": { + "description": "The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { "description": "Metadata for UpdateDocument operation.", "id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", @@ -14982,6 +15091,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "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": "GoogleCloudDialogflowV2EntityType", @@ -15225,6 +15349,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -17046,6 +17193,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "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", @@ -17250,6 +17412,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -18709,6 +18894,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -18858,6 +19050,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 689fec9fed..9b7c278038 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v2 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -298,12 +302,16 @@ export namespace dialogflow_v2 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -523,7 +531,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -590,7 +598,7 @@ export namespace dialogflow_v2 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -632,6 +640,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1539,7 +1551,7 @@ export namespace dialogflow_v2 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1585,7 +1597,7 @@ export namespace dialogflow_v2 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1602,11 +1614,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2217,7 +2229,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2284,7 +2296,7 @@ export namespace dialogflow_v2 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2326,6 +2338,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3229,7 +3245,7 @@ export namespace dialogflow_v2 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -3275,7 +3291,7 @@ export namespace dialogflow_v2 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -3292,11 +3308,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4327,6 +4343,19 @@ export namespace dialogflow_v2 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -4472,6 +4501,24 @@ export namespace dialogflow_v2 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -5512,6 +5559,10 @@ export namespace dialogflow_v2 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -5624,6 +5675,96 @@ export namespace dialogflow_v2 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -6409,6 +6550,19 @@ export namespace dialogflow_v2 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -7308,6 +7462,24 @@ export namespace dialogflow_v2 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * Instructs the speech recognizer how to process the audio content. */ @@ -8961,10 +9133,26 @@ export namespace dialogflow_v2 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2SpeechToTextConfig { + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -23596,6 +23784,7 @@ export namespace dialogflow_v2 { conversationModels: Resource$Projects$Locations$Conversationmodels; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -23616,6 +23805,9 @@ export namespace dialogflow_v2 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23914,6 +24106,100 @@ export namespace dialogflow_v2 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -24130,6 +24416,13 @@ export namespace dialogflow_v2 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -35231,6 +35524,122 @@ export namespace dialogflow_v2 { requestBody?: Schema$GoogleCloudDialogflowV2SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 2beff5da0d..e189e4b3e3 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v2beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -298,12 +302,16 @@ export namespace dialogflow_v2beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -523,7 +531,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -590,7 +598,7 @@ export namespace dialogflow_v2beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -632,6 +640,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1539,7 +1551,7 @@ export namespace dialogflow_v2beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1585,7 +1597,7 @@ export namespace dialogflow_v2beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1602,11 +1614,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2217,7 +2229,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2284,7 +2296,7 @@ export namespace dialogflow_v2beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2326,6 +2338,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3229,7 +3245,7 @@ export namespace dialogflow_v2beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -3275,7 +3291,7 @@ export namespace dialogflow_v2beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -3292,11 +3308,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4116,7 +4132,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1AudioInput { /** - * Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + * Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. */ audio?: string | null; /** @@ -4719,6 +4735,19 @@ export namespace dialogflow_v2beta1 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -5528,6 +5557,24 @@ export namespace dialogflow_v2beta1 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -6872,6 +6919,10 @@ export namespace dialogflow_v2beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7464,10 +7515,26 @@ export namespace dialogflow_v2beta1 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2beta1SpeechToTextConfig { + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -8286,6 +8353,19 @@ export namespace dialogflow_v2beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -8461,6 +8541,24 @@ export namespace dialogflow_v2beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -22861,6 +22959,7 @@ export namespace dialogflow_v2beta1 { answerRecords: Resource$Projects$Locations$Answerrecords; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -22877,6 +22976,9 @@ export namespace dialogflow_v2beta1 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23175,6 +23277,100 @@ export namespace dialogflow_v2beta1 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -23391,6 +23587,13 @@ export namespace dialogflow_v2beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -33182,6 +33385,122 @@ export namespace dialogflow_v2beta1 { requestBody?: Schema$GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 16ea0dfd70..aa68995d28 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v3 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -424,7 +428,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest { /** - * Required. Format of test case names: `projects//locations/ /agents//testCases/`. + * Required. Format of test case names: `projects//locations//agents//testCases/`. */ names?: string[] | null; } @@ -509,12 +513,16 @@ export namespace dialogflow_v3 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -734,7 +742,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -801,7 +809,7 @@ export namespace dialogflow_v3 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -843,6 +851,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1750,7 +1762,7 @@ export namespace dialogflow_v3 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1796,7 +1808,7 @@ export namespace dialogflow_v3 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1813,11 +1825,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2573,6 +2585,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2625,6 +2641,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2691,7 +2711,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowRequest { /** - * Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`. + * Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`. */ flowVersion?: string | null; } @@ -2700,7 +2720,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2914,7 +2934,7 @@ export namespace dialogflow_v3 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2956,6 +2976,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3003,7 +3027,7 @@ export namespace dialogflow_v3 { */ lastUpdateTime?: string | null; /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string | null; /** @@ -3356,6 +3380,10 @@ export namespace dialogflow_v3 { * Optional. Knowledge connector configuration. */ knowledgeConnectorSettings?: Schema$GoogleCloudDialogflowCxV3KnowledgeConnectorSettings; + /** + * Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected. + */ + locked?: boolean | null; /** * Optional. Multi-lingual agent settings for this flow. */ @@ -3369,7 +3397,7 @@ export namespace dialogflow_v3 { */ nluSettings?: Schema$GoogleCloudDialogflowCxV3NluSettings; /** - * A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + * A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. */ transitionRouteGroups?: string[] | null; /** @@ -5321,7 +5349,7 @@ export namespace dialogflow_v3 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -5367,7 +5395,7 @@ export namespace dialogflow_v3 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -5384,11 +5412,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -6264,6 +6292,19 @@ export namespace dialogflow_v3 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -6409,6 +6450,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -7449,6 +7508,10 @@ export namespace dialogflow_v3 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7561,6 +7624,96 @@ export namespace dialogflow_v3 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -7995,6 +8148,19 @@ export namespace dialogflow_v3 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -8170,6 +8336,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -12814,7 +12998,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Environments$Deployflow extends StandardParameters { /** - * Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`. + * Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`. */ environment?: string; @@ -13005,7 +13189,7 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The environment to list results for. Format: `projects//locations//agents// environments/`. + * Required. The environment to list results for. Format: `projects//locations//agents//environments/`. */ parent?: string; } @@ -13949,7 +14133,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Environments$Experiments$Patch extends StandardParameters { /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string; /** @@ -17871,7 +18055,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Flows$Versions$Compareversions extends StandardParameters { /** - * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`. + * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`. */ baseVersion?: string; @@ -21362,7 +21546,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun extends StandardParameters { /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: `projects//locations//agents/`. */ parent?: string; @@ -21447,7 +21631,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch extends StandardParameters { /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string; /** @@ -21463,7 +21647,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Run extends StandardParameters { /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: `projects//locations//agents//testCases/`. */ name?: string; @@ -21695,7 +21879,7 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. + * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. */ parent?: string; } diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 95df81fe7a..d3f96c9d38 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v3beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -323,12 +327,16 @@ export namespace dialogflow_v3beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -586,7 +594,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest { /** - * Required. Format of test case names: `projects//locations/ /agents//testCases/`. + * Required. Format of test case names: `projects//locations//agents//testCases/`. */ names?: string[] | null; } @@ -1115,6 +1123,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1167,6 +1179,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1233,7 +1249,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowRequest { /** - * Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`. + * Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`. */ flowVersion?: string | null; } @@ -1242,7 +1258,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -1460,7 +1476,7 @@ export namespace dialogflow_v3beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -1502,6 +1518,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1598,7 +1618,7 @@ export namespace dialogflow_v3beta1 { */ lastUpdateTime?: string | null; /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string | null; /** @@ -1972,6 +1992,10 @@ export namespace dialogflow_v3beta1 { * Optional. Knowledge connector configuration. */ knowledgeConnectorSettings?: Schema$GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings; + /** + * Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected. + */ + locked?: boolean | null; /** * Optional. Multi-lingual agent settings for this flow. */ @@ -2007,7 +2031,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1FlowInvocation { /** - * Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + * Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`. */ flow?: string | null; /** @@ -2578,6 +2602,19 @@ export namespace dialogflow_v3beta1 { */ content?: string | null; } + /** + * A type schema object that's specified inline. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineSchema { + /** + * Schema of the elements if this is an ARRAY type. + */ + items?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchema; + /** + * Data type of the schema. + */ + type?: string | null; + } /** * Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow. */ @@ -3345,9 +3382,13 @@ export namespace dialogflow_v3beta1 { */ name?: string | null; /** - * Required. Type of parameter. + * Type of parameter. */ type?: string | null; + /** + * Optional. Type schema of parameter. + */ + typeSchema?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchema; } /** * Text input which can be used for prompt or banned phrases. @@ -4261,7 +4302,7 @@ export namespace dialogflow_v3beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -4307,7 +4348,7 @@ export namespace dialogflow_v3beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -4324,11 +4365,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4578,6 +4619,10 @@ export namespace dialogflow_v3beta1 { * Optional. Authentication information required by the API. */ authentication?: Schema$GoogleCloudDialogflowCxV3beta1ToolAuthentication; + /** + * Optional. Service Directory configuration. + */ + serviceDirectoryConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig; /** * Required. The OpenAPI schema specified as a text. */ @@ -4587,6 +4632,15 @@ export namespace dialogflow_v3beta1 { */ tlsConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolTLSConfig; } + /** + * Configuration for tools using Service Directory. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig { + /** + * Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent. + */ + service?: string | null; + } /** * The TLS configuration. */ @@ -4827,6 +4881,32 @@ export namespace dialogflow_v3beta1 { */ webhookStatuses?: string[] | null; } + /** + * Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1TypeSchema { + /** + * Set if this is an inline schema definition. + */ + inlineSchema?: Schema$GoogleCloudDialogflowCxV3beta1InlineSchema; + /** + * Set if this is a schema reference. + */ + schemaReference?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference; + } + /** + * A reference to the schema of an existing tool. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference { + /** + * The name of the schema. + */ + schema?: string | null; + /** + * The tool that contains this schema definition. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } /** * Metadata for UpdateDocument operation. */ @@ -5399,7 +5479,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -5466,7 +5546,7 @@ export namespace dialogflow_v3beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -5508,6 +5588,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -6411,7 +6495,7 @@ export namespace dialogflow_v3beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -6457,7 +6541,7 @@ export namespace dialogflow_v3beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -6474,11 +6558,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -7100,6 +7184,19 @@ export namespace dialogflow_v3beta1 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -7245,6 +7342,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -8285,6 +8400,10 @@ export namespace dialogflow_v3beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -8397,6 +8516,96 @@ export namespace dialogflow_v3beta1 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -8831,6 +9040,19 @@ export namespace dialogflow_v3beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * 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). */ @@ -9006,6 +9228,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -13984,7 +14224,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Environments$Deployflow extends StandardParameters { /** - * Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`. + * Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`. */ environment?: string; @@ -14175,7 +14415,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * Required. The environment to list results for. Format: `projects//locations//agents// environments/`. + * Required. The environment to list results for. Format: `projects//locations//agents//environments/`. */ parent?: string; } @@ -15125,7 +15365,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Environments$Experiments$Patch extends StandardParameters { /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string; /** @@ -19056,7 +19296,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Flows$Versions$Compareversions extends StandardParameters { /** - * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`. + * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`. */ baseVersion?: string; @@ -24068,7 +24308,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun extends StandardParameters { /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: `projects//locations//agents/`. */ parent?: string; @@ -24153,7 +24393,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch extends StandardParameters { /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string; /** @@ -24169,7 +24409,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Run extends StandardParameters { /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: `projects//locations//agents//testCases/`. */ name?: string; @@ -24401,7 +24641,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. + * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. */ parent?: string; }