blob: 97a6d0a4ef89fcb4850a716936bd02fa602d5223 [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:v3beta1",
"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": {
"resources": {
"locations": {
"resources": {
"agents": {
"methods": {
"create": {
"description": "Creates an agent in the specified location.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The location to create a agent for. Format: `projects//locations/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/agents",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Agent"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the agent to delete. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"export": {
"description": "Exports the specified agent to a ZIP file.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:export",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.export",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the agent to export. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}:export",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1ExportAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the agent. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all agents in the specified location.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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 location to list all agents for. Format: `projects//locations/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/agents",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListAgentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Agent"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Agent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"restore": {
"description": "Restores the specified agent from a ZIP file. Note that all existing intents, intent routes, entity types, pages and webhooks in the agent will be deleted.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:restore",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.restore",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the agent to restore into. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}:restore",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"create": {
"description": "Creates an entity type in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` 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 agent to create a entity type for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "This field has no effect for entity type not being used. For entity types that are used by intents or pages: * If `force` is set to false, an error will be returned with message indicating the referencing resources. * If `force` is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the entity type to delete. Format: `projects//locations//agents//entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+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": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to retrieve the entity type for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` 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"
},
"name": {
"description": "Required. The name of the entity type. Format: `projects//locations//agents//entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1EntityType"
},
"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": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to list entity types for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` 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"
},
"pageSize": {
"description": "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 agent to list all entity types for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` 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"
},
"name": {
"description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"environments": {
"methods": {
"create": {
"description": "Creates an Environment in the specified Agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.environments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The Agent to create an Environment for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/environments",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Environment"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified Environment.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.environments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified Environment.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.environments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Environment. Format: `projects//locations//agents//environments/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all environments in the specified Agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return in a single page. By default 20 and at most 100.",
"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 Agent to list all environments for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/environments",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"lookupEnvironmentHistory": {
"description": "Looks up the history of the specified Environment.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:lookupEnvironmentHistory",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.environments.lookupEnvironmentHistory",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "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"
}
},
"path": "v3beta1/{+name}:lookupEnvironmentHistory",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1LookupEnvironmentHistoryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified Environment.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.environments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the environment. Format: `projects//locations//agents//environments/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Environment"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"sessions": {
"methods": {
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:detectIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.environments.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"fulfillIntent": {
"description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:fulfillIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.environments.sessions.fulfillIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:fulfillIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1FulfillIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1FulfillIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"matchIntent": {
"description": "Returns preliminary intent match results, doesn't change the session status.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:matchIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.environments.sessions.matchIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:matchIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1MatchIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1MatchIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"create": {
"description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all session entity types in the specified session.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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 session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
}
},
"flows": {
"methods": {
"create": {
"description": "Creates a flow in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` 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 agent to create a flow for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/flows",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Flow"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Flow"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes a specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.flows.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the flow to delete. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` 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"
},
"name": {
"description": "Required. The name of the flow to get. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Flow"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all flows in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` 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"
},
"pageSize": {
"description": "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 agent containing the flows. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/flows",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListFlowsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.flows.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` 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"
},
"name": {
"description": "The unique identifier of the flow. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields get updated. If `update_mask` is not specified, an error will be returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Flow"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Flow"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"train": {
"description": "Trains the specified flow. Note that only the flow in 'draft' environment is trained.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:train",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.train",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The flow to train. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}:train",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1TrainFlowRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"pages": {
"methods": {
"create": {
"description": "Creates a page in the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.pages.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` 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 flow to create a page for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/pages",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Page"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Page"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified page.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.flows.pages.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "This field has no effect for pages with no incoming transitions. For pages with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. Target page in event handlers or Target page in transition routes that point to this page will be cleared).",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the page to delete. Format: `projects//locations//agents//Flows//pages/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified page.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.pages.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` 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"
},
"name": {
"description": "Required. The name of the page. Format: `projects//locations//agents//flows//pages/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Page"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all pages in the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.pages.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` 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"
},
"pageSize": {
"description": "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 flow to list all pages for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/pages",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListPagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified page.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.flows.pages.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` 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"
},
"name": {
"description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Page"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Page"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"transitionRouteGroups": {
"methods": {
"create": {
"description": "Creates an TransitionRouteGroup in the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. 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 flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/transitionRouteGroups",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified TransitionRouteGroup.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified TransitionRouteGroup.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. 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"
},
"name": {
"description": "Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all transition route groups in the specified flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. 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"
},
"pageSize": {
"description": "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 flow to list all transition route groups for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/transitionRouteGroups",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified TransitionRouteGroup.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. 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"
},
"name": {
"description": "The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1TransitionRouteGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"versions": {
"methods": {
"create": {
"description": "Creates a Version in the specified Flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.versions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The Flow to create an Version for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/versions",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Version"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified Version.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.flows.versions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Version to delete. Format: `projects//locations//agents//flows//versions/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified Version.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.versions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Version. Format: `projects//locations//agents//flows//versions/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all versions in the specified Flow.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.flows.versions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return in a single page. By default 20 and at most 100.",
"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 Flow to list all versions for. Format: `projects//locations//agents//flows/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/versions",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"load": {
"description": "Loads a specified version to draft version.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.flows.versions.load",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}:load",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1LoadVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified Version.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.flows.versions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields get updated. Currently only `description` and `display_name` can be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Version"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"intents": {
"methods": {
"create": {
"description": "Creates an intent in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.intents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` 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 agent to create an intent for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/intents",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified intent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.intents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the intent to delete. Format: `projects//locations//agents//intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+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": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.intents.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` 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"
},
"name": {
"description": "Required. The name of the intent. Format: `projects//locations//agents//intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Intent"
},
"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": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.intents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"intentView": {
"description": "The resource view to apply to the returned intent.",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_PARTIAL",
"INTENT_VIEW_FULL"
],
"enumDescriptions": [
"Not specified. Treated as INTENT_VIEW_FULL.",
"Training phrases field is not populated in the response.",
"All fields are populated."
],
"location": "query",
"type": "string"
},
"languageCode": {
"description": "The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` 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"
},
"pageSize": {
"description": "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 agent to list all intents for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/intents",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListIntentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified intent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.intents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` 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"
},
"name": {
"description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Intent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
},
"sessions": {
"methods": {
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.sessions.detectIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:detectIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1DetectIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1DetectIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"fulfillIntent": {
"description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.sessions.fulfillIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:fulfillIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1FulfillIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1FulfillIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"matchIntent": {
"description": "Returns preliminary intent match results, doesn't change the session status.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.sessions.matchIntent",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+session}:matchIntent",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1MatchIntentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1MatchIntentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"create": {
"description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.sessions.entityTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.sessions.entityTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.sessions.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all session entity types in the specified session.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.sessions.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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 session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified session entity type.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.sessions.entityTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The mask to control which fields get updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1SessionEntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
},
"webhooks": {
"methods": {
"create": {
"description": "Creates a webhook in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks",
"httpMethod": "POST",
"id": "dialogflow.projects.locations.agents.webhooks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The agent to create a webhook for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/webhooks",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"delete": {
"description": "Deletes the specified webhook.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}",
"httpMethod": "DELETE",
"id": "dialogflow.projects.locations.agents.webhooks.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"get": {
"description": "Retrieves the specified webhook.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.webhooks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+name}",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"list": {
"description": "Returns the list of all webhooks in the specified agent.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks",
"httpMethod": "GET",
"id": "dialogflow.projects.locations.agents.webhooks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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 agent to list all webhooks for. Format: `projects//locations//agents/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3beta1/{+parent}/webhooks",
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1ListWebhooksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
},
"patch": {
"description": "Updates the specified webhook.",
"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}",
"httpMethod": "PATCH",
"id": "dialogflow.projects.locations.agents.webhooks.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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": "v3beta1/{+name}",
"request": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"response": {
"$ref": "GoogleCloudDialogflowCxV3beta1Webhook"
},
"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": "v3beta1/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": "v3beta1/{+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": "v3beta1/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": "v3beta1/{+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": "v3beta1/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": "v3beta1/{+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": "v3beta1/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": "v3beta1/{+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": "v3beta1/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": "v3beta1/{+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": "v3beta1/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": "v3beta1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
]
}
}
}
}
}
},
"revision": "20200928",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowCxV3beta1Agent": {
"description": "Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..",
"id": "GoogleCloudDialogflowCxV3beta1Agent",
"properties": {
"avatarUri": {
"description": "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"
},
"defaultLanguageCode": {
"description": "Immutable. 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 Agents.UpdateAgent method.",
"type": "string"
},
"description": {
"description": "The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"displayName": {
"description": "Required. The human-readable name of the agent, unique within the location.",
"type": "string"
},
"enableSpellCorrection": {
"description": "Indicates if automatic spell correction is enabled in detect intent requests.",
"type": "boolean"
},
"enableStackdriverLogging": {
"description": "Indicates if stackdriver logging is enabled for the agent.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.",
"type": "string"
},
"speechToTextSettings": {
"$ref": "GoogleCloudDialogflowCxV3beta1SpeechToTextSettings",
"description": "Speech recognition related settings."
},
"startFlow": {
"description": "Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.",
"type": "string"
},
"timeZone": {
"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDialogflowCxV3beta1AudioInput": {