Google Git
Sign in
flutter / third_party / googleapis.dart / dad5d0c495047969526b7f31dba34318f255eedd / . / discovery / googleapis_beta / dialogflow__v2beta1.json
blob: d3452108304f090ea104c5e6bc9e69a2f423c621 [file] [log] [blame]
{
"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/",
"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:v2beta1",
"kind": "discovery#restDescription",
"name": "dialogflow",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"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"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
},
"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"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"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"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"getAgent": {
"description": "Retrieves the specified 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/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"setAgent": {
"description": "Creates/updates the specified agent.",
"httpMethod": "POST",
"id": "dialogflow.projects.setAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project of this agent.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"deleteAgent": {
"description": "Deletes the specified agent.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.deleteAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to delete is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"locations": {
"methods": {
"deleteAgent": {
"description": "Deletes the specified agent.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.deleteAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to delete is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"getAgent": {
"description": "Retrieves the specified agent.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.getAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"setAgent": {
"description": "Creates/updates the specified agent.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.setAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project of this agent.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}:cancel",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v2beta1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"agent": {
"methods": {
"export": {
"description": "Exports the specified agent to a ZIP file.\n\n\nOperation <response: ExportAgentResponse>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.export",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to export is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:export",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest"
},
"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\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.restore",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:restore",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"train": {
"description": "Trains the specified agent.\n\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.train",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to train is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:train",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest"
},
"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\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to import is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:import",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"fulfillment": {
"description": "Updates the fulfillment.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.fulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Required. The mask to control which fields get updated. If the mask is not\npresent, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the fulfillment.\nFormat: `projects/<Project ID>/agent/fulfillment`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"getFulfillment": {
"description": "Retrieves the fulfillment.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.getFulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the fulfillment.\nFormat: `projects/<Project ID>/agent/fulfillment`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"intents": {
"methods": {
"get": {
"description": "Retrieves the specified intent.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.intents.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
},
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified intent.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.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 used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"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 <response: BatchUpdateIntentsResponse>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.intents.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.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.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.intents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all intents from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an intent in the specified agent.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.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"
},
"parent": {
"description": "Required. The agent to create a intent for.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes intents in the specified agent.\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.intents.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"delete": {
"description": "Deletes the specified entity type.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete.\nFormat: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to list all entity types from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an entity type in the specified agent.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to create a entity type for.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes entity types in the specified agent.\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified entity type.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type.\nFormat: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified entity type.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agent.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"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 <response: BatchUpdateEntityTypesResponse>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create entity types in.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entities": {
"methods": {
"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 <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.entities.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to update or create entities in.\nFormat: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest"
},
"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 <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.entities.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to delete entries for. Format:\n`projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchCreate": {
"description": "Creates multiple new entities in the specified entity type.\n\nOperation <response: google.protobuf.Empty>",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.entityTypes.entities.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to create entities in. Format:\n`projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchCreate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"environments": {
"methods": {
"list": {
"description": "Returns the list of all non-draft environments of the specified agent.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and\nat most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parent": {
"description": "Required. The agent to list all environments from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/environments",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"users": {
"resources": {
"sessions": {
"methods": {
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.deleteContexts",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project\nID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session\nID>`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+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.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It's up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random number or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"list": {
"description": "Returns the list of all session entity types in the specified session.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"parent": {
"description": "Required. The session to list all session entity types from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"contexts": {
"methods": {
"delete": {
"description": "Deletes the specified context.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"parent": {
"description": "Required. The session to list all contexts from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"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.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.sessions.deleteContexts",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project\nID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session\nID>`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+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.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It's up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random number or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"delete": {
"description": "Deletes the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to list all session entity types from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"contexts": {
"methods": {
"create": {
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agent.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified context.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agent.sessions.contexts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.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"
},
"parent": {
"description": "Required. The session to list all contexts from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agent.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agent.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
}
}
},
"knowledgeBases": {
"methods": {
"delete": {
"description": "Deletes the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.knowledgeBases.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the knowledge base to delete.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
},
"force": {
"description": "Optional. Force deletes the knowledge base. When set to true, any documents\nin the knowledge base are also deleted.",
"location": "query",
"type": "boolean"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all knowledge bases of the specified agent.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "GET",
"id": "dialogflow.projects.knowledgeBases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parent": {
"description": "Required. The project to list of knowledge bases for.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/knowledgeBases",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "GET",
"id": "dialogflow.projects.knowledgeBases.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the knowledge base to retrieve.\nFormat `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.knowledgeBases.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The knowledge base resource name.\nThe name must be empty when creating a knowledge base.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Not specified means `update all`.\nCurrently, only `display_name` can be updated, an InvalidArgument will be\nreturned for attempting to update other fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "POST",
"id": "dialogflow.projects.knowledgeBases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project to create a knowledge base for.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/knowledgeBases",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"documents": {
"methods": {
"delete": {
"description": "Deletes the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.knowledgeBases.documents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the document to delete.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all documents of the knowledge base.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "GET",
"id": "dialogflow.projects.knowledgeBases.documents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The knowledge base to list all documents for.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v2beta1/{+parent}/documents",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a new document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "POST",
"id": "dialogflow.projects.knowledgeBases.documents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The knoweldge base to create a document for.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/documents",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"reload": {
"description": "Reloads the specified document from its specified source, content_uri or\ncontent. The previously loaded content of the document will be deleted.\nNote: Even when the content of the document has not changed, there still\nmay be side effects because of internal implementation changes.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "POST",
"id": "dialogflow.projects.knowledgeBases.documents.reload",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the document to reload.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}:reload",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "GET",
"id": "dialogflow.projects.knowledgeBases.documents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the document to retrieve.\nFormat `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.knowledgeBases.documents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. Not specified means `update all`.\nCurrently, only `display_name` can be updated, an InvalidArgument will be\nreturned for attempting to update other fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"agent": {
"methods": {
"getFulfillment": {
"description": "Retrieves the fulfillment.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.getFulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the fulfillment.\nFormat: `projects/<Project ID>/agent/fulfillment`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/fulfillment$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"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\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:restore",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"export": {
"description": "Exports the specified agent to a ZIP file.\n\n\nOperation <response: ExportAgentResponse>",
"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/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:export",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest"
},
"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).",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.search",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"parent": {
"description": "Required. The project to list agents from.\nFormat: `projects/<Project ID or '-'>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:search",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"updateFulfillment": {
"description": "Updates the fulfillment.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.updateFulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the fulfillment.\nFormat: `projects/<Project ID>/agent/fulfillment`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/fulfillment$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields get updated. If the mask is not\npresent, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Fulfillment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"train": {
"description": "Trains the specified agent.\n\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:train",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"getValidationResult": {
"description": "Gets agent validation result. Agent validation is performed during\ntraining time and is updated automatically when training is completed.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.getValidationResult",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent is associated with.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language for which you want a validation result. If not\nspecified, the agent's default language is used. [Many\nlanguages](https://cloud.google.com/dialogflow/docs/reference/language)\nare supported. Note: languages must be enabled in the agent before they can\nbe used.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent/validationResult",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ValidationResult"
},
"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\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/agent:import",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"intents": {
"methods": {
"batchUpdate": {
"description": "Updates/Creates multiple intents in the specified agent.\n\nOperation <response: BatchUpdateIntentsResponse>",
"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/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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.",
"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.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.intents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all intents from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes intents in the specified agent.\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest"
},
"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.",
"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"
},
"parent": {
"description": "Required. The agent to create a intent for.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/intents",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified intent.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.intents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
},
"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 used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified intent.",
"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 used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"patch": {
"description": "Updates the specified entity type.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified entity type.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type.\nFormat: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"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 <response: BatchUpdateEntityTypesResponse>",
"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/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified entity type.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete.\nFormat: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to list all entity types from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes entity types in the specified agent.\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest"
},
"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.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to create a entity type for.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entities": {
"methods": {
"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 <response: google.protobuf.Empty>",
"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/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest"
},
"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 <response: google.protobuf.Empty>",
"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/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchCreate": {
"description": "Creates multiple new entities in the specified entity type.\n\nOperation <response: google.protobuf.Empty>",
"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/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entities:batchCreate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"environments": {
"methods": {
"list": {
"description": "Returns the list of all non-draft environments of the specified agent.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to list all environments from.\nFormat: `projects/<Project ID>/agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and\nat most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v2beta1/{+parent}/environments",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"users": {
"resources": {
"sessions": {
"methods": {
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.environments.users.sessions.deleteContexts",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project\nID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session\nID>`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+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.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.environments.users.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It's up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random number or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"contexts": {
"methods": {
"delete": {
"description": "Deletes the specified context.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.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"
},
"parent": {
"description": "Required. The session to list all contexts from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/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": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"list": {
"description": "Returns the list of all session entity types in the specified session.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
},
"parent": {
"description": "Required. The session to list all session entity types from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` 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/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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.",
"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/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project\nID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session\nID>`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+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.",
"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/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It's up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random number or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"list": {
"description": "Returns the list of all session entity types in the specified session.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to list all session entity types from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"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/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` 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"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"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/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/\nsessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.\n\nThis method doesn't work with Google Assistant integration.\nContact Dialogflow support if you need to use session entities\nwith Google Assistant integration.",
"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/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>` or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"contexts": {
"methods": {
"list": {
"description": "Returns the list of all contexts in the specified session.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to list all contexts from.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"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"
}
},
"path": "v2beta1/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/<Project ID>/agent/sessions/<Session ID>` or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified context.",
"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/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"knowledgeBases": {
"methods": {
"list": {
"description": "Returns the list of all knowledge bases of the specified agent.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.knowledgeBases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parent": {
"description": "Required. The project to list of knowledge bases for.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+parent}/knowledgeBases",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.knowledgeBases.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the knowledge base to retrieve.\nFormat `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.knowledgeBases.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. Not specified means `update all`.\nCurrently, only `display_name` can be updated, an InvalidArgument will be\nreturned for attempting to update other fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The knowledge base resource name.\nThe name must be empty when creating a knowledge base.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates a knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.knowledgeBases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project to create a knowledge base for.\nFormat: `projects/<Project ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/knowledgeBases",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified knowledge base.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.knowledgeBases.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "Optional. Force deletes the knowledge base. When set to true, any documents\nin the knowledge base are also deleted.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the knowledge base to delete.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"documents": {
"methods": {
"create": {
"description": "Creates a new document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.knowledgeBases.documents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The knoweldge base to create a document for.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/documents",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"reload": {
"description": "Reloads the specified document from its specified source, content_uri or\ncontent. The previously loaded content of the document will be deleted.\nNote: Even when the content of the document has not changed, there still\nmay be side effects because of internal implementation changes.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.knowledgeBases.documents.reload",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the document to reload.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}:reload",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.knowledgeBases.documents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the document to retrieve.\nFormat `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.knowledgeBases.documents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "Optional. Not specified means `update all`.\nCurrently, only `display_name` can be updated, an InvalidArgument will be\nreturned for attempting to update other fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified document.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.knowledgeBases.documents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the document to delete.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all documents of the knowledge base.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.knowledgeBases.documents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parent": {
"description": "Required. The knowledge base to list all documents for.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+parent}/documents",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"httpMethod": "POST",
"id": "dialogflow.projects.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}:cancel",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
"id": "dialogflow.projects.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"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.",
"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": "v2beta1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
},
"revision": "20200428",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": {
"description": "Column properties for TableCard.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties",
"properties": {
"horizontalAlignment": {
"description": "Optional. Defines text alignment for all cells in this column.",
"enum": [
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
"LEADING",
"CENTER",
"TRAILING"
],
"enumDescriptions": [
"Text is aligned to the leading edge of the column.",
"Text is aligned to the leading edge of the column.",
"Text is centered in the column.",
"Text is aligned to the trailing edge of the column."
],
"type": "string"
},
"header": {
"description": "Required. Column heading.",
"type": "string"
}
},
"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"
},
"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 `<query, answer>` 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"
},
"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"
},
"source": {
"description": "Indicates which Knowledge Document this answer was extracted from.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCardCell": {
"description": "Cell of TableCardRow.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCardCell",
"properties": {
"text": {
"description": "Required. Text in this cell.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1GcsSource": {
"description": "Google Cloud Storage location for single input.",
"id": "GoogleCloudDialogflowV2beta1GcsSource",
"properties": {
"uri": {
"description": "Required. The Google Cloud Storage URIs for the inputs. A URI is of the\nform:\n gs://bucket/object-prefix-or-name\nWhether a prefix or name is used depends on the use case.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListContextsResponse": {
"description": "The response message for Contexts.ListContexts.",
"id": "GoogleCloudDialogflowV2beta1ListContextsResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"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": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListIntentsResponse": {
"description": "The response message for Intents.ListIntents.",
"id": "GoogleCloudDialogflowV2beta1ListIntentsResponse",
"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": "GoogleCloudDialogflowV2beta1Intent"
},
"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"
},
"GoogleCloudDialogflowV2beta1ListEntityTypesResponse": {
"description": "The response message for EntityTypes.ListEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse",
"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": "GoogleCloudDialogflowV2beta1EntityType"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": {
"description": "Opens the user's default web browser app to the specified uri\n(https://goo.gl/6GLJD2). If the user has an app installed that is\nregistered as the default handler for the URL, then this app will be\nopened instead, and its icon will be used in the suggested action UI.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri",
"properties": {
"uri": {
"description": "Required. The uri to open on the user device",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest",
"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"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmText": {
"description": "Rich Business Messaging (RBM) text response with suggestions.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmText",
"properties": {
"rbmSuggestion": {
"description": "Optional. One or more suggestions to show to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion"
},
"type": "array"
},
"text": {
"description": "Required. Text sent and displayed to the user.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": {
"description": "Carousel Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nFor more details about RBM rich cards, please see:\nhttps://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.\nIf you want to show a single card with more control over the layout,\nplease use RbmStandaloneCard instead.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard",
"properties": {
"cardWidth": {
"description": "Required. The width of the cards in the carousel.",
"enum": [
"CARD_WIDTH_UNSPECIFIED",
"SMALL",
"MEDIUM"
],
"enumDescriptions": [
"Not specified.",
"120 DP. Note that tall media cannot be used.",
"232 DP."
],
"type": "string"
},
"cardContents": {
"description": "Required. The cards in the carousel. A carousel must have at least\n2 cards and at most 10.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessage": {
"description": "A rich response message.\nCorresponds to the intent `Response` field in the Dialogflow console.\nFor more information, see\n[Rich response\nmessages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).",
"id": "GoogleCloudDialogflowV2IntentMessage",
"properties": {
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"description": "The carousel card response for Actions on Google."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion",
"description": "The link out suggestion chip for Actions on Google."
},
"browseCarouselCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard",
"description": "Browse carousel card for Actions on Google."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses",
"description": "The voice and text-only responses for Actions on Google."
},
"mediaContent": {
"$ref": "GoogleCloudDialogflowV2IntentMessageMediaContent",
"description": "The media content card for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "The image response."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A custom platform-specific response.",
"type": "object"
},
"text": {
"$ref": "GoogleCloudDialogflowV2IntentMessageText",
"description": "The text response."
},
"platform": {
"description": "Optional. The platform that this message is intended for.",
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"GOOGLE_HANGOUTS"
],
"enumDescriptions": [
"Default platform.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant\nSee [Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Google Hangouts."
],
"type": "string"
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"description": "The suggestion chips for Actions on Google."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelect",
"description": "The list card response for Actions on Google."
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies",
"description": "The quick replies response."
},
"card": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCard",
"description": "The card response."
},
"basicCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"description": "The basic card response for Actions on Google."
},
"tableCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCard",
"description": "Table card for Actions on Google."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image for the card."
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"type": "array"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"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": {
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\nsentiment).",
"format": "float",
"type": "number"
},
"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"
}
},
"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"
},
"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": {
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"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"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"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"
},
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is\ntrained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase"
},
"type": "array"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"type": "boolean"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentParameter"
},
"type": "array"
},
"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.\nEvent names are limited to 150 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"priority": {
"description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.",
"format": "int32",
"type": "integer"
},
"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"
},
"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/<Project ID>/agent/sessions/-/contexts/<Context ID>`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first responses will be\ncopied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).",
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant\nSee [Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Telephony Gateway.",
"Google Hangouts."
],
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY",
"GOOGLE_HANGOUTS"
],
"type": "string"
},
"type": "array"
},
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"name": {
"description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"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"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.",
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageMediaContent": {
"description": "The media content card for Actions on Google.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent",
"properties": {
"mediaType": {
"description": "Optional. What type of media is the content (ie \"audio\").",
"enum": [
"RESPONSE_MEDIA_TYPE_UNSPECIFIED",
"AUDIO"
],
"enumDescriptions": [
"Unspecified.",
"Response media type is audio."
],
"type": "string"
},
"mediaObjects": {
"description": "Required. List of media objects.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject"
},
"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"
},
"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"
},
"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"
},
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeBase": {
"description": "Represents knowledge base resource.\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeBase",
"properties": {
"name": {
"description": "The knowledge base resource name.\nThe name must be empty when creating a knowledge base.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the knowledge base. The name must be 1024\nbytes or less; otherwise, the creation request fails.",
"type": "string"
},
"languageCode": {
"description": "Language which represents the KnowledgeBase. When the KnowledgeBase is\ncreated/updated, this is populated for all non en-us languages. If not\npopulated, the default language en-us applies.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `<event: { name: \"welcome_event\",\nparameters: { name: \"Sam\" } }>` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`\"Hello #welcome_event.name! What can I do for you today?\"`.",
"id": "GoogleCloudDialogflowV2beta1EventInput",
"properties": {
"name": {
"description": "Required. The unique identifier of the event.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of parameters associated with the event.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
},
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://cloud.google.com/dialogflow/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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": {
"description": "Rich Business Messaging (RBM) suggested client-side action that the user\ncan choose from the card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction",
"properties": {
"text": {
"description": "Text to display alongside the action.",
"type": "string"
},
"openUrl": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri",
"description": "Suggested client side action: Open a URI on device"
},
"dial": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial",
"description": "Suggested client side action: Dial a phone number"
},
"postbackData": {
"description": "Opaque payload that the Dialogflow receives in a user event\nwhen the user taps the suggested action. This data will be also\nforwarded to webhook to allow performing custom business logic.",
"type": "string"
},
"shareLocation": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation",
"description": "Suggested client side action: Share user location"
}
},
"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"
},
"GoogleCloudDialogflowV2IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart",
"properties": {
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`.\nThis field is required for annotated parts of the training phrase.",
"type": "string"
},
"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"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": {
"description": "Standalone Rich Business Messaging (RBM) rich card.\n\nRich cards allow you to respond to users with more vivid content, e.g.\nwith media and suggestions.\n\nFor more details about RBM rich cards, please see:\nhttps://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.\nYou can group multiple rich cards into one using RbmCarouselCard but\ncarousel cards will give you less control over the card layout.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard",
"properties": {
"thumbnailImageAlignment": {
"description": "Required if orientation is horizontal.\nImage preview alignment for standalone cards with horizontal layout.",
"enum": [
"THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED",
"LEFT",
"RIGHT"
],
"enumDescriptions": [
"Not specified.",
"Thumbnail preview is left-aligned.",
"Thumbnail preview is right-aligned."
],
"type": "string"
},
"cardOrientation": {
"description": "Required. Orientation of the card.",
"enum": [
"CARD_ORIENTATION_UNSPECIFIED",
"HORIZONTAL",
"VERTICAL"
],
"enumDescriptions": [
"Not specified.",
"Horizontal layout.",
"Vertical layout."
],
"type": "string"
},
"cardContent": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent",
"description": "Required. Card content."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ValidationError": {
"description": "Represents a single validation error.",
"id": "GoogleCloudDialogflowV2beta1ValidationError",
"properties": {
"severity": {
"description": "The severity of the error.",
"enum": [
"SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"enumDescriptions": [
"Not specified. This value should never be used.",
"The agent doesn't follow Dialogflow best practicies.",
"The agent may not behave as expected.",
"The agent may experience partial failures.",
"The agent may completely fail."
],
"type": "string"
},
"entries": {
"description": "The names of the entries that the error is associated with.\nFormat:\n\n- \"projects/<Project ID>/agent\", if the error is associated with the entire\nagent.\n- \"projects/<Project ID>/agent/intents/<Intent ID>\", if the error is\nassociated with certain intents.\n- \"projects/<Project\nID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>\", if the\nerror is associated with certain intent training phrases.\n- \"projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter\nID>\", if the error is associated with certain intent parameters.\n- \"projects/<Project ID>/agent/entities/<Entity ID>\", if the error is\nassociated with certain entities.",
"items": {
"type": "string"
},
"type": "array"
},
"errorMessage": {
"description": "The detailed error messsage.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessage": {
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"id": "GoogleCloudDialogflowV2beta1IntentMessage",
"properties": {
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"description": "Displays quick replies."
},
"telephonySynthesizeSpeech": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech",
"description": "Synthesizes speech in Telephony Gateway."
},
"card": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"description": "Displays a card."
},
"basicCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"description": "Displays a basic card for Actions on Google."
},
"tableCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCard",
"description": "Table card for Actions on Google."
},
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect",
"description": "Displays a carousel card for Actions on Google."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion",
"description": "Displays a link out suggestion chip for Actions on Google."
},
"browseCarouselCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard",
"description": "Browse carousel card for Actions on Google."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses",
"description": "Returns a voice or text-only response for Actions on Google."
},
"telephonyTransferCall": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"description": "Transfers the call in Telephony Gateway."
},
"mediaContent": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent",
"description": "The media content card for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Displays an image."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A custom platform-specific response.",
"type": "object"
},
"rbmStandaloneRichCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard",
"description": "Standalone Rich Business Messaging (RBM) rich card response."
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageText",
"description": "Returns a text response."
},
"rbmCarouselRichCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard",
"description": "Rich Business Messaging (RBM) carousel rich card response."
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"description": "Displays suggestion chips for Actions on Google."
},
"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",
"GOOGLE_HANGOUTS"
],
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant\nSee [Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Telephony Gateway.",
"Google Hangouts."
],
"type": "string"
},
"telephonyPlayAudio": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio",
"description": "Plays audio from a file in Telephony Gateway."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"description": "Displays a list card for Actions on Google."
},
"rbmText": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmText",
"description": "Rich Business Messaging (RBM) text response.\n\nRBM allows businesses to send enriched and branded versions of SMS. See\nhttps://jibe.google.com/business-messaging."
}
},
"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": {
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is\ntrained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase"
},
"type": "array"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"type": "boolean"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentParameter"
},
"type": "array"
},
"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.\nEvent names are limited to 150 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.",
"format": "int32",
"type": "integer"
},
"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/<Project ID>/agent/sessions/-/contexts/<Context ID>`.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first responses will be\ncopied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).",
"enumDescriptions": [
"Default platform.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant\nSee [Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Google Hangouts."
],
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"GOOGLE_HANGOUTS"
],
"type": "string"
},
"type": "array"
},
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"name": {
"description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"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"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.",
"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"
},
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"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"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": {
"description": "Actions on Google action to open a given url.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"properties": {
"urlTypeHint": {
"description": "Optional. Specifies the type of viewer that is used when opening\nthe URL. Defaults to opening via web browser.",
"enum": [
"URL_TYPE_HINT_UNSPECIFIED",
"AMP_ACTION",
"AMP_CONTENT"
],
"enumDescriptions": [
"Unspecified",
"Url would be an amp action",
"URL that points directly to AMP content, or to a canonical URL\nwhich refers to AMP content via <link rel=\"amphtml\">."
],
"type": "string"
},
"url": {
"description": "Required. URL",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2beta1IntentParameter",
"properties": {
"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"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect a value for the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
"type": "boolean"
},
"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"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"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"
},
"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). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"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"
},
"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"
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image for the card."
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
},
"type": "array"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2IntentParameter",
"properties": {
"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"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect a value for the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"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"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": {
"description": "Rich Business Messaging (RBM) suggestion. Suggestions allow user to\neasily select/click a predefined response or perform an action (like\nopening a web uri).",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion",
"properties": {
"reply": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply",
"description": "Predefined replies for user to select instead of typing"
},
"action": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction",
"description": "Predefined client side actions that user can choose"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": {
"description": "Opens the device's location chooser so the user can pick a location\nto send back to the agent (https://goo.gl/GXotJW).",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowV2beta1AnnotatedConversationDataset": {
"description": "Represents an annotated conversation dataset.\nConversationDataset can have multiple AnnotatedConversationDataset, each of\nthem represents one result from one annotation task.\nAnnotatedConversationDataset can only be generated from annotation task,\nwhich will be triggered by LabelConversation.",
"id": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset",
"properties": {
"displayName": {
"description": "Required. The display name of the annotated conversation dataset.\nIt's specified when user starts an annotation task. Maximum of 64 bytes.",
"type": "string"
},
"description": {
"description": "Optional. The description of the annotated conversation dataset.\nMaximum of 10000 bytes.",
"type": "string"
},
"createTime": {
"description": "Output only. Creation time of this annotated conversation dataset.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Output only. AnnotatedConversationDataset resource name. Format:\n`projects/<Project ID>/conversationDatasets/<Conversation Dataset\nID>/annotatedConversationDatasets/<Annotated Conversation Dataset ID>`",
"type": "string"
},
"exampleCount": {
"description": "Output only. Number of examples in the annotated conversation dataset.",
"format": "int64",
"type": "string"
},
"questionTypeName": {
"description": "Output only. Question type name that identifies a labeling task.\nA question is a single task that a worker answers. A question type is set\nof related questions. Each question belongs to a particular question type.\nIt can be used in CrowdCompute UI to filter and manage labeling tasks.",
"type": "string"
},
"completedExampleCount": {
"description": "Output only. Number of examples that have annotations in the annotated\nconversation dataset.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": {
"description": "Browsing carousel tile",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem",
"properties": {
"footer": {
"description": "Optional. Text that appears at the bottom of the Browse Carousel\nCard. Maximum of one line of text.",
"type": "string"
},
"title": {
"description": "Required. Title of the carousel item. Maximum of two lines of text.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Hero image for the carousel item."
},
"description": {
"description": "Optional. Description of the carousel item. Maximum of four lines of\ntext.",
"type": "string"
},
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"description": "Required. Action to present to the user."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ExportAgentRequest": {
"description": "The request message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2beta1ExportAgentRequest",
"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://<bucket-name>/<object-name>`.\nIf left unspecified, the serialized agent is returned inline.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"properties": {
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
},
"subtitle": {
"description": "Optional. Subtitle of the list.",
"type": "string"
},
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2IntentMessageCard",
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCardButton"
},
"type": "array"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton",
"properties": {
"title": {
"description": "Required. The title of the button.",
"type": "string"
},
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1FulfillmentGenericWebService": {
"description": "Represents configuration for a generic web service.\nDialogflow supports two mechanisms for authentications:\n- Basic authentication with username and password.\n- Authentication with additional authentication headers.\nMore information could be found at:\nhttps://cloud.google.com/dialogflow/docs/fulfillment-configure.",
"id": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService",
"properties": {
"uri": {
"description": "Required. The fulfillment URI for receiving POST requests.",
"type": "string"
},
"password": {
"description": "Optional. The password for HTTP Basic authentication.",
"type": "string"
},
"isCloudFunction": {
"description": "Optional. Indicates if generic web service is created through Cloud Functions\nintegration. Defaults to false.",
"type": "boolean"
},
"username": {
"description": "Optional. The user name for HTTP Basic authentication.",
"type": "string"
},
"requestHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The HTTP request headers to send together with fulfillment requests.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentBatch": {
"description": "This message is a wrapper around a collection of intents.",
"id": "GoogleCloudDialogflowV2beta1IntentBatch",
"properties": {
"intents": {
"description": "A collection of intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1LabelConversationResponse": {
"description": "The response for\nConversationDatasets.LabelConversation.",
"id": "GoogleCloudDialogflowV2beta1LabelConversationResponse",
"properties": {
"annotatedConversationDataset": {
"$ref": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset",
"description": "New annotated conversation dataset created by the labeling task."
}
},
"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. The default is `0`. If set to `0`, 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/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListDocumentsResponse": {
"description": "Response message for Documents.ListDocuments.",
"id": "GoogleCloudDialogflowV2beta1ListDocumentsResponse",
"properties": {
"documents": {
"description": "The list of documents.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a\ndialog.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"properties": {
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
"description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
"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"
},
"GoogleCloudDialogflowV2beta1OutputAudioConfig": {
"description": "Instructs the speech synthesizer how to generate the output audio content.\nIf this audio config is supplied in a request, it overrides all existing\ntext-to-speech settings applied to the agent.",
"id": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"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 at 32kbps.",
"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"
},
"synthesizeSpeechConfig": {
"$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig",
"description": "Configuration of how speech should be synthesized."
},
"sampleRateHertz": {
"description": "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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1TextInput": {
"description": "Represents the natural language text to be processed.",
"id": "GoogleCloudDialogflowV2beta1TextInput",
"properties": {
"text": {
"description": "Required. The UTF-8 encoded natural language text to be processed.\nText length must not exceed 256 characters.",
"type": "string"
},
"languageCode": {
"description": "Required. The language of this conversational query. See [Language\nSupport](https://cloud.google.com/dialogflow/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"
}
},
"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"
},
"GoogleCloudDialogflowV2Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit\nof analysis, such as the query text.",
"id": "GoogleCloudDialogflowV2Sentiment",
"properties": {
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\nsentiment).",
"format": "float",
"type": "number"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SessionEntityType": {
"description": "Represents a session entity type.\n\nExtends or replaces a custom entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"custom entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
"id": "GoogleCloudDialogflowV2SessionEntityType",
"properties": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or `projects/<Project ID>/agent/environments/<Environment\nID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display\nName>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"type": "string"
},
"entityOverrideMode": {
"description": "Required. Indicates whether the additional data should override or\nsupplement the custom 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 custom entity type.",
"The collection of session entities extends the collection of entities in\nthe corresponding custom 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 custom entity type\nand merge."
],
"type": "string"
},
"entities": {
"description": "Required. The collection of entities associated with this session entity\ntype.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntities.",
"id": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest",
"properties": {
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
},
"entityValues": {
"description": "Required. The reference `values` of the entities to delete. Note that\nthese are not fully-qualified names, i.e. they don't start with\n`projects/<Project ID>`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EntityTypeBatch": {
"description": "This message is a wrapper around a collection of entity types.",
"id": "GoogleCloudDialogflowV2beta1EntityTypeBatch",
"properties": {
"entityTypes": {
"description": "A collection of entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntities.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest",
"properties": {
"entities": {
"description": "Required. The entities to update or create.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton"
},
"type": "array"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": {
"description": "Rich Business Messaging (RBM) Card content",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent",
"properties": {
"title": {
"description": "Optional. Title of the card (at most 200 bytes).\n\nAt least one of the title, description or media must be set.",
"type": "string"
},
"description": {
"description": "Optional. Description of the card (at most 2000 bytes).\n\nAt least one of the title, description or media must be set.",
"type": "string"
},
"media": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia",
"description": "Optional. However at least one of the title, description or media must\nbe set. Media (image, GIF or a video) to include in the card."
},
"suggestions": {
"description": "Optional. List of suggestions to include in the card.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `<event: { name: \"welcome_event\",\nparameters: { name: \"Sam\" } }>` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`\"Hello #welcome_event.name! What can I do for you today?\"`.",
"id": "GoogleCloudDialogflowV2EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://cloud.google.com/dialogflow/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": "The collection of parameters associated with the event.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig": {
"description": "Configuration of how speech should be synthesized.",
"id": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig",
"properties": {
"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"
},
"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"
},
"voice": {
"$ref": "GoogleCloudDialogflowV2beta1VoiceSelectionParams",
"description": "Optional. The desired voice of the synthesized audio."
},
"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 < 0.25 or > 4.0 will return an error.",
"format": "double",
"type": "number"
},
"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"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1InputAudioConfig": {
"description": "Instructs the speech recognizer on how to process the audio content.",
"id": "GoogleCloudDialogflowV2beta1InputAudioConfig",
"properties": {
"singleUtterance": {
"description": "If `false` (default), recognition does not cease until the\nclient closes the stream.\nIf `true`, the recognizer will detect a single spoken utterance in input\naudio. Recognition ceases when it detects the audio's voice has\nstopped or paused. In this case, once a detected intent is received, the\nclient should close the stream and start a new request with a new stream as\nneeded.\nNote: This setting is relevant only for streaming methods.\nNote: When specified, InputAudioConfig.single_utterance takes precedence\nover StreamingDetectIntentRequest.single_utterance.",
"type": "boolean"
},
"languageCode": {
"description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://cloud.google.com/dialogflow/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"
},
"speechContexts": {
"description": "Context information to assist speech recognition.\n\nSee [the Cloud Speech\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)\nfor more details.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SpeechContext"
},
"type": "array"
},
"phraseHints": {
"description": "A list of strings containing words and phrases that the speech\nrecognizer should recognize with higher likelihood.\n\nSee [the Cloud Speech\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)\nfor more details.\n\nThis field is deprecated. Please use [speech_contexts]() instead. If you\nspecify both [phrase_hints]() and [speech_contexts](), Dialogflow will\ntreat the [phrase_hints]() as a single additional [SpeechContext]().",
"items": {
"type": "string"
},
"type": "array"
},
"enableWordInfo": {
"description": "If `true`, Dialogflow returns SpeechWordInfo in\nStreamingRecognitionResult with information about the recognized speech\nwords, e.g. start and end time offsets. If false or unspecified, Speech\ndoesn't return any word-level information.",
"type": "boolean"
},
"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"
},
"model": {
"description": "Which Speech model to select for the given request. Select the\nmodel best suited to your domain to get best results. If a model is not\nexplicitly specified, then we auto-select a model based on the parameters\nin the InputAudioConfig.\nIf enhanced speech model is enabled for the agent and an enhanced\nversion of the specified model for the language does not exist, then the\nspeech is recognized using the standard version of the specified model.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)\nfor more details.",
"type": "string"
},
"modelVariant": {
"description": "Which variant of the Speech model to use.",
"enum": [
"SPEECH_MODEL_VARIANT_UNSPECIFIED",
"USE_BEST_AVAILABLE",
"USE_STANDARD",
"USE_ENHANCED"
],
"enumDescriptions": [
"No model variant specified. In this case Dialogflow defaults to\nUSE_BEST_AVAILABLE.",
"Use the best available variant of the Speech\nmodel that the caller is eligible for.\n\nPlease see the [Dialogflow\ndocs](https://cloud.google.com/dialogflow/docs/data-logging) for\nhow to make your project eligible for enhanced models.",
"Use standard model variant even if an enhanced model is available. See the\n[Cloud Speech\ndocumentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)\nfor details about enhanced models.",
"Use an enhanced model variant:\n\n* If an enhanced variant does not exist for the given\n model and request language, Dialogflow falls\n back to the standard variant.\n\n The [Cloud Speech\n documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)\n describes which models have enhanced variants.\n\n* If the API caller isn't eligible for enhanced models, Dialogflow returns\n an error. Please see the [Dialogflow\n docs](https://cloud.google.com/dialogflow/docs/data-logging)\n for how to make your project eligible."
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrase": {
"description": "Represents an example that the agent is trained on.",
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase",
"properties": {
"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"
},
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
},
"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"
},
"GoogleCloudDialogflowV2IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2IntentMessageImage",
"properties": {
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
},
"accessibilityText": {
"description": "Optional. A text description of the image to be used for accessibility,\ne.g., screen readers.",
"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"
},
"GoogleCloudDialogflowV2Message": {
"description": "Represents a message posted into a conversation.",
"id": "GoogleCloudDialogflowV2Message",
"properties": {
"createTime": {
"description": "Output only. The time when the message was created.",
"format": "google-datetime",
"type": "string"
},
"languageCode": {
"description": "Optional. The message language.\nThis should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)\nlanguage tag. Example: \"en-US\".",
"type": "string"
},
"name": {
"description": "The unique identifier of the message.\nFormat: `projects/<Project ID>/conversations/<Conversation\nID>/messages/<Message ID>`.",
"type": "string"
},
"content": {
"description": "Required. The message content.",
"type": "string"
},
"participantRole": {
"description": "Output only. The role of the participant.",
"enum": [
"ROLE_UNSPECIFIED",
"HUMAN_AGENT",
"AUTOMATED_AGENT",
"END_USER"
],
"enumDescriptions": [
"Participant role not set.",
"Participant is a human agent.",
"Participant is an automated agent, such as a Dialogflow agent.",
"Participant is an end user that has called or chatted with\nDialogflow services."
],
"type": "string"
},
"participant": {
"description": "Output only. The participant that sends this message.",
"type": "string"
},
"messageAnnotation": {
"$ref": "GoogleCloudDialogflowV2MessageAnnotation",
"description": "Output only. The annotation for the message."
}
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": {
"description": "Rich Business Messaging (RBM) Media displayed in Cards\nThe following media-types are currently supported:\n\nImage Types\n\n* image/jpeg\n* image/jpg'\n* image/gif\n* image/png\n\nVideo Types\n\n* video/h263\n* video/m4v\n* video/mp4\n* video/mpeg\n* video/mpeg4\n* video/webm",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia",
"properties": {
"fileUri": {
"description": "Required. Publicly reachable URI of the file. The RBM platform\ndetermines the MIME type of the file from the content-type field in\nthe HTTP headers when the platform fetches the file. The content-type\nfield must be present and accurate in the HTTP response from the URL.",
"type": "string"
},
"thumbnailUri": {
"description": "Optional. Publicly reachable URI of the thumbnail.If you don't\nprovide a thumbnail URI, the RBM platform displays a blank\nplaceholder thumbnail until the user's device downloads the file.\nDepending on the user's setting, the file may not download\nautomatically and may require the user to tap a download button.",
"type": "string"
},
"height": {
"description": "Required for cards with vertical orientation. The height of the media\nwithin a rich card with a vertical layout. (https://goo.gl/NeFCjz).\nFor a standalone card with horizontal layout, height is not\ncustomizable, and this field is ignored.",
"enum": [
"HEIGHT_UNSPECIFIED",
"SHORT",
"MEDIUM",
"TALL"
],
"enumDescriptions": [
"Not specified.",
"112 DP.",
"168 DP.",
"264 DP. Not available for rich card carousels when the card width\nis set to small."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListEnvironmentsResponse": {
"description": "The response message for Environments.ListEnvironments.",
"id": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"environments": {
"description": "The list of agent environments. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Environment"
},
"type": "array"
}
},
"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"
},
"GoogleCloudDialogflowV2EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2EntityTypeEntity",
"properties": {
"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 reference 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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2AnnotatedMessagePart": {
"description": "Represents a part of a message possibly annotated with an entity. The part\ncan be an entity or purely a part of the message between two entities or\nmessage start/end.",
"id": "GoogleCloudDialogflowV2AnnotatedMessagePart",
"properties": {
"text": {
"description": "A part of a message possibly annotated with an entity.",
"type": "string"
},
"entityType": {
"description": "The [Dialogflow system entity\ntype](https://cloud.google.com/dialogflow/docs/reference/system-entities)\nof this message part. If this is empty, Dialogflow could not annotate the\nphrase part with a system entity.",
"type": "string"
},
"formattedValue": {
"description": "The [Dialogflow system entity formatted value\n](https://cloud.google.com/dialogflow/docs/reference/system-entities) of\nthis message part. For example for a system entity of type\n`@sys.unit-currency`, this may contain:\n<pre>\n{\n \"amount\": 5,\n \"currency\": \"USD\"\n}\n</pre>",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCard": {
"description": "Table card for Actions on Google.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCard",
"properties": {
"title": {
"description": "Required. Title of the card.",
"type": "string"
},
"rows": {
"description": "Optional. Rows in this table of data.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCardRow"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle to the title.",
"type": "string"
},
"columnProperties": {
"description": "Optional. Display properties for the columns in this table.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageColumnProperties"
},
"type": "array"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Image which should be displayed on the card."
},
"buttons": {
"description": "Optional. List of buttons for the card.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"type": "array"
}
},
"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"
},
"GoogleCloudDialogflowV2QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2QueryResult",
"properties": {
"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"
},
"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"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the\n`sentiment_analysis_request_config` specified in the request."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nThis value is for informational purpose only and is only used to\nhelp match the best intent within the classification threshold.\nThis value may change for the same end-user expression at any time due to a\nmodel retraining or change in implementation.\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"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n\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"
},
"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"
},
"queryText": {
"description": "The original conversational query text:\n\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 automatic spell correction is enabled, `query_text` will contain the\n corrected user input.",
"type": "string"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Free-form diagnostic information for the associated detect intent request.\nThe fields of this data can change without notice, so you should not write\ncode that depends on its structure.\nThe data may contain:\n\n- webhook call latency\n- webhook errors",
"type": "object"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`<parameter name>.original` containing the original parameter values\nbefore the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"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`, `end_interaction` and `is_fallback`."
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes.",
"type": "string"
},
"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"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"action": {
"description": "The action name from the matched intent.",
"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"
},
"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<a href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. 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"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ConversationEvent": {
"description": "Represents a notification sent to Cloud Pub/Sub subscribers for conversation\nlifecycle events.",
"id": "GoogleCloudDialogflowV2ConversationEvent",
"properties": {
"errorStatus": {
"$ref": "GoogleRpcStatus",
"description": "More detailed information about an error. Only set for type\nUNRECOVERABLE_ERROR_IN_PHONE_CALL."
},
"type": {
"description": "The type of the event that this notification refers to.",
"enum": [
"TYPE_UNSPECIFIED",
"CONVERSATION_STARTED",
"CONVERSATION_FINISHED",
"HUMAN_INTERVENTION_NEEDED",
"NEW_MESSAGE",
"UNRECOVERABLE_ERROR"
],
"enumDescriptions": [
"Type not set.",
"A new conversation has been opened. This is fired when a telephone call\nis answered, or a conversation is created via the API.",
"An existing conversation has closed. This is fired when a telephone call\nis terminated, or a conversation is closed via the API.",
"An existing conversation has received notification from Dialogflow that\nhuman intervention is required.",
"An existing conversation has received a new message, either from API or\ntelephony. It is configured in\nConversationProfile.new_message_event_notification_config",
"Unrecoverable error during a telephone call.\n\nIn general non-recoverable errors only occur if something was\nmisconfigured in the ConversationProfile corresponding to the call. After\na non-recoverable error, Dialogflow may stop responding.\n\nWe don't fire this event:\n* in an API call because we can directly return the error, or,\n* when we can recover from an error."
],
"type": "string"
},
"conversation": {
"description": "The unique identifier of the conversation this notification\nrefers to.\nFormat: `projects/<Project ID>/conversations/<Conversation ID>`.",
"type": "string"
},
"newMessagePayload": {
"$ref": "GoogleCloudDialogflowV2Message",
"description": "Payload of NEW_MESSAGE event."
}
},
"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/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": {
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse",
"properties": {
"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": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": {
"description": "Row of TableCard.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow",
"properties": {
"dividerAfter": {
"description": "Optional. Whether to add a visual divider after this row.",
"type": "boolean"
},
"cells": {
"description": "Optional. List of cells that make up this row.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell"
},
"type": "array"
}
},
"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"
},
"GoogleCloudDialogflowV2EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"id": "GoogleCloudDialogflowV2EntityType",
"properties": {
"enableFuzzyExtraction": {
"description": "Optional. Enables fuzzy entity extraction during classification.",
"type": "boolean"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST",
"KIND_REGEXP"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a reference\nvalue.",
"List entity types contain a set of entries that do not map to reference\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases).",
"Regexp entity types allow to specify regular expressions in entries\nvalues."
],
"type": "string"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2WebhookRequest",
"properties": {
"queryResult": {
"$ref": "GoogleCloudDialogflowV2QueryResult",
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
},
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call."
},
"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/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`.",
"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/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/<Project ID>/agent/intents/<Intent ID>`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Environment": {
"description": "Represents an agent environment.",
"id": "GoogleCloudDialogflowV2beta1Environment",
"properties": {
"agentVersion": {
"description": "Optional. The agent version loaded into this environment.\nFormat: `projects/<Project ID>/agent/versions/<Version ID>`.",
"type": "string"
},
"state": {
"description": "Output only. The state of this environment. This field is read-only, i.e., it cannot be\nset by create and update methods.",
"enum": [
"STATE_UNSPECIFIED",
"STOPPED",
"LOADING",
"RUNNING"
],
"enumDescriptions": [
"Not specified. This value is not used.",
"Stopped.",
"Loading.",
"Running."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The last update time of this environment. This field is read-only, i.e., it\ncannot be set by create and update methods.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Output only. The unique identifier of this agent environment.\nFormat: `projects/<Project ID>/agent/environments/<Environment ID>`.\nFor Environment ID, \"-\" is reserved for 'draft' environment.",
"type": "string"
},
"description": {
"description": "Optional. The developer-provided description for this environment.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest",
"properties": {
"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"
},
"entityTypeBatchInline": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeBatch",
"description": "The collection of entity types to update or create."
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2MessageAnnotation": {
"description": "Represents the result of annotation for the message.",
"id": "GoogleCloudDialogflowV2MessageAnnotation",
"properties": {
"containEntities": {
"description": "Indicates whether the text message contains entities.",
"type": "boolean"
},
"parts": {
"description": "The collection of annotated message parts ordered by their\nposition in the message. You can recover the annotated message by\nconcatenating [AnnotatedMessagePart.text].",
"items": {
"$ref": "GoogleCloudDialogflowV2AnnotatedMessagePart"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem": {
"description": "Browsing carousel tile",
"id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem",
"properties": {
"description": {
"description": "Optional. Description of the carousel item. Maximum of four lines of\ntext.",
"type": "string"
},
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"description": "Required. Action to present to the user."
},
"footer": {
"description": "Optional. Text that appears at the bottom of the Browse Carousel\nCard. Maximum of one line of text.",
"type": "string"
},
"title": {
"description": "Required. Title of the carousel item. Maximum of two lines of text.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Hero image for the carousel item."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1DetectIntentRequest": {
"description": "The request to detect user's intent.",
"id": "GoogleCloudDialogflowV2beta1DetectIntentRequest",
"properties": {
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"description": "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."
},
"inputAudio": {
"description": "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"
},
"outputAudioConfigMask": {
"description": "Mask for output_audio_config indicating which settings in this\nrequest-level config should override speech synthesizer settings defined at\nagent-level.\n\nIf unspecified or empty, output_audio_config replaces the agent-level\nconfig in its entirety.",
"format": "google-fieldmask",
"type": "string"
},
"queryInput": {
"$ref": "GoogleCloudDialogflowV2beta1QueryInput",
"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": "GoogleCloudDialogflowV2beta1QueryParameters",
"description": "The parameters of this query."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2ExportAgentResponse",
"properties": {
"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"
},
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ImportAgentRequest": {
"description": "The request message for Agents.ImportAgent.",
"id": "GoogleCloudDialogflowV2beta1ImportAgentRequest",
"properties": {
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".",
"type": "string"
},
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1VoiceSelectionParams": {
"description": "Description of which voice to use for speech synthesis.",
"id": "GoogleCloudDialogflowV2beta1VoiceSelectionParams",
"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\nssml_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"
},
"GoogleCloudDialogflowV2beta1EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2beta1EntityTypeEntity",
"properties": {
"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 reference 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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1DocumentReloadStatus": {
"description": "The status of a reload attempt.",
"id": "GoogleCloudDialogflowV2beta1DocumentReloadStatus",
"properties": {
"time": {
"description": "Output only. The time of a reload attempt.\nThis reload may have been triggered automatically or manually and may\nnot have succeeded.",
"format": "google-datetime",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "Output only. The status of a reload attempt or the initial load."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCard": {
"description": "Table card for Actions on Google.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCard",
"properties": {
"title": {
"description": "Required. Title of the card.",
"type": "string"
},
"rows": {
"description": "Optional. Rows in this table of data.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle to the title.",
"type": "string"
},
"columnProperties": {
"description": "Optional. Display properties for the columns in this table.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties"
},
"type": "array"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Image which should be displayed on the card."
},
"buttons": {
"description": "Optional. List of buttons for the card.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ValidationResult": {
"description": "Represents the output of agent validation.",
"id": "GoogleCloudDialogflowV2beta1ValidationResult",
"properties": {
"validationErrors": {
"description": "Contains all validation errors.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1ValidationError"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest": {
"description": "The request message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest",
"properties": {
"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"
},
"intentBatchInline": {
"$ref": "GoogleCloudDialogflowV2beta1IntentBatch",
"description": "The collection of intents to update or create."
},
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookResponse": {
"description": "The response message for a webhook call.\n\nThis response is validated by the Dialogflow server. If validation fails,\nan error will be returned in the QueryResult.diagnostic_info field.\nSetting JSON fields to an empty value with the wrong type is a common error.\nTo avoid this error:\n\n- Use `\"\"` for empty strings\n- Use `{}` or `null` for empty objects\n- Use `[]` or `null` for empty arrays\n\nFor more information, see the\n[Protocol Buffers Language\nGuide](https://developers.google.com/protocol-buffers/docs/proto3#json).",
"id": "GoogleCloudDialogflowV2WebhookResponse",
"properties": {
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"type": "string"
},
"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"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCardButton": {
"description": "Contains information about a button.",
"id": "GoogleCloudDialogflowV2IntentMessageCardButton",
"properties": {
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
},
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1ReloadDocumentRequest": {
"description": "Request message for Documents.ReloadDocument.",
"id": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest",
"properties": {
"gcsSource": {
"$ref": "GoogleCloudDialogflowV2beta1GcsSource",
"description": "Optional. The path for a Cloud Storage source file for reloading document content.\nIf not provided, the Document's existing source will be reloaded."
}
},
"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"
},
"GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": {
"description": "Response media object for media content card.",
"id": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject",
"properties": {
"name": {
"description": "Required. Name of media card.",
"type": "string"
},
"description": {
"description": "Optional. Description of media card.",
"type": "string"
},
"contentUrl": {
"description": "Required. Url where the media is stored.",
"type": "string"
},
"icon": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Icon to display above media content."
},
"largeImage": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Image to display above media content."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2beta1ExportAgentResponse",
"properties": {
"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"
},
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"properties": {
"version": {
"description": "Optional. The version of the protocol used for this request.\nThis field is AoG-specific.",
"type": "string"
},
"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 Dialogflow Phone Gateway integration, this field has\nthe form:\n<pre>{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}</pre>\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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SpeechContext": {
"description": "Hints for the speech recognizer to help with recognition in a specific\nconversation state.",
"id": "GoogleCloudDialogflowV2beta1SpeechContext",
"properties": {
"phrases": {
"description": "Optional. A list of strings containing words and phrases that the speech\nrecognizer should recognize with higher likelihood.\n\nThis list can be used to:\n* improve accuracy for words and phrases you expect the user to say,\n e.g. typical commands for your Dialogflow agent\n* add additional words to the speech recognizer vocabulary\n* ...\n\nSee the [Cloud Speech\ndocumentation](https://cloud.google.com/speech-to-text/quotas) for usage\nlimits.",
"items": {
"type": "string"
},
"type": "array"
},
"boost": {
"description": "Optional. Boost for this context compared to other contexts:\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"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"
},
"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"
},
"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"
},
"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 be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
}
},
"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"
},
"GoogleCloudDialogflowV2beta1SubAgent": {
"description": "Contains basic configuration for a sub-agent.",
"id": "GoogleCloudDialogflowV2beta1SubAgent",
"properties": {
"project": {
"description": "Required. The project of this agent.\nFormat: `projects/<Project ID>`.",
"type": "string"
},
"environment": {
"description": "Optional. The unique identifier (`environment name` in dialogflow console)\nof this sub-agent environment. Assumes draft environment if `environment`\nis not set.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"properties": {
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig": {
"description": "Configures the types of sentiment analysis to perform.",
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig",
"properties": {
"analyzeQueryTextSentiment": {
"description": "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"
},
"GoogleCloudDialogflowV2beta1SearchAgentsResponse": {
"description": "The response message for Agents.SearchAgents.",
"id": "GoogleCloudDialogflowV2beta1SearchAgentsResponse",
"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": "GoogleCloudDialogflowV2beta1Agent"
},
"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"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse",
"properties": {
"displayText": {
"description": "Optional. The text to display.",
"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"
},
"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"
}
},
"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"
},
"GoogleCloudDialogflowV2IntentMessageMediaContent": {
"description": "The media content card for Actions on Google.",
"id": "GoogleCloudDialogflowV2IntentMessageMediaContent",
"properties": {
"mediaType": {
"description": "Optional. What type of media is the content (ie \"audio\").",
"enum": [
"RESPONSE_MEDIA_TYPE_UNSPECIFIED",
"AUDIO"
],
"enumDescriptions": [
"Unspecified.",
"Response media type is audio."
],
"type": "string"
},
"mediaObjects": {
"description": "Required. List of media objects.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Agent": {
"description": "Represents a conversational agent.",
"id": "GoogleCloudDialogflowV2beta1Agent",
"properties": {
"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"
},
"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"
},
"description": {
"description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"parent": {
"description": "Required. The project of this agent.\nFormat: `projects/<Project ID>`.",
"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"
},
"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/docs/integrations/web-demo)\nintegration.",
"type": "string"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See\n[Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes. This field cannot be\nset by the `Update` method.",
"type": "string"
},
"tier": {
"description": "Optional. The agent tier. If not specified, TIER_STANDARD is assumed.",
"enum": [
"TIER_UNSPECIFIED",
"TIER_STANDARD",
"TIER_ENTERPRISE",
"TIER_ENTERPRISE_PLUS"
],
"enumDescriptions": [
"Not specified. This value should never be used.",
"Standard tier.",
"Enterprise tier (Essentials).",
"Enterprise tier (Plus)."
],
"type": "string"
},
"displayName": {
"description": "Required. The name of this agent.",
"type": "string"
},
"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 custom entities."
],
"type": "string"
},
"enableLogging": {
"description": "Optional. Determines whether this agent should log conversation queries.",
"type": "boolean"
},
"apiVersion": {
"description": "Optional. API version displayed in Dialogflow console. If not specified,\nV2 API is assumed. Clients are free to query different service endpoints\nfor different API versions. However, bots connectors and webhook calls will\nfollow the specified API version.",
"enum": [
"API_VERSION_UNSPECIFIED",
"API_VERSION_V1",
"API_VERSION_V2",
"API_VERSION_V2_BETA_1"
],
"enumDescriptions": [
"Not specified.",
"Legacy V1 API.",
"V2 API.",
"V2beta1 API."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1QueryInput": {
"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": "GoogleCloudDialogflowV2beta1QueryInput",
"properties": {
"event": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "The event to be processed."
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1TextInput",
"description": "The natural language text to be processed."
},
"audioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig",
"description": "Instructs the speech recognizer how to process the speech audio."
}
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchCreateEntities.",
"id": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest",
"properties": {
"languageCode": {
"description": "Optional. The language used to access language-specific data.\nIf not specified, the agent's default language is used.\nFor more information, see\n[Multilingual intent and entity\ndata](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
},
"entities": {
"description": "Required. The entities to create.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1RestoreAgentRequest": {
"description": "The request message for Agents.RestoreAgent.",
"id": "GoogleCloudDialogflowV2beta1RestoreAgentRequest",
"properties": {
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
"type": "string"
},
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1DetectIntentResponse": {
"description": "The message returned from the DetectIntent method.",
"id": "GoogleCloudDialogflowV2beta1DetectIntentResponse",
"properties": {
"queryResult": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult",
"description": "The selected results of the conversational query or event processing.\nSee `alternative_query_results` for additional potential results."
},
"webhookStatus": {
"$ref": "GoogleRpcStatus",
"description": "Specifies the status of the webhook request."
},
"alternativeQueryResults": {
"description": "If Knowledge Connectors are enabled, there could be more than one result\nreturned for a given query or event, and this field will contain all\nresults except for the top one, which is captured in query_result. The\nalternative results are ordered by decreasing\n`QueryResult.intent_detection_confidence`. If Knowledge Connectors are\ndisabled, this field will be empty until multiple responses for regular\nintents are supported, at which point those additional results will be\nsurfaced here.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"type": "array"
},
"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"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"description": "The config used by the speech synthesizer to generate the output audio."
},
"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"
}
},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"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-<Project\nNumber>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account\nwhere <Project Number> 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"
},
"GoogleCloudDialogflowV2beta1WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2beta1WebhookRequest",
"properties": {
"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/<Project ID>/agent/sessions/<Session ID>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>`.",
"type": "string"
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult",
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
},
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call."
},
"alternativeQueryResults": {
"description": "Alternative query results from KnowledgeService.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelect",
"properties": {
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
},
"subtitle": {
"description": "Optional. Subtitle of the list.",
"type": "string"
},
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton",
"properties": {
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
},
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": {
"description": "Cell of TableCardRow.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell",
"properties": {
"text": {
"description": "Required. Text in this cell.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Fulfillment": {
"description": "Represents a fulfillment.",
"id": "GoogleCloudDialogflowV2beta1Fulfillment",
"properties": {
"genericWebService": {
"$ref": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService",
"description": "Configuration for a generic web service."
},
"features": {
"description": "Optional. The field defines whether the fulfillment is enabled for certain features.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1FulfillmentFeature"
},
"type": "array"
},
"name": {
"description": "Required. The unique identifier of the fulfillment.\nFormat: `projects/<Project ID>/agent/fulfillment`.",
"type": "string"
},
"displayName": {
"description": "Optional. The human-readable name of the fulfillment, unique within the agent.",
"type": "string"
},
"enabled": {
"description": "Optional. Whether fulfillment is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": {
"description": "Opens the user's default dialer app with the specified phone number\nbut does not dial automatically (https://goo.gl/ergbB2).",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial",
"properties": {
"phoneNumber": {
"description": "Required. The phone number to fill in the default dialer app.\nThis field should be in [E.164](https://en.wikipedia.org/wiki/E.164)\nformat. An example of a correctly formatted phone number:\n+15556767888.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1FulfillmentFeature": {
"description": "Whether fulfillment is enabled for the specific feature.",
"id": "GoogleCloudDialogflowV2beta1FulfillmentFeature",
"properties": {
"type": {
"description": "The type of the feature that enabled for fulfillment.",
"enum": [
"TYPE_UNSPECIFIED",
"SMALLTALK"
],
"enumDescriptions": [
"Feature type not specified.",
"Fulfillment is enabled for SmallTalk."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": {
"description": "Browse Carousel Card for Actions on Google.\nhttps://developers.google.com/actions/assistant/responses#browsing_carousel",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard",
"properties": {
"imageDisplayOptions": {
"description": "Optional. Settings for displaying the image. Applies to every image in\nitems.",
"enum": [
"IMAGE_DISPLAY_OPTIONS_UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED",
"BLURRED_BACKGROUND"
],
"enumDescriptions": [
"Fill the gaps between the image and the image container with gray\nbars.",
"Fill the gaps between the image and the image container with gray\nbars.",
"Fill the gaps between the image and the image container with white\nbars.",
"Image is scaled such that the image width and height match or exceed\nthe container dimensions. This may crop the top and bottom of the\nimage if the scaled image height is greater than the container\nheight, or crop the left and right of the image if the scaled image\nwidth is greater than the container width. This is similar to \"Zoom\nMode\" on a widescreen TV when playing a 4:3 video.",
"Pad the gaps between image and image frame with a blurred copy of the\nsame image."
],
"type": "string"
},
"items": {
"description": "Required. List of items in the Browse Carousel Card. Minimum of two\nitems, maximum of ten.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelectItem",
"properties": {
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
},
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": {
"description": "Actions on Google action to open a given url.",
"id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"properties": {
"urlTypeHint": {
"description": "Optional. Specifies the type of viewer that is used when opening\nthe URL. Defaults to opening via web browser.",
"enum": [
"URL_TYPE_HINT_UNSPECIFIED",
"AMP_ACTION",
"AMP_CONTENT"
],
"enumDescriptions": [
"Unspecified",
"Url would be an amp action",
"URL that points directly to AMP content, or to a canonical URL\nwhich refers to AMP content via <link rel=\"amphtml\">."
],
"type": "string"
},
"url": {
"description": "Required. URL",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": {
"description": "Rich Business Messaging (RBM) suggested reply that the user can click\ninstead of typing in their own response.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply",
"properties": {
"postbackData": {
"description": "Opaque payload that the Dialogflow receives in a user event\nwhen the user taps the suggested reply. This data will be also\nforwarded to webhook to allow performing custom business logic.",
"type": "string"
},
"text": {
"description": "Suggested reply text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest": {
"description": "The request message for Intents.BatchDeleteIntents.",
"id": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest",
"properties": {
"intents": {
"description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"type": "array"
}
},
"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 Dialogflow Phone Gateway integration, this field has\nthe form:\n<pre>{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}</pre>\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"
},
"GoogleCloudDialogflowV2beta1WebhookResponse": {
"description": "The response message for a webhook call.\n\nThis response is validated by the Dialogflow server. If validation fails,\nan error will be returned in the QueryResult.diagnostic_info field.\nSetting JSON fields to an empty value with the wrong type is a common error.\nTo avoid this error:\n\n- Use `\"\"` for empty strings\n- Use `{}` or `null` for empty objects\n- Use `[]` or `null` for empty arrays\n\nFor more information, see the\n[Protocol Buffers Language\nGuide](https://developers.google.com/protocol-buffers/docs/proto3#json).",
"id": "GoogleCloudDialogflowV2beta1WebhookResponse",
"properties": {
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields."
},
"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"
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"type": "string"
},
"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"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCardRow": {
"description": "Row of TableCard.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCardRow",
"properties": {
"dividerAfter": {
"description": "Optional. Whether to add a visual divider after this row.",
"type": "boolean"
},
"cells": {
"description": "Optional. List of cells that make up this row.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCardCell"
},
"type": "array"
}
},
"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"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": {
"description": "Browse Carousel Card for Actions on Google.\nhttps://developers.google.com/actions/assistant/responses#browsing_carousel",
"id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard",
"properties": {
"items": {
"description": "Required. List of items in the Browse Carousel Card. Minimum of two\nitems, maximum of ten.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem"
},
"type": "array"
},
"imageDisplayOptions": {
"description": "Optional. Settings for displaying the image. Applies to every image in\nitems.",
"enum": [
"IMAGE_DISPLAY_OPTIONS_UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED",
"BLURRED_BACKGROUND"
],
"enumDescriptions": [
"Fill the gaps between the image and the image container with gray\nbars.",
"Fill the gaps between the image and the image container with gray\nbars.",
"Fill the gaps between the image and the image container with white\nbars.",
"Image is scaled such that the image width and height match or exceed\nthe container dimensions. This may crop the top and bottom of the\nimage if the scaled image height is greater than the container\nheight, or crop the left and right of the image if the scaled image\nwidth is greater than the container width. This is similar to \"Zoom\nMode\" on a widescreen TV when playing a 4:3 video.",
"Pad the gaps between image and image frame with a blurred copy of the\nsame image."
],
"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"
},
"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"
},
"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"
},
"GoogleCloudDialogflowV2beta1Document": {
"description": "A document resource.\n\nNote: The `projects.agent.knowledgeBases.documents` resource is deprecated;\nonly use `projects.knowledgeBases.documents`.",
"id": "GoogleCloudDialogflowV2beta1Document",
"properties": {
"content": {
"description": "The raw content of the document. This field is only permitted for\nEXTRACTIVE_QA and FAQ knowledge types.\nNote: This field is in the process of being deprecated, please use\nraw_content instead.",
"type": "string"
},
"mimeType": {
"description": "Required. The MIME type of this document.",
"type": "string"
},
"knowledgeTypes": {
"description": "Required. The knowledge type of document content.",
"enumDescriptions": [
"The type is unspecified or arbitrary.",
"The document content contains question and answer pairs as either HTML or\nCSV. Typical FAQ HTML formats are parsed accurately, but unusual formats\nmay fail to be parsed.\n\nCSV must have questions in the first column and answers in the second,\nwith no header. Because of this explicit format, they are always parsed\naccurately.",
"Documents for which unstructured text is extracted and used for\nquestion answering."
],
"items": {
"enum": [
"KNOWLEDGE_TYPE_UNSPECIFIED",
"FAQ",
"EXTRACTIVE_QA"
],
"type": "string"
},
"type": "array"
},
"rawContent": {
"description": "The raw content of the document. This field is only permitted for\nEXTRACTIVE_QA and FAQ knowledge types.",
"format": "byte",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the document. The name must be 1024 bytes or\nless; otherwise, the creation request fails.",
"type": "string"
},
"contentUri": {
"description": "The URI where the file content is located.\n\nFor documents stored in Google Cloud Storage, these URIs must have\nthe form `gs://<bucket-name>/<object-name>`.\n\nNOTE: External URLs must correspond to public webpages, i.e., they must\nbe indexed by Google Search. In particular, URLs for showing documents in\nGoogle Cloud Storage (i.e. the URL in your browser) are not supported.\nInstead use the `gs://` format URI described above.",
"type": "string"
},
"enableAutoReload": {
"description": "Optional. If true, we try to automatically reload the document every day\n(at a time picked by the system). If false or unspecified, we don't try\nto automatically reload the document.\n\nCurrently you can only enable automatic reload for documents sourced from\na public url, see `source` field for the source types.\n\nReload status can be tracked in `latest_reload_status`. If a reload\nfails, we will keep the document unchanged.\n\nIf a reload fails with internal errors, the system will try to reload the\ndocument on the next day.\nIf a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the\nsystem will not try to reload the document anymore. You need to manually\nreload the document successfully by calling `ReloadDocument` and clear the\nerrors.",
"type": "boolean"
},
"latestReloadStatus": {
"$ref": "GoogleCloudDialogflowV2beta1DocumentReloadStatus",
"description": "Output only. The time and status of the latest reload.\nThis reload may have been triggered automatically or manually\nand may not have succeeded."
},
"name": {
"description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base\nID>/documents/<Document ID>`.",
"type": "string"
}
},
"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": {
"name": {
"description": "The unique identifier of the entity type.\nRequired for EntityTypes.UpdateEntityType and\nEntityTypes.BatchUpdateEntityTypes methods.\nFormat: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.",
"type": "string"
},
"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"
},
"enableFuzzyExtraction": {
"description": "Optional. Enables fuzzy entity extraction during classification.",
"type": "boolean"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST",
"KIND_REGEXP"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a reference\nvalue.",
"List entity types contain a set of entries that do not map to reference\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases).",
"Regexp entity types allow to specify regular expressions in entries\nvalues."
],
"type": "string"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1QueryParameters": {
"description": "Represents the parameters of the conversational query.",
"id": "GoogleCloudDialogflowV2beta1QueryParameters",
"properties": {
"knowledgeBaseNames": {
"description": "KnowledgeBases to get alternative results from. If not set, the\nKnowledgeBases enabled in the agent (through UI) will be used.\nFormat: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.",
"items": {
"type": "string"
},
"type": "array"
},
"contexts": {
"description": "The collection of contexts to be activated before this query is\nexecuted.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"sentimentAnalysisRequestConfig": {
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig",
"description": "Configures the type of sentiment analysis to perform. If not\nprovided, sentiment analysis is not performed.\nNote: Sentiment Analysis is only currently available for Enterprise Edition\nagents."
},
"timeZone": {
"description": "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"
},
"sessionEntityTypes": {
"description": "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": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"type": "array"
},
"webhookHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "This field can be used to pass HTTP headers for a webhook\ncall. These headers will be sent to webhook alone with the headers that\nhave been configured through Dialogflow web console. The headers defined\nwithin this field will overwrite the headers configured through Dialogflow\nconsole if there is a conflict. Header names are case-insensitive.\nGoogle's specified headers are not allowed. Including: \"Host\",\n\"Content-Length\", \"Connection\", \"From\", \"User-Agent\", \"Accept-Encoding\",\n\"If-Modified-Since\", \"If-None-Match\", \"X-Forwarded-For\", etc.",
"type": "object"
},
"subAgents": {
"description": "For mega agent query, directly specify which sub agents to query.\nIf any specified sub agent is not linked to the mega agent, an error will\nbe returned. If empty, Dialogflow will decide which sub agents to query.\nIf specified for a non-mega-agent query, will be silently ignored.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SubAgent"
},
"type": "array"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "This field can be used to pass custom data to your webhook.\nArbitrary JSON objects are supported.\nIf supplied, the value is used to populate the\n`WebhookRequest.original_detect_intent_request.payload`\nfield sent to your webhook.",
"type": "object"
},
"geoLocation": {
"$ref": "GoogleTypeLatLng",
"description": "The geo location of this conversational query."
},
"resetContexts": {
"description": "Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse",
"properties": {
"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"
},
"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"
},
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SessionEntityType": {
"description": "Represents a session entity type.\n\nExtends or replaces a custom entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"custom entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
"id": "GoogleCloudDialogflowV2beta1SessionEntityType",
"properties": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type\nDisplay Name>`, or\n`projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`<Entity Type Display Name>` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"type": "string"
},
"entityOverrideMode": {
"description": "Required. Indicates whether the additional data should override or\nsupplement the custom 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 custom entity type.",
"The collection of session entities extends the collection of entities in\nthe corresponding custom 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 custom entity type\nand merge."
],
"type": "string"
},
"entities": {
"description": "Required. The collection of entities associated with this session entity\ntype.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse": {
"description": "Response message for KnowledgeBases.ListKnowledgeBases.",
"id": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse",
"properties": {
"knowledgeBases": {
"description": "The list of knowledge bases.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"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"
},
"GoogleCloudDialogflowV2beta1QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2beta1QueryResult",
"properties": {
"queryText": {
"description": "The original conversational query text:\n\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 automatic spell correction is enabled, `query_text` will contain the\n corrected user input.",
"type": "string"
},
"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"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Free-form diagnostic information for the associated detect intent request.\nThe fields of this data can change without notice, so you should not write\ncode that depends on its structure.\nThe data may contain:\n\n- webhook call latency\n- webhook errors",
"type": "object"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`<parameter name>.original` containing the original parameter values\nbefore the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes.",
"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`, `end_interaction` and `is_fallback`."
},
"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"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"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"
},
"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"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
},
"knowledgeAnswers": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"description": "The result from Knowledge Connector (if any), ordered by decreasing\n`KnowledgeAnswers.match_confidence`."
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the\n`sentiment_analysis_request_config` specified in the request."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nThis value is for informational purpose only and is only used to\nhelp match the best intent within the classification threshold.\nThis value may change for the same end-user expression at any time due to a\nmodel retraining or change in implementation.\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"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n\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"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": {
"description": "Response media object for media content card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject",
"properties": {
"largeImage": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Image to display above media content."
},
"name": {
"description": "Required. Name of media card.",
"type": "string"
},
"description": {
"description": "Optional. Description of media card.",
"type": "string"
},
"contentUrl": {
"description": "Required. Url where the media is stored.",
"type": "string"
},
"icon": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Icon to display above media content."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1TrainAgentRequest": {
"description": "The request message for Agents.TrainAgent.",
"id": "GoogleCloudDialogflowV2beta1TrainAgentRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageColumnProperties": {
"description": "Column properties for TableCard.",
"id": "GoogleCloudDialogflowV2IntentMessageColumnProperties",
"properties": {
"horizontalAlignment": {
"description": "Optional. Defines text alignment for all cells in this column.",
"enum": [
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
"LEADING",
"CENTER",
"TRAILING"
],
"enumDescriptions": [
"Text is aligned to the leading edge of the column.",
"Text is aligned to the leading edge of the column.",
"Text is centered in the column.",
"Text is aligned to the trailing edge of the column."
],
"type": "string"
},
"header": {
"description": "Required. Column heading.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Context": {
"description": "Represents a context.",
"id": "GoogleCloudDialogflowV2Context",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the\ncontext expires. The default is `0`. If set to `0`, 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/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,\nor `projects/<Project ID>/agent/environments/<Environment ID>/users/<User\nID>/sessions/<Session ID>/contexts/<Context ID>`.\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.\n\nThe following context names are reserved for internal use by Dialogflow.\nYou should not use these contexts or create contexts with these names:\n\n* `__system_counters__`\n* `*_id_dialog_context`\n* `*_dialog_params_size`",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n- MapKey type: string\n- MapKey value: parameter name\n- MapValue type:\n - If parameter's entity type is a composite entity: map\n - Else: string or number, depending on parameter value type\n- MapValue value:\n - If parameter's entity type is a composite entity:\n map from composite entity property names to property values\n - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem",
"properties": {
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
},
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Dialogflow API",
"version": "v2beta1",
"version_module": true
}