UNPKG

@google-cloud/dialogflow

Version:
1,079 lines (1,078 loc) 1.16 MB
{ "nested": { "google": { "nested": { "cloud": { "nested": { "dialogflow": { "nested": { "v2": { "options": { "csharp_namespace": "Google.Cloud.Dialogflow.V2", "go_package": "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb", "java_multiple_files": true, "java_outer_classname": "WebhookProto", "java_package": "com.google.cloud.dialogflow.v2", "objc_class_prefix": "DF", "(google.api.resource_definition).type": "dialogflow.googleapis.com/CXSecuritySettings", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/securitySettings/{security_settings}" }, "nested": { "Agents": { "options": { "(google.api.default_host)": "dialogflow.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflow" }, "methods": { "GetAgent": { "requestType": "GetAgentRequest", "responseType": "Agent", "options": { "(google.api.http).get": "/v2/{parent=projects/*}/agent", "(google.api.http).additional_bindings.get": "/v2/{parent=projects/*/locations/*}/agent", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*}/agent", "additional_bindings": { "get": "/v2/{parent=projects/*/locations/*}/agent" } } }, { "(google.api.method_signature)": "parent" } ] }, "SetAgent": { "requestType": "SetAgentRequest", "responseType": "Agent", "options": { "(google.api.http).post": "/v2/{agent.parent=projects/*}/agent", "(google.api.http).body": "agent", "(google.api.http).additional_bindings.post": "/v2/{agent.parent=projects/*/locations/*}/agent", "(google.api.http).additional_bindings.body": "agent", "(google.api.method_signature)": "agent" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{agent.parent=projects/*}/agent", "body": "agent", "additional_bindings": { "post": "/v2/{agent.parent=projects/*/locations/*}/agent", "body": "agent" } } }, { "(google.api.method_signature)": "agent" } ] }, "DeleteAgent": { "requestType": "DeleteAgentRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v2/{parent=projects/*}/agent", "(google.api.http).additional_bindings.delete": "/v2/{parent=projects/*/locations/*}/agent", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v2/{parent=projects/*}/agent", "additional_bindings": { "delete": "/v2/{parent=projects/*/locations/*}/agent" } } }, { "(google.api.method_signature)": "parent" } ] }, "SearchAgents": { "requestType": "SearchAgentsRequest", "responseType": "SearchAgentsResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*}/agent:search", "(google.api.http).additional_bindings.get": "/v2/{parent=projects/*/locations/*}/agent:search", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*}/agent:search", "additional_bindings": { "get": "/v2/{parent=projects/*/locations/*}/agent:search" } } }, { "(google.api.method_signature)": "parent" } ] }, "TrainAgent": { "requestType": "TrainAgentRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{parent=projects/*}/agent:train", "(google.api.http).body": "*", "(google.api.http).additional_bindings.post": "/v2/{parent=projects/*/locations/*}/agent:train", "(google.api.http).additional_bindings.body": "*", "(google.api.method_signature)": "parent", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*}/agent:train", "body": "*", "additional_bindings": { "post": "/v2/{parent=projects/*/locations/*}/agent:train", "body": "*" } } }, { "(google.api.method_signature)": "parent" }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "google.protobuf.Struct" } } ] }, "ExportAgent": { "requestType": "ExportAgentRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{parent=projects/*}/agent:export", "(google.api.http).body": "*", "(google.api.http).additional_bindings.post": "/v2/{parent=projects/*/locations/*}/agent:export", "(google.api.http).additional_bindings.body": "*", "(google.api.method_signature)": "parent", "(google.longrunning.operation_info).response_type": "google.cloud.dialogflow.v2.ExportAgentResponse", "(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*}/agent:export", "body": "*", "additional_bindings": { "post": "/v2/{parent=projects/*/locations/*}/agent:export", "body": "*" } } }, { "(google.api.method_signature)": "parent" }, { "(google.longrunning.operation_info)": { "response_type": "google.cloud.dialogflow.v2.ExportAgentResponse", "metadata_type": "google.protobuf.Struct" } } ] }, "ImportAgent": { "requestType": "ImportAgentRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{parent=projects/*}/agent:import", "(google.api.http).body": "*", "(google.api.http).additional_bindings.post": "/v2/{parent=projects/*/locations/*}/agent:import", "(google.api.http).additional_bindings.body": "*", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*}/agent:import", "body": "*", "additional_bindings": { "post": "/v2/{parent=projects/*/locations/*}/agent:import", "body": "*" } } }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "google.protobuf.Struct" } } ] }, "RestoreAgent": { "requestType": "RestoreAgentRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{parent=projects/*}/agent:restore", "(google.api.http).body": "*", "(google.api.http).additional_bindings.post": "/v2/{parent=projects/*/locations/*}/agent:restore", "(google.api.http).additional_bindings.body": "*", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*}/agent:restore", "body": "*", "additional_bindings": { "post": "/v2/{parent=projects/*/locations/*}/agent:restore", "body": "*" } } }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "google.protobuf.Struct" } } ] }, "GetValidationResult": { "requestType": "GetValidationResultRequest", "responseType": "ValidationResult", "options": { "(google.api.http).get": "/v2/{parent=projects/*}/agent/validationResult", "(google.api.http).additional_bindings.get": "/v2/{parent=projects/*/locations/*}/agent/validationResult" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*}/agent/validationResult", "additional_bindings": { "get": "/v2/{parent=projects/*/locations/*}/agent/validationResult" } } } ] } } }, "Agent": { "options": { "(google.api.resource).type": "dialogflow.googleapis.com/Agent", "(google.api.resource).pattern": "projects/{project}/locations/{location}/agent" }, "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudresourcemanager.googleapis.com/Project" } }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "defaultLanguageCode": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "supportedLanguageCodes": { "rule": "repeated", "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "timeZone": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "description": { "type": "string", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "avatarUri": { "type": "string", "id": 7, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "enableLogging": { "type": "bool", "id": 8, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "matchMode": { "type": "MatchMode", "id": 9, "options": { "deprecated": true, "(google.api.field_behavior)": "OPTIONAL" } }, "classificationThreshold": { "type": "float", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "apiVersion": { "type": "ApiVersion", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "tier": { "type": "Tier", "id": 15, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "MatchMode": { "values": { "MATCH_MODE_UNSPECIFIED": 0, "MATCH_MODE_HYBRID": 1, "MATCH_MODE_ML_ONLY": 2 } }, "ApiVersion": { "values": { "API_VERSION_UNSPECIFIED": 0, "API_VERSION_V1": 1, "API_VERSION_V2": 2, "API_VERSION_V2_BETA_1": 3 } }, "Tier": { "valuesOptions": { "TIER_ENTERPRISE_PLUS": { "deprecated": true } }, "values": { "TIER_UNSPECIFIED": 0, "TIER_STANDARD": 1, "TIER_ENTERPRISE": 2, "TIER_ENTERPRISE_PLUS": 3 } } } }, "GetAgentRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } } } }, "SetAgentRequest": { "fields": { "agent": { "type": "Agent", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "DeleteAgentRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } } } }, "SearchAgentsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } }, "pageSize": { "type": "int32", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageToken": { "type": "string", "id": 3 } } }, "SearchAgentsResponse": { "fields": { "agents": { "rule": "repeated", "type": "Agent", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "TrainAgentRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } } } }, "ExportAgentRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } }, "agentUri": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "ExportAgentResponse": { "oneofs": { "agent": { "oneof": [ "agentUri", "agentContent" ] } }, "fields": { "agentUri": { "type": "string", "id": 1 }, "agentContent": { "type": "bytes", "id": 2 } } }, "ImportAgentRequest": { "oneofs": { "agent": { "oneof": [ "agentUri", "agentContent" ] } }, "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } }, "agentUri": { "type": "string", "id": 2 }, "agentContent": { "type": "bytes", "id": 3 } } }, "RestoreAgentRequest": { "oneofs": { "agent": { "oneof": [ "agentUri", "agentContent" ] } }, "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } }, "agentUri": { "type": "string", "id": 2 }, "agentContent": { "type": "bytes", "id": 3 } } }, "GetValidationResultRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent" } }, "languageCode": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ValidationError": { "fields": { "severity": { "type": "Severity", "id": 1 }, "entries": { "rule": "repeated", "type": "string", "id": 3 }, "errorMessage": { "type": "string", "id": 4 } }, "nested": { "Severity": { "values": { "SEVERITY_UNSPECIFIED": 0, "INFO": 1, "WARNING": 2, "ERROR": 3, "CRITICAL": 4 } } } }, "ValidationResult": { "fields": { "validationErrors": { "rule": "repeated", "type": "ValidationError", "id": 1 } } }, "AnswerRecords": { "options": { "(google.api.default_host)": "dialogflow.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflow" }, "methods": { "ListAnswerRecords": { "requestType": "ListAnswerRecordsRequest", "responseType": "ListAnswerRecordsResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*}/answerRecords", "(google.api.http).additional_bindings.get": "/v2/{parent=projects/*/locations/*}/answerRecords", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*}/answerRecords", "additional_bindings": { "get": "/v2/{parent=projects/*/locations/*}/answerRecords" } } }, { "(google.api.method_signature)": "parent" } ] }, "UpdateAnswerRecord": { "requestType": "UpdateAnswerRecordRequest", "responseType": "AnswerRecord", "options": { "(google.api.http).patch": "/v2/{answer_record.name=projects/*/answerRecords/*}", "(google.api.http).body": "answer_record", "(google.api.http).additional_bindings.patch": "/v2/{answer_record.name=projects/*/locations/*/answerRecords/*}", "(google.api.http).additional_bindings.body": "answer_record", "(google.api.method_signature)": "answer_record,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v2/{answer_record.name=projects/*/answerRecords/*}", "body": "answer_record", "additional_bindings": { "patch": "/v2/{answer_record.name=projects/*/locations/*/answerRecords/*}", "body": "answer_record" } } }, { "(google.api.method_signature)": "answer_record,update_mask" } ] } } }, "AnswerRecord": { "options": { "(google.api.resource).type": "dialogflow.googleapis.com/AnswerRecord", "(google.api.resource).pattern": "projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "oneofs": { "record": { "oneof": [ "agentAssistantRecord" ] } }, "fields": { "name": { "type": "string", "id": 1 }, "answerFeedback": { "type": "AnswerFeedback", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "agentAssistantRecord": { "type": "AgentAssistantRecord", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "ListAnswerRecordsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "dialogflow.googleapis.com/AnswerRecord" } }, "filter": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageSize": { "type": "int32", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageToken": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ListAnswerRecordsResponse": { "fields": { "answerRecords": { "rule": "repeated", "type": "AnswerRecord", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "UpdateAnswerRecordRequest": { "fields": { "answerRecord": { "type": "AnswerRecord", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "AnswerFeedback": { "oneofs": { "detailFeedback": { "oneof": [ "agentAssistantDetailFeedback" ] } }, "fields": { "correctnessLevel": { "type": "CorrectnessLevel", "id": 1 }, "agentAssistantDetailFeedback": { "type": "AgentAssistantFeedback", "id": 2 }, "clicked": { "type": "bool", "id": 3 }, "clickTime": { "type": "google.protobuf.Timestamp", "id": 5 }, "displayed": { "type": "bool", "id": 4 }, "displayTime": { "type": "google.protobuf.Timestamp", "id": 6 } }, "nested": { "CorrectnessLevel": { "values": { "CORRECTNESS_LEVEL_UNSPECIFIED": 0, "NOT_CORRECT": 1, "PARTIALLY_CORRECT": 2, "FULLY_CORRECT": 3 } } } }, "AgentAssistantFeedback": { "fields": { "answerRelevance": { "type": "AnswerRelevance", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "documentCorrectness": { "type": "DocumentCorrectness", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "documentEfficiency": { "type": "DocumentEfficiency", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "summarizationFeedback": { "type": "SummarizationFeedback", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "knowledgeSearchFeedback": { "type": "KnowledgeSearchFeedback", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "knowledgeAssistFeedback": { "type": "KnowledgeAssistFeedback", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "AnswerRelevance": { "values": { "ANSWER_RELEVANCE_UNSPECIFIED": 0, "IRRELEVANT": 1, "RELEVANT": 2 } }, "DocumentCorrectness": { "values": { "DOCUMENT_CORRECTNESS_UNSPECIFIED": 0, "INCORRECT": 1, "CORRECT": 2 } }, "DocumentEfficiency": { "values": { "DOCUMENT_EFFICIENCY_UNSPECIFIED": 0, "INEFFICIENT": 1, "EFFICIENT": 2 } }, "SummarizationFeedback": { "fields": { "startTime": { "type": "google.protobuf.Timestamp", "id": 1 }, "submitTime": { "type": "google.protobuf.Timestamp", "id": 2 }, "summaryText": { "type": "string", "id": 3 }, "textSections": { "keyType": "string", "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "KnowledgeSearchFeedback": { "fields": { "answerCopied": { "type": "bool", "id": 1 }, "clickedUris": { "rule": "repeated", "type": "string", "id": 2 } } }, "KnowledgeAssistFeedback": { "fields": { "answerCopied": { "type": "bool", "id": 1 }, "clickedUris": { "rule": "repeated", "type": "string", "id": 2 } } } } }, "AgentAssistantRecord": { "oneofs": { "answer": { "oneof": [ "articleSuggestionAnswer", "faqAnswer", "dialogflowAssistAnswer" ] } }, "fields": { "articleSuggestionAnswer": { "type": "ArticleAnswer", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "faqAnswer": { "type": "FaqAnswer", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "dialogflowAssistAnswer": { "type": "DialogflowAssistAnswer", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "Participants": { "options": { "(google.api.default_host)": "dialogflow.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflow" }, "methods": { "CreateParticipant": { "requestType": "CreateParticipantRequest", "responseType": "Participant", "options": { "(google.api.http).post": "/v2/{parent=projects/*/conversations/*}/participants", "(google.api.http).body": "participant", "(google.api.http).additional_bindings.post": "/v2/{parent=projects/*/locations/*/conversations/*}/participants", "(google.api.http).additional_bindings.body": "participant", "(google.api.method_signature)": "parent,participant" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*/conversations/*}/participants", "body": "participant", "additional_bindings": { "post": "/v2/{parent=projects/*/locations/*/conversations/*}/participants", "body": "participant" } } }, { "(google.api.method_signature)": "parent,participant" } ] }, "GetParticipant": { "requestType": "GetParticipantRequest", "responseType": "Participant", "options": { "(google.api.http).get": "/v2/{name=projects/*/conversations/*/participants/*}", "(google.api.http).additional_bindings.get": "/v2/{name=projects/*/locations/*/conversations/*/participants/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{name=projects/*/conversations/*/participants/*}", "additional_bindings": { "get": "/v2/{name=projects/*/locations/*/conversations/*/participants/*}" } } }, { "(google.api.method_signature)": "name" } ] }, "ListParticipants": { "requestType": "ListParticipantsRequest", "responseType": "ListParticipantsResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*/conversations/*}/participants", "(google.api.http).additional_bindings.get": "/v2/{parent=projects/*/locations/*/conversations/*}/participants", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*/conversations/*}/participants", "additional_bindings": { "get": "/v2/{parent=projects/*/locations/*/conversations/*}/participants" } } }, { "(google.api.method_signature)": "parent" } ] }, "UpdateParticipant": { "requestType": "UpdateParticipantRequest", "responseType": "Participant", "options": { "(google.api.http).patch": "/v2/{participant.name=projects/*/conversations/*/participants/*}", "(google.api.http).body": "participant", "(google.api.http).additional_bindings.patch": "/v2/{participant.name=projects/*/locations/*/conversations/*/participants/*}", "(google.api.http).additional_bindings.body": "participant", "(google.api.method_signature)": "participant,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v2/{participant.name=projects/*/conversations/*/participants/*}", "body": "participant", "additional_bindings": { "patch": "/v2/{participant.name=projects/*/locations/*/conversations/*/participants/*}", "body": "participant" }