luzifer/nginx-sso
1
0
Fork 0
mirror of https://github.com/Luzifer/nginx-sso.git synced 2024-12-22 13:51:18 +00:00
Code Issues Releases Wiki Activity
nginx-sso/vendor/google.golang.org/api/dialogflow/v2/dialogflow-api.json

4252 lines
214 KiB
JSON
Raw Normal View History

Update dependencies Signed-off-by: Knut Ahlers <knut@ahlers.me>
2019-04-21 17:58:15 +00:00
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/dialogflow": {
"description": "View, manage and query your Dialogflow agents"
}
}
}
},
"basePath": "",
"baseUrl": "https://dialogflow.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Dialogflow",
"description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "dialogflow:v2",
"kind": "discovery#restDescription",
"name": "dialogflow",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"getAgent": {
"description": "Retrieves the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent",
"httpMethod": "GET",
"id": "dialogflow.projects.getAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent",
"response": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"agent": {
"methods": {
"export": {
"description": "Exports the specified agent to a ZIP file.\n\nOperation \u003cresponse: ExportAgentResponse\u003e",
"flatPath": "v2/projects/{projectsId}/agent:export",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.export",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:export",
"request": {
"$ref": "GoogleCloudDialogflowV2ExportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"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 \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent:import",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:import",
"request": {
"$ref": "GoogleCloudDialogflowV2ImportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"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 \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent:restore",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.restore",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:restore",
"request": {
"$ref": "GoogleCloudDialogflowV2RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"search": {
"description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).",
"flatPath": "v2/projects/{projectsId}/agent:search",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.search",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at 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 project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:search",
"response": {
"$ref": "GoogleCloudDialogflowV2SearchAgentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"train": {
"description": "Trains the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent:train",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.train",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to train is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:train",
"request": {
"$ref": "GoogleCloudDialogflowV2TrainAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"batchDelete": {
"description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse\u003e",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create entity types in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an entity type in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language to retrieve entity synonyms for. If not specified,\nthe agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the entity type.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all entity types in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "Optional. The language to list entity synonyms for. If not specified,\nthe agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at 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 entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entities": {
"methods": {
"batchCreate": {
"description": "Creates multiple new entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to create entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchCreate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchCreateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to delete entries for. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates or creates multiple entities in the specified entity type. This\nmethod does not affect entities in the entity type that aren't explicitly\nspecified in the request.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to update or create entities in.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"intents": {
"methods": {
"batchDelete": {
"description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v2/projects/{projectsId}/agent/intents:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
"flatPath": "v2/projects/{projectsId}/agent/intents:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an intent in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/intents",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to create a intent for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents",
"request": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified intent and its direct or indirect followup intents.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.intents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the intent to delete. If this intent has direct or\nindirect followup intents, we also delete them.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified intent.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.intents.get",
"parameterOrder": [
"name"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all intents in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/intents",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.intents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language to list training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at 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 intents from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents",
"response": {
"$ref": "GoogleCloudDialogflowV2ListIntentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified intent.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.intents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"sessions": {
"methods": {
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.deleteContexts",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data\nas a result. This method is not idempotent, because it may cause contexts\nand session entity types to be updated, which in turn might affect\nresults of future queries.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`. It's up to the API\ncaller to choose an appropriate session ID. It can be a random number or\nsome type of user identifier (preferably hashed). The length of the session\nID must not exceed 36 bytes.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"contexts": {
"methods": {
"create": {
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.contexts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at 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 session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\n\nThe `Context ID` is always converted to lowercase, may only contain\ncharacters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"create": {
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the session\nentity type.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all session entity types in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at 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 session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.\n\n`\u003cEntity Type Display Name\u003e` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"flatPath": "v2/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
},
"revision": "20190402",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowV2Agent": {
"description": "Represents a conversational agent.",
"id": "GoogleCloudDialogflowV2Agent",
"properties": {
"avatarUri": {
"description": "Optional. The URI of the agent's avatar.\nAvatars are used throughout the Dialogflow console and in the self-hosted\n[Web\nDemo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo)\nintegration.",
"type": "string"
},
"classificationThreshold": {
"description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent will be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.",
"format": "float",
"type": "number"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See\n[Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes. This field cannot be\nset by the `Update` method.",
"type": "string"
},
"description": {
"description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"displayName": {
"description": "Required. The name of this agent.",
"type": "string"
},
"enableLogging": {
"description": "Optional. Determines whether this agent should log conversation queries.",
"type": "boolean"
},
"matchMode": {
"description": "Optional. Determines how intents are detected from user queries.",
"enum": [
"MATCH_MODE_UNSPECIFIED",
"MATCH_MODE_HYBRID",
"MATCH_MODE_ML_ONLY"
],
"enumDescriptions": [
"Not specified.",
"Best for agents with a small number of examples in intents and/or wide\nuse of templates syntax and composite entities.",
"Can be used for agents with a large number of examples in intents,\nespecially the ones using @sys.any or very large developer entities."
],
"type": "string"
},
"parent": {
"description": "Required. The project of this agent.\nFormat: `projects/\u003cProject ID\u003e`.",
"type": "string"
},
"supportedLanguageCodes": {
"description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
"items": {
"type": "string"
},
"type": "array"
},
"timeZone": {
"description": "Required. The time zone of this agent from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchCreateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchCreateEntities.",
"id": "GoogleCloudDialogflowV2BatchCreateEntitiesRequest",
"properties": {
"entities": {
"description": "Required. The entities to create.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteEntitiesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntities.",
"id": "GoogleCloudDialogflowV2BatchDeleteEntitiesRequest",
"properties": {
"entityValues": {
"description": "Required. The canonical `values` of the entities to delete. Note that\nthese are not fully-qualified names, i.e. they don't start with\n`projects/\u003cProject ID\u003e`.",
"items": {
"type": "string"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest",
"properties": {
"entityTypeNames": {
"description": "Required. The names entity types to delete. All names must point to the\nsame agent as `parent`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteIntentsRequest": {
"description": "The request message for Intents.BatchDeleteIntents.",
"id": "GoogleCloudDialogflowV2BatchDeleteIntentsRequest",
"properties": {
"intents": {
"description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntities.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntitiesRequest",
"properties": {
"entities": {
"description": "Required. The entities to update or create.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest",
"properties": {
"entityTypeBatchInline": {
"$ref": "GoogleCloudDialogflowV2EntityTypeBatch",
"description": "The collection of entity types to update or create."
},
"entityTypeBatchUri": {
"description": "The URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".",
"type": "string"
},
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entity_types`. If not\nspecified, the agent's default language is used.\n[Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateIntentsRequest": {
"description": "The request message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2BatchUpdateIntentsRequest",
"properties": {
"intentBatchInline": {
"$ref": "GoogleCloudDialogflowV2IntentBatch",
"description": "The collection of intents to update or create."
},
"intentBatchUri": {
"description": "The URI to a Google Cloud Storage file containing intents to update or\ncreate. The file format can either be a serialized proto (of IntentBatch\ntype) or JSON object. Note: The URI must start with \"gs://\".",
"type": "string"
},
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"type": "string"
},
"languageCode": {
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intents`. If not specified, the agent's default language is\nused. [Many\nlanguages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Context": {
"description": "Represents a context.",
"id": "GoogleCloudDialogflowV2Context",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 20 minutes if there\nare no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\n\nThe `Context ID` is always converted to lowercase, may only contain\ncharacters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\nRefer to [this\ndoc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)\nfor syntax.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2DetectIntentRequest": {
"description": "The request to detect user's intent.",
"id": "GoogleCloudDialogflowV2DetectIntentRequest",
"properties": {
"inputAudio": {
"description": "Optional. The natural language speech audio to be processed. This field\nshould be populated iff `query_input` is set to an input audio config.\nA single request can contain up to 1 minute of speech audio data.",
"format": "byte",
"type": "string"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2OutputAudioConfig",
"description": "Optional. Instructs the speech synthesizer how to generate the output\naudio. If this field is not set and agent-level speech synthesizer is not\nconfigured, no output audio is generated."
},
"queryInput": {
"$ref": "GoogleCloudDialogflowV2QueryInput",
"description": "Required. The input specification. It can be set to:\n\n1. an audio config\n which instructs the speech recognizer how to process the speech audio,\n\n2. a conversational query in the form of text, or\n\n3. an event that specifies which intent to trigger."
},
"queryParams": {
"$ref": "GoogleCloudDialogflowV2QueryParameters",
"description": "Optional. The parameters of this query."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2DetectIntentResponse": {
"description": "The message returned from the DetectIntent method.",
"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.",
"format": "byte",
"type": "string"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2OutputAudioConfig",
"description": "The config used by the speech synthesizer to generate the output audio."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2QueryResult",
"description": "The selected results of the conversational query or event processing.\nSee `alternative_query_results` for additional potential results."
},
"responseId": {
"description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.",
"type": "string"
},
"webhookStatus": {
"$ref": "GoogleRpcStatus",
"description": "Specifies the status of the webhook request."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"id": "GoogleCloudDialogflowV2EntityType",
"properties": {
"autoExpansionMode": {
"description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
"enum": [
"AUTO_EXPANSION_MODE_UNSPECIFIED",
"AUTO_EXPANSION_MODE_DEFAULT"
],
"enumDescriptions": [
"Auto expansion disabled for the entity.",
"Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
],
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
"List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
],
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityTypeBatch": {
"description": "This message is a wrapper around a collection of entity types.",
"id": "GoogleCloudDialogflowV2EntityTypeBatch",
"properties": {
"entityTypes": {
"description": "A collection of entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2EntityTypeEntity",
"properties": {
"synonyms": {
"description": "Required. A collection of value synonyms. For example, if the entity type\nis *vegetable*, and `value` is *scallions*, a synonym could be *green\nonions*.\n\nFor `KIND_LIST` entity types:\n\n* This collection must contain exactly one synonym equal to `value`.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Required. The primary value associated with this entity entry.\nFor example, if the entity type is *vegetable*, the value could be\n*scallions*.\n\nFor `KIND_MAP` entity types:\n\n* A canonical value to be used in place of synonyms.\n\nFor `KIND_LIST` entity types:\n\n* A string that can contain references to other entity types (with or\n without aliases).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: \"welcome_event\",\nparameters: { name: \"Sam\" } }\u003e` 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",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes. Note that queries in\nthe same session do not necessarily need to specify the same language.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the event.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with the event.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ExportAgentRequest": {
"description": "The request message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2ExportAgentRequest",
"properties": {
"agentUri": {
"description": "Optional. The\n[Google Cloud Storage](https://cloud.google.com/storage/docs/)\nURI to export the agent to.\nThe format of this URI must be `gs://\u003cbucket-name\u003e/\u003cobject-name\u003e`.\nIf left unspecified, the serialized agent is returned inline.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2ExportAgentResponse",
"properties": {
"agentContent": {
"description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2/projects/\u0026lt;project_name\u0026gt;/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u0026lt;agent zip file\u0026gt;\u003c/pre\u003e",
"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"
},
"GoogleCloudDialogflowV2ImportAgentRequest": {
"description": "The request message for Agents.ImportAgent.",
"id": "GoogleCloudDialogflowV2ImportAgentRequest",
"properties": {
"agentContent": {
"description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2/projects/\u0026lt;project_name\u0026gt;/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u0026lt;agent zip file\u0026gt; | base64 -w 0)'\n }\"\u003c/pre\u003e",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2InputAudioConfig": {
"description": "Instructs the speech recognizer how to process the audio content.",
"id": "GoogleCloudDialogflowV2InputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. Audio encoding of the audio content to process.",
"enum": [
"AUDIO_ENCODING_UNSPECIFIED",
"AUDIO_ENCODING_LINEAR_16",
"AUDIO_ENCODING_FLAC",
"AUDIO_ENCODING_MULAW",
"AUDIO_ENCODING_AMR",
"AUDIO_ENCODING_AMR_WB",
"AUDIO_ENCODING_OGG_OPUS",
"AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
],
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
"[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is lossless (therefore\nrecognition is not compromised) and requires only about half the\nbandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and\n24-bit samples, however, not all fields in `STREAMINFO` are supported.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
"Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
"Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
"Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
"Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nDialogflow API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
],
"type": "string"
},
"languageCode": {
"description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes. Note that queries in\nthe same session do not necessarily need to specify the same language.",
"type": "string"
},
"phraseHints": {
"description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)\nfor more details.",
"items": {
"type": "string"
},
"type": "array"
},
"sampleRateHertz": {
"description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics) for\nmore details.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Intent": {
"description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
"id": "GoogleCloudDialogflowV2Intent",
"properties": {
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e"
],
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
],
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.",
"items": {
"type": "string"
},
"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.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo"
},
"type": "array"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"items": {
"type": "string"
},
"type": "array"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent.\nNote: If `ml_diabled` setting is set to true, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentParameter"
},
"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 BatchUpdateIntents, in order to\nmake this intent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities. If this is zero or unspecified, we use the default\npriority 500000.\n\nNegative numbers mean that the intent is disabled.",
"format": "int32",
"type": "integer"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"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/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is\ntrained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase"
},
"type": "array"
},
"webhookState": {
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
],
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentBatch": {
"description": "This message is a wrapper around a collection of intents.",
"id": "GoogleCloudDialogflowV2IntentBatch",
"properties": {
"intents": {
"description": "A collection of intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentFollowupIntentInfo": {
"description": "Represents a single followup intent in the chain.",
"id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo",
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessage": {
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"id": "GoogleCloudDialogflowV2IntentMessage",
"properties": {
"basicCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"description": "The basic card response for Actions on Google."
},
"card": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCard",
"description": "The card response."
},
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"description": "The carousel card response for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "The image response."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion",
"description": "The link out suggestion chip for Actions on Google."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelect",
"description": "The list card response for Actions on Google."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.\nSee the Intent.Message.Platform type for a description of the\nstructure that may be required for your platform.",
"type": "object"
},
"platform": {
"description": "Optional. The platform that this message is intended for.",
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
],
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e"
],
"type": "string"
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies",
"description": "The quick replies response."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses",
"description": "The voice and text-only responses for Actions on Google."
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"description": "The suggestion chips for Actions on Google."
},
"text": {
"$ref": "GoogleCloudDialogflowV2IntentMessageText",
"description": "The text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"type": "array"
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image for the card."
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton",
"properties": {
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
},
"title": {
"description": "Required. The title of the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2IntentMessageCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCardButton"
},
"type": "array"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"id": "GoogleCloudDialogflowV2IntentMessageCardButton",
"properties": {
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
},
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelect": {
"description": "The card for presenting a carousel of options to select from.",
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"properties": {
"items": {
"description": "Required. Carousel items.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2IntentMessageImage",
"properties": {
"accessibilityText": {
"description": "Optional. A text description of the image to be used for accessibility,\ne.g., screen readers.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
"id": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion",
"properties": {
"destinationName": {
"description": "Required. The name of the app or site this chip is linking to.",
"type": "string"
},
"uri": {
"description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelect",
"properties": {
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem"
},
"type": "array"
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelectItem",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"id": "GoogleCloudDialogflowV2IntentMessageQuickReplies",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a\ndialog.",
"id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"properties": {
"key": {
"description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
"type": "string"
},
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse",
"properties": {
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
},
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech.",
"type": "string"
},
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSuggestion": {
"description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.",
"id": "GoogleCloudDialogflowV2IntentMessageSuggestion",
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowV2IntentMessageText",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2IntentParameter",
"properties": {
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
"items": {
"type": "string"
},
"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`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentTrainingPhrase": {
"description": "Represents an example that the agent is trained on.",
"id": "GoogleCloudDialogflowV2IntentTrainingPhrase",
"properties": {
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
},
"parts": {
"description": "Required. The ordered list of training phrase parts.\nThe parts are concatenated in order to form the training phrase.\n\nNote: The API does not automatically annotate training phrases like the\nDialogflow Console does.\n\nNote: Do not forget to include whitespace at part boundaries,\nso the training phrase is well formatted when the parts are concatenated.\n\nIf the training phrase does not need to be annotated with parameters,\nyou just need a single part with only the Part.text field set.\n\nIf you want to annotate the training phrase, you must create multiple\nparts, where the fields of each part are populated in one of two ways:\n\n- `Part.text` is set to a part of the phrase that has no parameters.\n- `Part.text` is set to a part of the phrase that you want to annotate,\n and the `entity_type`, `alias`, and `user_defined` fields are all\n set.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart"
},
"type": "array"
},
"timesAddedCount": {
"description": "Optional. Indicates how many times this example was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Required. The type of the training phrase.",
"enum": [
"TYPE_UNSPECIFIED",
"EXAMPLE",
"TEMPLATE"
],
"enumDescriptions": [
"Not specified. This value should never be used.",
"Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings.\nTemplate mode has been deprecated. Example mode is the only supported\nway to create new training phrases. If you have existing training\nphrases that you've created in template mode, those will continue to\nwork."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart",
"properties": {
"alias": {
"description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
},
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated.\nThis field is set to true when the Dialogflow Console is used to\nmanually annotate the part. When creating an annotated part with the\nAPI, you must set this to true.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListContextsResponse": {
"description": "The response message for Contexts.ListContexts.",
"id": "GoogleCloudDialogflowV2ListContextsResponse",
"properties": {
"contexts": {
"description": "The list of contexts. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"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"
},
"GoogleCloudDialogflowV2ListEntityTypesResponse": {
"description": "The response message for EntityTypes.ListEntityTypes.",
"id": "GoogleCloudDialogflowV2ListEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The list of agent entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"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",
"properties": {
"intents": {
"description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"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"
},
"GoogleCloudDialogflowV2ListSessionEntityTypesResponse": {
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"id": "GoogleCloudDialogflowV2ListSessionEntityTypesResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"sessionEntityTypes": {
"description": "The list of session entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"properties": {
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field is set to the value of the `QueryParameters.payload`\nfield passed in the request. Some integrations that query a Dialogflow\nagent may provide additional information in the payload.\n\nIn particular for the Telephony Gateway this field has the form:\n\u003cpre\u003e{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}\u003c/pre\u003e\nNote: The caller ID field (`caller_id`) will be redacted for Standard\nEdition agents and populated with the caller ID in [E.164\nformat](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.",
"type": "object"
},
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request.\nThis field is AoG-specific.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2OutputAudioConfig": {
"description": "Instructs the speech synthesizer how to generate the output audio content.",
"id": "GoogleCloudDialogflowV2OutputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. Audio encoding of the synthesized audio content.",
"enum": [
"OUTPUT_AUDIO_ENCODING_UNSPECIFIED",
"OUTPUT_AUDIO_ENCODING_LINEAR_16",
"OUTPUT_AUDIO_ENCODING_MP3",
"OUTPUT_AUDIO_ENCODING_OGG_OPUS"
],
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).\nAudio content returned as LINEAR16 also contains a WAV header.",
"MP3 audio.",
"Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate."
],
"type": "string"
},
"sampleRateHertz": {
"description": "Optional. The synthesis sample rate (in hertz) for this audio. If not\nprovided, then the synthesizer will use the default sample rate based on\nthe audio encoding. If this is different from the voice's natural sample\nrate, then the synthesizer will honor this request by converting to the\ndesired sample rate (which might result in worse audio quality).",
"format": "int32",
"type": "integer"
},
"synthesizeSpeechConfig": {
"$ref": "GoogleCloudDialogflowV2SynthesizeSpeechConfig",
"description": "Optional. Configuration of how speech should be synthesized."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryInput": {
"description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.",
"id": "GoogleCloudDialogflowV2QueryInput",
"properties": {
"audioConfig": {
"$ref": "GoogleCloudDialogflowV2InputAudioConfig",
"description": "Instructs the speech recognizer how to process the speech audio."
},
"event": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "The event to be processed."
},
"text": {
"$ref": "GoogleCloudDialogflowV2TextInput",
"description": "The natural language text to be processed."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryParameters": {
"description": "Represents the parameters of the conversational query.",
"id": "GoogleCloudDialogflowV2QueryParameters",
"properties": {
"contexts": {
"description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"geoLocation": {
"$ref": "GoogleTypeLatLng",
"description": "Optional. The geo location of this conversational query."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data into the webhook\nassociated with the agent. Arbitrary JSON objects are supported.",
"type": "object"
},
"resetContexts": {
"description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
"type": "boolean"
},
"sentimentAnalysisRequestConfig": {
"$ref": "GoogleCloudDialogflowV2SentimentAnalysisRequestConfig",
"description": "Optional. Configures the type of sentiment analysis to perform. If not\nprovided, sentiment analysis is not performed."
},
"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.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
},
"timeZone": {
"description": "Optional. The time zone of this conversational query from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris. If not provided, the time zone specified in\nagent settings is used.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2QueryResult",
"properties": {
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n- `false` if the matched intent has required parameters and not all of\n the required parameter values have been collected.\n- `true` if all required parameter values have been collected, or if the\n matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The free-form diagnostic info. For example, this field could contain\nwebhook call latency. The string keys of the Struct's fields map can change\nwithout notice.",
"type": "object"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen.\nNote: This is a legacy field, `fulfillment_messages` should be preferred.",
"type": "string"
},
"intent": {
"$ref": "GoogleCloudDialogflowV2Intent",
"description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nIf there are `multiple knowledge_answers` messages, this value is set to\nthe greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"type": "object"
},
"queryText": {
"description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
"type": "string"
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the\n`sentiment_analysis_request_config` specified in the request."
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set.\n\nThis field is not guaranteed to be accurate or set. In particular this\nfield isn't set for StreamingDetectIntent since the streaming endpoint has\nseparate confidence estimates per portion of the audio in\nStreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"webhookPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
"type": "object"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2RestoreAgentRequest": {
"description": "The request message for Agents.RestoreAgent.",
"id": "GoogleCloudDialogflowV2RestoreAgentRequest",
"properties": {
"agentContent": {
"description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2/projects/\u0026lt;project_name\u0026gt;/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u0026lt;agent zip file\u0026gt; | base64 -w 0)'\n }\"\u003c/pre\u003e",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SearchAgentsResponse": {
"description": "The response message for Agents.SearchAgents.",
"id": "GoogleCloudDialogflowV2SearchAgentsResponse",
"properties": {
"agents": {
"description": "The list of agents. There will be a maximum number of items returned based\non the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"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"
},
"GoogleCloudDialogflowV2Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit\nof analysis, such as the query text.",
"id": "GoogleCloudDialogflowV2Sentiment",
"properties": {
"magnitude": {
"description": "A non-negative number in the [0, +inf) range, which represents the absolute\nmagnitude of sentiment, regardless of score (positive or negative).",
"format": "float",
"type": "number"
},
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\nsentiment).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SentimentAnalysisRequestConfig": {
"description": "Configures the types of sentiment analysis to perform.",
"id": "GoogleCloudDialogflowV2SentimentAnalysisRequestConfig",
"properties": {
"analyzeQueryTextSentiment": {
"description": "Optional. Instructs the service to perform sentiment analysis on\n`query_text`. If not provided, sentiment analysis is not performed on\n`query_text`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SentimentAnalysisResult": {
"description": "The result of sentiment analysis as configured by\n`sentiment_analysis_request_config`.",
"id": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
"$ref": "GoogleCloudDialogflowV2Sentiment",
"description": "The sentiment analysis result for `query_text`."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SessionEntityType": {
"description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
"id": "GoogleCloudDialogflowV2SessionEntityType",
"properties": {
"entities": {
"description": "Required. The collection of entities associated with this session entity\ntype.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"entityOverrideMode": {
"description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
"enum": [
"ENTITY_OVERRIDE_MODE_UNSPECIFIED",
"ENTITY_OVERRIDE_MODE_OVERRIDE",
"ENTITY_OVERRIDE_MODE_SUPPLEMENT"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.",
"The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\n\nNote: Even in this override mode calls to `ListSessionEntityTypes`,\n`GetSessionEntityType`, `CreateSessionEntityType` and\n`UpdateSessionEntityType` only return the additional entities added in\nthis session entity type. If you want to get the supplemented list,\nplease call EntityTypes.GetEntityType on the developer entity type\nand merge."
],
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.\n\n`\u003cEntity Type Display Name\u003e` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SynthesizeSpeechConfig": {
"description": "Configuration of how speech should be synthesized.",
"id": "GoogleCloudDialogflowV2SynthesizeSpeechConfig",
"properties": {
"effectsProfileId": {
"description": "Optional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.",
"items": {
"type": "string"
},
"type": "array"
},
"pitch": {
"description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.",
"format": "double",
"type": "number"
},
"speakingRate": {
"description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and\n0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any\nother values \u003c 0.25 or \u003e 4.0 will return an error.",
"format": "double",
"type": "number"
},
"voice": {
"$ref": "GoogleCloudDialogflowV2VoiceSelectionParams",
"description": "Optional. The desired voice of the synthesized audio."
},
"volumeGainDb": {
"description": "Optional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range [-96.0, 16.0]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2TextInput": {
"description": "Represents the natural language text to be processed.",
"id": "GoogleCloudDialogflowV2TextInput",
"properties": {
"languageCode": {
"description": "Required. The language of this conversational query. See [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes. Note that queries in\nthe same session do not necessarily need to specify the same language.",
"type": "string"
},
"text": {
"description": "Required. The UTF-8 encoded natural language text to be processed.\nText length must not exceed 256 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2TrainAgentRequest": {
"description": "The request message for Agents.TrainAgent.",
"id": "GoogleCloudDialogflowV2TrainAgentRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowV2VoiceSelectionParams": {
"description": "Description of which voice to use for speech synthesis.",
"id": "GoogleCloudDialogflowV2VoiceSelectionParams",
"properties": {
"name": {
"description": "Optional. The name of the voice. If not set, the service will choose a\nvoice based on the other parameters such as language_code and gender.",
"type": "string"
},
"ssmlGender": {
"description": "Optional. The preferred gender of the voice. If not set, the service will\nchoose a voice based on the other parameters such as language_code and\nname. Note that this is only a preference, not requirement. If a\nvoice of the appropriate gender is not available, the synthesizer should\nsubstitute a voice with a different gender rather than failing the request.",
"enum": [
"SSML_VOICE_GENDER_UNSPECIFIED",
"SSML_VOICE_GENDER_MALE",
"SSML_VOICE_GENDER_FEMALE",
"SSML_VOICE_GENDER_NEUTRAL"
],
"enumDescriptions": [
"An unspecified gender, which means that the client doesn't care which\ngender the selected voice will have.",
"A male voice.",
"A female voice.",
"A gender-neutral voice."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2WebhookRequest",
"properties": {
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2QueryResult",
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookResponse": {
"description": "The response message for a webhook call.",
"id": "GoogleCloudDialogflowV2WebhookResponse",
"properties": {
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input."
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"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`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.\nSee the related `fulfillment_messages[i].payload field`, which may be used\nas an alternative to this field.\n\nThis field can be used for Actions on Google responses.\nIt should have a structure similar to the JSON message shown here. For more\ninformation, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"google\": {\n \"expectUserResponse\": true,\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"textToSpeech\": \"this is a simple response\"\n }\n }\n ]\n }\n }\n}\u003c/pre\u003e",
"type": "object"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Context": {
"description": "Represents a context.",
"id": "GoogleCloudDialogflowV2beta1Context",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 20 minutes if there\nare no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`,\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\n\nThe `Context ID` is always converted to lowercase, may only contain\ncharacters in a-zA-Z0-9_-% and may be at most 250 bytes long.\n\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\nRefer to [this\ndoc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)\nfor syntax.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"id": "GoogleCloudDialogflowV2beta1EntityType",
"properties": {
"autoExpansionMode": {
"description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
"enum": [
"AUTO_EXPANSION_MODE_UNSPECIFIED",
"AUTO_EXPANSION_MODE_DEFAULT"
],
"enumDescriptions": [
"Auto expansion disabled for the entity.",
"Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
],
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
"List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
],
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2beta1EntityTypeEntity",
"properties": {
"synonyms": {
"description": "Required. A collection of value synonyms. For example, if the entity type\nis *vegetable*, and `value` is *scallions*, a synonym could be *green\nonions*.\n\nFor `KIND_LIST` entity types:\n\n* This collection must contain exactly one synonym equal to `value`.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Required. The primary value associated with this entity entry.\nFor example, if the entity type is *vegetable*, the value could be\n*scallions*.\n\nFor `KIND_MAP` entity types:\n\n* A canonical value to be used in place of synonyms.\n\nFor `KIND_LIST` entity types:\n\n* A string that can contain references to other entity types (with or\n without aliases).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: \"welcome_event\",\nparameters: { name: \"Sam\" } }\u003e` 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": "GoogleCloudDialogflowV2beta1EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes. Note that queries in\nthe same session do not necessarily need to specify the same language.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the event.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with the event.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2beta1ExportAgentResponse",
"properties": {
"agentContent": {
"description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u0026lt;project_name\u0026gt;/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u0026lt;agent zip file\u0026gt;\u003c/pre\u003e",
"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"
},
"GoogleCloudDialogflowV2beta1Intent": {
"description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
"id": "GoogleCloudDialogflowV2beta1Intent",
"properties": {
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e",
"Telephony Gateway."
],
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY"
],
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations\n(e.g., Actions on Google or Dialogflow phone gateway) use this information\nto close interaction with an end user. Default is false.",
"type": "boolean"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.",
"items": {
"type": "string"
},
"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.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo"
},
"type": "array"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"items": {
"type": "string"
},
"type": "array"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent.\nNote: If `ml_disabled` setting is set to true, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.",
"type": "boolean"
},
"mlEnabled": {
"description": "Optional. Indicates whether Machine Learning is enabled for the intent.\nNote: If `ml_enabled` setting is set to false, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.\nDEPRECATED! Please use `ml_disabled` field instead.\nNOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,\nthen the default value is determined as follows:\n- Before April 15th, 2018 the default is:\n ml_enabled = false / ml_disabled = true.\n- After April 15th, 2018 the default is:\n ml_enabled = true / ml_disabled = false.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentParameter"
},
"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 BatchUpdateIntents, in order to\nmake this intent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities. If this is zero or unspecified, we use the default\npriority 500000.\n\nNegative numbers mean that the intent is disabled.",
"format": "int32",
"type": "integer"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"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/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is\ntrained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase"
},
"type": "array"
},
"webhookState": {
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
],
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": {
"description": "Represents a single followup intent in the chain.",
"id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo",
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessage": {
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"id": "GoogleCloudDialogflowV2beta1IntentMessage",
"properties": {
"basicCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"description": "Displays a basic card for Actions on Google."
},
"card": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"description": "Displays a card."
},
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect",
"description": "Displays a carousel card for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Displays an image."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion",
"description": "Displays a link out suggestion chip for Actions on Google."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"description": "Displays a list card for Actions on Google."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.\nSee the Intent.Message.Platform type for a description of the\nstructure that may be required for your platform.",
"type": "object"
},
"platform": {
"description": "Optional. The platform that this message is intended for.",
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY"
],
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e",
"Telephony Gateway."
],
"type": "string"
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"description": "Displays quick replies."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses",
"description": "Returns a voice or text-only response for Actions on Google."
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"description": "Displays suggestion chips for Actions on Google."
},
"telephonyPlayAudio": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio",
"description": "Plays audio from a file in Telephony Gateway."
},
"telephonySynthesizeSpeech": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech",
"description": "Synthesizes speech in Telephony Gateway."
},
"telephonyTransferCall": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"description": "Transfers the call in Telephony Gateway."
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageText",
"description": "Returns a text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
},
"type": "array"
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image for the card."
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton",
"properties": {
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
},
"title": {
"description": "Required. The title of the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton"
},
"type": "array"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton",
"properties": {
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
},
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": {
"description": "The card for presenting a carousel of options to select from.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect",
"properties": {
"items": {
"description": "Required. Carousel items.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"properties": {
"accessibilityText": {
"description": "A text description of the image to be used for accessibility,\ne.g., screen readers. Required if image_uri is set for CarouselSelect.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion",
"properties": {
"destinationName": {
"description": "Required. The name of the app or site this chip is linking to.",
"type": "string"
},
"uri": {
"description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"properties": {
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem"
},
"type": "array"
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a\ndialog.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"properties": {
"key": {
"description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
"type": "string"
},
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse",
"properties": {
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
},
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech.",
"type": "string"
},
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestion": {
"description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion",
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": {
"description": "Plays audio from a file in Telephony Gateway.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio",
"properties": {
"audioUri": {
"description": "Required. URI to a Google Cloud Storage object containing the audio to\nplay, e.g., \"gs://bucket/object\". The object must contain a single\nchannel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.\n\nThis object must be readable by the `service-\u003cProject\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` service account\nwhere \u003cProject Number\u003e is the number of the Telephony Gateway project\n(usually the same as the Dialogflow agent project). If the Google Cloud\nStorage bucket is in the Telephony Gateway project, this permission is\nadded by default when enabling the Dialogflow V2 API.\n\nFor audio from other sources, consider using the\n`TelephonySynthesizeSpeech` message with SSML.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": {
"description": "Synthesizes speech and plays back the synthesized audio to the caller in\nTelephony Gateway.\n\nTelephony Gateway takes the synthesizer settings from\n`DetectIntentResponse.output_audio_config` which can either be set\nat request-level or can come from the agent-level synthesizer config.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech",
"properties": {
"ssml": {
"description": "The SSML to be synthesized. For more information, see\n[SSML](https://developers.google.com/actions/reference/ssml).",
"type": "string"
},
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": {
"description": "Transfers the call in Telephony Gateway.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"properties": {
"phoneNumber": {
"description": "Required. The phone number to transfer the call to\nin [E.164 format](https://en.wikipedia.org/wiki/E.164).\n\nWe currently only allow transferring to US numbers (+1xxxyyyzzzz).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageText",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2beta1IntentParameter",
"properties": {
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
"items": {
"type": "string"
},
"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`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrase": {
"description": "Represents an example that the agent is trained on.",
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase",
"properties": {
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
},
"parts": {
"description": "Required. The ordered list of training phrase parts.\nThe parts are concatenated in order to form the training phrase.\n\nNote: The API does not automatically annotate training phrases like the\nDialogflow Console does.\n\nNote: Do not forget to include whitespace at part boundaries,\nso the training phrase is well formatted when the parts are concatenated.\n\nIf the training phrase does not need to be annotated with parameters,\nyou just need a single part with only the Part.text field set.\n\nIf you want to annotate the training phrase, you must create multiple\nparts, where the fields of each part are populated in one of two ways:\n\n- `Part.text` is set to a part of the phrase that has no parameters.\n- `Part.text` is set to a part of the phrase that you want to annotate,\n and the `entity_type`, `alias`, and `user_defined` fields are all\n set.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart"
},
"type": "array"
},
"timesAddedCount": {
"description": "Optional. Indicates how many times this example was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Required. The type of the training phrase.",
"enum": [
"TYPE_UNSPECIFIED",
"EXAMPLE",
"TEMPLATE"
],
"enumDescriptions": [
"Not specified. This value should never be used.",
"Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings.\nTemplate mode has been deprecated. Example mode is the only supported\nway to create new training phrases. If you have existing training\nphrases that you've created in template mode, those will continue to\nwork."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart",
"properties": {
"alias": {
"description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
},
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated.\nThis field is set to true when the Dialogflow Console is used to\nmanually annotate the part. When creating an annotated part with the\nAPI, you must set this to true.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswers": {
"description": "Represents the result of querying a Knowledge base.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"properties": {
"answers": {
"description": "A list of answers from Knowledge Connector.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": {
"description": "An answer from Knowledge Connector.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer",
"properties": {
"answer": {
"description": "The piece of text from the `source` knowledge base document that answers\nthis conversational query.",
"type": "string"
},
"faqQuestion": {
"description": "The corresponding FAQ question if the answer was extracted from a FAQ\nDocument, empty otherwise.",
"type": "string"
},
"matchConfidence": {
"description": "The system's confidence score that this Knowledge answer is a good match\nfor this conversational query.\nThe range is from 0.0 (completely uncertain) to 1.0 (completely certain).\nNote: The confidence score is likely to vary somewhat (possibly even for\nidentical requests), as the underlying model is under constant\nimprovement. It may be deprecated in the future. We recommend using\n`match_confidence_level` which should be generally more stable.",
"format": "float",
"type": "number"
},
"matchConfidenceLevel": {
"description": "The system's confidence level that this knowledge answer is a good match\nfor this conversational query.\nNOTE: The confidence level for a given `\u003cquery, answer\u003e` pair may change\nwithout notice, as it depends on models that are constantly being\nimproved. However, it will change less frequently than the confidence\nscore below, and should be preferred for referencing the quality of an\nanswer.",
"enum": [
"MATCH_CONFIDENCE_LEVEL_UNSPECIFIED",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Not specified.",
"Indicates that the confidence is low.",
"Indicates our confidence is medium.",
"Indicates our confidence is high."
],
"type": "string"
},
"source": {
"description": "Indicates which Knowledge Document this answer was extracted from.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": {
"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata",
"properties": {
"state": {
"description": "Required. The current state of this operation.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"State unspecified.",
"The operation has been created.",
"The operation is currently running.",
"The operation is done, either cancelled or completed."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest",
"properties": {
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field is set to the value of the `QueryParameters.payload`\nfield passed in the request. Some integrations that query a Dialogflow\nagent may provide additional information in the payload.\n\nIn particular for the Telephony Gateway this field has the form:\n\u003cpre\u003e{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}\u003c/pre\u003e\nNote: The caller ID field (`caller_id`) will be redacted for Standard\nEdition agents and populated with the caller ID in [E.164\nformat](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.",
"type": "object"
},
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request.\nThis field is AoG-specific.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2beta1QueryResult",
"properties": {
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n- `false` if the matched intent has required parameters and not all of\n the required parameter values have been collected.\n- `true` if all required parameter values have been collected, or if the\n matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The free-form diagnostic info. For example, this field could contain\nwebhook call latency. The string keys of the Struct's fields map can change\nwithout notice.",
"type": "object"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen.\nNote: This is a legacy field, `fulfillment_messages` should be preferred.",
"type": "string"
},
"intent": {
"$ref": "GoogleCloudDialogflowV2beta1Intent",
"description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nIf there are `multiple knowledge_answers` messages, this value is set to\nthe greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"knowledgeAnswers": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"description": "The result from Knowledge Connector (if any), ordered by decreasing\n`KnowledgeAnswers.match_confidence`."
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)\nfor a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"type": "object"
},
"queryText": {
"description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
"type": "string"
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the\n`sentiment_analysis_request_config` specified in the request."
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set.\n\nThis field is not guaranteed to be accurate or set. In particular this\nfield isn't set for StreamingDetectIntent since the streaming endpoint has\nseparate confidence estimates per portion of the audio in\nStreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"webhookPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
"type": "object"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit\nof analysis, such as the query text.",
"id": "GoogleCloudDialogflowV2beta1Sentiment",
"properties": {
"magnitude": {
"description": "A non-negative number in the [0, +inf) range, which represents the absolute\nmagnitude of sentiment, regardless of score (positive or negative).",
"format": "float",
"type": "number"
},
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\nsentiment).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisResult": {
"description": "The result of sentiment analysis as configured by\n`sentiment_analysis_request_config`.",
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
"$ref": "GoogleCloudDialogflowV2beta1Sentiment",
"description": "The sentiment analysis result for `query_text`."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2beta1WebhookRequest",
"properties": {
"alternativeQueryResults": {
"description": "Alternative query results from KnowledgeService.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"type": "array"
},
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult",
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1WebhookResponse": {
"description": "The response message for a webhook call.",
"id": "GoogleCloudDialogflowV2beta1WebhookResponse",
"properties": {
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations\n(e.g., Actions on Google or Dialogflow phone gateway) use this information\nto close interaction with an end user. Default is false.",
"type": "boolean"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input."
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"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`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.\nSee the related `fulfillment_messages[i].payload field`, which may be used\nas an alternative to this field.\n\nThis field can be used for Actions on Google responses.\nIt should have a structure similar to the JSON message shown here. For more\ninformation, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"google\": {\n \"expectUserResponse\": true,\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"textToSpeech\": \"this is a simple response\"\n }\n }\n ]\n }\n }\n}\u003c/pre\u003e",
"type": "object"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeLatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
"id": "GoogleTypeLatLng",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Dialogflow API",
"version": "v2",
"version_module": true
}
Reference in a new issue Copy permalink