@google-cloud/dialogflow-cx
Version:
1,068 lines (1,067 loc) • 1.15 MB
JSON
{
"nested": {
"google": {
"nested": {
"cloud": {
"nested": {
"dialogflow": {
"nested": {
"cx": {
"nested": {
"v3": {
"options": {
"csharp_namespace": "Google.Cloud.Dialogflow.Cx.V3",
"go_package": "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb",
"java_multiple_files": true,
"java_outer_classname": "VersionProto",
"java_package": "com.google.cloud.dialogflow.cx.v3",
"objc_class_prefix": "DF",
"ruby_package": "Google::Cloud::Dialogflow::CX::V3",
"(google.api.resource_definition).type": "dlp.googleapis.com/DeidentifyTemplate",
"(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}"
},
"nested": {
"AdvancedSettings": {
"fields": {
"audioExportGcsDestination": {
"type": "GcsDestination",
"id": 2
},
"speechSettings": {
"type": "SpeechSettings",
"id": 3
},
"dtmfSettings": {
"type": "DtmfSettings",
"id": 5
},
"loggingSettings": {
"type": "LoggingSettings",
"id": 6
}
},
"nested": {
"SpeechSettings": {
"fields": {
"endpointerSensitivity": {
"type": "int32",
"id": 1
},
"noSpeechTimeout": {
"type": "google.protobuf.Duration",
"id": 2
},
"useTimeoutBasedEndpointing": {
"type": "bool",
"id": 3
},
"models": {
"keyType": "string",
"type": "string",
"id": 5
}
}
},
"DtmfSettings": {
"fields": {
"enabled": {
"type": "bool",
"id": 1
},
"maxDigits": {
"type": "int32",
"id": 2
},
"finishDigit": {
"type": "string",
"id": 3
},
"interdigitTimeoutDuration": {
"type": "google.protobuf.Duration",
"id": 6
},
"endpointingTimeoutDuration": {
"type": "google.protobuf.Duration",
"id": 7
}
}
},
"LoggingSettings": {
"fields": {
"enableStackdriverLogging": {
"type": "bool",
"id": 2
},
"enableInteractionLogging": {
"type": "bool",
"id": 3
},
"enableConsentBasedRedaction": {
"type": "bool",
"id": 4
}
}
}
}
},
"GcsDestination": {
"fields": {
"uri": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
}
}
},
"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": {
"ListAgents": {
"requestType": "ListAgentsRequest",
"responseType": "ListAgentsResponse",
"options": {
"(google.api.http).get": "/v3/{parent=projects/*/locations/*}/agents",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v3/{parent=projects/*/locations/*}/agents"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetAgent": {
"requestType": "GetAgentRequest",
"responseType": "Agent",
"options": {
"(google.api.http).get": "/v3/{name=projects/*/locations/*/agents/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v3/{name=projects/*/locations/*/agents/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"CreateAgent": {
"requestType": "CreateAgentRequest",
"responseType": "Agent",
"options": {
"(google.api.http).post": "/v3/{parent=projects/*/locations/*}/agents",
"(google.api.http).body": "agent",
"(google.api.method_signature)": "parent,agent"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v3/{parent=projects/*/locations/*}/agents",
"body": "agent"
}
},
{
"(google.api.method_signature)": "parent,agent"
}
]
},
"UpdateAgent": {
"requestType": "UpdateAgentRequest",
"responseType": "Agent",
"options": {
"(google.api.http).patch": "/v3/{agent.name=projects/*/locations/*/agents/*}",
"(google.api.http).body": "agent",
"(google.api.method_signature)": "agent,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v3/{agent.name=projects/*/locations/*/agents/*}",
"body": "agent"
}
},
{
"(google.api.method_signature)": "agent,update_mask"
}
]
},
"DeleteAgent": {
"requestType": "DeleteAgentRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v3/{name=projects/*/locations/*/agents/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v3/{name=projects/*/locations/*/agents/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"ExportAgent": {
"requestType": "ExportAgentRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v3/{name=projects/*/locations/*/agents/*}:export",
"(google.api.http).body": "*",
"(google.longrunning.operation_info).response_type": "ExportAgentResponse",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v3/{name=projects/*/locations/*/agents/*}:export",
"body": "*"
}
},
{
"(google.longrunning.operation_info)": {
"response_type": "ExportAgentResponse",
"metadata_type": "google.protobuf.Struct"
}
}
]
},
"RestoreAgent": {
"requestType": "RestoreAgentRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v3/{name=projects/*/locations/*/agents/*}:restore",
"(google.api.http).body": "*",
"(google.longrunning.operation_info).response_type": "google.protobuf.Empty",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Struct"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v3/{name=projects/*/locations/*/agents/*}:restore",
"body": "*"
}
},
{
"(google.longrunning.operation_info)": {
"response_type": "google.protobuf.Empty",
"metadata_type": "google.protobuf.Struct"
}
}
]
},
"ValidateAgent": {
"requestType": "ValidateAgentRequest",
"responseType": "AgentValidationResult",
"options": {
"(google.api.http).post": "/v3/{name=projects/*/locations/*/agents/*}:validate",
"(google.api.http).body": "*"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v3/{name=projects/*/locations/*/agents/*}:validate",
"body": "*"
}
}
]
},
"GetAgentValidationResult": {
"requestType": "GetAgentValidationResultRequest",
"responseType": "AgentValidationResult",
"options": {
"(google.api.http).get": "/v3/{name=projects/*/locations/*/agents/*/validationResult}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v3/{name=projects/*/locations/*/agents/*/validationResult}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"GetGenerativeSettings": {
"requestType": "GetGenerativeSettingsRequest",
"responseType": "GenerativeSettings",
"options": {
"(google.api.http).get": "/v3/{name=projects/*/locations/*/agents/*/generativeSettings}",
"(google.api.method_signature)": "name,language_code"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v3/{name=projects/*/locations/*/agents/*/generativeSettings}"
}
},
{
"(google.api.method_signature)": "name,language_code"
}
]
},
"UpdateGenerativeSettings": {
"requestType": "UpdateGenerativeSettingsRequest",
"responseType": "GenerativeSettings",
"options": {
"(google.api.http).patch": "/v3/{generative_settings.name=projects/*/locations/*/agents/*/generativeSettings}",
"(google.api.http).body": "generative_settings",
"(google.api.method_signature)": "generative_settings,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v3/{generative_settings.name=projects/*/locations/*/agents/*/generativeSettings}",
"body": "generative_settings"
}
},
{
"(google.api.method_signature)": "generative_settings,update_mask"
}
]
}
}
},
"SpeechToTextSettings": {
"fields": {
"enableSpeechAdaptation": {
"type": "bool",
"id": 1
}
}
},
"Agent": {
"options": {
"(google.api.resource).type": "dialogflow.googleapis.com/Agent",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/agents/{agent}"
},
"oneofs": {
"_genAppBuilderSettings": {
"oneof": [
"genAppBuilderSettings"
]
},
"_satisfiesPzs": {
"oneof": [
"satisfiesPzs"
]
},
"_satisfiesPzi": {
"oneof": [
"satisfiesPzi"
]
}
},
"fields": {
"name": {
"type": "string",
"id": 1
},
"displayName": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"defaultLanguageCode": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "IMMUTABLE"
}
},
"supportedLanguageCodes": {
"rule": "repeated",
"type": "string",
"id": 4
},
"timeZone": {
"type": "string",
"id": 5,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"description": {
"type": "string",
"id": 6
},
"avatarUri": {
"type": "string",
"id": 7
},
"speechToTextSettings": {
"type": "SpeechToTextSettings",
"id": 13
},
"startFlow": {
"type": "string",
"id": 16,
"options": {
"(google.api.field_behavior)": "IMMUTABLE",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Flow"
}
},
"securitySettings": {
"type": "string",
"id": 17,
"options": {
"(google.api.resource_reference).type": "dialogflow.googleapis.com/SecuritySettings"
}
},
"enableStackdriverLogging": {
"type": "bool",
"id": 18,
"options": {
"deprecated": true
}
},
"enableSpellCorrection": {
"type": "bool",
"id": 20
},
"enableMultiLanguageTraining": {
"type": "bool",
"id": 40,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"locked": {
"type": "bool",
"id": 27
},
"advancedSettings": {
"type": "AdvancedSettings",
"id": 22
},
"gitIntegrationSettings": {
"type": "GitIntegrationSettings",
"id": 30
},
"textToSpeechSettings": {
"type": "TextToSpeechSettings",
"id": 31
},
"genAppBuilderSettings": {
"type": "GenAppBuilderSettings",
"id": 33,
"options": {
"proto3_optional": true
}
},
"answerFeedbackSettings": {
"type": "AnswerFeedbackSettings",
"id": 38,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"personalizationSettings": {
"type": "PersonalizationSettings",
"id": 42,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"clientCertificateSettings": {
"type": "ClientCertificateSettings",
"id": 43,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"satisfiesPzs": {
"type": "bool",
"id": 45,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"proto3_optional": true
}
},
"satisfiesPzi": {
"type": "bool",
"id": 46,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"proto3_optional": true
}
}
},
"nested": {
"GitIntegrationSettings": {
"oneofs": {
"gitSettings": {
"oneof": [
"githubSettings"
]
}
},
"fields": {
"githubSettings": {
"type": "GithubSettings",
"id": 1
}
},
"nested": {
"GithubSettings": {
"fields": {
"displayName": {
"type": "string",
"id": 1
},
"repositoryUri": {
"type": "string",
"id": 2
},
"trackingBranch": {
"type": "string",
"id": 3
},
"accessToken": {
"type": "string",
"id": 4
},
"branches": {
"rule": "repeated",
"type": "string",
"id": 5
}
}
}
}
},
"GenAppBuilderSettings": {
"fields": {
"engine": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
}
}
},
"AnswerFeedbackSettings": {
"fields": {
"enableAnswerFeedback": {
"type": "bool",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"PersonalizationSettings": {
"fields": {
"defaultEndUserMetadata": {
"type": "google.protobuf.Struct",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ClientCertificateSettings": {
"fields": {
"sslCertificate": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"privateKey": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "secretmanager.googleapis.com/SecretVersion"
}
},
"passphrase": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"(google.api.resource_reference).type": "secretmanager.googleapis.com/SecretVersion"
}
}
}
}
}
},
"ListAgentsRequest": {
"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
},
"pageToken": {
"type": "string",
"id": 3
}
}
},
"ListAgentsResponse": {
"fields": {
"agents": {
"rule": "repeated",
"type": "Agent",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
}
}
},
"GetAgentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Agent"
}
}
}
},
"CreateAgentRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "dialogflow.googleapis.com/Agent"
}
},
"agent": {
"type": "Agent",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
}
}
},
"UpdateAgentRequest": {
"fields": {
"agent": {
"type": "Agent",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 2
}
}
},
"DeleteAgentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Agent"
}
}
}
},
"ExportAgentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Agent"
}
},
"agentUri": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"dataFormat": {
"type": "DataFormat",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"environment": {
"type": "string",
"id": 5,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Environment"
}
},
"gitDestination": {
"type": "GitDestination",
"id": 6,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"includeBigqueryExportSettings": {
"type": "bool",
"id": 7,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
},
"nested": {
"DataFormat": {
"values": {
"DATA_FORMAT_UNSPECIFIED": 0,
"BLOB": 1,
"JSON_PACKAGE": 4
}
},
"GitDestination": {
"fields": {
"trackingBranch": {
"type": "string",
"id": 1
},
"commitMessage": {
"type": "string",
"id": 2
}
}
}
}
},
"ExportAgentResponse": {
"oneofs": {
"agent": {
"oneof": [
"agentUri",
"agentContent",
"commitSha"
]
}
},
"fields": {
"agentUri": {
"type": "string",
"id": 1
},
"agentContent": {
"type": "bytes",
"id": 2
},
"commitSha": {
"type": "string",
"id": 3
}
}
},
"RestoreAgentRequest": {
"oneofs": {
"agent": {
"oneof": [
"agentUri",
"agentContent",
"gitSource"
]
}
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Agent"
}
},
"agentUri": {
"type": "string",
"id": 2
},
"agentContent": {
"type": "bytes",
"id": 3
},
"gitSource": {
"type": "GitSource",
"id": 6
},
"restoreOption": {
"type": "RestoreOption",
"id": 5
}
},
"nested": {
"GitSource": {
"fields": {
"trackingBranch": {
"type": "string",
"id": 1
}
}
},
"RestoreOption": {
"values": {
"RESTORE_OPTION_UNSPECIFIED": 0,
"KEEP": 1,
"FALLBACK": 2
}
}
}
},
"ValidateAgentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/Agent"
}
},
"languageCode": {
"type": "string",
"id": 2
}
}
},
"GetAgentValidationResultRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/AgentValidationResult"
}
},
"languageCode": {
"type": "string",
"id": 2
}
}
},
"AgentValidationResult": {
"options": {
"(google.api.resource).type": "dialogflow.googleapis.com/AgentValidationResult",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/agents/{agent}/validationResult"
},
"fields": {
"name": {
"type": "string",
"id": 1
},
"flowValidationResults": {
"rule": "repeated",
"type": "FlowValidationResult",
"id": 2
}
}
},
"GetGenerativeSettingsRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "dialogflow.googleapis.com/AgentGenerativeSettings"
}
},
"languageCode": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
}
}
},
"UpdateGenerativeSettingsRequest": {
"fields": {
"generativeSettings": {
"type": "GenerativeSettings",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"AudioEncoding": {
"values": {
"AUDIO_ENCODING_UNSPECIFIED": 0,
"AUDIO_ENCODING_LINEAR_16": 1,
"AUDIO_ENCODING_FLAC": 2,
"AUDIO_ENCODING_MULAW": 3,
"AUDIO_ENCODING_AMR": 4,
"AUDIO_ENCODING_AMR_WB": 5,
"AUDIO_ENCODING_OGG_OPUS": 6,
"AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE": 7,
"AUDIO_ENCODING_ALAW": 8
}
},
"SpeechModelVariant": {
"values": {
"SPEECH_MODEL_VARIANT_UNSPECIFIED": 0,
"USE_BEST_AVAILABLE": 1,
"USE_STANDARD": 2,
"USE_ENHANCED": 3
}
},
"SpeechWordInfo": {
"fields": {
"word": {
"type": "string",
"id": 3
},
"startOffset": {
"type": "google.protobuf.Duration",
"id": 1
},
"endOffset": {
"type": "google.protobuf.Duration",
"id": 2
},
"confidence": {
"type": "float",
"id": 4
}
}
},
"BargeInConfig": {
"fields": {
"noBargeInDuration": {
"type": "google.protobuf.Duration",
"id": 1
},
"totalDuration": {
"type": "google.protobuf.Duration",
"id": 2
}
}
},
"InputAudioConfig": {
"fields": {
"audioEncoding": {
"type": "AudioEncoding",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"sampleRateHertz": {
"type": "int32",
"id": 2
},
"enableWordInfo": {
"type": "bool",
"id": 13
},
"phraseHints": {
"rule": "repeated",
"type": "string",
"id": 4
},
"model": {
"type": "string",
"id": 7
},
"modelVariant": {
"type": "SpeechModelVariant",
"id": 10
},
"singleUtterance": {
"type": "bool",
"id": 8
},
"bargeInConfig": {
"type": "BargeInConfig",
"id": 15
},
"optOutConformerModelMigration": {
"type": "bool",
"id": 26
}
}
},
"SsmlVoiceGender": {
"values": {
"SSML_VOICE_GENDER_UNSPECIFIED": 0,
"SSML_VOICE_GENDER_MALE": 1,
"SSML_VOICE_GENDER_FEMALE": 2,
"SSML_VOICE_GENDER_NEUTRAL": 3
}
},
"VoiceSelectionParams": {
"fields": {
"name": {
"type": "string",
"id": 1
},
"ssmlGender": {
"type": "SsmlVoiceGender",
"id": 2
}
}
},
"SynthesizeSpeechConfig": {
"fields": {
"speakingRate": {
"type": "double",
"id": 1
},
"pitch": {
"type": "double",
"id": 2
},
"volumeGainDb": {
"type": "double",
"id": 3
},