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 API descriptions

Browse Source
This commit is contained in:
Sebastian Thiel
2020-07-10 09:11:32 +08:00
parent b6ee34dcff
commit 69fb05c4e1
271 changed files with 82506 additions and 23249 deletions
Download Patch File Download Diff File Expand all files Collapse all files

630
etc/api/dialogflow/v2/dialogflow-api.json
View File

@@ -288,7 +288,7 @@
]
},
"import": {
"description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest.\n\nOperation <response: google.protobuf.Empty>",
"description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest. After the import, the imported draft\nagent will be trained automatically (unless disabled in agent settings).\nHowever, once the import is done, training may not be completed yet. Please\ncall TrainAgent and wait for the operation it returns in order to train\nexplicitly.\n\nOperation <response: google.protobuf.Empty>\nAn operation which tracks when importing is complete. It only tracks\nwhen the draft agent is updated not when it is done training.",
"flatPath": "v2/projects/{projectsId}/agent:import",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.import",
@@ -317,7 +317,7 @@
]
},
"restore": {
"description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted.\n\nOperation <response: google.protobuf.Empty>",
"description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted. After the restore, the\nrestored draft agent will be trained automatically (unless disabled in\nagent settings). However, once the restore is done, training may not be\ncompleted yet. Please call TrainAgent and wait for the operation it\nreturns in order to train explicitly.\n\nOperation <response: google.protobuf.Empty>\nAn operation which tracks when restoring is complete. It only tracks\nwhen the draft agent is updated not when it is done training.",
"flatPath": "v2/projects/{projectsId}/agent:restore",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.restore",
@@ -777,6 +777,45 @@
}
},
"environments": {
"methods": {
"list": {
"description": "Returns the list of all non-draft environments of the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/environments",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and\nat most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all environments from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/environments",
"response": {
"$ref": "GoogleCloudDialogflowV2ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"users": {
"resources": {
@@ -2010,11 +2049,442 @@
}
}
},
"revision": "20200408",
"revision": "20200706",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowCxV3beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse",
"properties": {
"agentContent": {
"description": "Uncompressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in ExportAgentRequest.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfo": {
"description": "Represents page information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfo",
"properties": {
"currentPage": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse.\nThe unique identifier of the current page.\nFormat: `projects/<Project ID>/locations/<Location ID>/agents/<Agent\nID>/flows/<Flow ID>/pages/<Page ID>`.",
"type": "string"
},
"formInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo",
"description": "Optional for both WebhookRequest and WebhookResponse.\nInformation about the form."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": {
"description": "Represents form information.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo",
"properties": {
"parameterInfo": {
"description": "Optional for both WebhookRequest and WebhookResponse.\nThe parameters contained in the form. Note that the webhook cannot add\nor remove any form parameter.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": {
"description": "Represents parameter information.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo",
"properties": {
"displayName": {
"description": "Always present for WebhookRequest. Required for\nWebhookResponse.\nThe human-readable name of the parameter, unique within the form. This\nfield cannot be modified by the webhook.",
"type": "string"
},
"justCollected": {
"description": "Optional for WebhookRequest. Ignored for WebhookResponse.\nIndicates if the parameter value was just collected on the last\nconversation turn.",
"type": "boolean"
},
"required": {
"description": "Optional for both WebhookRequest and WebhookResponse.\nIndicates whether the parameter is required. Optional parameters will\nnot trigger prompts; however, they are filled if the user specifies\nthem. Required parameters must be filled before form filling concludes.",
"type": "boolean"
},
"state": {
"description": "Always present for WebhookRequest. Required for\nWebhookResponse. The state of the parameter. This field can be set\nto INVALID by\nthe webhook to invalidate the parameter; other values set by the\nwebhook will be ignored.",
"enum": [
"PARAMETER_STATE_UNSPECIFIED",
"EMPTY",
"INVALID",
"FILLED"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Indicates that the parameter does not have a value.",
"Indicates that the parameter value is invalid. This field can be used\nby the webhook to invalidate the parameter and ask the server to\ncollect it from the user again.",
"Indicates that the parameter has a value."
],
"type": "string"
},
"value": {
"description": "Optional for both WebhookRequest and WebhookResponse.\nThe value of the parameter. This field can be set by the webhook to\nchange the parameter value.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessage": {
"description": "Represents a response message that can be returned by a conversational agent.\n\nResponse messages are also used for output audio synthesis. The approach is\nas follows:\n\n* If at least one OutputAudioText response is present, then all\n OutputAudioText responses are linearly concatenated, and the result is used\n for output audio synthesis.\n* If the OutputAudioText responses are a mixture of text and SSML, then the\n concatenated result is treated as SSML; otherwise, the result is treated as\n either text or SSML as appropriate. The agent designer should ideally use\n either text or SSML consistently throughout the bot design.\n* Otherwise, all Text responses are linearly concatenated, and the result is\n used for output audio synthesis.\n\nThis approach allows for more sophisticated user experience scenarios, where\nthe text displayed to the user may differ from what is heard.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessage",
"properties": {
"conversationSuccess": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess",
"description": "Indicates that the conversation succeeded."
},
"endInteraction": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction",
"description": "Output only. A signal that indicates the interaction with the Dialogflow agent has\nended.\nThis message is generated by Dialogflow only when the conversation\nreaches `END_SESSION` or `END_PAGE` page. It is not supposed to be\ndefined by the user.\nIt's guaranteed that there is at most one such message in each response."
},
"humanAgentHandoff": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff",
"description": "Hands off conversation to a human agent."
},
"liveAgentHandoff": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff",
"description": "Hands off conversation to a human agent."
},
"mixedAudio": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio",
"description": "Output only. An audio response message composed of both the synthesized Dialogflow\nagent responses and responses defined via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user."
},
"outputAudioText": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText",
"description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.",
"type": "object"
},
"playAudio": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio",
"description": "Signal that the client should play an audio clip hosted at a\nclient-specific URI. Dialogflow uses this to construct\nmixed_audio. However, Dialogflow itself\ndoes not try to read or process the URI in any way."
},
"text": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText",
"description": "Returns a text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": {
"description": "Indicates that the conversation succeeded, i.e., the bot handled the issue\nthat the customer talked to it about.\n\nDialogflow only uses this to determine which conversations should be\ncounted as successful and doesn't process the metadata in this message in\nany way. Note that Dialogflow also considers conversations that get to the\nconversation end page as successful even if they don't return\nConversationSuccess.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer\n issue.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": {
"description": "Indicates that interaction with the Dialogflow agent has ended.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff": {
"description": "Indicates that the conversation should be handed off to a human agent.\n\nDialogflow only uses this to determine which conversations were handed off\nto a human agent for measurement purposes. What else to do with this signal\nis up to you and your handoff procedures.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates something went extremely wrong in the\n conversation.\n* In a webhook response when you determine that the customer issue can only\n be handled by a human.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose\nany structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": {
"description": "Indicates that the conversation should be handed off to a live agent.\n\nDialogflow only uses this to determine which conversations were handed off\nto a human agent for measurement purposes. What else to do with this signal\nis up to you and your handoff procedures.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates something went extremely wrong in the\n conversation.\n* In a webhook response when you determine that the customer issue can only\n be handled by a human.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose\nany structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": {
"description": "Represents an audio message that is composed of both segments\nsynthesized from the Dialogflow agent prompts and ones hosted externally\nat the specified URIs.\nThe external URIs are specified via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio",
"properties": {
"segments": {
"description": "Segments this audio response is composed of.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": {
"description": "Represents one segment of audio.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment",
"properties": {
"allowPlaybackInterruption": {
"description": "Whether the playback of this segment can be interrupted by the end\nuser's speech and the client should then start the next Dialogflow\nrequest.",
"type": "boolean"
},
"audio": {
"description": "Raw audio synthesized from the Dialogflow agent's response using\nthe output config specified in the request.",
"format": "byte",
"type": "string"
},
"uri": {
"description": "Client-specific URI that points to an audio clip accessible to the\nclient. Dialogflow does not impose any validation on it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": {
"description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText",
"properties": {
"ssml": {
"description": "The SSML text to be synthesized. For more information, see\n[SSML](/speech/text-to-speech/docs/ssml).",
"type": "string"
},
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": {
"description": "Specifies an audio clip to be played by the client as part of the response.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio",
"properties": {
"allowPlaybackInterruption": {
"description": "Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.",
"type": "boolean"
},
"audioUri": {
"description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this\nvalue. It is specific to the client that reads it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageText",
"properties": {
"allowPlaybackInterruption": {
"description": "Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.",
"type": "boolean"
},
"text": {
"description": "Required. A collection of text responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1SessionInfo": {
"description": "Represents session information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"properties": {
"parameters": {
"additionalProperties": {
"type": "any"
},
"description": "Optional for WebhookRequest. Optional for WebhookResponse.\nAll parameters collected from forms and intents during the session.\nParameters can be created, updated, or removed by the webhook. To remove a\nparameter from the session, the webhook should explicitly set the parameter\nvalue to null in WebhookResponse. The map is keyed by parameters'\ndisplay names.",
"type": "object"
},
"session": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse.\nThe unique identifier of the session. This\nfield can be used by the webhook to identify a user.\nFormat: `projects/<Project ID>/locations/<Location ID>/agents/<Agent\nID>/sessions/<Session ID>`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
"properties": {
"detectIntentResponseId": {
"description": "Always present. The unique identifier of the DetectIntentResponse that\nwill be returned to the API caller.",
"type": "string"
},
"fulfillmentInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo",
"description": "Always present. Information about the fulfillment that triggered this\nwebhook call."
},
"intentInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo",
"description": "Information about the last matched intent."
},
"messages": {
"description": "The list of rich message responses to present to the user. Webhook can\nchoose to append or replace this list in\nWebhookResponse.fulfillment_response;",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage"
},
"type": "array"
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfo",
"description": "Information about page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom data set in QueryParameters.payload.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"description": "Information about session status."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": {
"description": "Represents fulfillment information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo",
"properties": {
"tag": {
"description": "Always present. The tag used to identify which fulfillment is being\ncalled.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": {
"description": "Represents intent information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo",
"properties": {
"lastMatchedIntent": {
"description": "Always present. The unique identifier of the last matched\nintent. Format: `projects/<Project ID>/locations/<Location\nID>/agents/<Agent ID>/intents/<Intent ID>`.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue"
},
"description": "Parameters identified as a result of intent matching. This is a map of\nthe name of the identified parameter to the value of the parameter\nidentified from the user's utterance. All parameters defined in the\nmatched intent that are identified will be surfaced here.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": {
"description": "Represents a value for an intent parameter.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue",
"properties": {
"originalValue": {
"description": "Always present. Original text value extracted from user utterance.",
"type": "string"
},
"resolvedValue": {
"description": "Always present. Structured value for the parameter extracted from user\nutterance.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookResponse": {
"description": "The response message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookResponse",
"properties": {
"fulfillmentResponse": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse",
"description": "The fulfillment response to send to the user. This field can be omitted by\nthe webhook if it does not intend to send any response to the user."
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfo",
"description": "Information about page status. This field can be omitted by the webhook if\nit does not intend to modify page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Value to append directly to QueryResult.webhook_payloads.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"description": "Information about session status. This field can be omitted by the webhook\nif it does not intend to modify session status."
},
"targetFlow": {
"description": "The target flow to transition to.\nFormat: `projects/<Project ID>/locations/<Location ID>/agents/<Agent\nID>/flows/<Flow ID>`.",
"type": "string"
},
"targetPage": {
"description": "The target page to transition to.\nFormat: `projects/<Project ID>/locations/<Location ID>/agents/<Agent\nID>/flows/<Flow ID>/pages/<Page ID>`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": {
"description": "Represents a fulfillment response to the user.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse",
"properties": {
"mergeBehavior": {
"description": "Merge behavior for `messages`.",
"enum": [
"MERGE_BEHAVIOR_UNSPECIFIED",
"APPEND",
"REPLACE"
],
"enumDescriptions": [
"Not specified. `APPEND` will be used.",
"`messages` will be appended to the list of messages waiting to be sent\nto the user.",
"`messages` will replace the list of messages waiting to be sent to the\nuser."
],
"type": "string"
},
"messages": {
"description": "The list of rich message responses to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Agent": {
"description": "Represents a conversational agent.",
"description": "A Dialogflow agent is a virtual agent that handles conversations with your\nend-users. It is a natural language understanding module that understands the\nnuances of human language. Dialogflow translates end-user text or audio\nduring a conversation to structured data that your apps and services can\nunderstand. You design and build a Dialogflow agent to handle the types of\nconversations required for your system.\n\nFor more information about agents, see the\n[Agents\ndocumentation](https://cloud.google.com/dialogflow/docs/agents-overview).",
"id": "GoogleCloudDialogflowV2Agent",
"properties": {
"apiVersion": {
@@ -2317,7 +2787,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
@@ -2396,7 +2866,7 @@
"id": "GoogleCloudDialogflowV2DetectIntentResponse",
"properties": {
"outputAudio": {
"description": "The audio data bytes encoded as specified in the request.\nNote: The output audio is generated based on the values of default platform\ntext responses found in the `query_result.fulfillment_messages` field. If\nmultiple default text responses exist, they will be concatenated when\ngenerating audio. If no default platform text responses exist, the\ngenerated audio content will be empty.",
"description": "The audio data bytes encoded as specified in the request.\nNote: The output audio is generated based on the values of default platform\ntext responses found in the `query_result.fulfillment_messages` field. If\nmultiple default text responses exist, they will be concatenated when\ngenerating audio. If no default platform text responses exist, the\ngenerated audio content will be empty.\n\nIn some scenarios, multiple output audio fields may be present in the\nresponse structure. In these cases, only the top-most-level audio output\nhas content.",
"format": "byte",
"type": "string"
},
@@ -2505,6 +2975,46 @@
},
"type": "object"
},
"GoogleCloudDialogflowV2Environment": {
"description": "Represents an agent environment.",
"id": "GoogleCloudDialogflowV2Environment",
"properties": {
"agentVersion": {
"description": "Optional. The agent version loaded into this environment.\nFormat: `projects/<Project ID>/agent/versions/<Version ID>`.",
"type": "string"
},
"description": {
"description": "Optional. The developer-provided description for this environment.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"name": {
"description": "Output only. The unique identifier of this agent environment.\nFormat: `projects/<Project ID>/agent/environments/<Environment ID>`.\nFor Environment ID, \"-\" is reserved for 'draft' environment.",
"type": "string"
},
"state": {
"description": "Output only. The state of this environment. This field is read-only, i.e., it cannot be\nset by create and update methods.",
"enum": [
"STATE_UNSPECIFIED",
"STOPPED",
"LOADING",
"RUNNING"
],
"enumDescriptions": [
"Not specified. This value is not used.",
"Stopped.",
"Loading.",
"Running."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The last update time of this environment. This field is read-only, i.e., it\ncannot be set by create and update methods.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `<event: { name: \"welcome_event\",\nparameters: { name: \"Sam\" } }>` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`\"Hello #welcome_event.name! What can I do for you today?\"`.",
"id": "GoogleCloudDialogflowV2EventInput",
@@ -2522,7 +3032,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of parameters associated with the event.",
"description": "The collection of parameters associated with the event.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
@@ -2624,7 +3134,7 @@
"type": "object"
},
"uri": {
"description": "Required. The fulfillment URI for receiving POST requests.",
"description": "Required. The fulfillment URI for receiving POST requests.\nIt must use https protocol.",
"type": "string"
},
"username": {
@@ -3580,7 +4090,7 @@
"type": "array"
},
"value": {
"description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"type": "string"
}
},
@@ -3682,6 +4192,24 @@
},
"type": "object"
},
"GoogleCloudDialogflowV2ListEnvironmentsResponse": {
"description": "The response message for Environments.ListEnvironments.",
"id": "GoogleCloudDialogflowV2ListEnvironmentsResponse",
"properties": {
"environments": {
"description": "The list of agent environments. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Environment"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListIntentsResponse": {
"description": "The response message for Intents.ListIntents.",
"id": "GoogleCloudDialogflowV2ListIntentsResponse",
@@ -3959,7 +4487,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"description": "The collection of extracted parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
},
"queryText": {
@@ -4053,7 +4581,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2SentimentAnalysisResult": {
"description": "The result of sentiment analysis as configured by\n`sentiment_analysis_request_config`.",
"description": "The result of sentiment analysis. Sentiment analysis inspects user input\nand identifies the prevailing subjective opinion, especially to determine a\nuser's attitude as positive, negative, or neutral.\nFor Participants.AnalyzeContent, it needs to be configured in\nDetectIntentRequest.query_params. For\nParticipants.StreamingAnalyzeContent, it needs to be configured in\nStreamingDetectIntentRequest.query_params.\nAnd for Participants.AnalyzeContent and\nParticipants.StreamingAnalyzeContent, it needs to be configured in\nConversationProfile.human_agent_assistant_config",
"id": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
@@ -4100,7 +4628,7 @@
"id": "GoogleCloudDialogflowV2SpeechContext",
"properties": {
"boost": {
"description": "Optional. Boost for this context compared to other contexts:\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.",
"description": "Optional. Boost for this context compared to other contexts:\n\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.",
"format": "float",
"type": "number"
},
@@ -4274,21 +4802,21 @@
"properties": {
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
"description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
@@ -4299,18 +4827,18 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
},
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.",
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.",
"type": "string"
}
},
@@ -4400,7 +4928,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
@@ -4495,7 +5023,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of parameters associated with the event.",
"description": "The collection of parameters associated with the event.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
@@ -4574,7 +5102,7 @@
"type": "array"
},
"followupIntentInfo": {
"description": "Read-only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.",
"description": "Output only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo"
},
@@ -4607,7 +5135,7 @@
"type": "boolean"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"outputContexts": {
@@ -4625,11 +5153,11 @@
"type": "array"
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"description": "Optional. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"priority": {
"description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.",
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.",
"format": "int32",
"type": "integer"
},
@@ -4638,7 +5166,7 @@
"type": "boolean"
},
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"description": "Output only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"trainingPhrases": {
@@ -5227,7 +5755,7 @@
"type": "string"
},
"height": {
"description": "Required for cards with vertical orientation. The height of the media\nwithin a rich card with a vertical layout. (https://goo.gl/NeFCjz).\nFor a standalone card with horizontal layout, height is not\ncustomizable, and this field is ignored.",
"description": "Required for cards with vertical orientation. The height of the media\nwithin a rich card with a vertical layout.\nFor a standalone card with horizontal layout, height is not\ncustomizable, and this field is ignored.",
"enum": [
"HEIGHT_UNSPECIFIED",
"SHORT",
@@ -5250,7 +5778,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": {
"description": "Carousel Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nFor more details about RBM rich cards, please see:\nhttps://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.\nIf you want to show a single card with more control over the layout,\nplease use RbmStandaloneCard instead.",
"description": "Carousel Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nIf you want to show a single card with more control over the layout,\nplease use RbmStandaloneCard instead.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard",
"properties": {
"cardContents": {
@@ -5278,7 +5806,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": {
"description": "Standalone Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nFor more details about RBM rich cards, please see:\nhttps://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.\nYou can group multiple rich cards into one using RbmCarouselCard but\ncarousel cards will give you less control over the card layout.",
"description": "Standalone Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nYou can group multiple rich cards into one using RbmCarouselCard but\ncarousel cards will give you less control over the card layout.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard",
"properties": {
"cardContent": {
@@ -5344,7 +5872,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": {
"description": "Opens the user's default dialer app with the specified phone number\nbut does not dial automatically (https://goo.gl/ergbB2).",
"description": "Opens the user's default dialer app with the specified phone number\nbut does not dial automatically.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial",
"properties": {
"phoneNumber": {
@@ -5355,7 +5883,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": {
"description": "Opens the user's default web browser app to the specified uri\n(https://goo.gl/6GLJD2). If the user has an app installed that is\nregistered as the default handler for the URL, then this app will be\nopened instead, and its icon will be used in the suggested action UI.",
"description": "Opens the user's default web browser app to the specified uri\nIf the user has an app installed that is\nregistered as the default handler for the URL, then this app will be\nopened instead, and its icon will be used in the suggested action UI.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri",
"properties": {
"uri": {
@@ -5366,7 +5894,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": {
"description": "Opens the device's location chooser so the user can pick a location\nto send back to the agent (https://goo.gl/GXotJW).",
"description": "Opens the device's location chooser so the user can pick a location\nto send back to the agent.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation",
"properties": {},
"type": "object"
@@ -5651,7 +6179,7 @@
"type": "array"
},
"value": {
"description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"type": "string"
}
},
@@ -5776,7 +6304,7 @@
"id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata",
"properties": {
"state": {
"description": "Required. The current state of this operation.",
"description": "Required. Output only. The current state of this operation.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
@@ -5888,7 +6416,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"description": "The collection of extracted parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
},
"queryText": {
@@ -5937,7 +6465,7 @@
"type": "object"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisResult": {
"description": "The result of sentiment analysis as configured by\n`sentiment_analysis_request_config`.",
"description": "The result of sentiment analysis. Sentiment analysis inspects user input\nand identifies the prevailing subjective opinion, especially to determine a\nuser's attitude as positive, negative, or neutral.\nFor Participants.AnalyzeContent, it needs to be configured in\nDetectIntentRequest.query_params. For\nParticipants.StreamingAnalyzeContent, it needs to be configured in\nStreamingDetectIntentRequest.query_params.\nAnd for Participants.AnalyzeContent and\nParticipants.StreamingAnalyzeContent, it needs to be configured in\nConversationProfile.human_agent_assistant_config",
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
@@ -6019,21 +6547,21 @@
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
"description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
@@ -6044,18 +6572,34 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
},
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.",
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV3alpha1ExportAgentResponse",
"properties": {
"agentContent": {
"description": "Uncompressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in ExportAgentRequest.",
"type": "string"
}
},