OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-06 11:34:34 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
255c7f5ad58ef67fccfa69afc2f6f37550ab0fc7
google-apis-rs/etc/api/dialogflow/v2beta1/dialogflow-api.json
Sebastian Thiel 255c7f5ad5 Update to latest versions of API declarations
2018-10-13 13:49:14 +02:00

7183 lines
366 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"ownerDomain": "google.com",
"name": "dialogflow",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Dialogflow API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"getAgent": {
"path": "v2beta1/{+parent}/agent",
"id": "dialogflow.projects.getAgent",
"description": "Retrieves the specified agent.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent"
}
},
"resources": {
"knowledgeBases": {
"methods": {
"list": {
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases",
"path": "v2beta1/{+parent}/knowledgeBases",
"id": "dialogflow.projects.knowledgeBases.list",
"description": "Returns the list of all knowledge bases of the specified agent.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"type": "integer"
},
"parent": {
"location": "path",
"description": "Required. The project to list of knowledge bases for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.knowledgeBases.get",
"description": "Retrieves the specified knowledge base.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"location": "path",
"description": "Required. The name of the knowledge base to retrieve.\nFormat `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a knowledge base.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The project to create a knowledge base for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases",
"path": "v2beta1/{+parent}/knowledgeBases",
"id": "dialogflow.projects.knowledgeBases.create"
},
"delete": {
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"force": {
"description": "Optional. Force deletes the knowledge base. When set to true, any documents\nin the knowledge base are also deleted.",
"type": "boolean",
"location": "query"
},
"name": {
"description": "Required. The name of the knowledge base to delete.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.knowledgeBases.delete",
"description": "Deletes the specified knowledge base."
}
},
"resources": {
"documents": {
"methods": {
"delete": {
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"location": "path",
"description": "The name of the document to delete.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.knowledgeBases.documents.delete",
"description": "Deletes the specified document.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: KnowledgeOperationMetadata\u003e"
},
"list": {
"id": "dialogflow.projects.knowledgeBases.documents.list",
"path": "v2beta1/{+parent}/documents",
"description": "Returns the list of all documents of the knowledge base.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"location": "path",
"description": "Required. The knowledge base to list all documents for.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents"
},
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Required. The name of the document to retrieve.\nFormat `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.knowledgeBases.documents.get",
"description": "Retrieves the specified document."
},
"create": {
"id": "dialogflow.projects.knowledgeBases.documents.create",
"path": "v2beta1/{+parent}/documents",
"description": "Creates a new document.\n\nOperation \u003cresponse: Document,\n metadata: KnowledgeOperationMetadata\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameters": {
"parent": {
"description": "Required. The knoweldge base to create a document for.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/knowledgeBases/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents"
}
}
}
}
},
"humanAgentAssistants": {
"methods": {
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The resource name of the agent assistant.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/humanAgentAssistants/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants/{humanAgentAssistantsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.humanAgentAssistants.get",
"description": "Retrieves a human agent assistant."
},
"patch": {
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants/{humanAgentAssistantsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.humanAgentAssistants.patch",
"description": "Updates the specified human agent assistant.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"description": "Optional. The mask to specify which fields to update.",
"format": "google-fieldmask",
"type": "string"
},
"name": {
"location": "path",
"description": "Required for all methods except `create` (`create` populates the name\nautomatically).\nThe unique identifier of human agent assistant.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/humanAgentAssistants/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"compileSuggestions": {
"description": "Uses the specified human agent assistant to come up with suggestions\n(relevant articles and FAQs) on how to respond to a given conversation.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1CompileSuggestionsRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1CompileSuggestionsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"description": "Required. The resource name of the agent assistant.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/humanAgentAssistants/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants/{humanAgentAssistantsId}:compileSuggestions",
"path": "v2beta1/{+name}:compileSuggestions",
"id": "dialogflow.projects.humanAgentAssistants.compileSuggestions"
},
"delete": {
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.humanAgentAssistants.delete",
"description": "Deletes the specified human agent assistant.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The resource name of the agent assistant.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/humanAgentAssistants/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants/{humanAgentAssistantsId}"
},
"list": {
"id": "dialogflow.projects.humanAgentAssistants.list",
"path": "v2beta1/{+parent}/humanAgentAssistants",
"description": "Returns the list of all human agent assistants.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page.\nThe default value is 100; the maximum value is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The project to list all agent assistants from.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants"
},
"create": {
"flatPath": "v2beta1/projects/{projectsId}/humanAgentAssistants",
"path": "v2beta1/{+parent}/humanAgentAssistants",
"id": "dialogflow.projects.humanAgentAssistants.create",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"description": "Creates a human agent assistant.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The project to create a agent assistant for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
}
}
}
},
"conversationProfiles": {
"methods": {
"list": {
"description": "Returns the list of all conversation profiles in the specified project.",
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"description": "Required. The project to list all conversation profiles from.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversationProfiles",
"id": "dialogflow.projects.conversationProfiles.list",
"path": "v2beta1/{+parent}/conversationProfiles"
},
"get": {
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.conversationProfiles.get",
"description": "Retrieves the specified conversation profile.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Required. The resource name of the conversation profile.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversation Profile\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversationProfiles/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}"
},
"patch": {
"description": "Updates the specified conversation profile.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"type": "string"
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically).\nThe unique identifier of this conversation profile.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversation Profile\nID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversationProfiles/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.conversationProfiles.patch"
},
"create": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"description": "Creates a conversation profile in the specified project.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The project to create a conversation profile for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/conversationProfiles",
"path": "v2beta1/{+parent}/conversationProfiles",
"id": "dialogflow.projects.conversationProfiles.create"
},
"delete": {
"flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}",
"id": "dialogflow.projects.conversationProfiles.delete",
"path": "v2beta1/{+name}",
"description": "Deletes the specified conversation profile.",
"httpMethod": "DELETE",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/conversationProfiles/[^/]+$",
"location": "path",
"description": "Required. The name of the conversation profile to delete.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversation Profile\nID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"agent": {
"methods": {
"train": {
"description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameters": {
"parent": {
"description": "Required. The project that the agent to train is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent:train",
"id": "dialogflow.projects.agent.train",
"path": "v2beta1/{+parent}/agent:train"
},
"export": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest"
},
"description": "Exports the specified agent to a ZIP file.\n\n\nOperation \u003cresponse: ExportAgentResponse,\n metadata: google.protobuf.Struct\u003e",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent:export",
"path": "v2beta1/{+parent}/agent:export",
"id": "dialogflow.projects.agent.export"
},
"restore": {
"description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent:restore",
"path": "v2beta1/{+parent}/agent:restore",
"id": "dialogflow.projects.agent.restore"
},
"import": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest"
},
"description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent:import",
"path": "v2beta1/{+parent}/agent:import",
"id": "dialogflow.projects.agent.import"
},
"search": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
"required": true,
"type": "string"
},
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent:search",
"path": "v2beta1/{+parent}/agent:search",
"id": "dialogflow.projects.agent.search",
"description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections)."
}
},
"resources": {
"knowledgeBases": {
"methods": {
"delete": {
"description": "Deletes the specified knowledge base.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameters": {
"force": {
"location": "query",
"description": "Optional. Force deletes the knowledge base. When set to true, any documents\nin the knowledge base are also deleted.",
"type": "boolean"
},
"name": {
"description": "Required. The name of the knowledge base to delete.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}",
"id": "dialogflow.projects.agent.knowledgeBases.delete",
"path": "v2beta1/{+name}"
},
"list": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"type": "integer"
},
"parent": {
"description": "Required. The project to list of knowledge bases for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$",
"location": "path"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases",
"path": "v2beta1/{+parent}/knowledgeBases",
"id": "dialogflow.projects.agent.knowledgeBases.list",
"description": "Returns the list of all knowledge bases of the specified agent."
},
"get": {
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.knowledgeBases.get",
"description": "Retrieves the specified knowledge base.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$",
"location": "path",
"description": "Required. The name of the knowledge base to retrieve.\nFormat `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The project to create a knowledge base for.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases",
"path": "v2beta1/{+parent}/knowledgeBases",
"id": "dialogflow.projects.agent.knowledgeBases.create",
"description": "Creates a knowledge base.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
}
}
},
"resources": {
"documents": {
"methods": {
"create": {
"description": "Creates a new document.\n\nOperation \u003cresponse: Document,\n metadata: KnowledgeOperationMetadata\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"location": "path",
"description": "Required. The knoweldge base to create a document for.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents",
"path": "v2beta1/{+parent}/documents",
"id": "dialogflow.projects.agent.knowledgeBases.documents.create"
},
"delete": {
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}",
"id": "dialogflow.projects.agent.knowledgeBases.documents.delete",
"path": "v2beta1/{+name}",
"description": "Deletes the specified document.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: KnowledgeOperationMetadata\u003e",
"httpMethod": "DELETE",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"location": "path",
"description": "The name of the document to delete.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns the list of all documents of the knowledge base.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The knowledge base to list all documents for.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 10 and at most 100.",
"format": "int32",
"type": "integer"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents",
"path": "v2beta1/{+parent}/documents",
"id": "dialogflow.projects.agent.knowledgeBases.documents.list"
},
"get": {
"flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.knowledgeBases.documents.get",
"description": "Retrieves the specified document.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$",
"location": "path",
"description": "Required. The name of the document to retrieve.\nFormat `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"required": true,
"type": "string"
}
}
}
}
}
}
},
"intents": {
"methods": {
"delete": {
"description": "Deletes the specified intent and its direct or indirect followup intents.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"location": "path",
"description": "Required. The name of the intent to delete. If this intent has direct or\nindirect followup intents, we also delete them.\n\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.intents.delete"
},
"list": {
"description": "Returns the list of all intents in the specified agent.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"languageCode": {
"location": "query",
"description": "Optional. The language to list training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent before they can be used.",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
},
"intentView": {
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"description": "Optional. The resource view to apply to the returned intent.",
"type": "string",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The agent to list all intents from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/intents",
"path": "v2beta1/{+parent}/intents",
"id": "dialogflow.projects.agent.intents.list"
},
"create": {
"description": "Creates an intent in the specified agent.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"languageCode": {
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string",
"location": "query"
},
"intentView": {
"location": "query",
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"description": "Optional. The resource view to apply to the returned intent.",
"type": "string"
},
"parent": {
"pattern": "^projects/[^/]+/agent$",
"location": "path",
"description": "Required. The agent to create a intent for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/intents",
"path": "v2beta1/{+parent}/intents",
"id": "dialogflow.projects.agent.intents.create"
},
"batchDelete": {
"description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/agent$",
"location": "path",
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete",
"id": "dialogflow.projects.agent.intents.batchDelete",
"path": "v2beta1/{+parent}/intents:batchDelete"
},
"get": {
"description": "Retrieves the specified intent.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"parameters": {
"languageCode": {
"description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string",
"location": "query"
},
"name": {
"description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"location": "path"
},
"intentView": {
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"description": "Optional. The resource view to apply to the returned intent.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
"id": "dialogflow.projects.agent.intents.get",
"path": "v2beta1/{+name}"
},
"patch": {
"flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.intents.patch",
"description": "Updates the specified intent.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"intentView": {
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"description": "Optional. The resource view to apply to the returned intent.",
"type": "string",
"location": "query"
},
"languageCode": {
"location": "query",
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"batchUpdate": {
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate",
"path": "v2beta1/{+parent}/intents:batchUpdate",
"id": "dialogflow.projects.agent.intents.batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest"
},
"description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e"
}
}
},
"entityTypes": {
"methods": {
"patch": {
"description": "Updates the specified entity type.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"languageCode": {
"location": "query",
"description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.entityTypes.patch"
},
"get": {
"description": "Retrieves the specified entity type.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The name of the entity type.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
"required": true,
"type": "string"
},
"languageCode": {
"location": "query",
"description": "Optional. The language to retrieve entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.entityTypes.get"
},
"batchUpdate": {
"path": "v2beta1/{+parent}/entityTypes:batchUpdate",
"id": "dialogflow.projects.agent.entityTypes.batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest"
},
"description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/agent$",
"location": "path",
"description": "Required. The name of the agent to update or create entity types in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate"
},
"delete": {
"description": "Deletes the specified entity type.",
"httpMethod": "DELETE",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
"id": "dialogflow.projects.agent.entityTypes.delete",
"path": "v2beta1/{+name}"
},
"list": {
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
},
"parent": {
"description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$",
"location": "path"
},
"languageCode": {
"location": "query",
"description": "Optional. The language to list entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
"id": "dialogflow.projects.agent.entityTypes.list",
"path": "v2beta1/{+parent}/entityTypes",
"description": "Returns the list of all entity types in the specified agent."
},
"batchDelete": {
"id": "dialogflow.projects.agent.entityTypes.batchDelete",
"path": "v2beta1/{+parent}/entityTypes:batchDelete",
"description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/agent$",
"location": "path",
"description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete"
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
"path": "v2beta1/{+parent}/entityTypes",
"id": "dialogflow.projects.agent.entityTypes.create",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
},
"description": "Creates an entity type in the specified agent."
}
},
"resources": {
"entities": {
"methods": {
"batchUpdate": {
"path": "v2beta1/{+parent}/entities:batchUpdate",
"id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest"
},
"description": "Updates or creates multiple entities in the specified entity type. This\nmethod does not affect entities in the entity type that aren't explicitly\nspecified in the request.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The name of the entity type to update or create entities in.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate"
},
"batchDelete": {
"description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameters": {
"parent": {
"description": "Required. The name of the entity type to delete entries for. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete",
"id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
"path": "v2beta1/{+parent}/entities:batchDelete"
},
"batchCreate": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest"
},
"description": "Creates multiple new entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The name of the entity type to create entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate",
"path": "v2beta1/{+parent}/entities:batchCreate",
"id": "dialogflow.projects.agent.entityTypes.entities.batchCreate"
}
}
}
}
},
"environments": {
"resources": {
"users": {
"resources": {
"sessions": {
"methods": {
"detectIntent": {
"description": "Processes a natural language query and returns structured, actionable data\nas a result. This method is not idempotent, because it may cause contexts\nand session entity types to be updated, which in turn might affect\nresults of future queries.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"session"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It’s up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random numbers or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}:detectIntent",
"id": "dialogflow.projects.agent.environments.users.sessions.detectIntent",
"path": "v2beta1/{+session}:detectIntent"
},
"deleteContexts": {
"description": "Deletes all active contexts in the specified session.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"parent"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or `projects/\u003cProject\nID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession\nID\u003e`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.agent.environments.users.sessions.deleteContexts"
}
},
"resources": {
"entityTypes": {
"methods": {
"delete": {
"description": "Deletes the specified session entity type.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e` or `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment\nID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display\nName\u003e`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.delete"
},
"list": {
"description": "Returns the list of all session entity types in the specified session.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path",
"description": "Required. The session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/\nsessions/\u003cSession ID\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes",
"path": "v2beta1/{+parent}/entityTypes",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.list"
},
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e` or `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment\nID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display\nName\u003e`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.get",
"description": "Retrieves the specified session entity type."
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display Name\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`\u003cEntity Type Display Name\u003e` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.patch",
"path": "v2beta1/{+name}",
"description": "Updates the specified session entity type.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
}
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/\nsessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes",
"path": "v2beta1/{+parent}/entityTypes",
"id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.create",
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
}
}
}
},
"contexts": {
"methods": {
"delete": {
"description": "Deletes the specified context.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.delete",
"path": "v2beta1/{+name}"
},
"list": {
"description": "Returns the list of all contexts in the specified session.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"parameters": {
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
},
"parent": {
"description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.list",
"path": "v2beta1/{+parent}/contexts"
},
"get": {
"description": "Retrieves the specified context.",
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"location": "path",
"description": "Required. The name of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.get",
"path": "v2beta1/{+name}"
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$",
"location": "path",
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`,\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. The `Context ID` is\nalways converted to lowercase. If `Environment ID` is not specified, we\nassume default 'draft' environment. If `User ID` is not specified, we\nassume default '-' user.",
"required": true,
"type": "string"
},
"updateMask": {
"location": "query",
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}",
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.patch",
"path": "v2beta1/{+name}",
"description": "Updates the specified context.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"create": {
"id": "dialogflow.projects.agent.environments.users.sessions.contexts.create",
"path": "v2beta1/{+parent}/contexts",
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts"
}
}
}
}
}
}
}
}
},
"sessions": {
"resources": {
"entityTypes": {
"methods": {
"list": {
"description": "Returns the list of all session entity types in the specified session.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path",
"description": "Required. The session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/\nsessions/\u003cSession ID\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"id": "dialogflow.projects.agent.sessions.entityTypes.list",
"path": "v2beta1/{+parent}/entityTypes"
},
"get": {
"description": "Retrieves the specified session entity type.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Required. The name of the session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e` or `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment\nID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display\nName\u003e`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.entityTypes.get"
},
"patch": {
"description": "Updates the specified session entity type.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display Name\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`\u003cEntity Type Display Name\u003e` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"location": "path"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.entityTypes.patch"
},
"create": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"description": "Creates a session entity type.\n\nIf the specified session entity type already exists, overrides the\nsession entity type.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The session to create a session entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/\nsessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
"path": "v2beta1/{+parent}/entityTypes",
"id": "dialogflow.projects.agent.sessions.entityTypes.create"
},
"delete": {
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
"location": "path",
"description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e` or `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment\nID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display\nName\u003e`. If `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.entityTypes.delete",
"description": "Deletes the specified session entity type."
}
}
},
"contexts": {
"methods": {
"delete": {
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.contexts.delete",
"description": "Deletes the specified context."
},
"list": {
"description": "Returns the list of all contexts in the specified session.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.agent.sessions.contexts.list"
},
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.contexts.get",
"description": "Retrieves the specified context."
},
"patch": {
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.agent.sessions.contexts.patch",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"description": "Updates the specified context.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`,\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. The `Context ID` is\nalways converted to lowercase. If `Environment ID` is not specified, we\nassume default 'draft' environment. If `User ID` is not specified, we\nassume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
"location": "path"
}
}
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.agent.sessions.contexts.create",
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
}
}
}
},
"methods": {
"detectIntent": {
"httpMethod": "POST",
"parameterOrder": [
"session"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
},
"parameters": {
"session": {
"description": "Required. The name of the session this query is sent to. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we are using\n\"-\". It’s up to the API caller to choose an appropriate `Session ID` and\n`User Id`. They can be a random numbers or some type of user and session\nidentifiers (preferably hashed). The length of the `Session ID` and\n`User ID` must not exceed 36 characters.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
"id": "dialogflow.projects.agent.sessions.detectIntent",
"path": "v2beta1/{+session}:detectIntent",
"description": "Processes a natural language query and returns structured, actionable data\nas a result. This method is not idempotent, because it may cause contexts\nand session entity types to be updated, which in turn might affect\nresults of future queries.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
}
},
"deleteContexts": {
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.agent.sessions.deleteContexts",
"description": "Deletes all active contexts in the specified session.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"parent"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path",
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or `projects/\u003cProject\nID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession\nID\u003e`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts"
}
}
}
}
},
"environments": {
"resources": {
"users": {
"resources": {
"conversations": {
"methods": {
"deleteContexts": {
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"parent"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The name of the session to delete all contexts from. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or `projects/\u003cProject\nID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser ID\u003e/sessions/\u003cSession\nID\u003e`. If `Environment ID` is not specified we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.environments.users.conversations.deleteContexts",
"description": "Deletes all active contexts in the specified session."
}
},
"resources": {
"contexts": {
"methods": {
"list": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"parent": {
"location": "path",
"description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+$"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.environments.users.conversations.contexts.list",
"description": "Returns the list of all contexts in the specified session."
},
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The name of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+/contexts/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.environments.users.conversations.contexts.get",
"description": "Retrieves the specified context."
},
"patch": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"location": "query",
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+/contexts/[^/]+$",
"location": "path",
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`,\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. The `Context ID` is\nalways converted to lowercase. If `Environment ID` is not specified, we\nassume default 'draft' environment. If `User ID` is not specified, we\nassume default '-' user.",
"required": true,
"type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.environments.users.conversations.contexts.patch",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"description": "Updates the specified context."
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e` or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e`. If `Environment ID` is not specified, we assume\ndefault 'draft' environment. If `User ID` is not specified, we assume\ndefault '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts",
"path": "v2beta1/{+parent}/contexts",
"id": "dialogflow.projects.environments.users.conversations.contexts.create",
"description": "Creates a context.\n\nIf the specified context already exists, overrides the context.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"delete": {
"description": "Deletes the specified context.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. If `Environment ID` is\nnot specified, we assume default 'draft' environment. If `User ID` is not\nspecified, we assume default '-' user.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/environments/[^/]+/users/[^/]+/conversations/[^/]+/contexts/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/environments/{environmentsId}/users/{usersId}/conversations/{conversationsId}/contexts/{contextsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.environments.users.conversations.contexts.delete"
}
}
}
}
}
}
}
}
},
"phoneNumberOrders": {
"methods": {
"cancel": {
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the order to delete.\nFormat: `projects/\u003cProject ID\u003e/phoneNumberOrders/\u003cOrder ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/phoneNumberOrders/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/phoneNumberOrders/{phoneNumberOrdersId}:cancel",
"path": "v2beta1/{+name}:cancel",
"id": "dialogflow.projects.phoneNumberOrders.cancel",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest"
},
"description": "Cancels an `PhoneNumberOrder`.\nReturns an error if the order is in state\nIN_PROGRESS or\nCOMPLETED."
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The unique identifier of the order to retrieve.\nFormat: `projects/\u003cProject ID\u003e/phoneNumberOrders/\u003cOrder ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/phoneNumberOrders/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/phoneNumberOrders/{phoneNumberOrdersId}",
"id": "dialogflow.projects.phoneNumberOrders.get",
"path": "v2beta1/{+name}",
"description": "Returns a specific `PhoneNumberOrder`."
},
"list": {
"flatPath": "v2beta1/projects/{projectsId}/phoneNumberOrders",
"path": "v2beta1/{+parent}/phoneNumberOrders",
"id": "dialogflow.projects.phoneNumberOrders.list",
"description": "Lists of all `PhoneNumberOrder` resources in the specified project.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page.\nThe default value is 100. The maximum value is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"description": "Required. The project to list all orders from.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"pattern": "^projects/[^/]+/phoneNumberOrders/[^/]+$",
"location": "path",
"description": "Required. The unique identifier of this order.\nFormat: `projects/\u003cProject ID\u003e/phoneNumberOrders/\u003cOrder ID\u003e`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/phoneNumberOrders/{phoneNumberOrdersId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.phoneNumberOrders.patch",
"description": "Updates the specified `PhoneNumberOrder` resource.\nReturns an error if the order is in state\nIN_PROGRESS or\nCOMPLETED.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
}
},
"create": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. Resource identifier of the project requesting the orders.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/phoneNumberOrders",
"path": "v2beta1/{+parent}/phoneNumberOrders",
"id": "dialogflow.projects.phoneNumberOrders.create",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
},
"description": "Creates an order to request phone numbers be added to a project.\nThe initial `LifecycleState` of a newly created order is\nPENDING."
}
}
},
"conversations": {
"methods": {
"complete": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Conversation"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. Resource identifier of the conversation to close.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}:complete",
"path": "v2beta1/{+name}:complete",
"id": "dialogflow.projects.conversations.complete",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1CompleteConversationRequest"
},
"description": "Completes the specified conversation. Finished conversations are purged\nfrom the database after 30 days."
},
"list": {
"description": "Returns the list of all conversations in the specified project.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListConversationsResponse"
},
"parameters": {
"filter": {
"location": "query",
"description": "A filter expression that filters conversations listed in the response. In\ngeneral, the expression must specify the field name, a comparison operator,\nand the value to use for filtering:\n\u003cul\u003e\n \u003cli\u003eThe value must be a string, a number, or a boolean.\u003c/li\u003e\n \u003cli\u003eThe comparison operator must be either `=`,`!=`, `\u003e`, or `\u003c`.\u003c/li\u003e\n \u003cli\u003eTo filter on multiple expressions, separate the\n expressions with `AND` or `OR` (omitting both implies `AND`).\u003c/li\u003e\n \u003cli\u003eFor clarity, expressions can be enclosed in parentheses.\u003c/li\u003e\n\u003c/ul\u003e\nOnly `lifecycle_state` can be filtered on in this way. For example,\nthe following expression only returns `FINISHED` conversations:\n\n`lifecycle_state = \"FINISHED\"`",
"type": "string"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
},
"parent": {
"description": "Required. The project from which to list all conversation.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations",
"id": "dialogflow.projects.conversations.list",
"path": "v2beta1/{+parent}/conversations"
},
"get": {
"description": "Retrieves the specific conversation.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Conversation"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Required. The name of the conversation. Format:\n`projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.conversations.get"
},
"create": {
"description": "Creates a new conversation. Conversation are auto-completed after 24 hours.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Conversation"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Conversation"
},
"parameters": {
"parent": {
"description": "Required. Resource identifier of the project creating the conversation.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations",
"id": "dialogflow.projects.conversations.create",
"path": "v2beta1/{+parent}/conversations"
},
"addConversationPhoneNumber": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationPhoneNumber"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"description": "The name of this conversation.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}:addConversationPhoneNumber",
"path": "v2beta1/{+name}:addConversationPhoneNumber",
"id": "dialogflow.projects.conversations.addConversationPhoneNumber",
"description": "Sets a phone number for this converstion to connect to.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest"
}
}
},
"resources": {
"messages": {
"methods": {
"list": {
"id": "dialogflow.projects.conversations.messages.list",
"path": "v2beta1/{+parent}/messages",
"description": "Lists messages that belong to a given conversation.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListMessagesResponse"
},
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer"
},
"parent": {
"description": "Required. The name of the conversation to list messages for.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/messages"
}
}
},
"participants": {
"methods": {
"create": {
"path": "v2beta1/{+parent}/participants",
"id": "dialogflow.projects.conversations.participants.create",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1Participant"
},
"description": "Creates a new participant in a conversation.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Participant"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. Resource identifier of the conversation adding the participant.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants"
},
"get": {
"response": {
"$ref": "GoogleCloudDialogflowV2beta1Participant"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The name of the participant. Format:\n`projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/\u003cParticipant ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.conversations.participants.get",
"description": "Retrieves a conversation participant."
},
"list": {
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants",
"path": "v2beta1/{+parent}/participants",
"id": "dialogflow.projects.conversations.participants.list",
"description": "Returns the list of all participants in the specified conversation.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListParticipantsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"description": "Required. The conversation to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+$",
"location": "path"
}
}
},
"analyzeContent": {
"description": "Adds a text (chat, for example), or audio (phone recording, for example)\nmessage from a participan into the conversation.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest"
},
"response": {
"$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentResponse"
},
"parameterOrder": [
"participant"
],
"httpMethod": "POST",
"parameters": {
"participant": {
"description": "Required. The name of the participant this text comes from.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/\u003cParticipant ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent",
"path": "v2beta1/{+participant}:analyzeContent",
"id": "dialogflow.projects.conversations.participants.analyzeContent"
},
"streamingAnalyzeContent": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest"
},
"description": "Adds a text (chat, for example), or audio (phone recording, for example)\nmessage from a participan into the conversation.\nNote: This method is only available through the gRPC API (not REST).\n\nThe top-level message sent to the client by the server is\n`StreamingAnalyzeContentResponse`. Multiple response messages can be\nreturned in order. The first one or more messages contain the\n`recognition_result` field. Each result represents a more complete\ntranscript of what the user said. The next message contains the\n`reply_text` field and potentially the `reply_audio` field. The message can\nalso contain the `automated_agent_reply` field.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse"
},
"parameterOrder": [
"participant"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"participant": {
"location": "path",
"description": "Required. The name of the participant this text comes from.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/\u003cParticipant ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}:streamingAnalyzeContent",
"path": "v2beta1/{+participant}:streamingAnalyzeContent",
"id": "dialogflow.projects.conversations.participants.streamingAnalyzeContent"
}
},
"resources": {
"suggestions": {
"methods": {
"list": {
"description": "Retrieves suggestions for live agents.\n\nThis method should be used by human agent client software to fetch\nsuggestions in real-time, while the conversation with an end user is in\nprogress. The functionality is implemented in terms of the\n[list pagination](/apis/design/design_patterns#list_pagination)\ndesign pattern. The client app should use the `next_page_token` field\nto fetch the next batch of suggestions.",
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListSuggestionsResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$",
"location": "path",
"description": "Required. The name of the conversation participant for whom to fetch\nsuggestions.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/\u003cParticipant ID\u003e`.",
"required": true,
"type": "string"
},
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of items to return in a single page. The\ndefault value is 100; the maximum value is 1000.",
"format": "int32",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions",
"id": "dialogflow.projects.conversations.participants.suggestions.list",
"path": "v2beta1/{+parent}/suggestions"
}
}
}
}
}
}
},
"phoneNumbers": {
"methods": {
"delete": {
"description": "Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on a `PhoneNumber` in the\nACTIVE state.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The unique identifier of the `PhoneNumber` to delete.\nFormat: `projects/\u003cProject ID\u003e/phoneNumbers/\u003cPhoneNumber ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$",
"location": "path"
}
},
"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}",
"path": "v2beta1/{+name}",
"id": "dialogflow.projects.phoneNumbers.delete"
},
"list": {
"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers",
"path": "v2beta1/{+parent}/phoneNumbers",
"id": "dialogflow.projects.phoneNumbers.list",
"description": "Returns the list of all phone numbers in the specified project.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The project to list all `PhoneNumber` resources from.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
},
"showDeleted": {
"location": "query",
"description": "Optional. Controls whether `PhoneNumber` resources in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false.",
"type": "boolean"
},
"pageToken": {
"location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of items to return in a single page.\nThe default value is 100. The maximum value is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
}
}
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber"
},
"parameters": {
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"description": "Required. The unique identifier of this phone number.\nFormat: `projects/\u003cProject ID\u003e/phoneNumbers/\u003cPhoneNumber ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}",
"id": "dialogflow.projects.phoneNumbers.patch",
"path": "v2beta1/{+name}",
"description": "Updates the specified `PhoneNumber`.",
"request": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber"
}
},
"undelete": {
"request": {
"$ref": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest"
},
"description": "Cancels the deletion request for a `PhoneNumber`. This method may only be\ncalled on a `PhoneNumber` in the\nDELETE_REQUESTED state.",
"response": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The unique identifier of the `PhoneNumber` to delete.\nFormat: `projects/\u003cProject ID\u003e/phoneNumbers/\u003cPhoneNumber ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/phoneNumbers/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}:undelete",
"path": "v2beta1/{+name}:undelete",
"id": "dialogflow.projects.phoneNumbers.undelete"
}
}
},
"operations": {
"methods": {
"get": {
"httpMethod": "GET",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/operations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}",
"id": "dialogflow.projects.operations.get",
"path": "v2beta1/{+name}",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
}
}
}
}
}
},
"parameters": {
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
"quotaUser": {
"location": "query",
"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.",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"alt": {
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"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"
},
"key": {
"location": "query",
"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.",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
}
},
"version": "v2beta1",
"baseUrl": "https://dialogflow.googleapis.com/",
"servicePath": "",
"kind": "discovery#restDescription",
"description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).",
"basePath": "",
"id": "dialogflow:v2beta1",
"documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
"revision": "20181009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"phoneNumbers": {
"description": "The list of `PhoneNumber` resources. There is a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumber"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse",
"description": "The response message for PhoneNumbers.ListPhoneNumbers.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"type": "object",
"properties": {
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.",
"type": "string"
},
"agentContent": {
"description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e <agent zip file>\u003c/pre\u003e",
"format": "byte",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ExportAgentResponse"
},
"GoogleCloudDialogflowV2beta1ConversationProfile": {
"description": "Defines the services to connect to incoming Dialogflow conversations.",
"type": "object",
"properties": {
"displayName": {
"description": "Required. Human readable name for this profile. Max length 1024 bytes.",
"type": "string"
},
"loggingConfig": {
"$ref": "GoogleCloudDialogflowV2beta1LoggingConfig",
"description": "Optional. Configuration for logging conversation lifecycle events."
},
"automatedAgentConfig": {
"$ref": "GoogleCloudDialogflowV2beta1AutomatedAgentConfig",
"description": "Optional. Configuration for an automated agent to use with this profile."
},
"notificationConfig": {
"description": "Optional. Configuration for publishing conversation lifecycle events.",
"$ref": "GoogleCloudDialogflowV2beta1NotificationConfig"
},
"humanAgentAssistantConfig": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig",
"description": "Optional. Configuration for agent assistance to use with this profile."
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically).\nThe unique identifier of this conversation profile.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversation Profile\nID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ConversationProfile"
},
"GoogleCloudDialogflowV2OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"type": "object",
"properties": {
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field is set to the value of the `QueryParameters.payload`\nfield passed in the request. Some integrations that query a Dialogflow\nagent may provide additional information in the payload.\n\nIn particular for the Telephony Gateway this field has the form:\n\u003cpre\u003e{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}\u003c/pre\u003e\nNote: The caller ID field (`caller_id`) will be redacted for Standard\nEdition agents and populated with the caller ID in [E.164\nformat](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.",
"type": "object"
},
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request.\nThis field is AoG-specific.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest"
},
"GoogleCloudDialogflowV2beta1OutputAudio": {
"description": "Represents the natural language speech audio to be played to the end user.",
"type": "object",
"properties": {
"config": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"description": "Required. Instructs the speech synthesizer how to generate the speech\naudio."
},
"audio": {
"description": "Required. The natural language speech audio.",
"format": "byte",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1OutputAudio"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "GoogleRpcStatus"
},
"metadata": {
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
}
},
"id": "GoogleLongrunningOperation"
},
"GoogleCloudDialogflowV2beta1ListConversationsResponse": {
"description": "The response message for Conversations.ListConversations.",
"type": "object",
"properties": {
"conversations": {
"description": "The list of conversations. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Conversation"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListConversationsResponse"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": {
"properties": {
"phoneNumber": {
"description": "Required. The phone number to transfer the call to\nin [E.164 format](https://en.wikipedia.org/wiki/E.164).\n\nWe currently only allow transferring to US numbers (+1xxxyyyzzzz).",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall",
"description": "Transfers the call in Telephony Gateway.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageImage": {
"properties": {
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
},
"accessibilityText": {
"description": "A text description of the image to be used for accessibility,\ne.g., screen readers. Required if image_uri is set for CarouselSelect.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "The image response message.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig": {
"description": "Configures the types of sentiment analysis to perform.",
"type": "object",
"properties": {
"analyzeQueryTextSentiment": {
"description": "Optional. Instructs the service to perform sentiment analysis on\n`query_text`. If not provided, sentiment analysis is not performed on\n`query_text`.",
"type": "boolean"
}
},
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig"
},
"GoogleCloudDialogflowV2beta1CompleteConversationRequest": {
"description": "The request message for Conversations.CompleteConversation.",
"type": "object",
"properties": {},
"id": "GoogleCloudDialogflowV2beta1CompleteConversationRequest"
},
"GoogleCloudDialogflowV2beta1SearchAgentsResponse": {
"description": "The response message for Agents.SearchAgents.",
"type": "object",
"properties": {
"agents": {
"description": "The list of agents. There will be a maximum number of items returned based\non the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Agent"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1SearchAgentsResponse"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"type": "object",
"properties": {
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech.",
"type": "string"
},
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
},
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"type": "object",
"properties": {
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
},
"image": {
"description": "Optional. The image to display.",
"$ref": "GoogleCloudDialogflowV2IntentMessageImage"
},
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
}
},
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem"
},
"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"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton",
"description": "The button object that appears at the bottom of a card.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1QueryInput": {
"description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.",
"type": "object",
"properties": {
"audioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig",
"description": "Instructs the speech recognizer how to process the speech audio."
},
"event": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "The event to be processed."
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1TextInput",
"description": "The natural language text to be processed."
}
},
"id": "GoogleCloudDialogflowV2beta1QueryInput"
},
"GoogleCloudDialogflowV2beta1Agent": {
"description": "Represents a conversational agent.",
"type": "object",
"properties": {
"matchMode": {
"enumDescriptions": [
"Not specified.",
"Best for agents with a small number of examples in intents and/or wide\nuse of templates syntax and composite entities.",
"Can be used for agents with a large number of examples in intents,\nespecially the ones using @sys.any or very large developer entities."
],
"enum": [
"MATCH_MODE_UNSPECIFIED",
"MATCH_MODE_HYBRID",
"MATCH_MODE_ML_ONLY"
],
"description": "Optional. Determines how intents are detected from user queries.",
"type": "string"
},
"supportedLanguageCodes": {
"description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
"type": "array",
"items": {
"type": "string"
}
},
"enableLogging": {
"description": "Optional. Determines whether this agent should log conversation queries.",
"type": "boolean"
},
"avatarUri": {
"description": "Optional. The URI of the agent's avatar.\nAvatars are used throughout the Dialogflow console and in the self-hosted\n[Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.",
"type": "string"
},
"classificationThreshold": {
"description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent is be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.",
"format": "float",
"type": "number"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See\n[Language Support](https://dialogflow.com/docs/reference/language) for a\nlist of the currently supported language codes.\nThis field cannot be set by the `Update` method.",
"type": "string"
},
"timeZone": {
"description": "Required. The time zone of this agent from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris.",
"type": "string"
},
"description": {
"description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
},
"displayName": {
"description": "Required. The name of this agent.",
"type": "string"
},
"parent": {
"description": "Required. The project of this agent.\nFormat: `projects/\u003cProject ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Agent"
},
"GoogleCloudDialogflowV2beta1PhoneNumberOrder": {
"description": "Represents a phone number order.\nOrders can assign phone numbers to projects.",
"type": "object",
"properties": {
"description": {
"description": "Optional. A description of the order, limit is 1024 bytes.",
"type": "string"
},
"phoneNumberSpec": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberSpec",
"description": "Order is for new numbers."
},
"createTime": {
"description": "Output only. The time this order was created.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this order was last updated.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this order.\nFormat: `projects/\u003cProject ID\u003e/phoneNumberOrders/\u003cOrder ID\u003e`.",
"type": "string"
},
"lifecycleState": {
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"PENDING",
"IN_PROGRESS",
"COMPLETED",
"CANCELLED"
],
"description": "Output only. The current status of the order.",
"type": "string",
"enumDescriptions": [
"Unknown.",
"Order is awaiting action.",
"Order is being worked on, and is partially fulfilled.",
"Order has been fulfilled.",
"Order has been cancelled."
]
},
"phoneNumbers": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. A map of ordered numbers filled so far, keyed by their\nresource name. Key format:\n`projects/\u003cProject ID\u003e/phoneNumbers/\u003cPhoneNumber ID\u003e`.\nValue format: E.164 phone number. Output only.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
},
"GoogleCloudDialogflowV2IntentTrainingPhrase": {
"description": "Represents an example or template that the agent is trained on.",
"type": "object",
"properties": {
"timesAddedCount": {
"description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
"format": "int32",
"type": "integer"
},
"type": {
"enum": [
"TYPE_UNSPECIFIED",
"EXAMPLE",
"TEMPLATE"
],
"description": "Required. The type of the training phrase.",
"type": "string",
"enumDescriptions": [
"Not specified. This value should never be used.",
"Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings."
]
},
"parts": {
"description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart"
}
},
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentTrainingPhrase"
},
"GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchCreateEntities.",
"type": "object",
"properties": {
"entities": {
"description": "Required. The entities to create.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
}
},
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest"
},
"GoogleCloudDialogflowV2beta1SuggestionFaqAnswer": {
"description": "Represents suggested answer from \"frequently asked questions\".",
"type": "object",
"properties": {
"answer": {
"description": "Output only. The piece of text from the `source` knowledge base document.",
"type": "string"
},
"confidence": {
"description": "The system's confidence score that this Knowledge answer is a good match\nfor this conversational query, range from 0.0 (completely uncertain)\nto 1.0 (completely certain).",
"format": "float",
"type": "number"
},
"question": {
"description": "Output only. The corresponding FAQ question.",
"type": "string"
},
"source": {
"description": "Output only. Indicates which Knowledge Document this answer was extracted\nfrom.\nFormat: `projects/\u003cProject ID\u003e/agent/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. A map that contains metadata about the answer and the\ndocument from which it originates.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer"
},
"GoogleCloudDialogflowV2beta1CompileSuggestionsResponse": {
"description": "The response message for\nHumanAgentAssistants.RequestCompileSuggestions",
"type": "object",
"properties": {
"suggestions": {
"description": "Required.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Suggestion"
}
}
},
"id": "GoogleCloudDialogflowV2beta1CompileSuggestionsResponse"
},
"GoogleCloudDialogflowV2beta1RestoreAgentRequest": {
"description": "The request message for Agents.RestoreAgent.",
"type": "object",
"properties": {
"agentContent": {
"description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat <agent zip file> | base64 -w 0)'\n }\"\u003c/pre\u003e",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1RestoreAgentRequest"
},
"GoogleCloudDialogflowV2beta1DetectIntentResponse": {
"properties": {
"outputAudioConfig": {
"description": "Instructs the speech synthesizer how to generate the output audio. This\nfield is populated from the agent-level speech synthesizer configuration,\nif enabled.",
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig"
},
"outputAudio": {
"description": "The audio data bytes encoded as specified in the request.",
"format": "byte",
"type": "string"
},
"queryResult": {
"description": "The selected results of the conversational query or event processing.\nSee `alternative_query_results` for additional potential results.",
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"webhookStatus": {
"$ref": "GoogleRpcStatus",
"description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests."
},
"alternativeQueryResults": {
"description": "If Knowledge Connectors are enabled, there could be more than one result\nreturned for a given query or event, and this field will contain all\nresults except for the top one, which is captured in query_result. The\nalternative results are ordered by decreasing\n`QueryResult.intent_detection_confidence`. If Knowledge Connectors are\ndisabled, this field will be empty until multiple responses for regular\nintents are supported, at which point those additional results will be\nsurfaced here.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
}
},
"responseId": {
"description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1DetectIntentResponse",
"description": "The message returned from the DetectIntent method.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1Participant": {
"description": "Represents a single side of the conversation.",
"type": "object",
"properties": {
"role": {
"enum": [
"ROLE_UNSPECIFIED",
"HUMAN_AGENT",
"AUTOMATED_AGENT",
"END_USER"
],
"description": "Required. The role this participant plays in the conversation.",
"type": "string",
"enumDescriptions": [
"Participant role not set.",
"Participant is a human agent.",
"Participant is an automated agent, such as a Dialogflow agent.",
"Participant is an end user that has called or chatted with\nDialogflow services."
]
},
"name": {
"description": "Required. The unique identifier of this participant.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/\u003cParticipant ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Participant"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": {
"description": "Plays audio from a file in Telephony Gateway.",
"type": "object",
"properties": {
"audioUri": {
"description": "Required. URI to a Google Cloud Storage object containing the audio to\nplay, e.g., \"gs://bucket/object\". The object must contain a single\nchannel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.\n\nThis object must be readable by the `service-\u003cProject\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` service account\nwhere \u003cProject Number\u003e is the number of the Telephony Gateway project\n(usually the same as the Dialogflow agent project). If the Google Cloud\nStorage bucket is in the Telephony Gateway project, this permission is\nadded by default when enabling the Dialogflow V2 API.\n\nFor audio from other sources, consider using the\n`TelephonySynthesizeSpeech` message with SSML.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio"
},
"GoogleCloudDialogflowV2beta1WebhookRequest": {
"properties": {
"queryResult": {
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.",
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
},
"originalDetectIntentRequest": {
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
"$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest"
},
"alternativeQueryResults": {
"description": "Alternative query results from KnowledgeService.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1QueryResult"
}
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1WebhookRequest",
"description": "The request message for a webhook call.",
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"type": "object",
"properties": {
"items": {
"description": "Required. List items.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem"
}
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageListSelect"
},
"GoogleCloudDialogflowV2beta1IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"type": "object",
"properties": {
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
},
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "GoogleProtobufEmpty"
},
"GoogleCloudDialogflowV2IntentMessageListSelectItem": {
"description": "An item in the list.",
"type": "object",
"properties": {
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"info": {
"description": "Required. Additional information about this option.",
"$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo"
},
"title": {
"description": "Required. The title of the list item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image to display."
}
},
"id": "GoogleCloudDialogflowV2IntentMessageListSelectItem"
},
"GoogleCloudDialogflowV2beta1Suggestion": {
"description": "Represents a suggestion for a human agent.",
"type": "object",
"properties": {
"name": {
"description": "Output only. The name of this suggestion. Format:\n`projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/participants/*/suggestions/\u003cSuggestion ID\u003e`.",
"type": "string"
},
"faqAnswers": {
"description": "Optional. Answers extracted from FAQ documents.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer"
}
},
"articles": {
"description": "Output only. Articles ordered by score in descending order.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SuggestionArticle"
}
},
"createTime": {
"description": "Output only. The time the suggestion was created.",
"format": "google-datetime",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Suggestion"
},
"GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest": {
"description": "The request message for Intents.BatchDeleteIntents.",
"type": "object",
"properties": {
"intents": {
"description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest"
},
"GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": {
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"type": "object",
"properties": {
"source": {
"description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers.",
"type": "string"
},
"version": {
"description": "Optional. The version of the protocol used for this request.\nThis field is AoG-specific.",
"type": "string"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field is set to the value of the `QueryParameters.payload`\nfield passed in the request. Some integrations that query a Dialogflow\nagent may provide additional information in the payload.\n\nIn particular for the Telephony Gateway this field has the form:\n\u003cpre\u003e{\n \"telephony\": {\n \"caller_id\": \"+18558363987\"\n }\n}\u003c/pre\u003e\nNote: The caller ID field (`caller_id`) will be redacted for Standard\nEdition agents and populated with the caller ID in [E.164\nformat](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest"
},
"GoogleCloudDialogflowV2beta1WebhookResponse": {
"description": "The response message for a webhook call.",
"type": "object",
"properties": {
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations\n(e.g., Actions on Google or Dialogflow phone gateway) use this information\nto close interaction with an end user. Default is false.",
"type": "boolean"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2beta1EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input."
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"type": "string"
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
}
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.\nSee the related `fulfillment_messages[i].payload field`, which may be used\nas an alternative to this field.\n\nThis field can be used for Actions on Google responses.\nIt should have a structure similar to the JSON message shown here. For more\ninformation, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"google\": {\n \"expectUserResponse\": true,\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"textToSpeech\": \"this is a simple response\"\n }\n }\n ]\n }\n }\n}\u003c/pre\u003e",
"type": "object"
},
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1WebhookResponse"
},
"GoogleCloudDialogflowV2IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a\ndialog.",
"type": "object",
"properties": {
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo"
},
"GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse": {
"description": "The top-level message returned from the `StreamingAnalyzeContent` method.\n\nMultiple response messages can be returned in order:\n\n1. If the input was set to streaming audio, the first one or more messages\n contain `recognition_result`. Each `recognition_result` represents a more\n complete transcript of what the user said. The last `recognition_result`\n has `is_final` set to `true`.\n\n2. The next message contains `reply_text` and optionally `reply_audio`\n returned by an agent. This message may also contain\n `automated_agent_reply`.",
"type": "object",
"properties": {
"replyText": {
"description": "Optional. The output text content.\nThis field is set if an automated agent responded with a text for the user.",
"type": "string"
},
"replyAudio": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudio",
"description": "Optional. The audio data bytes encoded as specified in the request.\nThis field is set if:\n - The `reply_audio_config` field is specified in the request.\n - The automated agent, which this output comes from, responded with audio.\n In such case, the `reply_audio.config` field contains settings used to\n synthesize the speech."
},
"automatedAgentReply": {
"$ref": "GoogleCloudDialogflowV2beta1AutomatedAgentReply",
"description": "Optional. Only set if a Dialogflow automated agent has responded."
},
"recognitionResult": {
"$ref": "GoogleCloudDialogflowV2beta1StreamingRecognitionResult",
"description": "The result of speech recognition."
}
},
"id": "GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"type": "object",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction"
},
"GoogleCloudDialogflowV2IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"type": "object",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageQuickReplies"
},
"GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"type": "object",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityType"
}
}
},
"id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse"
},
"GoogleCloudDialogflowV2beta1Document": {
"description": "A document resource.\n\nNote: resource `projects.agent.knowledgeBases.documents` is deprecated,\nplease use `projects.knowledgeBases.documents` instead.",
"type": "object",
"properties": {
"name": {
"description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"type": "string"
},
"content": {
"description": "The raw content of the document. This field is only permitted for\nEXTRACTIVE_QA and FAQ knowledge types.\nNote: This field is in the process of being deprecated, please use\nraw_content instead.",
"type": "string"
},
"mimeType": {
"description": "Required. The MIME type of this document.",
"type": "string"
},
"knowledgeTypes": {
"enumDescriptions": [
"The type is unspecified or arbitrary.",
"The document content contains question and answer pairs as either HTML or\nCSV. Typical FAQ HTML formats are parsed accurately, but unusual formats\nmay fail to be parsed.\n\nCSV must have questions in the first column and answers in the second,\nwith no header. Because of this explicit format, they are always parsed\naccurately.",
"Documents for which unstructured text is extracted and used for\nquestion answering."
],
"description": "Required. The knowledge type of document content.",
"type": "array",
"items": {
"enum": [
"KNOWLEDGE_TYPE_UNSPECIFIED",
"FAQ",
"EXTRACTIVE_QA"
],
"type": "string"
}
},
"rawContent": {
"description": "The raw content of the document. This field is only permitted for\nEXTRACTIVE_QA and FAQ knowledge types.",
"format": "byte",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the document. The name must be 1024 bytes or\nless; otherwise, the creation request fails.",
"type": "string"
},
"contentUri": {
"description": "The URI where the file content is located.\n\nFor documents stored in Google Cloud Storage, these URIs must have\nthe form `gs://\u003cbucket-name\u003e/\u003cobject-name\u003e`.\n\nNOTE: External URLs must correspond to public webpages, i.e., they must\nbe indexed by Google Search. In particular, URLs for showing documents in\nGoogle Cloud Storage (i.e. the URL in your browser) are not supported.\nInstead use the `gs://` format URI described above.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Document"
},
"GoogleCloudDialogflowV2beta1EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"type": "object",
"properties": {
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"kind": {
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
"List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
],
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST"
],
"description": "Required. Indicates the kind of entity type.",
"type": "string"
},
"autoExpansionMode": {
"enumDescriptions": [
"Auto expansion disabled for the entity.",
"Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
],
"enum": [
"AUTO_EXPANSION_MODE_UNSPECIFIED",
"AUTO_EXPANSION_MODE_DEFAULT"
],
"description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
"type": "string"
},
"entities": {
"description": "Optional. The collection of entities associated with the entity type.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
}
}
},
"id": "GoogleCloudDialogflowV2beta1EntityType"
},
"GoogleCloudDialogflowV2beta1QueryParameters": {
"description": "Represents the parameters of the conversational query.",
"type": "object",
"properties": {
"knowledgeBaseNames": {
"description": "Optional. KnowledgeBases to get alternative results from. If not set, the\nKnowledgeBases enabled in the agent (through UI) will be used.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"type": "array",
"items": {
"type": "string"
}
},
"contexts": {
"description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"sentimentAnalysisRequestConfig": {
"description": "Optional. Configures the type of sentiment analysis to perform. If not\nprovided, sentiment analysis is not performed.\nNote: Sentiment Analysis is only currently available for Enterprise Edition\nagents.",
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig"
},
"timeZone": {
"description": "Optional. The time zone of this conversational query from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris. If not provided, the time zone specified in\nagent settings is used.",
"type": "string"
},
"sessionEntityTypes": {
"description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
}
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This field can be used to pass custom data into the webhook\nassociated with the agent. Arbitrary JSON objects are supported.",
"type": "object"
},
"geoLocation": {
"description": "Optional. The geo location of this conversational query.",
"$ref": "GoogleTypeLatLng"
},
"resetContexts": {
"description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
"type": "boolean"
}
},
"id": "GoogleCloudDialogflowV2beta1QueryParameters"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
"type": "object",
"properties": {
"textToSpeech": {
"description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
"type": "string"
},
"ssml": {
"description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech.",
"type": "string"
},
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse"
},
"GoogleCloudDialogflowV2beta1SessionEntityType": {
"description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
"type": "object",
"properties": {
"name": {
"description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`, or\n`projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type Display Name\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment. If `User ID` is not specified, we assume default '-' user.\n\n`\u003cEntity Type Display Name\u003e` must be the display name of an existing entity\ntype in the same agent that will be overridden or supplemented.",
"type": "string"
},
"entityOverrideMode": {
"enumDescriptions": [
"Not specified. This value should be never used.",
"The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.",
"The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type."
],
"enum": [
"ENTITY_OVERRIDE_MODE_UNSPECIFIED",
"ENTITY_OVERRIDE_MODE_OVERRIDE",
"ENTITY_OVERRIDE_MODE_SUPPLEMENT"
],
"description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
"type": "string"
},
"entities": {
"description": "Required. The collection of entities associated with this session entity\ntype.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
}
}
},
"id": "GoogleCloudDialogflowV2beta1SessionEntityType"
},
"GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse": {
"description": "Response message for KnowledgeBases.ListKnowledgeBases.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"knowledgeBases": {
"description": "The list of knowledge bases.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse"
},
"GoogleCloudDialogflowV2beta1QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"type": "object",
"properties": {
"webhookPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
"type": "object"
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
}
},
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.",
"type": "string"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"type": "object"
},
"knowledgeAnswers": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers",
"description": "The result from Knowledge Connector (if any), ordered by decreasing\n`KnowledgeAnswers.match_confidence`."
},
"sentimentAnalysisResult": {
"$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult",
"description": "The sentiment analysis result, which depends on the\n`sentiment_analysis_request_config` specified in the request."
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nIf there are `multiple knowledge_answers` messages, this value is set to\nthe greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n- `false` if the matched intent has required parameters and not all of\n the required parameter values have been collected.\n- `true` if all required parameter values have been collected, or if the\n matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set.\n\nThis field is not guaranteed to be accurate or set. In particular this\nfield isn't set for StreamingDetectIntent since the streaming endpoint has\nseparate confidence estimates per portion of the audio in\nStreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"queryText": {
"description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
"type": "string"
},
"diagnosticInfo": {
"description": "The free-form diagnostic info. For example, this field\ncould contain webhook call latency.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
}
},
"intent": {
"$ref": "GoogleCloudDialogflowV2beta1Intent",
"description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`."
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language Support](https://dialogflow.com/docs/reference/language)\nfor a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
}
},
"id": "GoogleCloudDialogflowV2beta1QueryResult"
},
"GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": {
"description": "Synthesizes speech and plays back the synthesized audio to the caller in\nTelephony Gateway.\n\nTelephony Gateway takes the synthesizer settings from\n`DetectIntentResponse.output_audio_config` which can either be set\nat request-level or can come from the agent-level synthesizer config.",
"type": "object",
"properties": {
"text": {
"description": "The raw text to be synthesized.",
"type": "string"
},
"ssml": {
"description": "The SSML to be synthesized. For more information, see\n[SSML](https://developers.google.com/actions/reference/ssml).",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech"
},
"GoogleCloudDialogflowV2beta1SuggestionArticle": {
"description": "Represents suggested article.",
"type": "object",
"properties": {
"uri": {
"description": "Output only. The article URI.",
"type": "string"
},
"snippets": {
"description": "Output only. Article snippets.",
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"description": "Output only. The article title.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. A map that contains metadata about the answer and the\ndocument from which it originates.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2beta1SuggestionArticle"
},
"GoogleCloudDialogflowV2beta1TrainAgentRequest": {
"description": "The request message for Agents.TrainAgent.",
"type": "object",
"properties": {},
"id": "GoogleCloudDialogflowV2beta1TrainAgentRequest"
},
"GoogleCloudDialogflowV2Context": {
"description": "Represents a context.",
"type": "object",
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 20 minutes even if there\nare no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\nRefer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for\nsyntax.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2Context"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": {
"description": "An item in the carousel.",
"type": "object",
"properties": {
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional info about the option item."
},
"title": {
"description": "Required. Title of the carousel item.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage",
"description": "Optional. The image to display."
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": {
"description": "An answer from Knowledge Connector.",
"type": "object",
"properties": {
"source": {
"description": "Indicates which Knowledge Document this answer was extracted from.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base\nID\u003e/documents/\u003cDocument ID\u003e`.",
"type": "string"
},
"answer": {
"description": "The piece of text from the `source` knowledge base document that answers\nthis conversational query.",
"type": "string"
},
"faqQuestion": {
"description": "The corresponding FAQ question if the answer was extracted from a FAQ\nDocument, empty otherwise.",
"type": "string"
},
"matchConfidenceLevel": {
"enumDescriptions": [
"Not specified.",
"Indicates that the confidence is low.",
"Indicates our confidence is medium.",
"Indicates our confidence is high."
],
"enum": [
"MATCH_CONFIDENCE_LEVEL_UNSPECIFIED",
"LOW",
"MEDIUM",
"HIGH"
],
"description": "The system's confidence level that this knowledge answer is a good match\nfor this conversational query.\nNOTE: The confidence level for a given `\u003cquery, answer\u003e` pair may change\nwithout notice, as it depends on models that are constantly being\nimproved. However, it will change less frequently than the confidence\nscore below, and should be preferred for referencing the quality of an\nanswer.",
"type": "string"
},
"matchConfidence": {
"description": "The system's confidence score that this Knowledge answer is a good match\nfor this converstational query, range from 0.0 (completely uncertain)\nto 1.0 (completely certain).\nNote: The confidence score is likely to vary somewhat (possibly even for\nidentical requests), as the underlying model is under constant\nimprovement, we may deprecate it in the future. We recommend using\n`match_confidence_level` which should be generally more stable.",
"format": "float",
"type": "number"
}
},
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer"
},
"GoogleCloudDialogflowV2beta1ConversationPhoneNumber": {
"description": "Represents a phone number for telephony integration. It allows for connecting\na particular conversation over telephony.",
"type": "object",
"properties": {
"phoneNumber": {
"description": "Output only. The phone number to connect to this conversation.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ConversationPhoneNumber"
},
"GoogleCloudDialogflowV2beta1ListContextsResponse": {
"description": "The response message for Contexts.ListContexts.",
"type": "object",
"properties": {
"contexts": {
"description": "The list of contexts. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListContextsResponse"
},
"GoogleCloudDialogflowV2beta1ListEntityTypesResponse": {
"properties": {
"entityTypes": {
"description": "The list of agent entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse",
"description": "The response message for EntityTypes.ListEntityTypes.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListIntentsResponse": {
"description": "The response message for Intents.ListIntents.",
"type": "object",
"properties": {
"intents": {
"description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListIntentsResponse"
},
"GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
"type": "object",
"properties": {
"entityTypeNames": {
"description": "Required. The names entity types to delete. All names must point to the\nsame agent as `parent`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest"
},
"GoogleCloudDialogflowV2BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"type": "object",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2Intent"
}
}
},
"id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse"
},
"GoogleCloudDialogflowV2beta1ArticleSuggestionConfig": {
"description": "Defines article suggestions that a human agent assistant can provide.",
"type": "object",
"properties": {
"knowledgeBaseName": {
"description": "Required. Settings for knowledge base, Format:\n`projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ArticleSuggestionConfig"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": {
"description": "Opens the given URI.",
"type": "object",
"properties": {
"uri": {
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction"
},
"GoogleCloudDialogflowV2IntentMessage": {
"properties": {
"carouselSelect": {
"description": "The carousel card response for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect"
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion",
"description": "The link out suggestion chip for Actions on Google."
},
"simpleResponses": {
"description": "The voice and text-only responses for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "The image response."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.\nSee the Intent.Message.Platform type for a description of the\nstructure that may be required for your platform.",
"type": "object"
},
"text": {
"$ref": "GoogleCloudDialogflowV2IntentMessageText",
"description": "The text response."
},
"platform": {
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e"
],
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
],
"description": "Optional. The platform that this message is intended for.",
"type": "string"
},
"suggestions": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions",
"description": "The suggestion chips for Actions on Google."
},
"listSelect": {
"description": "The list card response for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2IntentMessageListSelect"
},
"quickReplies": {
"description": "The quick replies response.",
"$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies"
},
"card": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCard",
"description": "The card response."
},
"basicCard": {
"description": "The basic card response for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard"
}
},
"id": "GoogleCloudDialogflowV2IntentMessage",
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageBasicCard": {
"description": "The basic card message. Useful for displaying information.",
"type": "object",
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"image": {
"$ref": "GoogleCloudDialogflowV2IntentMessageImage",
"description": "Optional. The image for the card."
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
}
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageBasicCard"
},
"GoogleCloudDialogflowV2beta1Sentiment": {
"properties": {
"score": {
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\nsentiment).",
"format": "float",
"type": "number"
},
"magnitude": {
"description": "A non-negative number in the [0, +inf) range, which represents the absolute\nmagnitude of sentiment, regardless of score (positive or negative).",
"format": "float",
"type": "number"
}
},
"id": "GoogleCloudDialogflowV2beta1Sentiment",
"description": "The sentiment, such as positive/negative feeling or association, for a unit\nof analysis, such as the query text.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig": {
"description": "Defines the Human Agent Assistant to connect to a conversation.",
"type": "object",
"properties": {
"notificationConfig": {
"$ref": "GoogleCloudDialogflowV2beta1NotificationConfig",
"description": "Optional. Pub/Sub topic on which to publish new agent assistant events."
},
"name": {
"description": "Required. ID of the agent assistant to use.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig"
},
"GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest": {
"description": "The request message for Conversations.AddConversationPhoneNumber.",
"type": "object",
"properties": {},
"id": "GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest"
},
"GoogleCloudDialogflowV2beta1Intent": {
"description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
"type": "object",
"properties": {
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent.\nNote: If `ml_disabled` setting is set to true, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.",
"type": "boolean"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"mlEnabled": {
"description": "Optional. Indicates whether Machine Learning is enabled for the intent.\nNote: If `ml_enabled` setting is set to false, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.\nDEPRECATED! Please use `ml_disabled` field instead.\nNOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,\nthen the default value is determined as follows:\n- Before April 15th, 2018 the default is:\n ml_enabled = false / ml_disabled = true.\n- After April 15th, 2018 the default is:\n ml_enabled = true / ml_disabled = false.",
"type": "boolean"
},
"trainingPhrases": {
"description": "Optional. The collection of examples/templates that the agent is\ntrained on.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase"
}
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"type": "boolean"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentParameter"
}
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or BatchUpdateIntents, in order to\nmake this intent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.",
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities. Zero or negative numbers mean that the intent is disabled.",
"format": "int32",
"type": "integer"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Context"
}
},
"endInteraction": {
"description": "Optional. Indicates that this intent ends an interaction. Some integrations\n(e.g., Actions on Google or Dialogflow phone gateway) use this information\nto close interaction with an end user. Default is false.",
"type": "boolean"
},
"defaultResponsePlatforms": {
"description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
"type": "array",
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY"
],
"type": "string"
},
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e",
"Telephony Gateway."
]
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessage"
}
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"type": "array",
"items": {
"type": "string"
}
},
"webhookState": {
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"type": "string",
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
],
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
]
},
"followupIntentInfo": {
"description": "Read-only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo"
}
}
},
"id": "GoogleCloudDialogflowV2beta1Intent"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": {
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
"type": "object",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse"
},
"GoogleCloudDialogflowV2IntentMessageSuggestion": {
"description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.",
"type": "object",
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageSuggestion"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"type": "object",
"properties": {
"entityType": {
"description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
"type": "string"
},
"alias": {
"description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated by the\ndeveloper.",
"type": "boolean"
},
"text": {
"description": "Required. The text corresponding to the example or template,\nif there are no annotations. For\nannotated examples, it is the text for one of the example's parts.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart"
},
"GoogleCloudDialogflowV2beta1AnalyzeContentRequest": {
"properties": {
"audio": {
"description": "The natural language speech audio to be processed.",
"$ref": "GoogleCloudDialogflowV2beta1InputAudio"
},
"replyAudioConfig": {
"description": "Optional. Instructs the speech synthesizer how to generate the output\naudio.",
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig"
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1InputText",
"description": "The natural language text to be processed."
}
},
"id": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest",
"description": "The request message for Conversations.AnalyzeContent.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: “welcome_event”,\nparameters: { name: “Sam” } }\u003e` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`“Hello #welcome_event.name! What can I do for you today?”`.",
"type": "object",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the event.",
"type": "string"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the event.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
}
}
},
"id": "GoogleCloudDialogflowV2beta1EventInput"
},
"GoogleCloudDialogflowV2beta1KnowledgeBase": {
"description": "Represents knowledge base resource.\n\nNote: resource `projects.agent.knowledgeBases` is deprecated, please use\n`projects.knowledgeBases` instead.",
"type": "object",
"properties": {
"name": {
"description": "The knowledge base resource name.\nThe name must be empty when creating a knowledge base.\nFormat: `projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the knowledge base. The name must be 1024\nbytes or less; otherwise, the creation request fails.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1KnowledgeBase"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": {
"description": "An item in the list.",
"type": "object",
"properties": {
"title": {
"description": "Required. The title of the list item.",
"type": "string"
},
"image": {
"description": "Optional. The image to display.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage"
},
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"info": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo",
"description": "Required. Additional information about this option."
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem"
},
"GoogleCloudDialogflowV2IntentTrainingPhrasePart": {
"description": "Represents a part of a training phrase.",
"type": "object",
"properties": {
"entityType": {
"description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
"type": "string"
},
"alias": {
"description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.",
"type": "string"
},
"userDefined": {
"description": "Optional. Indicates whether the text was manually annotated by the\ndeveloper.",
"type": "boolean"
},
"text": {
"description": "Required. The text corresponding to the example or template,\nif there are no annotations. For\nannotated examples, it is the text for one of the example's parts.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart"
},
"GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": {
"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
"type": "object",
"properties": {
"state": {
"description": "Required. The current state of this operation.",
"type": "string",
"enumDescriptions": [
"State unspecified.",
"The operation has been created.",
"The operation is currently running.",
"The operation is done, either cancelled or completed."
],
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE"
]
}
},
"id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata"
},
"GoogleCloudDialogflowV2beta1CompileSuggestionsRequest": {
"properties": {
"messages": {
"description": "Required. List of messages in a conversation in chronological order.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Message"
}
}
},
"id": "GoogleCloudDialogflowV2beta1CompileSuggestionsRequest",
"description": "The request message for\nHumanAgentAssistants.RequestCompileSuggestions.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessage": {
"description": "Corresponds to the `Response` field in the Dialogflow console.",
"type": "object",
"properties": {
"carouselSelect": {
"description": "Displays a carousel card for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect"
},
"linkOutSuggestion": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion",
"description": "Displays a link out suggestion chip for Actions on Google."
},
"simpleResponses": {
"description": "Returns a voice or text-only response for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses"
},
"telephonyTransferCall": {
"description": "Transfers the call in Telephony Gateway.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall"
},
"image": {
"description": "Displays an image.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Returns a response containing a custom, platform-specific payload.\nSee the Intent.Message.Platform type for a description of the\nstructure that may be required for your platform.",
"type": "object"
},
"text": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageText",
"description": "Returns a text response."
},
"platform": {
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e",
"Telephony Gateway."
],
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE",
"TELEPHONY"
],
"description": "Optional. The platform that this message is intended for.",
"type": "string"
},
"suggestions": {
"description": "Displays suggestion chips for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions"
},
"telephonyPlayAudio": {
"description": "Plays audio from a file in Telephony Gateway.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio"
},
"listSelect": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect",
"description": "Displays a list card for Actions on Google."
},
"quickReplies": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies",
"description": "Displays quick replies."
},
"telephonySynthesizeSpeech": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech",
"description": "Synthesizes speech in Telephony Gateway."
},
"card": {
"description": "Displays a card.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard"
},
"basicCard": {
"description": "Displays a basic card for Actions on Google.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessage"
},
"GoogleCloudDialogflowV2Intent": {
"description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
"type": "object",
"properties": {
"displayName": {
"description": "Required. The name of this intent.",
"type": "string"
},
"rootFollowupIntentName": {
"description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"mlDisabled": {
"description": "Optional. Indicates whether Machine Learning is disabled for the intent.\nNote: If `ml_diabled` setting is set to true, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.",
"type": "boolean"
},
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
"parameters": {
"description": "Optional. The collection of parameters associated with the intent.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentParameter"
}
},
"resetContexts": {
"description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
"type": "boolean"
},
"trainingPhrases": {
"description": "Optional. The collection of examples/templates that the agent is\ntrained on.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase"
}
},
"parentFollowupIntentName": {
"description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or BatchUpdateIntents, in order to\nmake this intent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"events": {
"description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.",
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities. Zero or negative numbers mean that the intent is disabled.",
"format": "int32",
"type": "integer"
},
"outputContexts": {
"description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
}
},
"defaultResponsePlatforms": {
"enumDescriptions": [
"Not specified.",
"Facebook.",
"Slack.",
"Telegram.",
"Kik.",
"Skype.",
"Line.",
"Viber.",
"Actions on Google.\nWhen using Actions on Google, you can choose one of the specific\nIntent.Message types that mention support for Actions on Google,\nor you can use the advanced Intent.Message.payload field.\nThe payload field provides access to AoG features not available in the\nspecific message types.\nIf using the Intent.Message.payload field, it should have a structure\nsimilar to the JSON message shown here. For more information, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"expectUserResponse\": true,\n \"isSsml\": false,\n \"noInputPrompts\": [],\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"displayText\": \"hi\",\n \"textToSpeech\": \"hello\"\n }\n }\n ],\n \"suggestions\": [\n {\n \"title\": \"Say this\"\n },\n {\n \"title\": \"or this\"\n }\n ]\n },\n \"systemIntent\": {\n \"data\": {\n \"@type\": \"type.googleapis.com/google.actions.v2.OptionValueSpec\",\n \"listSelect\": {\n \"items\": [\n {\n \"optionInfo\": {\n \"key\": \"key1\",\n \"synonyms\": [\n \"key one\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n },\n {\n \"optionInfo\": {\n \"key\": \"key2\",\n \"synonyms\": [\n \"key two\"\n ]\n },\n \"title\": \"must not be empty, but unique\"\n }\n ]\n }\n },\n \"intent\": \"actions.intent.OPTION\"\n }\n}\u003c/pre\u003e"
],
"description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
"type": "array",
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"FACEBOOK",
"SLACK",
"TELEGRAM",
"KIK",
"SKYPE",
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
],
"type": "string"
}
},
"action": {
"description": "Optional. The name of the action associated with the intent.\nNote: The action name must not contain whitespaces.",
"type": "string"
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"messages": {
"description": "Optional. The collection of rich messages corresponding to the\n`Response` field in the Dialogflow console.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
}
},
"inputContextNames": {
"description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
"type": "array",
"items": {
"type": "string"
}
},
"webhookState": {
"enumDescriptions": [
"Webhook is disabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent.",
"Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
],
"enum": [
"WEBHOOK_STATE_UNSPECIFIED",
"WEBHOOK_STATE_ENABLED",
"WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
],
"description": "Optional. Indicates whether webhooks are enabled for the intent.",
"type": "string"
},
"followupIntentInfo": {
"description": "Read-only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo"
}
}
},
"id": "GoogleCloudDialogflowV2Intent"
},
"GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
"type": "object",
"properties": {
"destinationName": {
"description": "Required. The name of the app or site this chip is linking to.",
"type": "string"
},
"uri": {
"description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion"
},
"GoogleCloudDialogflowV2beta1AutomatedAgentReply": {
"description": "Represent a response from an automated agent.",
"type": "object",
"properties": {
"detectIntentResponse": {
"description": "Required. Response of the Dialogflow Sessions.DetectIntent call.",
"$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse"
}
},
"id": "GoogleCloudDialogflowV2beta1AutomatedAgentReply"
},
"GoogleCloudDialogflowV2beta1IntentParameter": {
"description": "Represents intent parameters.",
"type": "object",
"properties": {
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
"type": "array",
"items": {
"type": "string"
}
},
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
"type": "string"
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"value": {
"description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentParameter"
},
"GoogleCloudDialogflowV2beta1Message": {
"properties": {
"participantRole": {
"enumDescriptions": [
"Participant role not set.",
"Participant is a human agent.",
"Participant is an automated agent, such as a Dialogflow agent.",
"Participant is an end user that has called or chatted with\nDialogflow services."
],
"enum": [
"ROLE_UNSPECIFIED",
"HUMAN_AGENT",
"AUTOMATED_AGENT",
"END_USER"
],
"description": "Optional. The role of the participant.",
"type": "string"
},
"participant": {
"description": "Required. The participant that said this message.",
"type": "string"
},
"createTime": {
"description": "Optional. The time when the message was sent.",
"format": "google-datetime",
"type": "string"
},
"languageCode": {
"description": "Required. The message language.\nThis should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)\nlanguage tag. Example: \"en-US\".",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the message.\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation\nID\u003e/messages/\u003cMessage ID\u003e`.",
"type": "string"
},
"content": {
"description": "Required. The message content.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Message",
"description": "Represents a message posted into a conversation.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageBasicCard": {
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"image": {
"description": "Optional. The image for the card.",
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage"
},
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton"
}
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard",
"description": "The basic card message. Useful for displaying information.",
"type": "object"
},
"GoogleCloudDialogflowV2IntentParameter": {
"description": "Represents intent parameters.",
"type": "object",
"properties": {
"value": {
"description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the parameter.",
"type": "string"
},
"entityTypeDisplayName": {
"description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
"type": "string"
},
"prompts": {
"description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
"type": "array",
"items": {
"type": "string"
}
},
"mandatory": {
"description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
"type": "boolean"
},
"defaultValue": {
"description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
"type": "string"
},
"isList": {
"description": "Optional. Indicates whether the parameter represents a list of values.",
"type": "boolean"
},
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentParameter"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"id": "GoogleRpcStatus"
},
"GoogleCloudDialogflowV2beta1ListParticipantsResponse": {
"description": "The response message for Conversations.ListParticipants.",
"type": "object",
"properties": {
"participants": {
"description": "The list of participants. There is a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Participant"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListParticipantsResponse"
},
"GoogleCloudDialogflowV2beta1InputAudio": {
"description": "Represents the natural language speech audio to be processed.",
"type": "object",
"properties": {
"config": {
"$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig",
"description": "Required. Instructs the speech recognizer how to process the speech audio."
},
"audio": {
"description": "Required. The natural language speech audio to be processed.\nA single request can contain up to 1 minute of speech audio data.\nThe transcribed text cannot contain more than 256 bytes.",
"format": "byte",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1InputAudio"
},
"GoogleCloudDialogflowV2IntentMessageCard": {
"properties": {
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"buttons": {
"description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCardButton"
}
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageCard",
"description": "The card response message.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"type": "object",
"properties": {
"items": {
"description": "Required. List items.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem"
}
},
"title": {
"description": "Optional. The overall title of the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect"
},
"GoogleCloudDialogflowV2beta1ExportAgentRequest": {
"description": "The request message for Agents.ExportAgent.",
"type": "object",
"properties": {
"agentUri": {
"description": "Optional. The\n[Google Cloud Storage](https://cloud.google.com/storage/docs/)\nURI to export the agent to.\nThe format of this URI must be `gs://\u003cbucket-name\u003e/\u003cobject-name\u003e`.\nIf left unspecified, the serialized agent is returned inline.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ExportAgentRequest"
},
"GoogleCloudDialogflowV2beta1StreamingRecognitionResult": {
"description": "Contains a speech recognition result corresponding to a portion of the audio\nthat is currently being processed or an indication that this is the end\nof the single requested utterance.\n\nExample:\n\n1. transcript: \"tube\"\n\n2. transcript: \"to be a\"\n\n3. transcript: \"to be\"\n\n4. transcript: \"to be or not to be\"\n is_final: true\n\n5. transcript: \" that's\"\n\n6. transcript: \" that is\"\n\n7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE`\n\n8. transcript: \" that is the question\"\n is_final: true\n\nOnly two of the responses contain final results (#4 and #8 indicated by\n`is_final: true`). Concatenating these generates the full transcript: \"to be\nor not to be that is the question\".\n\nIn each response we populate:\n\n* for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`.\n\n* for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`.",
"type": "object",
"properties": {
"messageType": {
"enumDescriptions": [
"Not specified. Should never be used.",
"Message contains a (possibly partial) transcript.",
"Event indicates that the server has detected the end of the user's speech\nutterance and expects no additional speech. Therefore, the server will\nnot process additional audio (although it may subsequently return\nadditional results). The client should stop sending additional audio\ndata, half-close the gRPC connection, and wait for any additional results\nuntil the server closes the gRPC connection. This message is only sent if\n`single_utterance` was set to `true`, and is not used otherwise."
],
"enum": [
"MESSAGE_TYPE_UNSPECIFIED",
"TRANSCRIPT",
"END_OF_SINGLE_UTTERANCE"
],
"description": "Type of the result message.",
"type": "string"
},
"confidence": {
"description": "The Speech confidence between 0.0 and 1.0 for the current portion of audio.\nA higher number indicates an estimated greater likelihood that the\nrecognized words are correct. The default of 0.0 is a sentinel value\nindicating that confidence was not set.\n\nThis field is typically only provided if `is_final` is true and you should\nnot rely on it being accurate or even set.",
"format": "float",
"type": "number"
},
"transcript": {
"description": "Transcript text representing the words that the user spoke.\nPopulated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.",
"type": "string"
},
"isFinal": {
"description": "The default of 0.0 is a sentinel value indicating `confidence` was not set.\nIf `false`, the `StreamingRecognitionResult` represents an\ninterim result that may change. If `true`, the recognizer will not return\nany further hypotheses about this piece of the audio. May only be populated\nfor `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.",
"type": "boolean"
}
},
"id": "GoogleCloudDialogflowV2beta1StreamingRecognitionResult"
},
"GoogleCloudDialogflowV2beta1ListSuggestionsResponse": {
"description": "The response message for [Conversations.ListSuggestions]",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Optional. Token to retrieve the next page of results or empty if there are\nno more results in the list.",
"type": "string"
},
"suggestions": {
"description": "Required.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Suggestion"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListSuggestionsResponse"
},
"GoogleCloudDialogflowV2IntentMessageBasicCardButton": {
"description": "The button object that appears at the bottom of a card.",
"type": "object",
"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"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton"
},
"GoogleCloudDialogflowV2beta1LoggingConfig": {
"description": "Defines logging behavior for conversation lifecycle events.",
"type": "object",
"properties": {},
"id": "GoogleCloudDialogflowV2beta1LoggingConfig"
},
"GoogleCloudDialogflowV2beta1HumanAgentAssistant": {
"description": "Represents a human agent assistant that provides suggestions to help\nhuman agents to resolve customer issues. This defines the types of content\nthat the human agent assistant can present to a human agent.",
"type": "object",
"properties": {
"faqAnswersConfig": {
"$ref": "GoogleCloudDialogflowV2beta1FaqAnswersConfig",
"description": "Optional. Settings for knowledge service."
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically).\nThe unique identifier of human agent assistant.\nFormat: `projects/\u003cProject ID\u003e/humanAgentAssistants/\u003cHuman Agent Assistant\nID\u003e`.",
"type": "string"
},
"articleSuggestionConfig": {
"$ref": "GoogleCloudDialogflowV2beta1ArticleSuggestionConfig",
"description": "Optional. Settings for article suggestion."
}
},
"id": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
},
"GoogleCloudDialogflowV2beta1IntentBatch": {
"description": "This message is a wrapper around a collection of intents.",
"type": "object",
"properties": {
"intents": {
"description": "A collection of intents.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
}
}
},
"id": "GoogleCloudDialogflowV2beta1IntentBatch"
},
"GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
"type": "object",
"properties": {
"intents": {
"description": "The collection of updated or created intents.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Intent"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse"
},
"GoogleCloudDialogflowV2beta1Context": {
"properties": {
"lifespanCount": {
"description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 10 minutes even if there\nare no matching queries.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`,\nor `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID\u003e/users/\u003cUser\nID\u003e/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`. The `Context ID` is\nalways converted to lowercase. If `Environment ID` is not specified, we\nassume default 'draft' environment. If `User ID` is not specified, we\nassume default '-' user.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with this context.\nRefer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for\nsyntax.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2beta1Context",
"description": "Represents a context.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1ListDocumentsResponse": {
"description": "Response message for Documents.ListDocuments.",
"type": "object",
"properties": {
"documents": {
"description": "The list of documents.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Document"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListDocumentsResponse"
},
"GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": {
"description": "Additional info about the select item for when it is triggered in a\ndialog.",
"type": "object",
"properties": {
"synonyms": {
"description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo"
},
"GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
"type": "object",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse"
}
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses"
},
"GoogleCloudDialogflowV2beta1OutputAudioConfig": {
"description": "Instructs the speech synthesizer how to generate the output audio content.",
"type": "object",
"properties": {
"audioEncoding": {
"description": "Required. Audio encoding of the synthesized audio content.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).\nAudio content returned as LINEAR16 also contains a WAV header.",
"MP3 audio.",
"Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate."
],
"enum": [
"OUTPUT_AUDIO_ENCODING_UNSPECIFIED",
"OUTPUT_AUDIO_ENCODING_LINEAR_16",
"OUTPUT_AUDIO_ENCODING_MP3",
"OUTPUT_AUDIO_ENCODING_OGG_OPUS"
]
},
"synthesizeSpeechConfig": {
"$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig",
"description": "Optional. Configuration of how speech should be synthesized."
},
"sampleRateHertz": {
"description": "Optional. The synthesis sample rate (in hertz) for this audio. If not\nprovided, then the synthesizer will use the default sample rate based on\nthe audio encoding. If this is different from the voice's natural sample\nrate, then the synthesizer will honor this request by converting to the\ndesired sample rate (which might result in worse audio quality).",
"format": "int32",
"type": "integer"
}
},
"id": "GoogleCloudDialogflowV2beta1OutputAudioConfig"
},
"GoogleCloudDialogflowV2beta1TextInput": {
"description": "Represents the natural language text to be processed.",
"type": "object",
"properties": {
"languageCode": {
"description": "Required. The language of this conversational query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
"type": "string"
},
"text": {
"description": "Required. The UTF-8 encoded natural language text to be processed.\nText length must not exceed 256 bytes.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1TextInput"
},
"GoogleCloudDialogflowV2beta1ListMessagesResponse": {
"description": "The response message for Conversations.ListMessages.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Optional. Token to retrieve the next page of results, or empty if there are\nno more results in the list.",
"type": "string"
},
"messages": {
"description": "Required. The list of messages. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1Message"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListMessagesResponse"
},
"GoogleCloudDialogflowV2beta1ListConversationProfilesResponse": {
"properties": {
"conversationProfiles": {
"description": "The list of project conversation profiles. There is a maximum number\nof items returned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationProfile"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse",
"description": "The response message for ConversationProfiles.ListConversationProfiles.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": {
"description": "The card for presenting a carousel of options to select from.",
"type": "object",
"properties": {
"items": {
"description": "Required. Carousel items.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem"
}
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect"
},
"GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse": {
"description": "The response message for HumanAgentAssistants.ListHumanAgentAssistants.",
"type": "object",
"properties": {
"humanAgentAssistants": {
"description": "The list of project agent assistants. There is a maximum number of\nitems returned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistant"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse"
},
"GoogleCloudDialogflowV2beta1EntityTypeBatch": {
"description": "This message is a wrapper around a collection of entity types.",
"type": "object",
"properties": {
"entityTypes": {
"description": "A collection of entity types.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityType"
}
}
},
"id": "GoogleCloudDialogflowV2beta1EntityTypeBatch"
},
"GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest": {
"properties": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"entityValues": {
"description": "Required. The canonical `values` of the entities to delete. Note that\nthese are not fully-qualified names, i.e. they don't start with\n`projects/\u003cProject ID\u003e`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest",
"description": "The request message for EntityTypes.BatchDeleteEntities.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest": {
"properties": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
},
"entities": {
"description": "Required. The entities to update or create.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
}
}
},
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest",
"description": "The request message for EntityTypes.BatchUpdateEntities.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageCard": {
"description": "The card response message.",
"type": "object",
"properties": {
"buttons": {
"description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton"
}
},
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
},
"imageUri": {
"description": "Optional. The public URI to an image file for the card.",
"type": "string"
},
"title": {
"description": "Optional. The title of the card.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageCard"
},
"GoogleCloudDialogflowV2EventInput": {
"description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: “welcome_event”,\nparameters: { name: “Sam” } }\u003e` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`“Hello #welcome_event.name! What can I do for you today?”`.",
"type": "object",
"properties": {
"languageCode": {
"description": "Required. The language of this query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the event.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The collection of parameters associated with the event.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2EventInput"
},
"GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig": {
"description": "Configuration of how speech should be synthesized.",
"type": "object",
"properties": {
"effectsProfileId": {
"description": "Optional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.",
"type": "array",
"items": {
"type": "string"
}
},
"volumeGainDb": {
"description": "Optional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range [-96.0, 16.0]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.",
"format": "double",
"type": "number"
},
"pitch": {
"description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.",
"format": "double",
"type": "number"
},
"voice": {
"$ref": "GoogleCloudDialogflowV2beta1VoiceSelectionParams",
"description": "Optional. The desired voice of the synthesized audio."
},
"speakingRate": {
"description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and\n0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any\nother values \u003c 0.25 or \u003e 4.0 will return an error.",
"format": "double",
"type": "number"
}
},
"id": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestion": {
"properties": {
"title": {
"description": "Required. The text shown the in the suggestion chip.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion",
"description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1InputAudioConfig": {
"description": "Instructs the speech recognizer how to process the audio content.",
"type": "object",
"properties": {
"sampleRateHertz": {
"description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics) for\nmore details.",
"format": "int32",
"type": "integer"
},
"model": {
"description": "Optional. Which Speech model to select for the given request. Select the\nmodel best suited to your domain to get best results. If a model is not\nexplicitly specified, then we auto-select a model based on the parameters\nin the InputAudioConfig.\nIf enhanced speech model is enabled for the agent and an enhanced\nversion of the specified model for the language does not exist, then the\nspeech is recognized using the standard version of the specified model.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)\nfor more details.",
"type": "string"
},
"languageCode": {
"description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
"type": "string"
},
"phraseHints": {
"description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to\n[Cloud Speech API\ndocumentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)\nfor more details.",
"type": "array",
"items": {
"type": "string"
}
},
"audioEncoding": {
"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"
],
"description": "Required. Audio encoding of the audio content to process.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
"[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is lossless (therefore\nrecognition is not compromised) and requires only about half the\nbandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and\n24-bit samples, however, not all fields in `STREAMINFO` are supported.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
"Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
"Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
"Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
"Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nDialogflow API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
]
}
},
"id": "GoogleCloudDialogflowV2beta1InputAudioConfig"
},
"GoogleCloudDialogflowV2IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"type": "object",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion"
}
}
},
"id": "GoogleCloudDialogflowV2IntentMessageSuggestions"
},
"GoogleCloudDialogflowV2beta1IntentTrainingPhrase": {
"description": "Represents an example or template that the agent is trained on.",
"type": "object",
"properties": {
"timesAddedCount": {
"description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
"format": "int32",
"type": "integer"
},
"type": {
"enumDescriptions": [
"Not specified. This value should never be used.",
"Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
"Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings."
],
"enum": [
"TYPE_UNSPECIFIED",
"EXAMPLE",
"TEMPLATE"
],
"description": "Required. The type of the training phrase.",
"type": "string"
},
"parts": {
"description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart"
}
},
"name": {
"description": "Output only. The unique identifier of this training phrase.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase"
},
"GoogleCloudDialogflowV2IntentMessageSimpleResponses": {
"description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
"type": "object",
"properties": {
"simpleResponses": {
"description": "Required. The list of simple responses.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse"
}
}
},
"id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses"
},
"GoogleCloudDialogflowV2IntentMessageImage": {
"description": "The image response message.",
"type": "object",
"properties": {
"imageUri": {
"description": "Optional. The public URI to an image file.",
"type": "string"
},
"accessibilityText": {
"description": "Optional. A text description of the image to be used for accessibility,\ne.g., screen readers.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageImage"
},
"GoogleCloudDialogflowV2beta1InputText": {
"description": "Represents the natural language text to be processed.",
"type": "object",
"properties": {
"text": {
"description": "Required. The UTF-8 encoded natural language text to be processed.\nText length must not exceed 256 bytes.",
"type": "string"
},
"languageCode": {
"description": "Required. The language of this conversational query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1InputText"
},
"GoogleCloudDialogflowV2IntentMessageText": {
"description": "The text response message.",
"type": "object",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2IntentMessageText"
},
"GoogleCloudDialogflowV2beta1NotificationConfig": {
"description": "Defines notification behavior for conversation lifecycle events.",
"type": "object",
"properties": {
"topic": {
"description": "Optional. Name of the Cloud Pub/Sub topic to publish conversation\nevents like\nCONVERSATION_STARTED as\nserialized ConversationEvent protos.\n\nIf enable_notifications is\n`true` and no topic is supplied, a new topic is created and listed\nhere.\n\nNotification works for phone calls, if this topic either is in the same\nproject as the conversation or you grant `service-\u003cConversation Project\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service\nAgent` role in the topic project.\n\nFormat: `projects/\u003cProject ID\u003e/topics/\u003cTopic ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1NotificationConfig"
},
"GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
"type": "object",
"properties": {
"destinationName": {
"description": "Required. The name of the app or site this chip is linking to.",
"type": "string"
},
"uri": {
"description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion"
},
"GoogleCloudDialogflowV2beta1InputTextConfig": {
"description": "Defines the language used in the input text.",
"type": "object",
"properties": {
"languageCode": {
"description": "Required. The language of this conversational query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1InputTextConfig"
},
"GoogleCloudDialogflowV2EntityTypeEntity": {
"description": "Optional. Represents an entity.",
"type": "object",
"properties": {
"value": {
"description": "Required.\nFor `KIND_MAP` entity types:\n A canonical name to be used in place of synonyms.\nFor `KIND_LIST` entity types:\n A string that can contain references to other entity types (with or\n without aliases).",
"type": "string"
},
"synonyms": {
"description": "Required. A collection of synonyms. For `KIND_LIST` entity types this\nmust contain exactly one synonym equal to `value`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2EntityTypeEntity"
},
"GoogleCloudDialogflowV2beta1FaqAnswersConfig": {
"description": "Defines FAQ responses that a human agent assistant can provide.",
"type": "object",
"properties": {
"maxResults": {
"description": "Optional. Maximum number of results to return. If unset, defaults to 10.",
"format": "int32",
"type": "integer"
},
"knowledgeBaseName": {
"description": "Required. Settings for knowledge base, Format:\n`projects/\u003cProject ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1FaqAnswersConfig"
},
"GoogleCloudDialogflowV2QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"type": "object",
"properties": {
"intent": {
"description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`.",
"$ref": "GoogleCloudDialogflowV2Intent"
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language Support](https://dialogflow.com/docs/reference/language)\nfor a list of the currently supported language codes.",
"type": "string"
},
"outputContexts": {
"description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
}
},
"webhookPayload": {
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
}
},
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
}
},
"action": {
"description": "The action name from the matched intent.",
"type": "string"
},
"webhookSource": {
"description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.",
"type": "string"
},
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The collection of extracted parameters.",
"type": "object"
},
"intentDetectionConfidence": {
"description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).\nIf there are `multiple knowledge_answers` messages, this value is set to\nthe greatest `knowledgeAnswers.match_confidence` value in the list.",
"format": "float",
"type": "number"
},
"allRequiredParamsPresent": {
"description": "This field is set to:\n- `false` if the matched intent has required parameters and not all of\n the required parameter values have been collected.\n- `true` if all required parameter values have been collected, or if the\n matched intent doesn't contain any required parameters.",
"type": "boolean"
},
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set.\n\nThis field is not guaranteed to be accurate or set. In particular this\nfield isn't set for StreamingDetectIntent since the streaming endpoint has\nseparate confidence estimates per portion of the audio in\nStreamingRecognitionResult.",
"format": "float",
"type": "number"
},
"queryText": {
"description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
"type": "string"
},
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The free-form diagnostic info. For example, this field\ncould contain webhook call latency.",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2QueryResult"
},
"GoogleCloudDialogflowV2beta1PhoneNumber": {
"description": "Represents a phone number.\n`PhoneNumber` resources enable phone calls to be answered by Dialogflow\nservices and are added to a project through a `PhoneNumberOrder`.",
"type": "object",
"properties": {
"phoneNumber": {
"description": "Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164)\nformat. An example of a correctly formatted phone number: +15556767888.",
"type": "string"
},
"conversationProfile": {
"description": "Optional. The conversation profile calls to this `PhoneNumber` should use.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversationProfile\nID\u003e`.",
"type": "string"
},
"lifecycleState": {
"enumDescriptions": [
"This value is never used.",
"Number is active and can receive phone calls.",
"Number is pending deletion, and cannot receive calls."
],
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
"DELETE_REQUESTED"
],
"description": "Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`.\n`PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming\ncalls and can be removed completely within 30 days.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of this phone number.\nFormat: `projects/\u003cProject ID\u003e/phoneNumbers/\u003cPhoneNumber ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1PhoneNumber"
},
"GoogleCloudDialogflowV2beta1PhoneNumberSpec": {
"properties": {
"preferredAreaCodes": {
"description": "Optional. Area codes to use. An empty list means 'any code'. Each value\nis treated as equally preferred. Each entry has a limit of 10 bytes.\n\"area code\" corresponds to \"National Destination Code\" described in\n[E.164](https://en.wikipedia.org/wiki/E.164) standard.",
"type": "array",
"items": {
"type": "string"
}
},
"count": {
"description": "Required. Total numbers requested, between 1 and 10 inclusive.",
"format": "int32",
"type": "integer"
}
},
"id": "GoogleCloudDialogflowV2beta1PhoneNumberSpec",
"description": "Request for new numbers fitting a set of parameters.\nThe country code for newly requested numbers defaults to 1 (US) until the\nservice is available in other regions.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentMessageText": {
"description": "The text response message.",
"type": "object",
"properties": {
"text": {
"description": "Optional. The collection of the agent's responses.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageText"
},
"GoogleCloudDialogflowV2IntentMessageCarouselSelect": {
"properties": {
"items": {
"description": "Required. Carousel items.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem"
}
}
},
"id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect",
"description": "The card for presenting a carousel of options to select from.",
"type": "object"
},
"GoogleTypeLatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
"type": "object",
"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"
}
},
"id": "GoogleTypeLatLng"
},
"GoogleCloudDialogflowV2beta1IntentMessageSuggestions": {
"description": "The collection of suggestions.",
"type": "object",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion"
}
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions"
},
"GoogleCloudDialogflowV2IntentFollowupIntentInfo": {
"description": "Represents a single followup intent in the chain.",
"type": "object",
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo"
},
"GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": {
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"sessionEntityTypes": {
"description": "The list of session entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1SessionEntityType"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse"
},
"GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": {
"description": "The quick replies response message.",
"type": "object",
"properties": {
"quickReplies": {
"description": "Optional. The collection of quick replies.",
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"description": "Optional. The title of the collection of quick replies.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies"
},
"GoogleCloudDialogflowV2EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"type": "object",
"properties": {
"entities": {
"description": "Optional. The collection of entities associated with the entity type.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2EntityTypeEntity"
}
},
"name": {
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"type": "string"
},
"displayName": {
"description": "Required. The name of the entity type.",
"type": "string"
},
"kind": {
"enumDescriptions": [
"Not specified. This value should be never used.",
"Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
"List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
],
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST"
],
"description": "Required. Indicates the kind of entity type.",
"type": "string"
},
"autoExpansionMode": {
"enum": [
"AUTO_EXPANSION_MODE_UNSPECIFIED",
"AUTO_EXPANSION_MODE_DEFAULT"
],
"description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
"type": "string",
"enumDescriptions": [
"Auto expansion disabled for the entity.",
"Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
]
}
},
"id": "GoogleCloudDialogflowV2EntityType"
},
"GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest": {
"description": "The request message for PhoneNumbers.UndeletePhoneNumber.",
"type": "object",
"properties": {},
"id": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest"
},
"GoogleCloudDialogflowV2WebhookRequest": {
"properties": {
"queryResult": {
"description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.",
"$ref": "GoogleCloudDialogflowV2QueryResult"
},
"originalDetectIntentRequest": {
"$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest",
"description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call."
},
"responseId": {
"description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
"session": {
"description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2WebhookRequest",
"description": "The request message for a webhook call.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": {
"properties": {
"followupIntentName": {
"description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
},
"parentFollowupIntentName": {
"description": "The unique identifier of the followup intent's parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo",
"description": "Represents a single followup intent in the chain.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest": {
"description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
"type": "object",
"properties": {
"languageCode": {
"description": "Optional. The language of entity synonyms defined in `entity_types`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
},
"entityTypeBatchUri": {
"description": "The URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".",
"type": "string"
},
"entityTypeBatchInline": {
"$ref": "GoogleCloudDialogflowV2beta1EntityTypeBatch",
"description": "The collection of entity types to update or create."
}
},
"id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest"
},
"GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest": {
"properties": {},
"id": "GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest",
"description": "The request message for PhoneNumberOrders.CancelPhoneNumberOrder.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1AnalyzeContentResponse": {
"properties": {
"automatedAgentReply": {
"$ref": "GoogleCloudDialogflowV2beta1AutomatedAgentReply",
"description": "Optional. Only set if a Dialogflow automated agent has responded."
},
"replyText": {
"description": "Output only. The output text content.\nThis field is set if the automated agent responded with text to show to\nthe user.",
"type": "string"
},
"replyAudio": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudio",
"description": "Optional. The audio data bytes encoded as specified in the request.\nThis field is set if:\n - `reply_audio_config` was specified in the request, or\n - The automated agent responded with audio to play to the user. In such\n case, `reply_audio.config` contains settings used to synthesize the\n speech."
}
},
"id": "GoogleCloudDialogflowV2beta1AnalyzeContentResponse",
"description": "The response message for Conversations.AnalyzeContent.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1DetectIntentRequest": {
"description": "The request to detect user's intent.",
"type": "object",
"properties": {
"queryInput": {
"description": "Required. The input specification. It can be set to:\n\n1. an audio config\n which instructs the speech recognizer how to process the speech audio,\n\n2. a conversational query in the form of text, or\n\n3. an event that specifies which intent to trigger.",
"$ref": "GoogleCloudDialogflowV2beta1QueryInput"
},
"queryParams": {
"description": "Optional. The parameters of this query.",
"$ref": "GoogleCloudDialogflowV2beta1QueryParameters"
},
"outputAudioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"description": "Optional. Instructs the speech synthesizer how to generate the output\naudio. If this field is not set and agent-level speech synthesizer is not\nconfigured, no output audio is generated."
},
"inputAudio": {
"description": "Optional. The natural language speech audio to be processed. This field\nshould be populated iff `query_input` is set to an input audio config.\nA single request can contain up to 1 minute of speech audio data.",
"format": "byte",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1DetectIntentRequest"
},
"GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse": {
"description": "The response message for PhoneNumberOrders.ListPhoneNumberOrders.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
},
"phoneNumberOrders": {
"description": "The list of orders. There is a maximum number of items returned based\non the page_size field in the request.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1PhoneNumberOrder"
}
}
},
"id": "GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse"
},
"GoogleCloudDialogflowV2ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
"type": "object",
"properties": {
"agentContent": {
"description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e <agent zip file>\u003c/pre\u003e",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2ExportAgentResponse"
},
"GoogleCloudDialogflowV2beta1VoiceSelectionParams": {
"properties": {
"name": {
"description": "Optional. The name of the voice. If not set, the service will choose a\nvoice based on the other parameters such as language_code and gender.",
"type": "string"
},
"ssmlGender": {
"enumDescriptions": [
"An unspecified gender, which means that the client doesn't care which\ngender the selected voice will have.",
"A male voice.",
"A female voice.",
"A gender-neutral voice."
],
"enum": [
"SSML_VOICE_GENDER_UNSPECIFIED",
"SSML_VOICE_GENDER_MALE",
"SSML_VOICE_GENDER_FEMALE",
"SSML_VOICE_GENDER_NEUTRAL"
],
"description": "Optional. The preferred gender of the voice. If not set, the service will\nchoose a voice based on the other parameters such as language_code and\nname. Note that this is only a preference, not requirement. If a\nvoice of the appropriate gender is not available, the synthesizer should\nsubstitute a voice with a different gender rather than failing the request.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1VoiceSelectionParams",
"description": "Description of which voice to use for speech synthesis.",
"type": "object"
},
"GoogleCloudDialogflowV2beta1ImportAgentRequest": {
"description": "The request message for Agents.ImportAgent.",
"type": "object",
"properties": {
"agentContent": {
"description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\u003cpre\u003ecurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth application-default\n print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat <agent zip file> | base64 -w 0)'\n }\"\u003c/pre\u003e",
"format": "byte",
"type": "string"
},
"agentUri": {
"description": "The URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1ImportAgentRequest"
},
"GoogleCloudDialogflowV2beta1EntityTypeEntity": {
"description": "Optional. Represents an entity.",
"type": "object",
"properties": {
"value": {
"description": "Required.\nFor `KIND_MAP` entity types:\n A canonical name to be used in place of synonyms.\nFor `KIND_LIST` entity types:\n A string that can contain references to other entity types (with or\n without aliases).",
"type": "string"
},
"synonyms": {
"description": "Required. A collection of synonyms. For `KIND_LIST` entity types this\nmust contain exactly one synonym equal to `value`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleCloudDialogflowV2beta1EntityTypeEntity"
},
"GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest": {
"description": "The top-level message sent by the client to the `StreamingAnalyzeContent`\nmethod.\n\nMultiple request messages must be sent in the following order:\n\n1. The first message must contain `participant` and `config` fields. To\n receive an audio response, the first message must also contain the\n `reply_audio_config` field. The first message must not contain `input`.\n\n2. All subsequent messages must contain only input data. Specifically:\n - If the `config` in the first message was set to `audio_config`, then\n all subsequent messages must contain only `input_audio`. It is a good\n practice to split the input audio into short chunks and deliver each\n chunk in a separate message.\n - If the `config` in the first message was set to `text_config`, then\n the second message must contain only `input_text`. Moreover, the\n `input_text` field can be only sent once.\n After all input is delivered, the client must half-close, or abort the\n request stream.",
"type": "object",
"properties": {
"audioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig",
"description": "Instructs the speech recognizer how to process the speech audio."
},
"textConfig": {
"$ref": "GoogleCloudDialogflowV2beta1InputTextConfig",
"description": "The natural language text to be processed."
},
"inputText": {
"description": "The UTF-8 encoded natural language text to be processed. Must be sent if\n`text_config` is set in the first message. Text length must not exceed\n256 bytes. The `input_text` field can be only sent once.",
"type": "string"
},
"replyAudioConfig": {
"$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig",
"description": "Optional. Instructs the speech synthesizer how to generate the output\naudio."
},
"inputAudio": {
"description": "The input audio content to be recognized. Must be sent if `audio_config`\nis set in the first message. The complete audio over all streaming\nmessages must not exceed 1 minute.",
"format": "byte",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest"
},
"GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest": {
"description": "The request message for Intents.BatchUpdateIntents.",
"type": "object",
"properties": {
"languageCode": {
"description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intents`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
},
"intentBatchUri": {
"description": "The URI to a Google Cloud Storage file containing intents to update or\ncreate. The file format can either be a serialized proto (of IntentBatch\ntype) or JSON object. Note: The URI must start with \"gs://\".",
"type": "string"
},
"intentView": {
"enum": [
"INTENT_VIEW_UNSPECIFIED",
"INTENT_VIEW_FULL"
],
"description": "Optional. The resource view to apply to the returned intent.",
"type": "string",
"enumDescriptions": [
"Training phrases field is not populated in the response.",
"All fields are populated."
]
},
"intentBatchInline": {
"$ref": "GoogleCloudDialogflowV2beta1IntentBatch",
"description": "The collection of intents to update or create."
}
},
"id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest"
},
"GoogleCloudDialogflowV2beta1AutomatedAgentConfig": {
"properties": {
"agent": {
"description": "Required. ID of the Dialogflow agent environment to use.\n\nThis project needs to either be the same project as the conversation or you\nneed to grant `service-\u003cConversation Project\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\nService Agent` role in this project.\n\nFormat: `projects/\u003cProject ID\u003e/agent/environments/\u003cEnvironment ID or '-'\u003e`\nIf environment is not specified, the default `draft` environment is\nused. Refer to\n[DetectIntentRequest](/dialogflow-enterprise/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest)\nfor more details.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1AutomatedAgentConfig",
"description": "Defines the Automated Agent to connect to a conversation.",
"type": "object"
},
"GoogleCloudDialogflowV2IntentMessageCardButton": {
"description": "Optional. Contains information about a button.",
"type": "object",
"properties": {
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
},
"postback": {
"description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2IntentMessageCardButton"
},
"GoogleCloudDialogflowV2WebhookResponse": {
"description": "The response message for a webhook call.",
"type": "object",
"properties": {
"source": {
"description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
"type": "string"
},
"followupEventInput": {
"$ref": "GoogleCloudDialogflowV2EventInput",
"description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input."
},
"outputContexts": {
"description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2Context"
}
},
"fulfillmentText": {
"description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
"type": "string"
},
"fulfillmentMessages": {
"description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2IntentMessage"
}
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.\nSee the related `fulfillment_messages[i].payload field`, which may be used\nas an alternative to this field.\n\nThis field can be used for Actions on Google responses.\nIt should have a structure similar to the JSON message shown here. For more\ninformation, see\n[Actions on Google Webhook\nFormat](https://developers.google.com/actions/dialogflow/webhook)\n\u003cpre\u003e{\n \"google\": {\n \"expectUserResponse\": true,\n \"richResponse\": {\n \"items\": [\n {\n \"simpleResponse\": {\n \"textToSpeech\": \"this is a simple response\"\n }\n }\n ]\n }\n }\n}\u003c/pre\u003e",
"type": "object"
}
},
"id": "GoogleCloudDialogflowV2WebhookResponse"
},
"GoogleCloudDialogflowV2beta1KnowledgeAnswers": {
"description": "Represents the result of querying a Knowledge base.",
"type": "object",
"properties": {
"answers": {
"description": "A list of answers from Knowledge Connector.",
"type": "array",
"items": {
"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer"
}
}
},
"id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers"
},
"GoogleCloudDialogflowV2beta1SentimentAnalysisResult": {
"description": "The result of sentiment analysis as configured by\n`sentiment_analysis_request_config`.",
"type": "object",
"properties": {
"queryTextSentiment": {
"description": "The sentiment analysis result for `query_text`.",
"$ref": "GoogleCloudDialogflowV2beta1Sentiment"
}
},
"id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult"
},
"GoogleCloudDialogflowV2beta1Conversation": {
"description": "Represents a conversation.\nA conversation is an interaction between an agent, including live agents\nand Dialogflow agents, and a support customer. Conversations can\ninclude phone calls and text-based chat sessions.",
"type": "object",
"properties": {
"endTime": {
"description": "Output only. The time the conversation was finished.",
"format": "google-datetime",
"type": "string"
},
"lifecycleState": {
"enumDescriptions": [
"Unknown.",
"Conversation is currently open for media analysis.",
"Conversation has been completed."
],
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"IN_PROGRESS",
"COMPLETED"
],
"description": "Output only. The current state of the Conversation.",
"type": "string"
},
"startTime": {
"description": "Output only. The time the conversation was started.",
"format": "google-datetime",
"type": "string"
},
"conversationProfile": {
"description": "Required. The Conversation Profile to be used to configure this\nConversation. This field cannot be updated.\nFormat: `projects/\u003cProject ID\u003e/conversationProfiles/\u003cConversation Profile\nID\u003e`.",
"type": "string"
},
"phoneNumber": {
"$ref": "GoogleCloudDialogflowV2beta1ConversationPhoneNumber",
"description": "Output only. Required if the conversation is to be connected over\ntelephony."
},
"name": {
"description": "The unique identifier of this conversation.\nRequired for all methods except `create` (`create` populates the name\nautomatically).\nFormat: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.",
"type": "string"
}
},
"id": "GoogleCloudDialogflowV2beta1Conversation"
}
},
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"canonicalName": "Dialogflow",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://dialogflow.googleapis.com/"
}
Reference in New Issue View Git Blame Copy Permalink