Google Git
Sign in
code / google-api-go-client / refs/heads/master / . / dialogflow / v2 / dialogflow-api.json
blob: de1d5da2111e2d1226d25fb35b096a84d657ddf0 [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/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "dialogflow:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://dialogflow.mtls.googleapis.com/",
"name": "dialogflow",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"deleteAgent": {
"description": "Deletes the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent",
"httpMethod": "DELETE",
"id": "dialogflow.projects.deleteAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to delete is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+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.",
"flatPath": "v2/projects/{projectsId}/agent",
"httpMethod": "GET",
"id": "dialogflow.projects.getAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to fetch is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent",
"response": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"setAgent": {
"description": "Creates/updates the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent",
"httpMethod": "POST",
"id": "dialogflow.projects.setAgent",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project of this agent. Format: `projects/`.",
"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": "v2/{+parent}/agent",
"request": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"agent": {
"methods": {
"export": {
"description": "Exports the specified agent to a ZIP file. Operation ",
"flatPath": "v2/projects/{projectsId}/agent:export",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.export",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to export is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:export",
"request": {
"$ref": "GoogleCloudDialogflowV2ExportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"getFulfillment": {
"description": "Retrieves the fulfillment.",
"flatPath": "v2/projects/{projectsId}/agent/fulfillment",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.getFulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the fulfillment. Format: `projects//agent/fulfillment`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/fulfillment$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Fulfillment"
},
"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 training time and is updated automatically when training is completed.",
"flatPath": "v2/projects/{projectsId}/agent/validationResult",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.getValidationResult",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project that the agent is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent/validationResult",
"response": {
"$ref": "GoogleCloudDialogflowV2ValidationResult"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"import": {
"description": "Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.",
"flatPath": "v2/projects/{projectsId}/agent:import",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to import is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:import",
"request": {
"$ref": "GoogleCloudDialogflowV2ImportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"restore": {
"description": "Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.",
"flatPath": "v2/projects/{projectsId}/agent:restore",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.restore",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to restore is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:restore",
"request": {
"$ref": "GoogleCloudDialogflowV2RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"search": {
"description": "Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id \"-\". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).",
"flatPath": "v2/projects/{projectsId}/agent:search",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.search",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project to list agents from. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:search",
"response": {
"$ref": "GoogleCloudDialogflowV2SearchAgentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"train": {
"description": "Trains the specified agent. Operation ",
"flatPath": "v2/projects/{projectsId}/agent:train",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.train",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to train is associated with. Format: `projects/`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/agent:train",
"request": {
"$ref": "GoogleCloudDialogflowV2TrainAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"updateFulfillment": {
"description": "Updates the fulfillment.",
"flatPath": "v2/projects/{projectsId}/agent/fulfillment",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.updateFulfillment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the fulfillment. Format: `projects//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 present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Fulfillment"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Fulfillment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"batchDelete": {
"description": "Deletes entity types in the specified agent. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates/Creates multiple entity types in the specified agent. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create entity types in. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an entity type in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to create a entity type for. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the entity type. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all entity types in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all entity types from. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified entity type.",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entities": {
"methods": {
"batchCreate": {
"description": "Creates multiple new entities in the specified entity type. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchCreate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchCreateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchDelete": {
"description": "Deletes entities in the specified entity type. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"environments": {
"methods": {
"list": {
"description": "Returns the list of all non-draft environments of the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/environments",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all environments from. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/environments",
"response": {
"$ref": "GoogleCloudDialogflowV2ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"users": {
"resources": {
"sessions": {
"methods": {
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts",
"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: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}:detectIntent",
"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: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"contexts": {
"methods": {
"create": {
"description": "Creates a context. If the specified context already exists, overrides the context.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"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: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts",
"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 default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_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": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"create": {
"description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes",
"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. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"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: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"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: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.",
"location": "path",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
}
}
},
"intents": {
"methods": {
"batchDelete": {
"description": "Deletes intents in the specified agent. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/intents:batchDelete",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to delete all entities types for. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents:batchDelete",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchDeleteIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"batchUpdate": {
"description": "Updates/Creates multiple intents in the specified agent. Operation ",
"flatPath": "v2/projects/{projectsId}/agent/intents:batchUpdate",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create intents in. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents:batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2BatchUpdateIntentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"create": {
"description": "Creates an intent in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/intents",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.intents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to create a intent for. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents",
"request": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified intent and its direct or indirect followup intents.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.intents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects//agent/intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified intent.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.intents.get",
"parameterOrder": [
"name"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the intent. Format: `projects//agent/intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all intents in the specified agent.",
"flatPath": "v2/projects/{projectsId}/agent/intents",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.intents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The agent to list all intents from. Format: `projects//agent`.",
"location": "path",
"pattern": "^projects/[^/]+/agent$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/intents",
"response": {
"$ref": "GoogleCloudDialogflowV2ListIntentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified intent.",
"flatPath": "v2/projects/{projectsId}/agent/intents/{intentsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.intents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"location": "query",
"type": "string"
},
"name": {
"description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"sessions": {
"methods": {
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.deleteContexts",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowV2DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"contexts": {
"methods": {
"create": {
"description": "Creates a context. If the specified context already exists, overrides the context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.contexts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.contexts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all contexts in the specified session.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.contexts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/contexts",
"response": {
"$ref": "GoogleCloudDialogflowV2ListContextsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified context.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.contexts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"response": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"entityTypes": {
"methods": {
"create": {
"description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.agent.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.agent.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.agent.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowV2ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.",
"flatPath": "v2/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.agent.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.",
"location": "path",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
},
"locations": {
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"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": "v2/{+name}:cancel",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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 method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"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": "v2/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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 server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations",
"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"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"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 makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v2/projects/{projectsId}/operations/{operationsId}:cancel",
"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": "v2/{+name}:cancel",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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 method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v2/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v2/projects/{projectsId}/operations",
"httpMethod": "GET",
"id": "dialogflow.projects.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/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
},
"revision": "20201017",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowCxV3PageInfo": {
"description": "Represents page information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3PageInfo",
"properties": {
"currentPage": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.",
"type": "string"
},
"formInfo": {
"$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfo",
"description": "Optional for both WebhookRequest and WebhookResponse. Information about the form."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3PageInfoFormInfo": {
"description": "Represents form information.",
"id": "GoogleCloudDialogflowCxV3PageInfoFormInfo",
"properties": {
"parameterInfo": {
"description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo": {
"description": "Represents parameter information.",
"id": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo",
"properties": {
"displayName": {
"description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.",
"type": "string"
},
"justCollected": {
"description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.",
"type": "boolean"
},
"required": {
"description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.",
"type": "boolean"
},
"state": {
"description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.",
"enum": [
"PARAMETER_STATE_UNSPECIFIED",
"EMPTY",
"INVALID",
"FILLED"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Indicates that the parameter does not have a value.",
"Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.",
"Indicates that the parameter has a value."
],
"type": "string"
},
"value": {
"description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessage": {
"description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.",
"id": "GoogleCloudDialogflowCxV3ResponseMessage",
"properties": {
"conversationSuccess": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess",
"description": "Indicates that the conversation succeeded."
},
"endInteraction": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction",
"description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.",
"readOnly": true
},
"liveAgentHandoff": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff",
"description": "Hands off conversation to a human agent."
},
"mixedAudio": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio",
"description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"readOnly": true
},
"outputAudioText": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText",
"description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.",
"type": "object"
},
"playAudio": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio",
"description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way."
},
"text": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageText",
"description": "Returns a text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess": {
"description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageEndInteraction": {
"description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff": {
"description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageMixedAudio": {
"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio",
"properties": {
"segments": {
"description": "Segments this audio response is composed of.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment": {
"description": "Represents one segment of audio.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"audio": {
"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.",
"format": "byte",
"type": "string"
},
"uri": {
"description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText": {
"description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"ssml": {
"description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).",
"type": "string"
},
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessagePlayAudio": {
"description": "Specifies an audio clip to be played by the client as part of the response.",
"id": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"audioUri": {
"description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowCxV3ResponseMessageText",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"text": {
"description": "Required. A collection of text responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3SessionInfo": {
"description": "Represents session information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3SessionInfo",
"properties": {
"parameters": {
"additionalProperties": {
"type": "any"
},
"description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.",
"type": "object"
},
"session": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a user. Format: `projects//locations//agents//sessions/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3WebhookRequest",
"properties": {
"detectIntentResponseId": {
"description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.",
"type": "string"
},
"fulfillmentInfo": {
"$ref": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo",
"description": "Always present. Information about the fulfillment that triggered this webhook call."
},
"intentInfo": {
"$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo",
"description": "Information about the last matched intent."
},
"messages": {
"description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;",
"items": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessage"
},
"type": "array"
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3PageInfo",
"description": "Information about page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom data set in QueryParameters.payload.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3SessionInfo",
"description": "Information about session status."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo": {
"description": "Represents fulfillment information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo",
"properties": {
"tag": {
"description": "Always present. The tag used to identify which fulfillment is being called.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookRequestIntentInfo": {
"description": "Represents intent information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo",
"properties": {
"lastMatchedIntent": {
"description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue"
},
"description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue": {
"description": "Represents a value for an intent parameter.",
"id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue",
"properties": {
"originalValue": {
"description": "Always present. Original text value extracted from user utterance.",
"type": "string"
},
"resolvedValue": {
"description": "Always present. Structured value for the parameter extracted from user utterance.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookResponse": {
"description": "The response message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3WebhookResponse",
"properties": {
"fulfillmentResponse": {
"$ref": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse",
"description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user."
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3PageInfo",
"description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Value to append directly to QueryResult.webhook_payloads.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3SessionInfo",
"description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status."
},
"targetFlow": {
"description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.",
"type": "string"
},
"targetPage": {
"description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse": {
"description": "Represents a fulfillment response to the user.",
"id": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse",
"properties": {
"mergeBehavior": {
"description": "Merge behavior for `messages`.",
"enum": [
"MERGE_BEHAVIOR_UNSPECIFIED",
"APPEND",
"REPLACE"
],
"enumDescriptions": [
"Not specified. `APPEND` will be used.",
"`messages` will be appended to the list of messages waiting to be sent to the user.",
"`messages` will replace the list of messages waiting to be sent to the user."
],
"type": "string"
},
"messages": {
"description": "The list of rich message responses to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3ResponseMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": {
"description": "Metadata associated with the long running operation for Versions.CreateVersion.",
"id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata",
"properties": {
"version": {
"description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse",
"properties": {
"agentContent": {
"description": "Uncompressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfo": {
"description": "Represents page information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfo",
"properties": {
"currentPage": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.",
"type": "string"
},
"formInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo",
"description": "Optional for both WebhookRequest and WebhookResponse. Information about the form."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": {
"description": "Represents form information.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo",
"properties": {
"parameterInfo": {
"description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": {
"description": "Represents parameter information.",
"id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo",
"properties": {
"displayName": {
"description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.",
"type": "string"
},
"justCollected": {
"description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.",
"type": "boolean"
},
"required": {
"description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.",
"type": "boolean"
},
"state": {
"description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.",
"enum": [
"PARAMETER_STATE_UNSPECIFIED",
"EMPTY",
"INVALID",
"FILLED"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Indicates that the parameter does not have a value.",
"Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.",
"Indicates that the parameter has a value."
],
"type": "string"
},
"value": {
"description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessage": {
"description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessage",
"properties": {
"conversationSuccess": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess",
"description": "Indicates that the conversation succeeded."
},
"endInteraction": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction",
"description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.",
"readOnly": true
},
"liveAgentHandoff": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff",
"description": "Hands off conversation to a human agent."
},
"mixedAudio": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio",
"description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"readOnly": true
},
"outputAudioText": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText",
"description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.",
"type": "object"
},
"playAudio": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio",
"description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way."
},
"text": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText",
"description": "Returns a text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": {
"description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": {
"description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": {
"description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": {
"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio",
"properties": {
"segments": {
"description": "Segments this audio response is composed of.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": {
"description": "Represents one segment of audio.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"audio": {
"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.",
"format": "byte",
"type": "string"
},
"uri": {
"description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": {
"description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"ssml": {
"description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).",
"type": "string"
},
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": {
"description": "Specifies an audio clip to be played by the client as part of the response.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"audioUri": {
"description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1ResponseMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowCxV3beta1ResponseMessageText",
"properties": {
"allowPlaybackInterruption": {
"description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.",
"readOnly": true,
"type": "boolean"
},
"text": {
"description": "Required. A collection of text responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1SessionInfo": {
"description": "Represents session information communicated to and from the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"properties": {
"parameters": {
"additionalProperties": {
"type": "any"
},
"description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.",
"type": "object"
},
"session": {
"description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a user. Format: `projects//locations//agents//sessions/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
"properties": {
"detectIntentResponseId": {
"description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.",
"type": "string"
},
"fulfillmentInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo",
"description": "Always present. Information about the fulfillment that triggered this webhook call."
},
"intentInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo",
"description": "Information about the last matched intent."
},
"messages": {
"description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage"
},
"type": "array"
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfo",
"description": "Information about page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom data set in QueryParameters.payload.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"description": "Information about session status."
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": {
"description": "Represents fulfillment information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo",
"properties": {
"tag": {
"description": "Always present. The tag used to identify which fulfillment is being called.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": {
"description": "Represents intent information communicated to the webhook.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo",
"properties": {
"lastMatchedIntent": {
"description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue"
},
"description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": {
"description": "Represents a value for an intent parameter.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue",
"properties": {
"originalValue": {
"description": "Always present. Original text value extracted from user utterance.",
"type": "string"
},
"resolvedValue": {
"description": "Always present. Structured value for the parameter extracted from user utterance.",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookResponse": {
"description": "The response message for a webhook call.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookResponse",
"properties": {
"fulfillmentResponse": {
"$ref": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse",
"description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user."
},
"pageInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1PageInfo",
"description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Value to append directly to QueryResult.webhook_payloads.",
"type": "object"
},
"sessionInfo": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo",
"description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status."
},
"targetFlow": {
"description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.",
"type": "string"
},
"targetPage": {
"description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": {
"description": "Represents a fulfillment response to the user.",
"id": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse",
"properties": {
"mergeBehavior": {
"description": "Merge behavior for `messages`.",
"enum": [
"MERGE_BEHAVIOR_UNSPECIFIED",
"APPEND",
"REPLACE"
],
"enumDescriptions": [
"Not specified. `APPEND` will be used.",
"`messages` will be appended to the list of messages waiting to be sent to the user.",
"`messages` will replace the list of messages waiting to be sent to the user."
],
"type": "string"
},
"messages": {
"description": "The list of rich message responses to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Agent": {
"description": "A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).",
"id": "GoogleCloudDialogflowV2Agent",
"properties": {
"apiVersion": {
"description": "Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow 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"
},
"avatarUri": {
"description": "Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.",
"type": "string"
},
"classificationThreshold": {
"description": "Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.",
"format": "float",
"type": "number"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.",
"type": "string"
},
"description": {
"description": "Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"displayName": {
"description": "Required. The name of this agent.",
"type": "string"
},
"enableLogging": {
"description": "Optional. Determines whether this agent should log conversation queries.",
"type": "boolean"
},
"matchMode": {
"description": "Optional. Determines how intents are detected from user queries.",
"enum": [
"MATCH_MODE_UNSPECIFIED",
"MATCH_MODE_HYBRID",
"MATCH_MODE_ML_ONLY"
],
"enumDescriptions": [
"Not specified.",
"Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.",
"Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large custom entities."
],
"type": "string"
},
"parent": {
"description": "Required. The project of this agent. Format: `projects/`.",
"type": "string"
},
"supportedLanguageCodes": {
"description": "Optional. The list of all languages supported by this agent (except for the `default_language_code`).",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"timeZone": {
"description": "Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2AnnotatedMessagePart": {
"description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.",
"id": "GoogleCloudDialogflowV2AnnotatedMessagePart",
"properties": {
"entityType": {
"description": "The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.",
"type": "string"
},
"formattedValue": {
"description": "The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { \"amount\": 5, \"currency\": \"USD\" } ",
"type": "any"
},
"text": {
"description": "A part of a message possibly annotated with an entity.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchCreateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchCreateEntities.",
"id": "GoogleCloudDialogflowV2BatchCreateEntitiesRequest",
"properties": {
"entities": {
"description": "Required. The entities to create.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteEntitiesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntities.",
"id": "GoogleCloudDialogflowV2BatchDeleteEntitiesRequest",
"properties": {
"entityValues": {
"description": "Required. The reference `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/`.",
"items": {
"type": "string"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest",
"properties": {
"entityTypeNames": {
"description": "Required. The names entity types to delete. All names must point to the same agent as `parent`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchDeleteIntentsRequest": {
"description": "The request message for Intents.BatchDeleteIntents.",
"id": "GoogleCloudDialogflowV2BatchDeleteIntentsRequest",
"properties": {
"intents": {
"description": "Required. The collection of intents to delete. Only intent `name` must be filled in.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntities.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntitiesRequest",
"properties": {
"entities": {
"description": "Required. The entities to update or create.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](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"
},
"GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest",
"properties": {
"entityTypeBatchInline": {
"$ref": "GoogleCloudDialogflowV2EntityTypeBatch",
"description": "The collection of entity types to update or create."
},
"entityTypeBatchUri": {
"description": "The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with \"gs://\".",
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](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"
},
"GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2BatchUpdateIntentsRequest": {
"id": "GoogleCloudDialogflowV2BatchUpdateIntentsRequest",
"properties": {
"intentBatchInline": {
"$ref": "GoogleCloudDialogflowV2IntentBatch",
"description": "The collection of intents to update or create."
},
"intentBatchUri": {
"description": "The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with \"gs://\".",
"type": "string"
},
"intentView": {
"description": "Optional. The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"type": "string"
},
"languageCode": {
"description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](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"
},
"GoogleCloudDialogflowV2BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Context": {
"description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).",
"id": "GoogleCloudDialogflowV2Context",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ConversationEvent": {
"description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.",
"id": "GoogleCloudDialogflowV2ConversationEvent",
"properties": {
"conversation": {
"description": "The unique identifier of the conversation this notification refers to. Format: `projects//conversations/`.",
"type": "string"
},
"errorStatus": {
"$ref": "GoogleRpcStatus",
"description": "More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL."
},
"newMessagePayload": {
"$ref": "GoogleCloudDialogflowV2Message",
"description": "Payload of NEW_MESSAGE event."
},
"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 is answered, or a conversation is created via the API.",
"An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.",
"An existing conversation has received notification from Dialogflow that human intervention is required.",
"An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config",
"Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2DetectIntentRequest": {
"description": "The request to detect user's intent.",
"id": "GoogleCloudDialogflowV2DetectIntentRequest",
"properties": {
"inputAudio": {
"description": "The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data.",
"format": "byte",
"type": "string"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2OutputAudioConfig",
"description": "Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated."
},
"outputAudioConfigMask": {
"description": "Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.",
"format": "google-fieldmask",
"type": "string"
},
"queryInput": {
"$ref": "GoogleCloudDialogflowV2QueryInput",
"description": "Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger."
},
"queryParams": {
"$ref": "GoogleCloudDialogflowV2QueryParameters",
"description": "The parameters of this query."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2DetectIntentResponse": {
"description": "The message returned from the DetectIntent method.",
"id": "GoogleCloudDialogflowV2DetectIntentResponse",
"properties": {
"outputAudio": {
"description": "The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.",
"format": "byte",
"type": "string"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2OutputAudioConfig",
"description": "The config used by the speech synthesizer to generate the output audio."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2QueryResult",
"description": "The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results."
},
"responseId": {
"description": "The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.",
"type": "string"
},
"webhookStatus": {
"$ref": "GoogleRpcStatus",
"description": "Specifies the status of the webhook request."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityType": {
"description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).",
"id": "GoogleCloudDialogflowV2EntityType",
"properties": {
"autoExpansionMode": {
"description": "Optional. Indicates whether the entity type can be automatically expanded.",
"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 listed in the entity."
],
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"enableFuzzyExtraction": {
"description": "Optional. Enables fuzzy entity extraction during classification.",
"type": "boolean"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST",
"KIND_REGEXP"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a reference value.",
"List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).",
"Regexp entity types allow to specify regular expressions in entries values."
],
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityTypeBatch": {
"description": "This message is a wrapper around a collection of entity types.",
"id": "GoogleCloudDialogflowV2EntityTypeBatch",
"properties": {
"entityTypes": {
"description": "A collection of entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2EntityTypeEntity",
"properties": {
"synonyms": {
"description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Environment": {
"description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).",
"id": "GoogleCloudDialogflowV2Environment",
"properties": {
"agentVersion": {
"description": "Optional. The agent version loaded into this environment. Format: `projects//agent/versions/`.",
"type": "string"
},
"description": {
"description": "Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"name": {
"description": "Output only. The unique identifier of this agent environment. Format: `projects//agent/environments/`. For Environment ID, \"-\" is reserved for 'draft' environment.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.",
"enum": [
"STATE_UNSPECIFIED",
"STOPPED",
"LOADING",
"RUNNING"
],
"enumDescriptions": [
"Not specified. This value is not used.",
"Stopped.",
"Loading.",
"Running."
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2EventInput": {
"description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.",
"id": "GoogleCloudDialogflowV2EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.",
"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. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ExportAgentRequest": {
"description": "The request message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2ExportAgentRequest",
"properties": {
"agentUri": {
"description": "Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2ExportAgentResponse",
"properties": {
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Fulfillment": {
"description": "By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).",
"id": "GoogleCloudDialogflowV2Fulfillment",
"properties": {
"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"
},
"features": {
"description": "Optional. The field defines whether the fulfillment is enabled for certain features.",
"items": {
"$ref": "GoogleCloudDialogflowV2FulfillmentFeature"
},
"type": "array"
},
"genericWebService": {
"$ref": "GoogleCloudDialogflowV2FulfillmentGenericWebService",
"description": "Configuration for a generic web service."
},
"name": {
"description": "Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2FulfillmentFeature": {
"description": "Whether fulfillment is enabled for the specific feature.",
"id": "GoogleCloudDialogflowV2FulfillmentFeature",
"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"
},
"GoogleCloudDialogflowV2FulfillmentGenericWebService": {
"description": "Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.",
"id": "GoogleCloudDialogflowV2FulfillmentGenericWebService",
"properties": {
"isCloudFunction": {
"description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.",
"type": "boolean"
},
"password": {
"description": "Optional. The password for HTTP Basic authentication.",
"type": "string"
},
"requestHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The HTTP request headers to send together with fulfillment requests.",
"type": "object"
},
"uri": {
"description": "Required. The fulfillment URI for receiving POST requests. It must use https protocol.",
"type": "string"
},
"username": {
"description": "Optional. The user name for HTTP Basic authentication.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ImportAgentRequest": {
"description": "The request message for Agents.ImportAgent.",
"id": "GoogleCloudDialogflowV2ImportAgentRequest",
"properties": {
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with \"gs://\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2InputAudioConfig": {
"description": "Instructs the speech recognizer how to process the audio content.",
"id": "GoogleCloudDialogflowV2InputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. Audio encoding of the audio content to process.",
"enum": [
"AUDIO_ENCODING_UNSPECIFIED",
"AUDIO_ENCODING_LINEAR_16",
"AUDIO_ENCODING_FLAC",
"AUDIO_ENCODING_MULAW",
"AUDIO_ENCODING_AMR",
"AUDIO_ENCODING_AMR_WB",
"AUDIO_ENCODING_OGG_OPUS",
"AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
],
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
"[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
"Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
"Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
"Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.",
"Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000."
],
"type": "string"
},
"enableWordInfo": {
"description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.",
"type": "boolean"
},
"languageCode": {
"description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.",
"type": "string"
},
"model": {
"description": "Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.",
"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 USE_BEST_AVAILABLE.",
"Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.",
"Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.",
"Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible."
],
"type": "string"
},
"phraseHints": {
"description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().",
"items": {
"type": "string"
},
"type": "array"
},
"sampleRateHertz": {
"description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.",
"format": "int32",
"type": "integer"
},
"singleUtterance": {
"description": "If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.",
"type": "boolean"
},
"speechContexts": {
"description": "Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.",
"items": {
"$ref": "GoogleCloudDialogflowV2SpeechContext"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Intent": {
"description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).",
"id": "GoogleCloudDialogflowV2Intent",
"properties": {
"action": {
"description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.",
"type": "string"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).",
"items": {
"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 See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Google Hangouts."
],
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"followupIntentInfo": {
"description": "Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo"
},
"type": "array"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`.",
"items": {
"type": "string"
},
"type": "array"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.",
"type": "boolean"
},
"name": {
"description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentParameter"
},
"type": "array"
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.",
"type": "string"
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.",
"format": "int32",
"type": "integer"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.",
"type": "boolean"
},
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects//agent/intents/`.",
"type": "string"
},
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is trained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase"
},
"type": "array"
},
"webhookState": {
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
],
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentBatch": {
"description": "This message is a wrapper around a collection of intents.",
"id": "GoogleCloudDialogflowV2IntentBatch",
"properties": {
"intents": {
"description": "A collection of intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentFollowupIntentInfo": {
"description": "Represents a single followup intent in the chain.",
"id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo",
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessage": {
"description": "A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).",
"id": "GoogleCloudDialogflowV2IntentMessage",
"properties": {
"basicCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"description": "The basic card response for Actions on Google."
},
"browseCarouselCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard",
"description": "Browse carousel card for Actions on Google."
},
"card": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCard",
"description": "The card response."
},
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"description": "The carousel card response for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "The image response."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion",
"description": "The link out suggestion chip for Actions on Google."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelect",
"description": "The list card response for Actions on Google."
},
"mediaContent": {
"$ref": "GoogleCloudDialogflowV2IntentMessageMediaContent",
"description": "The media content card for Actions on Google."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A custom platform-specific response.",
"type": "object"
},
"platform": {
"description": "Optional. The platform that this message is intended for.",
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"GOOGLE_HANGOUTS"
],
"enumDescriptions": [
"Default platform.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Google Hangouts."
],
"type": "string"
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies",
"description": "The quick replies response."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses",
"description": "The voice and text-only responses for Actions on Google."
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"description": "The suggestion chips for Actions on Google."
},
"tableCard": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCard",
"description": "Table card for Actions on Google."
},
"text": {
"$ref": "GoogleCloudDialogflowV2IntentMessageText",
"description": "The text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"type": "array"
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image for the card."
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton",
"properties": {
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
},
"title": {
"description": "Required. The title of the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": {
"description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel",
"id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard",
"properties": {
"imageDisplayOptions": {
"description": "Optional. Settings for displaying the image. Applies to every image in items.",
"enum": [
"IMAGE_DISPLAY_OPTIONS_UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED",
"BLURRED_BACKGROUND"
],
"enumDescriptions": [
"Fill the gaps between the image and the image container with gray bars.",
"Fill the gaps between the image and the image container with gray bars.",
"Fill the gaps between the image and the image container with white bars.",
"Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.",
"Pad the gaps between image and image frame with a blurred copy of the same image."
],
"type": "string"
},
"items": {
"description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem"
},
"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 text.",
"type": "string"
},
"footer": {
"description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Hero image for the carousel item."
},
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"description": "Required. Action to present to the user."
},
"title": {
"description": "Required. Title of the carousel item. Maximum of two lines of text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": {
"description": "Actions on Google action to open a given url.",
"id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"properties": {
"url": {
"description": "Required. URL",
"type": "string"
},
"urlTypeHint": {
"description": "Optional. Specifies the type of viewer that is used when opening the 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 which refers to AMP content via ."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2IntentMessageCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCardButton"
},
"type": "array"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCardButton": {
"description": "Contains information about a button.",
"id": "GoogleCloudDialogflowV2IntentMessageCardButton",
"properties": {
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to open.",
"type": "string"
},
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelect": {
"description": "The card for presenting a carousel of options to select from.",
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"properties": {
"items": {
"description": "Required. Carousel items.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageColumnProperties": {
"description": "Column properties for TableCard.",
"id": "GoogleCloudDialogflowV2IntentMessageColumnProperties",
"properties": {
"header": {
"description": "Required. Column heading.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2IntentMessageImage",
"properties": {
"accessibilityText": {
"description": "Optional. A text description of the image to be used for accessibility, e.g., screen readers.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app or 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 suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelect",
"properties": {
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle of the list.",
"type": "string"
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2IntentMessageListSelectItem",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageMediaContent": {
"description": "The media content card for Actions on Google.",
"id": "GoogleCloudDialogflowV2IntentMessageMediaContent",
"properties": {
"mediaObjects": {
"description": "Required. List of media objects.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": {
"description": "Response media object for media content card.",
"id": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject",
"properties": {
"contentUrl": {
"description": "Required. Url where the media is stored.",
"type": "string"
},
"description": {
"description": "Optional. Description of media card.",
"type": "string"
},
"icon": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Icon to display above media content."
},
"largeImage": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. Image to display above media content."
},
"name": {
"description": "Required. Name of media card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"id": "GoogleCloudDialogflowV2IntentMessageQuickReplies",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a dialog.",
"id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"properties": {
"key": {
"description": "Required. A unique key that will be sent back to the agent if this response is given.",
"type": "string"
},
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse",
"properties": {
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
},
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.",
"type": "string"
},
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.",
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSuggestion": {
"description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.",
"id": "GoogleCloudDialogflowV2IntentMessageSuggestion",
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCard": {
"description": "Table card for Actions on Google.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCard",
"properties": {
"buttons": {
"description": "Optional. List of buttons for the card.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"type": "array"
},
"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."
},
"rows": {
"description": "Optional. Rows in this table of data.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCardRow"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle to the title.",
"type": "string"
},
"title": {
"description": "Required. Title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCardCell": {
"description": "Cell of TableCardRow.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCardCell",
"properties": {
"text": {
"description": "Required. Text in this cell.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageTableCardRow": {
"description": "Row of TableCard.",
"id": "GoogleCloudDialogflowV2IntentMessageTableCardRow",
"properties": {
"cells": {
"description": "Optional. List of cells that make up this row.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageTableCardCell"
},
"type": "array"
},
"dividerAfter": {
"description": "Optional. Whether to add a visual divider after this row.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowV2IntentMessageText",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2IntentParameter",
"properties": {
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentTrainingPhrase": {
"description": "Represents an example that the agent is trained on.",
"id": "GoogleCloudDialogflowV2IntentTrainingPhrase",
"properties": {
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
},
"parts": {
"description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart"
},
"type": "array"
},
"timesAddedCount": {
"description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent 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 can be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart",
"properties": {
"alias": {
"description": "Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.",
"type": "string"
},
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListContextsResponse": {
"description": "The response message for Contexts.ListContexts.",
"id": "GoogleCloudDialogflowV2ListContextsResponse",
"properties": {
"contexts": {
"description": "The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListEntityTypesResponse": {
"description": "The response message for EntityTypes.ListEntityTypes.",
"id": "GoogleCloudDialogflowV2ListEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListEnvironmentsResponse": {
"description": "The response message for Environments.ListEnvironments.",
"id": "GoogleCloudDialogflowV2ListEnvironmentsResponse",
"properties": {
"environments": {
"description": "The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Environment"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListIntentsResponse": {
"description": "The response message for Intents.ListIntents.",
"id": "GoogleCloudDialogflowV2ListIntentsResponse",
"properties": {
"intents": {
"description": "The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ListSessionEntityTypesResponse": {
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"id": "GoogleCloudDialogflowV2ListSessionEntityTypesResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"sessionEntityTypes": {
"description": "The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Message": {
"description": "Represents a message posted into a conversation.",
"id": "GoogleCloudDialogflowV2Message",
"properties": {
"content": {
"description": "Required. The message content.",
"type": "string"
},
"createTime": {
"description": "Output only. The time when the message was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".",
"type": "string"
},
"messageAnnotation": {
"$ref": "GoogleCloudDialogflowV2MessageAnnotation",
"description": "Output only. The annotation for the message.",
"readOnly": true
},
"name": {
"description": "The unique identifier of the message. Format: `projects//conversations//messages/`.",
"type": "string"
},
"participant": {
"description": "Output only. The participant that sends this message.",
"readOnly": true,
"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 Dialogflow services."
],
"readOnly": true,
"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 position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text].",
"items": {
"$ref": "GoogleCloudDialogflowV2AnnotatedMessagePart"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.",
"id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"properties": {
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.",
"type": "object"
},
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request. This field is AoG-specific.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2OutputAudioConfig": {
"description": "Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.",
"id": "GoogleCloudDialogflowV2OutputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. Audio encoding of the synthesized audio content.",
"enum": [
"OUTPUT_AUDIO_ENCODING_UNSPECIFIED",
"OUTPUT_AUDIO_ENCODING_LINEAR_16",
"OUTPUT_AUDIO_ENCODING_MP3",
"OUTPUT_AUDIO_ENCODING_OGG_OPUS"
],
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio 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 file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate."
],
"type": "string"
},
"sampleRateHertz": {
"description": "The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).",
"format": "int32",
"type": "integer"
},
"synthesizeSpeechConfig": {
"$ref": "GoogleCloudDialogflowV2SynthesizeSpeechConfig",
"description": "Configuration of how speech should be synthesized."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryInput": {
"description": "Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text,. 3. An event that specifies which intent to trigger.",
"id": "GoogleCloudDialogflowV2QueryInput",
"properties": {
"audioConfig": {
"$ref": "GoogleCloudDialogflowV2InputAudioConfig",
"description": "Instructs the speech recognizer how to process the speech audio."
},
"event": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "The event to be processed."
},
"text": {
"$ref": "GoogleCloudDialogflowV2TextInput",
"description": "The natural language text to be processed."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryParameters": {
"description": "Represents the parameters of the conversational query.",
"id": "GoogleCloudDialogflowV2QueryParameters",
"properties": {
"contexts": {
"description": "The collection of contexts to be activated before this query is executed.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"geoLocation": {
"$ref": "GoogleTypeLatLng",
"description": "The geo location of this conversational query."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the `WebhookRequest.original_detect_intent_request.payload` field sent to your webhook.",
"type": "object"
},
"resetContexts": {
"description": "Specifies whether to delete all contexts in the current session before the new ones are activated.",
"type": "boolean"
},
"sentimentAnalysisRequestConfig": {
"$ref": "GoogleCloudDialogflowV2SentimentAnalysisRequestConfig",
"description": "Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed."
},
"sessionEntityTypes": {
"description": "Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
},
"timeZone": {
"description": "The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2QueryResult",
"properties": {
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"allRequiredParamsPresent": {
"description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors",
"type": "object"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.",
"type": "string"
},
"intent": {
"$ref": "GoogleCloudDialogflowV2Intent",
"description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
},
"queryText": {
"description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.",
"type": "string"
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request."
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"webhookPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.",
"type": "object"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2RestoreAgentRequest": {
"description": "The request message for Agents.RestoreAgent.",
"id": "GoogleCloudDialogflowV2RestoreAgentRequest",
"properties": {
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with \"gs://\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SearchAgentsResponse": {
"description": "The response message for Agents.SearchAgents.",
"id": "GoogleCloudDialogflowV2SearchAgentsResponse",
"properties": {
"agents": {
"description": "The list of agents. There will be a maximum number of items returned based on the page_size field in the request.",
"items": {
"$ref": "GoogleCloudDialogflowV2Agent"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.",
"id": "GoogleCloudDialogflowV2Sentiment",
"properties": {
"magnitude": {
"description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).",
"format": "float",
"type": "number"
},
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SentimentAnalysisRequestConfig": {
"description": "Configures the types of sentiment analysis to perform.",
"id": "GoogleCloudDialogflowV2SentimentAnalysisRequestConfig",
"properties": {
"analyzeQueryTextSentiment": {
"description": "Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SentimentAnalysisResult": {
"description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config",
"id": "GoogleCloudDialogflowV2SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
"$ref": "GoogleCloudDialogflowV2Sentiment",
"description": "The sentiment analysis result for `query_text`."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SessionEntityType": {
"description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).",
"id": "GoogleCloudDialogflowV2SessionEntityType",
"properties": {
"entities": {
"description": "Required. The collection of entities associated with this session entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"type": "array"
},
"entityOverrideMode": {
"description": "Required. Indicates whether the additional data should override or supplement 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 in the corresponding custom entity type.",
"The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge."
],
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SpeechContext": {
"description": "Hints for the speech recognizer to help with recognition in a specific conversation state.",
"id": "GoogleCloudDialogflowV2SpeechContext",
"properties": {
"boost": {
"description": "Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.",
"format": "float",
"type": "number"
},
"phrases": {
"description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to: * improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent * add additional words to the speech recognizer vocabulary * ... See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/quotas) for usage limits.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2SynthesizeSpeechConfig": {
"description": "Configuration of how speech should be synthesized.",
"id": "GoogleCloudDialogflowV2SynthesizeSpeechConfig",
"properties": {
"effectsProfileId": {
"description": "Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.",
"items": {
"type": "string"
},
"type": "array"
},
"pitch": {
"description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.",
"format": "double",
"type": "number"
},
"speakingRate": {
"description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values \u003c 0.25 or \u003e 4.0 will return an error.",
"format": "double",
"type": "number"
},
"voice": {
"$ref": "GoogleCloudDialogflowV2VoiceSelectionParams",
"description": "Optional. The desired voice of the synthesized audio."
},
"volumeGainDb": {
"description": "Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2TextInput": {
"description": "Represents the natural language text to be processed.",
"id": "GoogleCloudDialogflowV2TextInput",
"properties": {
"languageCode": {
"description": "Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.",
"type": "string"
},
"text": {
"description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2TrainAgentRequest": {
"description": "The request message for Agents.TrainAgent.",
"id": "GoogleCloudDialogflowV2TrainAgentRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowV2ValidationError": {
"description": "Represents a single validation error.",
"id": "GoogleCloudDialogflowV2ValidationError",
"properties": {
"entries": {
"description": "The names of the entries that the error is associated with. Format: - \"projects//agent\", if the error is associated with the entire agent. - \"projects//agent/intents/\", if the error is associated with certain intents. - \"projects//agent/intents//trainingPhrases/\", if the error is associated with certain intent training phrases. - \"projects//agent/intents//parameters/\", if the error is associated with certain intent parameters. - \"projects//agent/entities/\", if the error is associated with certain entities.",
"items": {
"type": "string"
},
"type": "array"
},
"errorMessage": {
"description": "The detailed error messsage.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2ValidationResult": {
"description": "Represents the output of agent validation.",
"id": "GoogleCloudDialogflowV2ValidationResult",
"properties": {
"validationErrors": {
"description": "Contains all validation errors.",
"items": {
"$ref": "GoogleCloudDialogflowV2ValidationError"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2VoiceSelectionParams": {
"description": "Description of which voice to use for speech synthesis.",
"id": "GoogleCloudDialogflowV2VoiceSelectionParams",
"properties": {
"name": {
"description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.",
"type": "string"
},
"ssmlGender": {
"description": "Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute 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 gender the selected voice will have.",
"A male voice.",
"A female voice.",
"A gender-neutral voice."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2WebhookRequest",
"properties": {
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2QueryResult",
"description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`."
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2WebhookResponse": {
"description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).",
"id": "GoogleCloudDialogflowV2WebhookResponse",
"properties": {
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields."
},
"fulfillmentMessages": {
"description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
},
"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 integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
},
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.",
"items": {
"$ref": "GoogleCloudDialogflowV2SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Context": {
"description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).",
"id": "GoogleCloudDialogflowV2beta1Context",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EntityType": {
"description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).",
"id": "GoogleCloudDialogflowV2beta1EntityType",
"properties": {
"autoExpansionMode": {
"description": "Optional. Indicates whether the entity type can be automatically expanded.",
"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 listed in the entity."
],
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"enableFuzzyExtraction": {
"description": "Optional. Enables fuzzy entity extraction during classification.",
"type": "boolean"
},
"entities": {
"description": "Optional. The collection of entity entries associated with the entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
},
"kind": {
"description": "Required. Indicates the kind of entity type.",
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST",
"KIND_REGEXP"
],
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a reference value.",
"List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).",
"Regexp entity types allow to specify regular expressions in entries values."
],
"type": "string"
},
"name": {
"description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EntityTypeEntity": {
"description": "An **entity entry** for an associated entity type.",
"id": "GoogleCloudDialogflowV2beta1EntityTypeEntity",
"properties": {
"synonyms": {
"description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1EventInput": {
"description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.",
"id": "GoogleCloudDialogflowV2beta1EventInput",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.",
"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. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"id": "GoogleCloudDialogflowV2beta1ExportAgentResponse",
"properties": {
"agentContent": {
"description": "Zip compressed raw byte content for agent.",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Intent": {
"description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).",
"id": "GoogleCloudDialogflowV2beta1Intent",
"properties": {
"action": {
"description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.",
"type": "string"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).",
"items": {
"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 See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Telephony Gateway.",
"Google Hangouts."
],
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.",
"type": "boolean"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"followupIntentInfo": {
"description": "Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo"
},
"readOnly": true,
"type": "array"
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`",
"items": {
"type": "string"
},
"type": "array"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.",
"type": "boolean"
},
"mlEnabled": {
"description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.",
"type": "boolean"
},
"name": {
"description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentParameter"
},
"type": "array"
},
"parentFollowupIntentName": {
"description": "Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.",
"type": "string"
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.",
"format": "int32",
"type": "integer"
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.",
"type": "boolean"
},
"rootFollowupIntentName": {
"description": "Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.",
"readOnly": true,
"type": "string"
},
"trainingPhrases": {
"description": "Optional. The collection of examples that the agent is trained on.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase"
},
"type": "array"
},
"webhookState": {
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
],
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": {
"description": "Represents a single followup intent in the chain.",
"id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo",
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessage": {
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"id": "GoogleCloudDialogflowV2beta1IntentMessage",
"properties": {
"basicCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"description": "Displays a basic card for Actions on Google."
},
"browseCarouselCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard",
"description": "Browse carousel card for Actions on Google."
},
"card": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"description": "Displays a card."
},
"carouselSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect",
"description": "Displays a carousel card for Actions on Google."
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Displays an image."
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion",
"description": "Displays a link out suggestion chip for Actions on Google."
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"description": "Displays a list card for Actions on Google."
},
"mediaContent": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent",
"description": "The media content card for Actions on Google."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A custom platform-specific response.",
"type": "object"
},
"platform": {
"description": "Optional. The platform that this message is intended for.",
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY",
"GOOGLE_HANGOUTS"
],
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"Telephony Gateway.",
"Google Hangouts."
],
"type": "string"
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"description": "Displays quick replies."
},
"rbmCarouselRichCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard",
"description": "Rich Business Messaging (RBM) carousel rich card response."
},
"rbmStandaloneRichCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard",
"description": "Standalone Rich Business Messaging (RBM) rich card response."
},
"rbmText": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmText",
"description": "Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging."
},
"simpleResponses": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses",
"description": "Returns a voice or text-only response for Actions on Google."
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"description": "Displays suggestion chips for Actions on Google."
},
"tableCard": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCard",
"description": "Table card for Actions on Google."
},
"telephonyPlayAudio": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio",
"description": "Plays audio from a file in Telephony Gateway."
},
"telephonySynthesizeSpeech": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech",
"description": "Synthesizes speech in Telephony Gateway."
},
"telephonyTransferCall": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"description": "Transfers the call in Telephony Gateway."
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageText",
"description": "Returns a text response."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
},
"type": "array"
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image for the card."
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton",
"properties": {
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
},
"title": {
"description": "Required. The title of the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": {
"description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard",
"properties": {
"imageDisplayOptions": {
"description": "Optional. Settings for displaying the image. Applies to every image in items.",
"enum": [
"IMAGE_DISPLAY_OPTIONS_UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED",
"BLURRED_BACKGROUND"
],
"enumDescriptions": [
"Fill the gaps between the image and the image container with gray bars.",
"Fill the gaps between the image and the image container with gray bars.",
"Fill the gaps between the image and the image container with white bars.",
"Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.",
"Pad the gaps between image and image frame with a blurred copy of the same image."
],
"type": "string"
},
"items": {
"description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": {
"description": "Browsing carousel tile",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem",
"properties": {
"description": {
"description": "Optional. Description of the carousel item. Maximum of four lines of text.",
"type": "string"
},
"footer": {
"description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Hero image for the carousel item."
},
"openUriAction": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"description": "Required. Action to present to the user."
},
"title": {
"description": "Required. Title of the carousel item. Maximum of two lines of text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": {
"description": "Actions on Google action to open a given url.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction",
"properties": {
"url": {
"description": "Required. URL",
"type": "string"
},
"urlTypeHint": {
"description": "Optional. Specifies the type of viewer that is used when opening the 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 which refers to AMP content via ."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCard": {
"description": "The card response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCard",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton"
},
"type": "array"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton",
"properties": {
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to open.",
"type": "string"
},
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": {
"description": "The card for presenting a carousel of options to select from.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect",
"properties": {
"items": {
"description": "Required. Carousel items.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": {
"description": "Column properties for TableCard.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties",
"properties": {
"header": {
"description": "Required. Column heading.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageImage": {
"description": "The image response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"properties": {
"accessibilityText": {
"description": "A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app or 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 suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"properties": {
"items": {
"description": "Required. List items.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle of the list.",
"type": "string"
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": {
"description": "An item in the list.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageMediaContent": {
"description": "The media content card for Actions on Google.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent",
"properties": {
"mediaObjects": {
"description": "Required. List of media objects.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": {
"description": "Response media object for media content card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject",
"properties": {
"contentUrl": {
"description": "Required. Url where the media is stored.",
"type": "string"
},
"description": {
"description": "Optional. Description of media card.",
"type": "string"
},
"icon": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Icon to display above media content."
},
"largeImage": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. Image to display above media content."
},
"name": {
"description": "Required. Name of media card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": {
"description": "Rich Business Messaging (RBM) Card content",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent",
"properties": {
"description": {
"description": "Optional. Description of the card (at most 2000 bytes). At 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 be 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"
},
"title": {
"description": "Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": {
"description": "Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia",
"properties": {
"fileUri": {
"description": "Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.",
"type": "string"
},
"height": {
"description": "Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, 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 is set to small."
],
"type": "string"
},
"thumbnailUri": {
"description": "Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": {
"description": "Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard",
"properties": {
"cardContents": {
"description": "Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": {
"description": "Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard",
"properties": {
"cardContent": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent",
"description": "Required. Card content."
},
"cardOrientation": {
"description": "Required. Orientation of the card.",
"enum": [
"CARD_ORIENTATION_UNSPECIFIED",
"HORIZONTAL",
"VERTICAL"
],
"enumDescriptions": [
"Not specified.",
"Horizontal layout.",
"Vertical layout."
],
"type": "string"
},
"thumbnailImageAlignment": {
"description": "Required if orientation is horizontal. Image 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"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": {
"description": "Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction",
"properties": {
"dial": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial",
"description": "Suggested client side action: Dial a phone number"
},
"openUrl": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri",
"description": "Suggested client side action: Open a URI on device"
},
"postbackData": {
"description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.",
"type": "string"
},
"shareLocation": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation",
"description": "Suggested client side action: Share user location"
},
"text": {
"description": "Text to display alongside the action.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": {
"description": "Opens the user's default dialer app with the specified phone number but does not dial automatically.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial",
"properties": {
"phoneNumber": {
"description": "Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": {
"description": "Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened 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"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": {
"description": "Opens the device's location chooser so the user can pick a location to send back to the agent.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation",
"properties": {},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": {
"description": "Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply",
"properties": {
"postbackData": {
"description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.",
"type": "string"
},
"text": {
"description": "Suggested reply text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": {
"description": "Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).",
"id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion",
"properties": {
"action": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction",
"description": "Predefined client side actions that user can choose"
},
"reply": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply",
"description": "Predefined replies for user to select instead of typing"
}
},
"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"
},
"GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a dialog.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"properties": {
"key": {
"description": "Required. A unique key that will be sent back to the agent if this response is given.",
"type": "string"
},
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse",
"properties": {
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
},
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.",
"type": "string"
},
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestion": {
"description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion",
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCard": {
"description": "Table card for Actions on Google.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCard",
"properties": {
"buttons": {
"description": "Optional. List of buttons for the card.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
},
"type": "array"
},
"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."
},
"rows": {
"description": "Optional. Rows in this table of data.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow"
},
"type": "array"
},
"subtitle": {
"description": "Optional. Subtitle to the title.",
"type": "string"
},
"title": {
"description": "Required. Title of the card.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": {
"description": "Cell of TableCardRow.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell",
"properties": {
"text": {
"description": "Required. Text in this cell.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": {
"description": "Row of TableCard.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow",
"properties": {
"cells": {
"description": "Optional. List of cells that make up this row.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell"
},
"type": "array"
},
"dividerAfter": {
"description": "Optional. Whether to add a visual divider after this row.",
"type": "boolean"
}
},
"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 play, e.g., \"gs://bucket/object\". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": {
"description": "Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at 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 [SSML](https://developers.google.com/actions/reference/ssml).",
"type": "string"
},
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": {
"description": "Transfers the call in Telephony Gateway.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"properties": {
"phoneNumber": {
"description": "Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageText": {
"description": "The text response message.",
"id": "GoogleCloudDialogflowV2beta1IntentMessageText",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentParameter": {
"description": "Represents intent parameters.",
"id": "GoogleCloudDialogflowV2beta1IntentParameter",
"properties": {
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrase": {
"description": "Represents an example that the agent is trained on.",
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase",
"properties": {
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
},
"parts": {
"description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart"
},
"type": "array"
},
"timesAddedCount": {
"description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent 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 can be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work."
],
"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 annotated part of the example. This field is required for annotated parts of the training phrase.",
"type": "string"
},
"entityType": {
"description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.",
"type": "string"
},
"text": {
"description": "Required. The text for this part.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswers": {
"description": "Represents the result of querying a Knowledge base.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"properties": {
"answers": {
"description": "A list of answers from Knowledge Connector.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": {
"description": "An answer from Knowledge Connector.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer",
"properties": {
"answer": {
"description": "The piece of text from the `source` knowledge base document that answers this conversational query.",
"type": "string"
},
"faqQuestion": {
"description": "The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.",
"type": "string"
},
"matchConfidence": {
"description": "The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable.",
"format": "float",
"type": "number"
},
"matchConfidenceLevel": {
"description": "The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.",
"enum": [
"MATCH_CONFIDENCE_LEVEL_UNSPECIFIED",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Not specified.",
"Indicates that the confidence is low.",
"Indicates our confidence is medium.",
"Indicates our confidence is high."
],
"type": "string"
},
"source": {
"description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": {
"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
"id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata",
"properties": {
"state": {
"description": "Required. Output only. 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."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to the `[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` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.",
"type": "object"
},
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request. This field is AoG-specific.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"id": "GoogleCloudDialogflowV2beta1QueryResult",
"properties": {
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"allRequiredParamsPresent": {
"description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors",
"type": "object"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.",
"type": "string"
},
"intent": {
"$ref": "GoogleCloudDialogflowV2beta1Intent",
"description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"knowledgeAnswers": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"description": "The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`."
},
"languageCode": {
"description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value",
"type": "object"
},
"queryText": {
"description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.",
"type": "string"
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request."
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"webhookPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.",
"type": "object"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1Sentiment": {
"description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.",
"id": "GoogleCloudDialogflowV2beta1Sentiment",
"properties": {
"magnitude": {
"description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).",
"format": "float",
"type": "number"
},
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisResult": {
"description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config",
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"properties": {
"queryTextSentiment": {
"$ref": "GoogleCloudDialogflowV2beta1Sentiment",
"description": "The sentiment analysis result for `query_text`."
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1SessionEntityType": {
"description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).",
"id": "GoogleCloudDialogflowV2beta1SessionEntityType",
"properties": {
"entities": {
"description": "Required. The collection of entities associated with this session entity type.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"type": "array"
},
"entityOverrideMode": {
"description": "Required. Indicates whether the additional data should override or supplement 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 in the corresponding custom entity type.",
"The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge."
],
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1WebhookRequest": {
"description": "The request message for a webhook call.",
"id": "GoogleCloudDialogflowV2beta1WebhookRequest",
"properties": {
"alternativeQueryResults": {
"description": "Alternative query results from KnowledgeService.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"type": "array"
},
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call."
},
"queryResult": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult",
"description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`."
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`,",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV2beta1WebhookResponse": {
"description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).",
"id": "GoogleCloudDialogflowV2beta1WebhookResponse",
"properties": {
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.",
"type": "boolean"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields."
},
"fulfillmentMessages": {
"description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"type": "array"
},
"fulfillmentText": {
"description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.",
"type": "string"
},
"outputContexts": {
"description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"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 integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)",
"type": "object"
},
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"type": "array"
},
"source": {
"description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowV3alpha1RunTestCaseMetadata": {
"description": "Metadata returned for the TestCases.RunTestCase long running operation.",
"id": "GoogleCloudDialogflowV3alpha1RunTestCaseMetadata",
"properties": {},
"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"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeLatLng": {
"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.",
"id": "GoogleTypeLatLng",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Dialogflow API",
"version": "v2",
"version_module": true
}