OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

update dependencies

Browse Source
This commit is contained in:
Sebastian Thiel
2023-01-25 11:39:00 +01:00
parent 37ccd2238d
commit 3edefb7f01
357 changed files with 128026 additions and 16259 deletions
Download Patch File Download Diff File Expand all files Collapse all files

503
etc/api/dialogflow/v3beta1/dialogflow-api.json
View File

@@ -148,7 +148,7 @@
],
"parameters": {
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
@@ -3078,7 +3078,7 @@
]
},
"import": {
"description": "Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse",
"description": "Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.testCases.import",
@@ -3820,7 +3820,7 @@
}
}
},
"revision": "20220228",
"revision": "20230110",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowCxV3AudioInput": {
@@ -3904,6 +3904,17 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ConversationSignals": {
"description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.",
"id": "GoogleCloudDialogflowCxV3ConversationSignals",
"properties": {
"turnSignals": {
"$ref": "GoogleCloudDialogflowCxV3TurnSignals",
"description": "Required. Turn signals for the current turn."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ConversationTurn": {
"description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.",
"id": "GoogleCloudDialogflowCxV3ConversationTurn",
@@ -4105,6 +4116,10 @@
"$ref": "GoogleCloudDialogflowCxV3EnvironmentVersionConfig"
},
"type": "array"
},
"webhookConfig": {
"$ref": "GoogleCloudDialogflowCxV3EnvironmentWebhookConfig",
"description": "The webhook configuration for this environment."
}
},
"type": "object"
@@ -4142,6 +4157,20 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3EnvironmentWebhookConfig": {
"description": "Configuration for webhooks.",
"id": "GoogleCloudDialogflowCxV3EnvironmentWebhookConfig",
"properties": {
"webhookOverrides": {
"description": "The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3Webhook"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3EventHandler": {
"description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.",
"id": "GoogleCloudDialogflowCxV3EventHandler",
@@ -4332,7 +4361,7 @@
"type": "array"
},
"tag": {
"description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.",
"description": "The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.",
"type": "string"
},
"webhook": {
@@ -4689,7 +4718,7 @@
"id": "GoogleCloudDialogflowCxV3Page",
"properties": {
"displayName": {
"description": "Required. The human-readable name of the page, unique within the agent.",
"description": "Required. The human-readable name of the page, unique within the flow.",
"type": "string"
},
"entryFulfillment": {
@@ -4846,6 +4875,10 @@
"description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.",
"id": "GoogleCloudDialogflowCxV3ResponseMessage",
"properties": {
"channel": {
"description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.",
"type": "string"
},
"conversationSuccess": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess",
"description": "Indicates that the conversation succeeded."
@@ -5196,7 +5229,11 @@
"id": "GoogleCloudDialogflowCxV3TestConfig",
"properties": {
"flow": {
"description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.",
"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.",
"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.",
"type": "string"
},
"trackingParameters": {
@@ -5301,6 +5338,61 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3TurnSignals": {
"description": "Collection of all signals that were extracted for a single turn of the conversation.",
"id": "GoogleCloudDialogflowCxV3TurnSignals",
"properties": {
"agentEscalated": {
"description": "Whether agent responded with LiveAgentHandoff fulfillment.",
"type": "boolean"
},
"dtmfUsed": {
"description": "Whether user was using DTMF input.",
"type": "boolean"
},
"failureReasons": {
"description": "Failure reasons of the turn.",
"items": {
"enum": [
"FAILURE_REASON_UNSPECIFIED",
"FAILED_INTENT",
"FAILED_WEBHOOK"
],
"enumDescriptions": [
"Failure reason is not assigned.",
"Whether NLU failed to recognize user intent.",
"Whether webhook failed during the turn."
],
"type": "string"
},
"type": "array"
},
"noMatch": {
"description": "Whether NLU predicted NO_MATCH.",
"type": "boolean"
},
"noUserInput": {
"description": "Whether user provided no input.",
"type": "boolean"
},
"reachedEndPage": {
"description": "Whether turn resulted in End Session page.",
"type": "boolean"
},
"userEscalated": {
"description": "Whether user was specifically asking for a live agent.",
"type": "boolean"
},
"webhookStatuses": {
"description": "Human-readable statuses of the webhooks triggered during this turn.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": {
"description": "Metadata for UpdateDocument operation.",
"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata",
@@ -5312,8 +5404,74 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3Webhook": {
"description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.",
"id": "GoogleCloudDialogflowCxV3Webhook",
"properties": {
"disabled": {
"description": "Indicates whether the webhook is disabled.",
"type": "boolean"
},
"displayName": {
"description": "Required. The human-readable name of the webhook, unique within the agent.",
"type": "string"
},
"genericWebService": {
"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebService",
"description": "Configuration for a generic web service."
},
"name": {
"description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.",
"type": "string"
},
"serviceDirectory": {
"$ref": "GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig",
"description": "Configuration for a [Service Directory](https://cloud.google.com/service-directory) service."
},
"timeout": {
"description": "Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookGenericWebService": {
"description": "Represents configuration for a generic web service.",
"id": "GoogleCloudDialogflowCxV3WebhookGenericWebService",
"properties": {
"allowedCaCerts": {
"description": "Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
},
"password": {
"description": "The password for HTTP Basic authentication.",
"type": "string"
},
"requestHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "The HTTP request headers to send together with webhook requests.",
"type": "object"
},
"uri": {
"description": "Required. The webhook URI for receiving POST requests. It must use https protocol.",
"type": "string"
},
"username": {
"description": "The user name for HTTP Basic authentication.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookRequest": {
"description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.",
"description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
"id": "GoogleCloudDialogflowCxV3WebhookRequest",
"properties": {
"detectIntentResponseId": {
@@ -5383,7 +5541,7 @@
"id": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo",
"properties": {
"tag": {
"description": "Always present. The tag used to identify which fulfillment is being called.",
"description": "Always present. The value of the Fulfillment.tag field will be populated in this field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes.",
"type": "string"
}
},
@@ -5511,8 +5669,23 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig": {
"description": "Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service.",
"id": "GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig",
"properties": {
"genericWebService": {
"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebService",
"description": "Generic Service configuration of this webhook."
},
"service": {
"description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1AdvancedSettings": {
"description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.",
"description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.",
"id": "GoogleCloudDialogflowCxV3beta1AdvancedSettings",
"properties": {
"loggingSettings": {
@@ -5569,6 +5742,10 @@
"description": "Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.",
"type": "boolean"
},
"locked": {
"description": "Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.",
"type": "string"
@@ -5824,6 +6001,17 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ConversationSignals": {
"description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.",
"id": "GoogleCloudDialogflowCxV3beta1ConversationSignals",
"properties": {
"turnSignals": {
"$ref": "GoogleCloudDialogflowCxV3beta1TurnSignals",
"description": "Required. Turn signals for the current turn."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ConversationTurn": {
"description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.",
"id": "GoogleCloudDialogflowCxV3beta1ConversationTurn",
@@ -6254,6 +6442,10 @@
"$ref": "GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig"
},
"type": "array"
},
"webhookConfig": {
"$ref": "GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig",
"description": "The webhook configuration for this environment."
}
},
"type": "object"
@@ -6291,6 +6483,20 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig": {
"description": "Configuration for webhooks.",
"id": "GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig",
"properties": {
"webhookOverrides": {
"description": "The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1EventHandler": {
"description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.",
"id": "GoogleCloudDialogflowCxV3beta1EventHandler",
@@ -6565,7 +6771,19 @@
"id": "GoogleCloudDialogflowCxV3beta1ExportAgentRequest",
"properties": {
"agentUri": {
"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.",
"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
},
"dataFormat": {
"description": "Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.",
"enum": [
"DATA_FORMAT_UNSPECIFIED",
"BLOB"
],
"enumDescriptions": [
"Unspecified format.",
"Agent content will be exported as raw bytes."
],
"type": "string"
},
"environment": {
@@ -6596,7 +6814,7 @@
"id": "GoogleCloudDialogflowCxV3beta1ExportFlowRequest",
"properties": {
"flowUri": {
"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. The format of this URI must be `gs:///`. If left unspecified, the serialized flow is returned inline.",
"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. The format of this URI must be `gs:///`. If left unspecified, the serialized flow is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
},
"includeReferencedFlows": {
@@ -6651,7 +6869,7 @@
"type": "string"
},
"gcsUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the test cases to. The format of this URI must be `gs:///`. If unspecified, the serialized test cases is returned inline.",
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the test cases to. The format of this URI must be `gs:///`. If unspecified, the serialized test cases is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
}
},
@@ -6708,7 +6926,7 @@
"type": "array"
},
"transitionRoutes": {
"description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.",
"description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute"
},
@@ -6880,7 +7098,7 @@
"type": "array"
},
"tag": {
"description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.",
"description": "The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.",
"type": "string"
},
"webhook": {
@@ -7011,7 +7229,7 @@
"type": "string"
},
"flowUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import flow from. The format of this URI must be `gs:///`.",
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import flow from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
},
"importOption": {
@@ -7066,7 +7284,7 @@
"type": "string"
},
"gcsUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import test cases from. The format of this URI must be `gs:///`.",
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import test cases from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
}
},
@@ -7691,7 +7909,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"description": "The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.",
"type": "object"
},
"resolvedInput": {
@@ -7831,7 +8049,7 @@
"id": "GoogleCloudDialogflowCxV3beta1Page",
"properties": {
"displayName": {
"description": "Required. The human-readable name of the page, unique within the agent.",
"description": "Required. The human-readable name of the page, unique within the flow.",
"type": "string"
},
"entryFulfillment": {
@@ -7981,6 +8199,10 @@
"description": "Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.",
"type": "boolean"
},
"channel": {
"description": "The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.",
"type": "string"
},
"currentPage": {
"description": "The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.",
"type": "string"
@@ -8005,7 +8227,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"description": "Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.",
"type": "object"
},
"payload": {
@@ -8050,7 +8272,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice.",
"description": "The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called \"Alternative Matched Intents\", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.",
"type": "object"
},
"dtmf": {
@@ -8079,7 +8301,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"description": "The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.",
"type": "object"
},
"responseMessages": {
@@ -8160,6 +8382,10 @@
"description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessage",
"properties": {
"channel": {
"description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.",
"type": "string"
},
"conversationSuccess": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess",
"description": "Indicates that the conversation succeeded."
@@ -8352,7 +8578,7 @@
"type": "string"
},
"agentUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`.",
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).",
"type": "string"
},
"restoreOption": {
@@ -8499,6 +8725,10 @@
"description": "Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.",
"id": "GoogleCloudDialogflowCxV3beta1SecuritySettings",
"properties": {
"audioExportSettings": {
"$ref": "GoogleCloudDialogflowCxV3beta1SecuritySettingsAudioExportSettings",
"description": "Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent."
},
"deidentifyTemplate": {
"description": "[DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`.",
"type": "string"
@@ -8559,13 +8789,48 @@
"type": "string"
},
"retentionWindowDays": {
"description": "Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use Dialogflow's default TTL. Note: Interaction logging is a limited access feature. Talk to your Google representative to check availability for you.",
"description": "Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1SecuritySettingsAudioExportSettings": {
"description": "Settings for exporting audio.",
"id": "GoogleCloudDialogflowCxV3beta1SecuritySettingsAudioExportSettings",
"properties": {
"audioExportPattern": {
"description": "Filename pattern for exported audio.",
"type": "string"
},
"audioFormat": {
"description": "File format for exported audio file. Currently only in telephony recordings.",
"enum": [
"AUDIO_FORMAT_UNSPECIFIED",
"MULAW",
"MP3",
"OGG"
],
"enumDescriptions": [
"Unspecified. Do not use.",
"G.711 mu-law PCM with 8kHz sample rate.",
"MP3 file format.",
"OGG Vorbis."
],
"type": "string"
},
"enableAudioRedaction": {
"description": "Enable audio redaction if it is true.",
"type": "boolean"
},
"gcsBucket": {
"description": "Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1SecuritySettingsInsightsExportSettings": {
"description": "Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs).",
"id": "GoogleCloudDialogflowCxV3beta1SecuritySettingsInsightsExportSettings",
@@ -8808,7 +9073,11 @@
"id": "GoogleCloudDialogflowCxV3beta1TestConfig",
"properties": {
"flow": {
"description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.",
"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.",
"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.",
"type": "string"
},
"trackingParameters": {
@@ -8990,7 +9259,7 @@
"id": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup",
"properties": {
"displayName": {
"description": "Required. The human-readable name of the transition route group, unique within the Agent. The display name can be no longer than 30 characters.",
"description": "Required. The human-readable name of the transition route group, unique within the flow. The display name can be no longer than 30 characters.",
"type": "string"
},
"name": {
@@ -9064,6 +9333,61 @@
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1TurnSignals": {
"description": "Collection of all signals that were extracted for a single turn of the conversation.",
"id": "GoogleCloudDialogflowCxV3beta1TurnSignals",
"properties": {
"agentEscalated": {
"description": "Whether agent responded with LiveAgentHandoff fulfillment.",
"type": "boolean"
},
"dtmfUsed": {
"description": "Whether user was using DTMF input.",
"type": "boolean"
},
"failureReasons": {
"description": "Failure reasons of the turn.",
"items": {
"enum": [
"FAILURE_REASON_UNSPECIFIED",
"FAILED_INTENT",
"FAILED_WEBHOOK"
],
"enumDescriptions": [
"Failure reason is not assigned.",
"Whether NLU failed to recognize user intent.",
"Whether webhook failed during the turn."
],
"type": "string"
},
"type": "array"
},
"noMatch": {
"description": "Whether NLU predicted NO_MATCH.",
"type": "boolean"
},
"noUserInput": {
"description": "Whether user provided no input.",
"type": "boolean"
},
"reachedEndPage": {
"description": "Whether turn resulted in End Session page.",
"type": "boolean"
},
"userEscalated": {
"description": "Whether user was specifically asking for a live agent.",
"type": "boolean"
},
"webhookStatuses": {
"description": "Human-readable statuses of the webhooks triggered during this turn.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": {
"description": "Metadata for UpdateDocument operation.",
"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata",
@@ -9335,7 +9659,7 @@
"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebService",
"properties": {
"allowedCaCerts": {
"description": "Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")",
"description": "Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
"items": {
"format": "byte",
"type": "string"
@@ -9365,7 +9689,7 @@
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequest": {
"description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.",
"description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
"properties": {
"detectIntentResponseId": {
@@ -9435,7 +9759,7 @@
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo",
"properties": {
"tag": {
"description": "Always present. The tag used to identify which fulfillment is being called.",
"description": "Always present. The value of the Fulfillment.tag field will be populated in this field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes.",
"type": "string"
}
},
@@ -9723,9 +10047,9 @@
],
"enumDescriptions": [
"Unspecified feature type.",
"Run article suggestion model.",
"Run FAQ model.",
"Run smart reply model."
"Run article suggestion model for chat.",
"Run FAQ model for chat.",
"Run smart reply model for chat."
],
"type": "string"
}
@@ -9865,7 +10189,12 @@
"GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata": {
"description": "Metadata for ConversationDatasets.",
"id": "GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata",
"properties": {},
"properties": {
"conversationDataset": {
"description": "The resource name of the conversation dataset that will be created. Format: `projects//locations//conversationDatasets/`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata": {
@@ -10061,7 +10390,7 @@
"id": "GoogleCloudDialogflowV2EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. 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.",
"description": "Required. The language of this query. 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. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.",
"type": "string"
},
"name": {
@@ -11296,7 +11625,7 @@
"type": "boolean"
},
"cancelsSlotFilling": {
"description": "Indicates whether the conversational query triggers a cancellation for slot filling.",
"description": "Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the [cancel slot filling documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).",
"type": "boolean"
},
"diagnosticInfo": {
@@ -11375,7 +11704,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.",
"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": "GoogleCloudDialogflowV2Sentiment",
"properties": {
"magnitude": {
@@ -11473,9 +11802,9 @@
],
"enumDescriptions": [
"Unspecified feature type.",
"Run article suggestion model.",
"Run FAQ model.",
"Run smart reply model."
"Run article suggestion model for chat.",
"Run FAQ model for chat.",
"Run smart reply model for chat."
],
"type": "string"
}
@@ -11818,13 +12147,15 @@
"TYPE_UNSPECIFIED",
"ARTICLE_SUGGESTION",
"FAQ",
"SMART_REPLY"
"SMART_REPLY",
"CONVERSATION_SUMMARIZATION"
],
"enumDescriptions": [
"Unspecified feature type.",
"Run article suggestion model.",
"Run article suggestion model for chat.",
"Run FAQ model.",
"Run smart reply model."
"Run smart reply model for chat.",
"Run conversation summarization model for chat."
],
"type": "string"
}
@@ -11877,6 +12208,7 @@
"TYPE_UNSPECIFIED",
"CONVERSATION_STARTED",
"CONVERSATION_FINISHED",
"HUMAN_INTERVENTION_NEEDED",
"NEW_MESSAGE",
"UNRECOVERABLE_ERROR"
],
@@ -11884,6 +12216,7 @@
"Type not set.",
"A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API.",
"An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.",
"An existing conversation has received notification from Dialogflow that human intervention is required.",
"An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config",
"Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error."
],
@@ -11969,7 +12302,7 @@
"id": "GoogleCloudDialogflowV2beta1EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. 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.",
"description": "Required. The language of this query. 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. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.",
"type": "string"
},
"name": {
@@ -13272,7 +13605,7 @@
"enumDescriptions": [
"Not specified. This value should never be used.",
"Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work."
"Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Note: Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases in template mode, they will be removed during training and it can cause a drop in agent performance."
],
"type": "string"
}
@@ -13504,7 +13837,7 @@
"type": "boolean"
},
"cancelsSlotFilling": {
"description": "Indicates whether the conversational query triggers a cancellation for slot filling.",
"description": "Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the [cancel slot filling documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).",
"type": "boolean"
},
"diagnosticInfo": {
@@ -13587,7 +13920,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.",
"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",
"properties": {
"magnitude": {
@@ -13681,13 +14014,15 @@
"TYPE_UNSPECIFIED",
"ARTICLE_SUGGESTION",
"FAQ",
"SMART_REPLY"
"SMART_REPLY",
"CONVERSATION_SUMMARIZATION"
],
"enumDescriptions": [
"Unspecified feature type.",
"Run article suggestion model.",
"Run article suggestion model for chat.",
"Run FAQ model.",
"Run smart reply model."
"Run smart reply model for chat.",
"Run conversation summarization model for chat."
],
"type": "string"
}
@@ -13892,6 +14227,17 @@
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1ConversationSignals": {
"description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.",
"id": "GoogleCloudDialogflowV3alpha1ConversationSignals",
"properties": {
"turnSignals": {
"$ref": "GoogleCloudDialogflowV3alpha1TurnSignals",
"description": "Required. Turn signals for the current turn."
}
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": {
"description": "Metadata for CreateDocument operation.",
"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata",
@@ -13974,6 +14320,65 @@
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1TurnSignals": {
"description": "Collection of all signals that were extracted for a single turn of the conversation.",
"id": "GoogleCloudDialogflowV3alpha1TurnSignals",
"properties": {
"agentEscalated": {
"description": "Whether agent responded with LiveAgentHandoff fulfillment.",
"type": "boolean"
},
"dtmfUsed": {
"description": "Whether user was using DTMF input.",
"type": "boolean"
},
"failureReasons": {
"description": "Failure reasons of the turn.",
"items": {
"enum": [
"FAILURE_REASON_UNSPECIFIED",
"FAILED_INTENT",
"FAILED_WEBHOOK"
],
"enumDescriptions": [
"Failure reason is not assigned.",
"Whether NLU failed to recognize user intent.",
"Whether webhook failed during the turn."
],
"type": "string"
},
"type": "array"
},
"noMatch": {
"description": "Whether NLU predicted NO_MATCH.",
"type": "boolean"
},
"noUserInput": {
"description": "Whether user provided no input.",
"type": "boolean"
},
"reachedEndPage": {
"description": "Whether turn resulted in End Session page.",
"type": "boolean"
},
"triggeredAbandonmentEvent": {
"description": "Whether agent has triggered the event corresponding to user abandoning the conversation.",
"type": "boolean"
},
"userEscalated": {
"description": "Whether user was specifically asking for a live agent.",
"type": "boolean"
},
"webhookStatuses": {
"description": "Human-readable statuses of the webhooks triggered during this turn.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": {
"description": "Metadata for UpdateDocument operation.",
"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata",
@@ -14091,7 +14496,7 @@
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"