diff options
Diffstat (limited to 'third_party/googleapis/google/cloud/dialogflow/v2beta1')
24 files changed, 0 insertions, 10694 deletions
diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/BUILD.bazel b/third_party/googleapis/google/cloud/dialogflow/v2beta1/BUILD.bazel deleted file mode 100644 index f762893..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/BUILD.bazel +++ /dev/null @@ -1,456 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "dialogflow_proto", - srcs = [ - "agent.proto", - "answer_record.proto", - "audio_config.proto", - "context.proto", - "conversation.proto", - "conversation_event.proto", - "conversation_profile.proto", - "document.proto", - "entity_type.proto", - "environment.proto", - "fulfillment.proto", - "gcs.proto", - "human_agent_assistant_event.proto", - "intent.proto", - "knowledge_base.proto", - "participant.proto", - "session.proto", - "session_entity_type.proto", - "validation_result.proto", - "version.proto", - "webhook.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "//google/api:field_behavior_proto", - "//google/api:resource_proto", - "//google/longrunning:operations_proto", - "//google/rpc:status_proto", - "//google/type:latlng_proto", - "@com_google_protobuf//:duration_proto", - "@com_google_protobuf//:empty_proto", - "@com_google_protobuf//:field_mask_proto", - "@com_google_protobuf//:struct_proto", - "@com_google_protobuf//:timestamp_proto", - ], -) - -proto_library_with_info( - name = "dialogflow_proto_with_info", - deps = [ - ":dialogflow_proto", - "//google/cloud:common_resources_proto", - "//google/cloud/location:location_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "dialogflow_java_proto", - deps = [":dialogflow_proto"], -) - -java_grpc_library( - name = "dialogflow_java_grpc", - srcs = [":dialogflow_proto"], - deps = [":dialogflow_java_proto"], -) - -java_gapic_library( - name = "dialogflow_java_gapic", - srcs = [":dialogflow_proto_with_info"], - gapic_yaml = None, - grpc_service_config = "dialogflow_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - test_deps = [ - ":dialogflow_java_grpc", - "//google/cloud/location:location_java_grpc", - ], - transport = "grpc+rest", - deps = [ - ":dialogflow_java_proto", - "//google/api:api_java_proto", - "//google/cloud/location:location_java_proto", - ], -) - -java_gapic_test( - name = "dialogflow_java_gapic_test_suite", - test_classes = [ - "com.google.cloud.dialogflow.v2beta1.AgentsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.AgentsClientTest", - "com.google.cloud.dialogflow.v2beta1.AnswerRecordsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.AnswerRecordsClientTest", - "com.google.cloud.dialogflow.v2beta1.ContextsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.ContextsClientTest", - "com.google.cloud.dialogflow.v2beta1.ConversationProfilesClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.ConversationProfilesClientTest", - "com.google.cloud.dialogflow.v2beta1.ConversationsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.ConversationsClientTest", - "com.google.cloud.dialogflow.v2beta1.DocumentsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.DocumentsClientTest", - "com.google.cloud.dialogflow.v2beta1.EntityTypesClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.EntityTypesClientTest", - "com.google.cloud.dialogflow.v2beta1.EnvironmentsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.EnvironmentsClientTest", - "com.google.cloud.dialogflow.v2beta1.FulfillmentsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.FulfillmentsClientTest", - "com.google.cloud.dialogflow.v2beta1.IntentsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.IntentsClientTest", - "com.google.cloud.dialogflow.v2beta1.KnowledgeBasesClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.KnowledgeBasesClientTest", - "com.google.cloud.dialogflow.v2beta1.ParticipantsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.ParticipantsClientTest", - "com.google.cloud.dialogflow.v2beta1.SessionEntityTypesClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.SessionEntityTypesClientTest", - "com.google.cloud.dialogflow.v2beta1.SessionsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.SessionsClientTest", - "com.google.cloud.dialogflow.v2beta1.VersionsClientHttpJsonTest", - "com.google.cloud.dialogflow.v2beta1.VersionsClientTest", - ], - runtime_deps = [":dialogflow_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-cloud-dialogflow-v2beta1-java", - include_samples = True, - transport = "grpc+rest", - deps = [ - ":dialogflow_java_gapic", - ":dialogflow_java_grpc", - ":dialogflow_java_proto", - ":dialogflow_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "dialogflow_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1", - protos = [":dialogflow_proto"], - deps = [ - "//google/api:annotations_go_proto", - "//google/longrunning:longrunning_go_proto", - "//google/rpc:status_go_proto", - "//google/type:latlng_go_proto", - ], -) - -go_gapic_library( - name = "dialogflow_go_gapic", - srcs = [":dialogflow_proto_with_info"], - grpc_service_config = "dialogflow_grpc_service_config.json", - importpath = "cloud.google.com/go/dialogflow/apiv2beta1;dialogflow", - metadata = True, - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - transport = "grpc+rest", - deps = [ - ":dialogflow_go_proto", - "//google/cloud/location:location_go_proto", - "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", - "@io_bazel_rules_go//proto/wkt:duration_go_proto", - "@io_bazel_rules_go//proto/wkt:struct_go_proto", - ], -) - -go_test( - name = "dialogflow_go_gapic_test", - srcs = [":dialogflow_go_gapic_srcjar_test"], - embed = [":dialogflow_go_gapic"], - importpath = "cloud.google.com/go/dialogflow/apiv2beta1", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-cloud-dialogflow-v2beta1-go", - deps = [ - ":dialogflow_go_gapic", - ":dialogflow_go_gapic_srcjar-metadata.srcjar", - ":dialogflow_go_gapic_srcjar-test.srcjar", - ":dialogflow_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "dialogflow_py_gapic", - srcs = [":dialogflow_proto"], - grpc_service_config = "dialogflow_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - transport = "grpc", - deps = [ - ], -) - -py_test( - name = "dialogflow_py_gapic_test", - srcs = [ - "dialogflow_py_gapic_pytest.py", - "dialogflow_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":dialogflow_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "dialogflow-v2beta1-py", - deps = [ - ":dialogflow_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "dialogflow_php_proto", - deps = [":dialogflow_proto"], -) - -php_grpc_library( - name = "dialogflow_php_grpc", - srcs = [":dialogflow_proto"], - deps = [":dialogflow_php_proto"], -) - -php_gapic_library( - name = "dialogflow_php_gapic", - srcs = [":dialogflow_proto_with_info"], - grpc_service_config = "dialogflow_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - deps = [ - ":dialogflow_php_grpc", - ":dialogflow_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-cloud-dialogflow-v2beta1-php", - deps = [ - ":dialogflow_php_gapic", - ":dialogflow_php_grpc", - ":dialogflow_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "dialogflow_nodejs_gapic", - package_name = "@google-cloud/dialogflow", - src = ":dialogflow_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "dialogflow_grpc_service_config.json", - main_service = "dialogflow", - package = "google.cloud.dialogflow.v2beta1", - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", -) - -nodejs_gapic_assembly_pkg( - name = "dialogflow-v2beta1-nodejs", - deps = [ - ":dialogflow_nodejs_gapic", - ":dialogflow_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "dialogflow_ruby_proto", - deps = [":dialogflow_proto"], -) - -ruby_grpc_library( - name = "dialogflow_ruby_grpc", - srcs = [":dialogflow_proto"], - deps = [":dialogflow_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "dialogflow_ruby_gapic", - srcs = [":dialogflow_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-api-id=dialogflow.googleapis.com", - "ruby-cloud-api-shortname=dialogflow", - "ruby-cloud-env-prefix=DIALOGFLOW", - "ruby-cloud-gem-name=google-cloud-dialogflow-v2beta1", - "ruby-cloud-product-url=https://cloud.google.com/dialogflow", - ], - grpc_service_config = "dialogflow_grpc_service_config.json", - rest_numeric_enums = False, - ruby_cloud_description = "Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow ES, providing the standard agent type suitable for small and simple agents.", - ruby_cloud_title = "Dialogflow V2beta1", - service_yaml = "dialogflow_v2beta1.yaml", - deps = [ - ":dialogflow_ruby_grpc", - ":dialogflow_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-cloud-dialogflow-v2beta1-ruby", - deps = [ - ":dialogflow_ruby_gapic", - ":dialogflow_ruby_grpc", - ":dialogflow_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "dialogflow_csharp_proto", - deps = [":dialogflow_proto"], -) - -csharp_grpc_library( - name = "dialogflow_csharp_grpc", - srcs = [":dialogflow_proto"], - deps = [":dialogflow_csharp_proto"], -) - -csharp_gapic_library( - name = "dialogflow_csharp_gapic", - srcs = [":dialogflow_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "dialogflow_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "dialogflow_v2beta1.yaml", - deps = [ - ":dialogflow_csharp_grpc", - ":dialogflow_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-cloud-dialogflow-v2beta1-csharp", - deps = [ - ":dialogflow_csharp_gapic", - ":dialogflow_csharp_grpc", - ":dialogflow_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "dialogflow_cc_proto", - deps = [":dialogflow_proto"], -) - -cc_grpc_library( - name = "dialogflow_cc_grpc", - srcs = [":dialogflow_proto"], - grpc_only = True, - deps = [":dialogflow_cc_proto"], -) diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/agent.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/agent.proto deleted file mode 100644 index 95b3933..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/agent.proto +++ /dev/null @@ -1,578 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/validation_result.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "AgentProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Agents][google.cloud.dialogflow.v2beta1.Agent]. -service Agents { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Retrieves the specified agent. - rpc GetAgent(GetAgentRequest) returns (Agent) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/agent" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/agent" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Creates/updates the specified agent. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc SetAgent(SetAgentRequest) returns (Agent) { - option (google.api.http) = { - post: "/v2beta1/{agent.parent=projects/*}/agent" - body: "agent" - additional_bindings { - post: "/v2beta1/{agent.parent=projects/*/locations/*}/agent" - body: "agent" - } - }; - option (google.api.method_signature) = "agent"; - } - - // Deletes the specified agent. - rpc DeleteAgent(DeleteAgentRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{parent=projects/*}/agent" - additional_bindings { - delete: "/v2beta1/{parent=projects/*/locations/*}/agent" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Returns the list of agents. - // Since there is at most one conversational agent per project, this method is - // useful primarily for listing all agents across projects the caller has - // access to. One can achieve that with a wildcard project collection id "-". - // Refer to [List - // Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). - rpc SearchAgents(SearchAgentsRequest) returns (SearchAgentsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/agent:search" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/agent:search" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Trains the specified agent. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc TrainAgent(TrainAgentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/agent:train" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/agent:train" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Exports the specified agent to a ZIP file. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] - rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/agent:export" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/agent:export" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - option (google.longrunning.operation_info) = { - response_type: "google.cloud.dialogflow.v2beta1.ExportAgentResponse" - metadata_type: "google.protobuf.Struct" - }; - } - - // Imports the specified agent from a ZIP file. - // - // Uploads new intents and entity types without deleting the existing ones. - // Intents and entity types with the same name are replaced with the new - // versions from [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest]. After the import, the imported draft - // agent will be trained automatically (unless disabled in agent settings). - // However, once the import is done, training may not be completed yet. Please - // call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it returns in order to train - // explicitly. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // The operation only tracks when importing is complete, not when it is done - // training. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc ImportAgent(ImportAgentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/agent:import" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/agent:import" - body: "*" - } - }; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Restores the specified agent from a ZIP file. - // - // Replaces the current agent version with a new one. All the intents and - // entity types in the older version are deleted. After the restore, the - // restored draft agent will be trained automatically (unless disabled in - // agent settings). However, once the restore is done, training may not be - // completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it - // returns in order to train explicitly. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // The operation only tracks when restoring is complete, not when it is done - // training. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/agent:restore" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/agent:restore" - body: "*" - } - }; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Gets agent validation result. Agent validation is performed during - // training time and is updated automatically when training is completed. - rpc GetValidationResult(GetValidationResultRequest) returns (ValidationResult) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/agent/validationResult" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/agent/validationResult" - } - }; - } -} - -// A Dialogflow agent is a virtual agent that handles conversations with your -// end-users. It is a natural language understanding module that understands the -// nuances of human language. Dialogflow translates end-user text or audio -// during a conversation to structured data that your apps and services can -// understand. You design and build a Dialogflow agent to handle the types of -// conversations required for your system. -// -// For more information about agents, see the -// [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). -// -message Agent { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Agent" - pattern: "projects/{project}/agent" - pattern: "projects/{project}/locations/{location}/agent" - }; - - // Match mode determines how intents are detected from user queries. - enum MatchMode { - // Not specified. - MATCH_MODE_UNSPECIFIED = 0; - - // Best for agents with a small number of examples in intents and/or wide - // use of templates syntax and composite entities. - MATCH_MODE_HYBRID = 1; - - // Can be used for agents with a large number of examples in intents, - // especially the ones using @sys.any or very large custom entities. - MATCH_MODE_ML_ONLY = 2; - } - - // API version for the agent. - enum ApiVersion { - // Not specified. - API_VERSION_UNSPECIFIED = 0; - - // Legacy V1 API. - API_VERSION_V1 = 1; - - // V2 API. - API_VERSION_V2 = 2; - - // V2beta1 API. - API_VERSION_V2_BETA_1 = 3; - } - - // Represents the agent tier. - enum Tier { - // Not specified. This value should never be used. - TIER_UNSPECIFIED = 0; - - // Trial Edition, previously known as Standard Edition. - TIER_STANDARD = 1; - - // Essentials Edition, previously known as Enterprise Essential Edition. - TIER_ENTERPRISE = 2; - - // Essentials Edition (same as TIER_ENTERPRISE), previously known as - // Enterprise Plus Edition. - TIER_ENTERPRISE_PLUS = 3 [deprecated = true]; - } - - // Required. The project of this agent. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "cloudresourcemanager.googleapis.com/Project" - } - ]; - - // Required. The name of this agent. - string display_name = 2; - - // Required. The default language of the agent as a language tag. See - // [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. This field cannot be - // set by the `Update` method. - string default_language_code = 3; - - // Optional. The list of all languages supported by this agent (except for the - // `default_language_code`). - repeated string supported_language_codes = 4; - - // Required. The time zone of this agent from the - // [time zone database](https://www.iana.org/time-zones), e.g., - // America/New_York, Europe/Paris. - string time_zone = 5; - - // Optional. The description of this agent. - // The maximum length is 500 characters. If exceeded, the request is rejected. - string description = 6; - - // Optional. The URI of the agent's avatar. - // Avatars are used throughout the Dialogflow console and in the self-hosted - // [Web - // Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) - // integration. - string avatar_uri = 7; - - // Optional. Determines whether this agent should log conversation queries. - bool enable_logging = 8; - - // Optional. Determines how intents are detected from user queries. - MatchMode match_mode = 9 [deprecated = true]; - - // Optional. To filter out false positive results and still get variety in - // matched natural language inputs for your agent, you can tune the machine - // learning classification threshold. If the returned score value is less than - // the threshold value, then a fallback intent will be triggered or, if there - // are no fallback intents defined, no intent will be triggered. The score - // values range from 0.0 (completely uncertain) to 1.0 (completely certain). - // If set to 0.0, the default of 0.3 is used. - float classification_threshold = 10; - - // Optional. API version displayed in Dialogflow console. If not specified, - // V2 API is assumed. Clients are free to query different service endpoints - // for different API versions. However, bots connectors and webhook calls will - // follow the specified API version. - ApiVersion api_version = 14; - - // Optional. The agent tier. If not specified, TIER_STANDARD is assumed. - Tier tier = 15; -} - -// The request message for [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent]. -message GetAgentRequest { - // Required. The project that the agent to fetch is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; -} - -// The request message for [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent]. -message SetAgentRequest { - // Required. The agent to update. - Agent agent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2; -} - -// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent]. -message DeleteAgentRequest { - // Required. The project that the agent to delete is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; -} - -// Contains basic configuration for a sub-agent. -message SubAgent { - // Required. The project of this agent. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string project = 1; - - // Optional. The unique identifier (`environment name` in dialogflow console) - // of this sub-agent environment. Assumes draft environment if `environment` - // is not set. - string environment = 2; -} - -// The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. -message SearchAgentsRequest { - // Required. The project to list agents from. - // Format: `projects/<Project ID or '-'>` or - // `projects/<Project ID or '-'>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; -} - -// The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. -message SearchAgentsResponse { - // The list of agents. There will be a maximum number of items returned based - // on the page_size field in the request. - repeated Agent agents = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent]. -message TrainAgentRequest { - // Required. The project that the agent to train is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; -} - -// The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. -message ExportAgentRequest { - // Required. The project that the agent to export is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; - - // Optional. The - // [Google Cloud Storage](https://cloud.google.com/storage/docs/) - // URI to export the agent to. - // The format of this URI must be `gs://<bucket-name>/<object-name>`. - // If left unspecified, the serialized agent is returned inline. - // - // Dialogflow performs a write operation for the Cloud Storage object - // on the caller's behalf, so your request authentication must - // have write permissions for the object. For more information, see - // [Dialogflow access - // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). - string agent_uri = 2; -} - -// The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. -message ExportAgentResponse { - // The exported agent. - oneof agent { - // The URI to a file containing the exported agent. This field is populated - // only if `agent_uri` is specified in `ExportAgentRequest`. - string agent_uri = 1; - - // Zip compressed raw byte content for agent. - bytes agent_content = 2; - } -} - -// The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent]. -message ImportAgentRequest { - // Required. The project that the agent to import is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; - - // Required. The agent to import. - oneof agent { - // The URI to a Google Cloud Storage file containing the agent to import. - // Note: The URI must start with "gs://". - // - // Dialogflow performs a read operation for the Cloud Storage object - // on the caller's behalf, so your request authentication must - // have read permissions for the object. For more information, see - // [Dialogflow access - // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). - string agent_uri = 2; - - // Zip compressed raw byte content for agent. - bytes agent_content = 3; - } -} - -// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent]. -message RestoreAgentRequest { - // Required. The project that the agent to restore is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; - - // Required. The agent to restore. - oneof agent { - // The URI to a Google Cloud Storage file containing the agent to restore. - // Note: The URI must start with "gs://". - // - // Dialogflow performs a read operation for the Cloud Storage object - // on the caller's behalf, so your request authentication must - // have read permissions for the object. For more information, see - // [Dialogflow access - // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). - string agent_uri = 2; - - // Zip compressed raw byte content for agent. - bytes agent_content = 3; - } -} - -// The request message for [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult]. -message GetValidationResultRequest { - // Required. The project that the agent is associated with. - // Format: `projects/<Project ID>` or - // `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Agent" - } - ]; - - // Optional. The language for which you want a validation result. If not - // specified, the agent's default language is used. [Many - // languages](https://cloud.google.com/dialogflow/docs/reference/language) - // are supported. Note: languages must be enabled in the agent before they can - // be used. - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/answer_record.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/answer_record.proto deleted file mode 100644 index 1193f90..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/answer_record.proto +++ /dev/null @@ -1,325 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/participant.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/timestamp.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "AnswerRecordsProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [AnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecord]. -service AnswerRecords { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Deprecated. - // Retrieves a specific answer record. - rpc GetAnswerRecord(GetAnswerRecordRequest) returns (AnswerRecord) { - option deprecated = true; - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/answerRecords/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/answerRecords/*}" - } - }; - } - - // Returns the list of all answer records in the specified project in reverse - // chronological order. - rpc ListAnswerRecords(ListAnswerRecordsRequest) returns (ListAnswerRecordsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/answerRecords" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/answerRecords" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Updates the specified answer record. - rpc UpdateAnswerRecord(UpdateAnswerRecordRequest) returns (AnswerRecord) { - option (google.api.http) = { - patch: "/v2beta1/{answer_record.name=projects/*/answerRecords/*}" - body: "answer_record" - additional_bindings { - patch: "/v2beta1/{answer_record.name=projects/*/locations/*/answerRecords/*}" - body: "answer_record" - } - }; - option (google.api.method_signature) = "answer_record,update_mask"; - } -} - -// Answer records are records to manage answer history and feedbacks for -// Dialogflow. -// -// Currently, answer record includes: -// -// - human agent assistant article suggestion -// - human agent assistant faq article -// -// It doesn't include: -// -// - `DetectIntent` intent matching -// - `DetectIntent` knowledge -// -// Answer records are not related to the conversation history in the -// Dialogflow Console. A Record is generated even when the end-user disables -// conversation history in the console. Records are created when there's a human -// agent assistant suggestion generated. -// -// A typical workflow for customers provide feedback to an answer is: -// -// 1. For human agent assistant, customers get suggestion via ListSuggestions -// API. Together with the answers, [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] are returned to the -// customers. -// 2. The customer uses the [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] to call the -// [UpdateAnswerRecord][] method to send feedback about a specific answer -// that they believe is wrong. -message AnswerRecord { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/AnswerRecord" - pattern: "projects/{project}/answerRecords/{answer_record}" - pattern: "projects/{project}/locations/{location}/answerRecords/{answer_record}" - }; - - // The unique identifier of this answer record. - // Required for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] method. - // Format: `projects/<Project ID>/locations/<Location - // ID>/answerRecords/<Answer Record ID>`. - string name = 1; - - // Optional. The AnswerFeedback for this record. You can set this with - // [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] in order to give us feedback about - // this answer. - AnswerFeedback answer_feedback = 3; - - // Output only. The record for this answer. - oneof record { - // Output only. The record for human agent assistant. - AgentAssistantRecord agent_assistant_record = 4; - } -} - -// Represents a record of a human agent assistant answer. -message AgentAssistantRecord { - // Output only. The agent assistant answer. - oneof answer { - // Output only. The article suggestion answer. - ArticleAnswer article_suggestion_answer = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The FAQ answer. - FaqAnswer faq_answer = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - } -} - -// Represents feedback the customer has about the quality & correctness of a -// certain answer in a conversation. -message AnswerFeedback { - // The correctness level of an answer. - enum CorrectnessLevel { - // Correctness level unspecified. - CORRECTNESS_LEVEL_UNSPECIFIED = 0; - - // Answer is totally wrong. - NOT_CORRECT = 1; - - // Answer is partially correct. - PARTIALLY_CORRECT = 2; - - // Answer is fully correct. - FULLY_CORRECT = 3; - } - - // The correctness level of the specific answer. - CorrectnessLevel correctness_level = 1; - - // Normally, detail feedback is provided when answer is not fully correct. - oneof detail_feedback { - // Optional. Detail feedback of agent assistant suggestions. - AgentAssistantFeedback agent_assistant_detail_feedback = 2; - } - - // Indicates whether the answer/item was clicked by the human agent - // or not. Default to false. - bool clicked = 3; - - // Time when the answer/item was clicked. - google.protobuf.Timestamp click_time = 5; - - // Indicates whether the answer/item was displayed to the human - // agent in the agent desktop UI. Default to false. - bool displayed = 4; - - // Time when the answer/item was displayed. - google.protobuf.Timestamp display_time = 6; -} - -// Detail feedback of Agent Assistant result. -message AgentAssistantFeedback { - // Relevance of an answer. - enum AnswerRelevance { - // Answer relevance unspecified. - ANSWER_RELEVANCE_UNSPECIFIED = 0; - - // Answer is irrelevant to query. - IRRELEVANT = 1; - - // Answer is relevant to query. - RELEVANT = 2; - } - - // Correctness of document. - enum DocumentCorrectness { - // Document correctness unspecified. - DOCUMENT_CORRECTNESS_UNSPECIFIED = 0; - - // Information in document is incorrect. - INCORRECT = 1; - - // Information in document is correct. - CORRECT = 2; - } - - // Efficiency of document. - enum DocumentEfficiency { - // Document efficiency unspecified. - DOCUMENT_EFFICIENCY_UNSPECIFIED = 0; - - // Document is inefficient. - INEFFICIENT = 1; - - // Document is efficient. - EFFICIENT = 2; - } - - // Feedback for conversation summarization. - message SummarizationFeedback { - // Timestamp when composing of the summary starts. - google.protobuf.Timestamp start_timestamp = 1; - - // Timestamp when the summary was submitted. - google.protobuf.Timestamp submit_timestamp = 2; - - // Text of actual submitted summary. - string summary_text = 3; - } - - // Optional. Whether or not the suggested answer is relevant. - // - // For example: - // - // * Query: "Can I change my mailing address?" - // * Suggested document says: "Items must be returned/exchanged within 60 - // days of the purchase date." - // * [answer_relevance][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.answer_relevance]: [AnswerRelevance.IRRELEVANT][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.AnswerRelevance.IRRELEVANT] - AnswerRelevance answer_relevance = 1; - - // Optional. Whether or not the information in the document is correct. - // - // For example: - // - // * Query: "Can I return the package in 2 days once received?" - // * Suggested document says: "Items must be returned/exchanged within 60 - // days of the purchase date." - // * Ground truth: "No return or exchange is allowed." - // * [document_correctness]: INCORRECT - DocumentCorrectness document_correctness = 2; - - // Optional. Whether or not the suggested document is efficient. For example, - // if the document is poorly written, hard to understand, hard to use or - // too long to find useful information, [document_efficiency][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_efficiency] is - // [DocumentEfficiency.INEFFICIENT][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.DocumentEfficiency.INEFFICIENT]. - DocumentEfficiency document_efficiency = 3; - - // Feedback for conversation summarization. - SummarizationFeedback summarization_feedback = 4; -} - -// Request message for [AnswerRecords.GetAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.GetAnswerRecord]. -message GetAnswerRecordRequest { - // Required. The name of the answer record to retrieve. - // Format: `projects/<Project ID>/locations/<Location - // ID>/answerRecords/<Answer Record Id>`. - string name = 1; -} - -// Request message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords]. -message ListAnswerRecordsRequest { - // Required. The project to list all answer records for in reverse - // chronological order. Format: `projects/<Project ID>/locations/<Location - // ID>`. - string parent = 1 [(google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/AnswerRecord" - }]; - - // Optional. Filters to restrict results to specific answer records. - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 2 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; - - // Optional. The maximum number of records to return in a single page. - // The server may return fewer records than this. If unspecified, we use 10. - // The maximum is 100. - int32 page_size = 3; - - // Optional. The - // [ListAnswerRecordsResponse.next_page_token][google.cloud.dialogflow.v2beta1.ListAnswerRecordsResponse.next_page_token] - // value returned from a previous list request used to continue listing on - // the next page. - string page_token = 4; -} - -// Response message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords]. -message ListAnswerRecordsResponse { - // The list of answer records. - repeated AnswerRecord answer_records = 1; - - // A token to retrieve next page of results. Or empty if there are no more - // results. - // Pass this value in the - // [ListAnswerRecordsRequest.page_token][google.cloud.dialogflow.v2beta1.ListAnswerRecordsRequest.page_token] - // field in the subsequent call to `ListAnswerRecords` method to retrieve the - // next page of results. - string next_page_token = 2; -} - -// Request message for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord]. -message UpdateAnswerRecordRequest { - // Required. Answer record to update. - AnswerRecord answer_record = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/audio_config.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/audio_config.proto deleted file mode 100644 index c72899d..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/audio_config.proto +++ /dev/null @@ -1,442 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/duration.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "AudioConfigProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; -option (google.api.resource_definition) = { - type: "automl.googleapis.com/Model" - pattern: "projects/{project}/locations/{location}/models/{model}" -}; - -// Audio encoding of the audio content sent in the conversational query request. -// Refer to the -// [Cloud Speech API -// documentation](https://cloud.google.com/speech-to-text/docs/basics) for more -// details. -enum AudioEncoding { - // Not specified. - AUDIO_ENCODING_UNSPECIFIED = 0; - - // Uncompressed 16-bit signed little-endian samples (Linear PCM). - AUDIO_ENCODING_LINEAR_16 = 1; - - // [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio - // Codec) is the recommended encoding because it is lossless (therefore - // recognition is not compromised) and requires only about half the - // bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and - // 24-bit samples, however, not all fields in `STREAMINFO` are supported. - AUDIO_ENCODING_FLAC = 2; - - // 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. - AUDIO_ENCODING_MULAW = 3; - - // Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000. - AUDIO_ENCODING_AMR = 4; - - // Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000. - AUDIO_ENCODING_AMR_WB = 5; - - // Opus encoded audio frames in Ogg container - // ([OggOpus](https://wiki.xiph.org/OggOpus)). - // `sample_rate_hertz` must be 16000. - AUDIO_ENCODING_OGG_OPUS = 6; - - // Although the use of lossy encodings is not recommended, if a very low - // bitrate encoding is required, `OGG_OPUS` is highly preferred over - // Speex encoding. The [Speex](https://speex.org/) encoding supported by - // Dialogflow API has a header byte in each block, as in MIME type - // `audio/x-speex-with-header-byte`. - // It is a variant of the RTP Speex encoding defined in - // [RFC 5574](https://tools.ietf.org/html/rfc5574). - // The stream is a sequence of blocks, one block per RTP packet. Each block - // starts with a byte containing the length of the block, in bytes, followed - // by one or more frames of Speex data, padded to an integral number of - // bytes (octets) as specified in RFC 5574. In other words, each RTP header - // is replaced with a single byte containing the block length. Only Speex - // wideband is supported. `sample_rate_hertz` must be 16000. - AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7; -} - -// Hints for the speech recognizer to help with recognition in a specific -// conversation state. -message SpeechContext { - // Optional. A list of strings containing words and phrases that the speech - // recognizer should recognize with higher likelihood. - // - // This list can be used to: - // - // * improve accuracy for words and phrases you expect the user to say, - // e.g. typical commands for your Dialogflow agent - // * add additional words to the speech recognizer vocabulary - // * ... - // - // See the [Cloud Speech - // documentation](https://cloud.google.com/speech-to-text/quotas) for usage - // limits. - repeated string phrases = 1; - - // Optional. Boost for this context compared to other contexts: - // - // * If the boost is positive, Dialogflow will increase the probability that - // the phrases in this context are recognized over similar sounding phrases. - // * If the boost is unspecified or non-positive, Dialogflow will not apply - // any boost. - // - // Dialogflow recommends that you use boosts in the range (0, 20] and that you - // find a value that fits your use case with binary search. - float boost = 2; -} - -// Variant of the specified [Speech model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. -// -// See the [Cloud Speech -// documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) -// for which models have different variants. For example, the "phone_call" model -// has both a standard and an enhanced variant. When you use an enhanced model, -// you will generally receive higher quality results than for a standard model. -enum SpeechModelVariant { - // No model variant specified. In this case Dialogflow defaults to - // USE_BEST_AVAILABLE. - SPEECH_MODEL_VARIANT_UNSPECIFIED = 0; - - // Use the best available variant of the [Speech - // model][InputAudioConfig.model] that the caller is eligible for. - // - // Please see the [Dialogflow - // docs](https://cloud.google.com/dialogflow/docs/data-logging) for - // how to make your project eligible for enhanced models. - USE_BEST_AVAILABLE = 1; - - // Use standard model variant even if an enhanced model is available. See the - // [Cloud Speech - // documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) - // for details about enhanced models. - USE_STANDARD = 2; - - // Use an enhanced model variant: - // - // * If an enhanced variant does not exist for the given - // [model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] and request language, Dialogflow falls - // back to the standard variant. - // - // The [Cloud Speech - // documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) - // describes which models have enhanced variants. - // - // * If the API caller isn't eligible for enhanced models, Dialogflow returns - // an error. Please see the [Dialogflow - // docs](https://cloud.google.com/dialogflow/docs/data-logging) - // for how to make your project eligible. - USE_ENHANCED = 3; -} - -// Information for a word recognized by the speech recognizer. -message SpeechWordInfo { - // The word this info is for. - string word = 3; - - // Time offset relative to the beginning of the audio that corresponds to the - // start of the spoken word. This is an experimental feature and the accuracy - // of the time offset can vary. - google.protobuf.Duration start_offset = 1; - - // Time offset relative to the beginning of the audio that corresponds to the - // end of the spoken word. This is an experimental feature and the accuracy of - // the time offset can vary. - google.protobuf.Duration end_offset = 2; - - // The Speech confidence between 0.0 and 1.0 for this word. A higher number - // indicates an estimated greater likelihood that the recognized word is - // correct. The default of 0.0 is a sentinel value indicating that confidence - // was not set. - // - // This field is not guaranteed to be fully stable over time for the same - // audio input. Users should also not rely on it to always be provided. - float confidence = 4; -} - -// Instructs the speech recognizer on how to process the audio content. -message InputAudioConfig { - // Required. Audio encoding of the audio content to process. - AudioEncoding audio_encoding = 1; - - // Required. Sample rate (in Hertz) of the audio content sent in the query. - // Refer to - // [Cloud Speech API - // documentation](https://cloud.google.com/speech-to-text/docs/basics) for - // more details. - int32 sample_rate_hertz = 2; - - // Required. The language of the supplied audio. Dialogflow does not do - // translations. See [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. Note that queries in - // the same session do not necessarily need to specify the same language. - string language_code = 3; - - // If `true`, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.v2beta1.SpeechWordInfo] in - // [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] with information about the recognized speech - // words, e.g. start and end time offsets. If false or unspecified, Speech - // doesn't return any word-level information. - bool enable_word_info = 13; - - // A list of strings containing words and phrases that the speech - // recognizer should recognize with higher likelihood. - // - // See [the Cloud Speech - // documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) - // for more details. - // - // This field is deprecated. Please use [speech_contexts]() instead. If you - // specify both [phrase_hints]() and [speech_contexts](), Dialogflow will - // treat the [phrase_hints]() as a single additional [SpeechContext](). - repeated string phrase_hints = 4 [deprecated = true]; - - // Context information to assist speech recognition. - // - // See [the Cloud Speech - // documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) - // for more details. - repeated SpeechContext speech_contexts = 11; - - // Which Speech model to select for the given request. Select the - // model best suited to your domain to get best results. If a model is not - // explicitly specified, then we auto-select a model based on the parameters - // in the InputAudioConfig. - // If enhanced speech model is enabled for the agent and an enhanced - // version of the specified model for the language does not exist, then the - // speech is recognized using the standard version of the specified model. - // Refer to - // [Cloud Speech API - // documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) - // for more details. - string model = 7; - - // Which variant of the [Speech model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. - SpeechModelVariant model_variant = 10; - - // If `false` (default), recognition does not cease until the - // client closes the stream. - // If `true`, the recognizer will detect a single spoken utterance in input - // audio. Recognition ceases when it detects the audio's voice has - // stopped or paused. In this case, once a detected intent is received, the - // client should close the stream and start a new request with a new stream as - // needed. - // Note: This setting is relevant only for streaming methods. - // Note: When specified, InputAudioConfig.single_utterance takes precedence - // over StreamingDetectIntentRequest.single_utterance. - bool single_utterance = 8; - - // Only used in [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and - // [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent]. - // If `false` and recognition doesn't return any result, trigger - // `NO_SPEECH_RECOGNIZED` event to Dialogflow agent. - bool disable_no_speech_recognized_event = 14; -} - -// Gender of the voice as described in -// [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice). -enum SsmlVoiceGender { - // An unspecified gender, which means that the client doesn't care which - // gender the selected voice will have. - SSML_VOICE_GENDER_UNSPECIFIED = 0; - - // A male voice. - SSML_VOICE_GENDER_MALE = 1; - - // A female voice. - SSML_VOICE_GENDER_FEMALE = 2; - - // A gender-neutral voice. - SSML_VOICE_GENDER_NEUTRAL = 3; -} - -// Description of which voice to use for speech synthesis. -message VoiceSelectionParams { - // Optional. The name of the voice. If not set, the service will choose a - // voice based on the other parameters such as language_code and - // [ssml_gender][google.cloud.dialogflow.v2beta1.VoiceSelectionParams.ssml_gender]. - // - // For the list of available voices, please refer to [Supported voices and - // languages](https://cloud.google.com/text-to-speech/docs/voices). - string name = 1; - - // Optional. The preferred gender of the voice. If not set, the service will - // choose a voice based on the other parameters such as language_code and - // [name][google.cloud.dialogflow.v2beta1.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a - // voice of the appropriate gender is not available, the synthesizer should - // substitute a voice with a different gender rather than failing the request. - SsmlVoiceGender ssml_gender = 2; -} - -// Configuration of how speech should be synthesized. -message SynthesizeSpeechConfig { - // Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal - // native speed supported by the specific voice. 2.0 is twice as fast, and - // 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any - // other values < 0.25 or > 4.0 will return an error. - double speaking_rate = 1; - - // Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 - // semitones from the original pitch. -20 means decrease 20 semitones from the - // original pitch. - double pitch = 2; - - // Optional. Volume gain (in dB) of the normal native volume supported by the - // specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of - // 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) - // will play at approximately half the amplitude of the normal native signal - // amplitude. A value of +6.0 (dB) will play at approximately twice the - // amplitude of the normal native signal amplitude. We strongly recommend not - // to exceed +10 (dB) as there's usually no effective increase in loudness for - // any value greater than that. - double volume_gain_db = 3; - - // Optional. An identifier which selects 'audio effects' profiles that are - // applied on (post synthesized) text to speech. Effects are applied on top of - // each other in the order they are given. - repeated string effects_profile_id = 5; - - // Optional. The desired voice of the synthesized audio. - VoiceSelectionParams voice = 4; -} - -// Audio encoding of the output audio format in Text-To-Speech. -enum OutputAudioEncoding { - // Not specified. - OUTPUT_AUDIO_ENCODING_UNSPECIFIED = 0; - - // Uncompressed 16-bit signed little-endian samples (Linear PCM). - // Audio content returned as LINEAR16 also contains a WAV header. - OUTPUT_AUDIO_ENCODING_LINEAR_16 = 1; - - // MP3 audio at 32kbps. - OUTPUT_AUDIO_ENCODING_MP3 = 2; - - // MP3 audio at 64kbps. - OUTPUT_AUDIO_ENCODING_MP3_64_KBPS = 4; - - // Opus encoded audio wrapped in an ogg container. The result will be a - // file which can be played natively on Android, and in browsers (at least - // Chrome and Firefox). The quality of the encoding is considerably higher - // than MP3 while using approximately the same bitrate. - OUTPUT_AUDIO_ENCODING_OGG_OPUS = 3; - - // 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. - OUTPUT_AUDIO_ENCODING_MULAW = 5; -} - -// Instructs the speech synthesizer how to generate the output audio content. -// If this audio config is supplied in a request, it overrides all existing -// text-to-speech settings applied to the agent. -message OutputAudioConfig { - // Required. Audio encoding of the synthesized audio content. - OutputAudioEncoding audio_encoding = 1 [(google.api.field_behavior) = REQUIRED]; - - // The synthesis sample rate (in hertz) for this audio. If not - // provided, then the synthesizer will use the default sample rate based on - // the audio encoding. If this is different from the voice's natural sample - // rate, then the synthesizer will honor this request by converting to the - // desired sample rate (which might result in worse audio quality). - int32 sample_rate_hertz = 2; - - // Configuration of how speech should be synthesized. - SynthesizeSpeechConfig synthesize_speech_config = 3; -} - -// [DTMF](https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling) -// digit in Telephony Gateway. -enum TelephonyDtmf { - // Not specified. This value may be used to indicate an absent digit. - TELEPHONY_DTMF_UNSPECIFIED = 0; - - // Number: '1'. - DTMF_ONE = 1; - - // Number: '2'. - DTMF_TWO = 2; - - // Number: '3'. - DTMF_THREE = 3; - - // Number: '4'. - DTMF_FOUR = 4; - - // Number: '5'. - DTMF_FIVE = 5; - - // Number: '6'. - DTMF_SIX = 6; - - // Number: '7'. - DTMF_SEVEN = 7; - - // Number: '8'. - DTMF_EIGHT = 8; - - // Number: '9'. - DTMF_NINE = 9; - - // Number: '0'. - DTMF_ZERO = 10; - - // Letter: 'A'. - DTMF_A = 11; - - // Letter: 'B'. - DTMF_B = 12; - - // Letter: 'C'. - DTMF_C = 13; - - // Letter: 'D'. - DTMF_D = 14; - - // Asterisk/star: '*'. - DTMF_STAR = 15; - - // Pound/diamond/hash/square/gate/octothorpe: '#'. - DTMF_POUND = 16; -} - -// A wrapper of repeated TelephonyDtmf digits. -message TelephonyDtmfEvents { - // A sequence of TelephonyDtmf digits. - repeated TelephonyDtmf dtmf_events = 1; -} - -// Configures speech transcription for [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile]. -message SpeechToTextConfig { - // The speech model used in speech to text. - // `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as - // `USE_ENHANCED`. It can be overridden in [AnalyzeContentRequest][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest] and - // [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest] request. - // If enhanced model variant is specified and an enhanced - // version of the specified model for the language does not exist, then it - // would emit an error. - SpeechModelVariant speech_model_variant = 1; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/context.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/context.proto deleted file mode 100644 index a8e8c21..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/context.proto +++ /dev/null @@ -1,375 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/struct.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ContextProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Contexts][google.cloud.dialogflow.v2beta1.Context]. -service Contexts { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all contexts in the specified session. - rpc ListContexts(ListContextsRequest) returns (ListContextsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" - additional_bindings { - get: "/v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contexts" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contexts" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contexts" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified context. - rpc GetContext(GetContextRequest) returns (Context) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/sessions/*/contexts/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/sessions/*/contexts/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates a context. - // - // If the specified context already exists, overrides the context. - rpc CreateContext(CreateContextRequest) returns (Context) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" - body: "context" - additional_bindings { - post: "/v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contexts" - body: "context" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contexts" - body: "context" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contexts" - body: "context" - } - }; - option (google.api.method_signature) = "parent,context"; - } - - // Updates the specified context. - rpc UpdateContext(UpdateContextRequest) returns (Context) { - option (google.api.http) = { - patch: "/v2beta1/{context.name=projects/*/agent/sessions/*/contexts/*}" - body: "context" - additional_bindings { - patch: "/v2beta1/{context.name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}" - body: "context" - } - additional_bindings { - patch: "/v2beta1/{context.name=projects/*/locations/*/agent/sessions/*/contexts/*}" - body: "context" - } - additional_bindings { - patch: "/v2beta1/{context.name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}" - body: "context" - } - }; - option (google.api.method_signature) = "context,update_mask"; - option (google.api.method_signature) = "context"; - } - - // Deletes the specified context. - rpc DeleteContext(DeleteContextRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/sessions/*/contexts/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/sessions/*/contexts/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Deletes all active contexts in the specified session. - rpc DeleteAllContexts(DeleteAllContextsRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" - additional_bindings { - delete: "/v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contexts" - } - additional_bindings { - delete: "/v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contexts" - } - additional_bindings { - delete: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contexts" - } - }; - option (google.api.method_signature) = "parent"; - } -} - -// Dialogflow contexts are similar to natural language context. If a person says -// to you "they are orange", you need context in order to understand what "they" -// is referring to. Similarly, for Dialogflow to handle an end-user expression -// like that, it needs to be provided with context in order to correctly match -// an intent. -// -// Using contexts, you can control the flow of a conversation. You can configure -// contexts for an intent by setting input and output contexts, which are -// identified by string names. When an intent is matched, any configured output -// contexts for that intent become active. While any contexts are active, -// Dialogflow is more likely to match intents that are configured with input -// contexts that correspond to the currently active contexts. -// -// For more information about context, see the -// [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). -message Context { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Context" - pattern: "projects/{project}/agent/sessions/{session}/contexts/{context}" - pattern: "projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}" - pattern: "projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}" - pattern: "projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}" - }; - - // Required. The unique identifier of the context. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context - // ID>`, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>/contexts/<Context ID>`, - // - // The `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - // - // If `Environment ID` is not specified, we assume default 'draft' - // environment. If `User ID` is not specified, we assume default '-' user. - // - // The following context names are reserved for internal use by Dialogflow. - // You should not use these contexts or create contexts with these names: - // - // * `__system_counters__` - // * `*_id_dialog_context` - // * `*_dialog_params_size` - string name = 1; - - // Optional. The number of conversational query requests after which the - // context expires. The default is `0`. If set to `0`, the context expires - // immediately. Contexts expire automatically after 20 minutes if there - // are no matching queries. - int32 lifespan_count = 2; - - // Optional. The collection of parameters associated with this context. - // - // Depending on your protocol or client library language, this is a - // map, associative array, symbol table, dictionary, or JSON object - // composed of a collection of (MapKey, MapValue) pairs: - // - // - MapKey type: string - // - MapKey value: parameter name - // - MapValue type: - // - If parameter's entity type is a composite entity: map - // - Else: depending on parameter value type, could be one of string, - // number, boolean, null, list or map - // - MapValue value: - // - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - // - Else: parameter value - google.protobuf.Struct parameters = 3; -} - -// The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. -message ListContextsRequest { - // Required. The session to list all contexts from. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Context" - } - ]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; -} - -// The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. -message ListContextsResponse { - // The list of contexts. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Context contexts = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext]. -message GetContextRequest { - // Required. The name of the context. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context - // ID>`, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>/contexts/<Context ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Context" - } - ]; -} - -// The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext]. -message CreateContextRequest { - // Required. The session to create a context for. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Context" - } - ]; - - // Required. The context to create. - Context context = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext]. -message UpdateContextRequest { - // Required. The context to update. - Context context = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext]. -message DeleteContextRequest { - // Required. The name of the context to delete. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context - // ID>`, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/contexts/<Context ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>/contexts/<Context ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Context" - } - ]; -} - -// The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts]. -message DeleteAllContextsRequest { - // Required. The name of the session to delete all contexts from. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified we assume default 'draft' environment. If - // `User ID` is not specified, we assume default '-' user. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Context" - } - ]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation.proto deleted file mode 100644 index 432d8c0..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation.proto +++ /dev/null @@ -1,494 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/participant.proto"; -import "google/protobuf/timestamp.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ConversationProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Conversations][google.cloud.dialogflow.v2beta1.Conversation]. -service Conversations { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Creates a new conversation. Conversations are auto-completed after 24 - // hours. - // - // Conversation Lifecycle: - // There are two stages during a conversation: Automated Agent Stage and - // Assist Stage. - // - // For Automated Agent Stage, there will be a dialogflow agent responding to - // user queries. - // - // For Assist Stage, there's no dialogflow agent responding to user queries. - // But we will provide suggestions which are generated from conversation. - // - // If [Conversation.conversation_profile][google.cloud.dialogflow.v2beta1.Conversation.conversation_profile] is configured for a dialogflow - // agent, conversation will start from `Automated Agent Stage`, otherwise, it - // will start from `Assist Stage`. And during `Automated Agent Stage`, once an - // [Intent][google.cloud.dialogflow.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation - // will transfer to Assist Stage. - rpc CreateConversation(CreateConversationRequest) returns (Conversation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/conversations" - body: "conversation" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/conversations" - body: "conversation" - } - }; - option (google.api.method_signature) = "parent,conversation"; - } - - // Returns the list of all conversations in the specified project. - rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/conversations" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/conversations" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specific conversation. - rpc GetConversation(GetConversationRequest) returns (Conversation) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/conversations/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/conversations/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Completes the specified conversation. Finished conversations are purged - // from the database after 30 days. - rpc CompleteConversation(CompleteConversationRequest) returns (Conversation) { - option (google.api.http) = { - post: "/v2beta1/{name=projects/*/conversations/*}:complete" - body: "*" - additional_bindings { - post: "/v2beta1/{name=projects/*/locations/*/conversations/*}:complete" - body: "*" - } - }; - option (google.api.method_signature) = "name"; - } - - // Batch ingests messages to conversation. Customers can use this RPC to - // ingest historical messages to conversation. - rpc BatchCreateMessages(BatchCreateMessagesRequest) returns (BatchCreateMessagesResponse) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*}/messages:batchCreate" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/conversations/*}/messages:batchCreate" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Lists messages that belong to a given conversation. - // `messages` are ordered by `create_time` in descending order. To fetch - // updates without duplication, send request with filter - // `create_time_epoch_microseconds > - // [first item's create_time of previous request]` and empty page_token. - rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/conversations/*}/messages" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/conversations/*}/messages" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Suggest summary for a conversation based on specific historical messages. - // The range of the messages to be used for summary can be specified in the - // request. - rpc SuggestConversationSummary(SuggestConversationSummaryRequest) returns (SuggestConversationSummaryResponse) { - option (google.api.http) = { - post: "/v2beta1/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummary" - body: "*" - additional_bindings { - post: "/v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:suggestConversationSummary" - body: "*" - } - }; - option (google.api.method_signature) = "conversation"; - } -} - -// Represents a conversation. -// A conversation is an interaction between an agent, including live agents -// and Dialogflow agents, and a support customer. Conversations can -// include phone calls and text-based chat sessions. -message Conversation { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Conversation" - pattern: "projects/{project}/conversations/{conversation}" - pattern: "projects/{project}/locations/{location}/conversations/{conversation}" - }; - - // Enumeration of the completion status of the conversation. - enum LifecycleState { - // Unknown. - LIFECYCLE_STATE_UNSPECIFIED = 0; - - // Conversation is currently open for media analysis. - IN_PROGRESS = 1; - - // Conversation has been completed. - COMPLETED = 2; - } - - // Enumeration of the different conversation stages a conversation can be in. - // Reference: - // https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages - enum ConversationStage { - // Unknown. Should never be used after a conversation is successfully - // created. - CONVERSATION_STAGE_UNSPECIFIED = 0; - - // The conversation should return virtual agent responses into the - // conversation. - VIRTUAL_AGENT_STAGE = 1; - - // The conversation should not provide responses, just listen and provide - // suggestions. - HUMAN_ASSIST_STAGE = 2; - } - - // Output only. The unique identifier of this conversation. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The current state of the Conversation. - LifecycleState lifecycle_state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. The Conversation Profile to be used to configure this - // Conversation. This field cannot be updated. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string conversation_profile = 3 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/ConversationProfile" - } - ]; - - // Output only. Required if the conversation is to be connected over - // telephony. - ConversationPhoneNumber phone_number = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The stage of a conversation. It indicates whether the virtual agent or a - // human agent is handling the conversation. - // - // If the conversation is created with the conversation profile that has - // Dialogflow config set, defaults to - // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]; Otherwise, defaults to - // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE]. - // - // If the conversation is created with the conversation profile that has - // Dialogflow config set but explicitly sets conversation_stage to - // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE], it skips - // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE] stage and directly goes to - // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE]. - ConversationStage conversation_stage = 7; - - // Output only. The time the conversation was started. - google.protobuf.Timestamp start_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The time the conversation was finished. - google.protobuf.Timestamp end_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Represents a phone number for telephony integration. It allows for connecting -// a particular conversation over telephony. -message ConversationPhoneNumber { - // Output only. The phone number to connect to this conversation. - string phone_number = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// The request message for [Conversations.CreateConversation][google.cloud.dialogflow.v2beta1.Conversations.CreateConversation]. -message CreateConversationRequest { - // Required. Resource identifier of the project creating the conversation. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Conversation" - } - ]; - - // Required. The conversation to create. - Conversation conversation = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Identifier of the conversation. Generally it's auto generated by Google. - // Only set it if you cannot wait for the response to return a - // auto-generated one to you. - // - // The conversation ID must be compliant with the regression fomula - // "[a-zA-Z][a-zA-Z0-9_-]*" with the characters length in range of [3,64]. - // If the field is provided, the caller is resposible for - // 1. the uniqueness of the ID, otherwise the request will be rejected. - // 2. the consistency for whether to use custom ID or not under a project to - // better ensure uniqueness. - string conversation_id = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. -message ListConversationsRequest { - // Required. The project from which to list all conversation. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Conversation" - } - ]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; - - // A filter expression that filters conversations listed in the response. In - // general, the expression must specify the field name, a comparison operator, - // and the value to use for filtering: - // <ul> - // <li>The value must be a string, a number, or a boolean.</li> - // <li>The comparison operator must be either `=`,`!=`, `>`, or `<`.</li> - // <li>To filter on multiple expressions, separate the - // expressions with `AND` or `OR` (omitting both implies `AND`).</li> - // <li>For clarity, expressions can be enclosed in parentheses.</li> - // </ul> - // Only `lifecycle_state` can be filtered on in this way. For example, - // the following expression only returns `COMPLETED` conversations: - // - // `lifecycle_state = "COMPLETED"` - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 4; -} - -// The response message for [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. -message ListConversationsResponse { - // The list of conversations. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Conversation conversations = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Conversations.GetConversation][google.cloud.dialogflow.v2beta1.Conversations.GetConversation]. -message GetConversationRequest { - // Required. The name of the conversation. Format: - // `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation - // ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Conversation" - } - ]; -} - -// The request message for [Conversations.CompleteConversation][google.cloud.dialogflow.v2beta1.Conversations.CompleteConversation]. -message CompleteConversationRequest { - // Required. Resource identifier of the conversation to close. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Conversation" - } - ]; -} - -// The request message to create one Message. Currently it is only used in -// BatchCreateMessagesRequest. -message CreateMessageRequest { - // Required. Resource identifier of the conversation to create message. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Conversation" - } - ]; - - // Required. The message to create. - // [Message.participant][google.cloud.dialogflow.v2beta1.Message.participant] is required. - Message message = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Conversations.BatchCreateMessagesRequest][]. -message BatchCreateMessagesRequest { - // Required. Resource identifier of the conversation to create message. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Conversation" - } - ]; - - // Required. A maximum of 1000 Messages can be created in a batch. - // [CreateMessageRequest.message.send_time][] is required. All created - // messages will have identical [Message.create_time][google.cloud.dialogflow.v2beta1.Message.create_time]. - repeated CreateMessageRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Conversations.BatchCreateMessagesResponse][]. -message BatchCreateMessagesResponse { - // Messages created. - repeated Message messages = 1; -} - -// The request message for [Conversations.ListMessages][google.cloud.dialogflow.v2beta1.Conversations.ListMessages]. -message ListMessagesRequest { - // Required. The name of the conversation to list messages for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Message" - } - ]; - - // Optional. Filter on message fields. Currently predicates on `create_time` - // and `create_time_epoch_microseconds` are supported. `create_time` only - // support milliseconds accuracy. E.g., - // `create_time_epoch_microseconds > 1551790877964485` or - // `create_time > "2017-01-15T01:30:15.01Z"`. - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 4; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; -} - -// The response message for [Conversations.ListMessages][google.cloud.dialogflow.v2beta1.Conversations.ListMessages]. -message ListMessagesResponse { - // Required. The list of messages. There will be a maximum number of items - // returned based on the page_size field in the request. - // `messages` is sorted by `create_time` in descending order. - repeated Message messages = 1; - - // Optional. Token to retrieve the next page of results, or empty if there are - // no more results in the list. - string next_page_token = 2; -} - -// The request message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. -message SuggestConversationSummaryRequest { - // Required. The conversation to fetch suggestion for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string conversation = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Conversation" - } - ]; - - // The name of the latest conversation message used as context for - // compiling suggestion. If empty, the latest message of the conversation will - // be used. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; - - // Max number of messages prior to and including - // [latest_message] to use as context when compiling the - // suggestion. By default 500 and at most 1000. - int32 context_size = 4; -} - -// The response message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. -message SuggestConversationSummaryResponse { - // Generated summary for a conversation. - message Summary { - // The summary content that is concatenated into one string. - string text = 1; - - // The summary content that is divided into sections. The key is the - // section's name and the value is the section's content. There is no - // specific format for the key or value. - map<string, string> text_sections = 4; - - // The name of the answer record. Format: - // "projects/<Project ID>/answerRecords/<Answer Record ID>" - string answer_record = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/AnswerRecord" - }]; - } - - // Generated summary. - Summary summary = 1; - - // The name of the latest conversation message used as context for - // compiling suggestion. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; - - // Number of messages prior to and including - // [last_conversation_message][] used to compile the suggestion. It may be - // smaller than the [SuggestSummaryRequest.context_size][] field in the - // request if there weren't that many messages in the conversation. - int32 context_size = 3; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_event.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_event.proto deleted file mode 100644 index 7f47dce..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_event.proto +++ /dev/null @@ -1,85 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/cloud/dialogflow/v2beta1/participant.proto"; -import "google/rpc/status.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ConversationEventProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Represents a notification sent to Pub/Sub subscribers for conversation -// lifecycle events. -message ConversationEvent { - // Enumeration of the types of events available. - enum Type { - // Type not set. - TYPE_UNSPECIFIED = 0; - - // A new conversation has been opened. This is fired when a telephone call - // is answered, or a conversation is created via the API. - CONVERSATION_STARTED = 1; - - // An existing conversation has closed. This is fired when a telephone call - // is terminated, or a conversation is closed via the API. - CONVERSATION_FINISHED = 2; - - // An existing conversation has received notification from Dialogflow that - // human intervention is required. - HUMAN_INTERVENTION_NEEDED = 3; - - // An existing conversation has received a new message, either from API or - // telephony. It is configured in - // [ConversationProfile.new_message_event_notification_config][google.cloud.dialogflow.v2beta1.ConversationProfile.new_message_event_notification_config] - NEW_MESSAGE = 5; - - // Unrecoverable error during a telephone call. - // - // In general non-recoverable errors only occur if something was - // misconfigured in the ConversationProfile corresponding to the call. After - // a non-recoverable error, Dialogflow may stop responding. - // - // We don't fire this event: - // - // * in an API call because we can directly return the error, or, - // * when we can recover from an error. - UNRECOVERABLE_ERROR = 4; - } - - // Required. The unique identifier of the conversation this notification - // refers to. - // Format: `projects/<Project ID>/conversations/<Conversation ID>`. - string conversation = 1; - - // Required. The type of the event that this notification refers to. - Type type = 2; - - // Optional. More detailed information about an error. Only set for type - // UNRECOVERABLE_ERROR_IN_PHONE_CALL. - google.rpc.Status error_status = 3; - - // Payload of conversation event. - oneof payload { - // Payload of NEW_MESSAGE event. - Message new_message_payload = 4; - } -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_profile.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_profile.proto deleted file mode 100644 index 0c1f552..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/conversation_profile.proto +++ /dev/null @@ -1,735 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/audio_config.proto"; -import "google/cloud/dialogflow/v2beta1/participant.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/timestamp.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ConversationProfileProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; -option (google.api.resource_definition) = { - type: "dialogflow.googleapis.com/CXSecuritySettings" - pattern: "projects/{project}/locations/{location}/securitySettings/{security_settings}" -}; -option (google.api.resource_definition) = { - type: "dialogflow.googleapis.com/ConversationModel" - pattern: "projects/{project}/locations/{location}/conversationModels/{conversation_model}" -}; - -// Service for managing [ConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfile]. -service ConversationProfiles { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all conversation profiles in the specified project. - rpc ListConversationProfiles(ListConversationProfilesRequest) returns (ListConversationProfilesResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/conversationProfiles" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/conversationProfiles" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified conversation profile. - rpc GetConversationProfile(GetConversationProfileRequest) returns (ConversationProfile) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/conversationProfiles/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/conversationProfiles/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates a conversation profile in the specified project. - // - // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] - // aren't populated in the response. You can retrieve them via - // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] API. - rpc CreateConversationProfile(CreateConversationProfileRequest) returns (ConversationProfile) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/conversationProfiles" - body: "conversation_profile" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/conversationProfiles" - body: "conversation_profile" - } - }; - option (google.api.method_signature) = "parent,conversation_profile"; - } - - // Updates the specified conversation profile. - // - // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] - // aren't populated in the response. You can retrieve them via - // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] API. - rpc UpdateConversationProfile(UpdateConversationProfileRequest) returns (ConversationProfile) { - option (google.api.http) = { - patch: "/v2beta1/{conversation_profile.name=projects/*/conversationProfiles/*}" - body: "conversation_profile" - additional_bindings { - patch: "/v2beta1/{conversation_profile.name=projects/*/locations/*/conversationProfiles/*}" - body: "conversation_profile" - } - }; - option (google.api.method_signature) = "conversation_profile,update_mask"; - } - - // Deletes the specified conversation profile. - rpc DeleteConversationProfile(DeleteConversationProfileRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/conversationProfiles/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/conversationProfiles/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Adds or updates a suggestion feature in a conversation profile. - // If the conversation profile contains the type of suggestion feature for - // the participant role, it will update it. Otherwise it will insert the - // suggestion feature. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata] - // - `response`: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] - // - // If a long running operation to add or update suggestion feature - // config for the same conversation profile, participant role and suggestion - // feature type exists, please cancel the existing long running operation - // before sending such request, otherwise the request will be rejected. - rpc SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{conversation_profile=projects/*/conversationProfiles/*}:setSuggestionFeatureConfig" - body: "*" - additional_bindings { - post: "/v2beta1/{conversation_profile=projects/*/locations/*/conversationProfiles/*}:setSuggestionFeatureConfig" - body: "*" - } - }; - option (google.api.method_signature) = "conversation_profile"; - option (google.longrunning.operation_info) = { - response_type: "ConversationProfile" - metadata_type: "SetSuggestionFeatureConfigOperationMetadata" - }; - } - - // Clears a suggestion feature from a conversation profile for the given - // participant role. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata] - // - `response`: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] - rpc ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{conversation_profile=projects/*/conversationProfiles/*}:clearSuggestionFeatureConfig" - body: "*" - additional_bindings { - post: "/v2beta1/{conversation_profile=projects/*/locations/*/conversationProfiles/*}:clearSuggestionFeatureConfig" - body: "*" - } - }; - option (google.api.method_signature) = "conversation_profile"; - option (google.longrunning.operation_info) = { - response_type: "ConversationProfile" - metadata_type: "ClearSuggestionFeatureConfigOperationMetadata" - }; - } -} - -// Defines the services to connect to incoming Dialogflow conversations. -message ConversationProfile { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/ConversationProfile" - pattern: "projects/{project}/conversationProfiles/{conversation_profile}" - pattern: "projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" - }; - - // The unique identifier of this conversation profile. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string name = 1; - - // Required. Human readable name for this profile. Max length 1024 bytes. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Output only. Create time of the conversation profile. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Update time of the conversation profile. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Configuration for an automated agent to use with this profile. - AutomatedAgentConfig automated_agent_config = 3; - - // Configuration for agent assistance to use with this profile. - HumanAgentAssistantConfig human_agent_assistant_config = 4; - - // Configuration for connecting to a live agent. - // - // Currently, this feature is not general available, please contact Google - // to get access. - HumanAgentHandoffConfig human_agent_handoff_config = 5; - - // Configuration for publishing conversation lifecycle events. - NotificationConfig notification_config = 6; - - // Configuration for logging conversation lifecycle events. - LoggingConfig logging_config = 7; - - // Configuration for publishing new message events. Event will be sent in - // format of [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] - NotificationConfig new_message_event_notification_config = 8; - - // Settings for speech transcription. - SpeechToTextConfig stt_config = 9; - - // Language code for the conversation profile. If not specified, the language - // is en-US. Language at ConversationProfile should be set for all non en-us - // languages. - // This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - // language tag. Example: "en-US". - string language_code = 10; - - // The time zone of this conversational profile from the - // [time zone database](https://www.iana.org/time-zones), e.g., - // America/New_York, Europe/Paris. Defaults to America/New_York. - string time_zone = 14; - - // Name of the CX SecuritySettings reference for the agent. - // Format: `projects/<Project ID>/locations/<Location - // ID>/securitySettings/<Security Settings ID>`. - string security_settings = 13 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/CXSecuritySettings" - }]; -} - -// Defines the Automated Agent to connect to a conversation. -message AutomatedAgentConfig { - // Required. ID of the Dialogflow agent environment to use. - // - // This project needs to either be the same project as the conversation or you - // need to grant `service-<Conversation Project - // Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API - // Service Agent` role in this project. - // - // - For ES agents, use format: `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID or '-'>`. If environment is not - // specified, the default `draft` environment is used. Refer to - // [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) - // for more details. - // - // - For CX agents, use format `projects/<Project ID>/locations/<Location - // ID>/agents/<Agent ID>/environments/<Environment ID - // or '-'>`. If environment is not specified, the default `draft` environment - // is used. - string agent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Agent" - } - ]; -} - -// Defines the Human Agent Assistant to connect to a conversation. -message HumanAgentAssistantConfig { - // Settings of suggestion trigger. - message SuggestionTriggerSettings { - // Do not trigger if last utterance is small talk. - bool no_small_talk = 1; - - // Only trigger suggestion if participant role of last utterance is - // END_USER. - bool only_end_user = 2; - } - - // Config for suggestion features. - message SuggestionFeatureConfig { - // The suggestion feature. - SuggestionFeature suggestion_feature = 5; - - // Automatically iterates all participants and tries to compile - // suggestions. - // - // Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. - bool enable_event_based_suggestion = 3; - - // Settings of suggestion trigger. - // - // Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use - // this field. - SuggestionTriggerSettings suggestion_trigger_settings = 10; - - // Configs of query. - SuggestionQueryConfig query_config = 6; - - // Configs of custom conversation model. - ConversationModelConfig conversation_model_config = 7; - - // Configs for processing conversation. - ConversationProcessConfig conversation_process_config = 8; - } - - // Detail human agent assistant config. - message SuggestionConfig { - // Configuration of different suggestion features. One feature can have only - // one config. - repeated SuggestionFeatureConfig feature_configs = 2; - - // If `group_suggestion_responses` is false, and there are multiple - // `feature_configs` in `event based suggestion` or - // StreamingAnalyzeContent, we will try to deliver suggestions to customers - // as soon as we get new suggestion. Different type of suggestions based on - // the same context will be in separate Pub/Sub event or - // `StreamingAnalyzeContentResponse`. - // - // If `group_suggestion_responses` set to true. All the suggestions to the - // same participant based on the same context will be grouped into a single - // Pub/Sub event or StreamingAnalyzeContentResponse. - bool group_suggestion_responses = 3; - } - - // Config for suggestion query. - message SuggestionQueryConfig { - // Knowledge base source settings. - // - // Supported features: ARTICLE_SUGGESTION, FAQ. - message KnowledgeBaseQuerySource { - // Required. Knowledge bases to query. Format: - // `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. Currently, only one knowledge - // base is supported. - repeated string knowledge_bases = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/KnowledgeBase" - } - ]; - } - - // Document source settings. - // - // Supported features: SMART_REPLY, SMART_COMPOSE. - message DocumentQuerySource { - // Required. Knowledge documents to query from. Format: - // `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`. - // Currently, only one document is supported. - repeated string documents = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - } - ]; - } - - // Dialogflow source setting. - // - // Supported feature: DIALOGFLOW_ASSIST. - message DialogflowQuerySource { - // Required. The name of a dialogflow virtual agent used for end user side intent - // detection and suggestion. Format: `projects/<Project Number / - // ID>/locations/<Location ID>/agent`. When multiple agents are allowed in - // the same Dialogflow project. - string agent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Agent" - } - ]; - } - - // Settings that determine how to filter recent conversation context when - // generating suggestions. - message ContextFilterSettings { - // If set to true, the last message from virtual agent (hand off message) - // and the message before it (trigger message of hand off) are dropped. - bool drop_handoff_messages = 1; - - // If set to true, all messages from virtual agent are dropped. - bool drop_virtual_agent_messages = 2; - - // If set to true, all messages from ivr stage are dropped. - bool drop_ivr_messages = 3; - } - - // Source of query. - oneof query_source { - // Query from knowledgebase. It is used by: - // ARTICLE_SUGGESTION, FAQ. - KnowledgeBaseQuerySource knowledge_base_query_source = 1; - - // Query from knowledge base document. It is used by: - // SMART_REPLY, SMART_COMPOSE. - DocumentQuerySource document_query_source = 2; - - // Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. - DialogflowQuerySource dialogflow_query_source = 3; - } - - // Maximum number of results to return. Currently, if unset, defaults to 10. - // And the max number is 20. - int32 max_results = 4; - - // Confidence threshold of query result. - // - // Agent Assist gives each suggestion a score in the range [0.0, 1.0], based - // on the relevance between the suggestion and the current conversation - // context. A score of 0.0 has no relevance, while a score of 1.0 has high - // relevance. Only suggestions with a score greater than or equal to the - // value of this field are included in the results. - // - // For a baseline model (the default), the recommended value is in the range - // [0.05, 0.1]. - // - // For a custom model, there is no recommended value. Tune this value by - // starting from a very low value and slowly increasing until you have - // desired results. - // - // If this field is not set, it is default to 0.0, which means that all - // suggestions are returned. - // - // Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. - float confidence_threshold = 5; - - // Determines how recent conversation context is filtered when generating - // suggestions. If unspecified, no messages will be dropped. - ContextFilterSettings context_filter_settings = 7; - } - - // Custom conversation models used in agent assist feature. - // - // Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, - // CONVERSATION_SUMMARIZATION. - message ConversationModelConfig { - // Conversation model resource name. Format: `projects/<Project - // ID>/conversationModels/<Model ID>`. - string model = 1 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/ConversationModel" - }]; - } - - // Config to process conversation. - message ConversationProcessConfig { - // Number of recent non-small-talk sentences to use as context for article - // and FAQ suggestion - int32 recent_sentences_count = 2; - } - - // Configuration for analyses to run on each conversation message. - message MessageAnalysisConfig { - // Enable entity extraction in conversation messages on [agent assist - // stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). - // If unspecified, defaults to false. - // - // Currently, this feature is not general available, please contact Google - // to get access. - bool enable_entity_extraction = 2; - - // Enable sentiment analysis in conversation messages on [agent assist - // stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). - // If unspecified, defaults to false. Sentiment analysis inspects user input - // and identifies the prevailing subjective opinion, especially to determine - // a user's attitude as positive, negative, or neutral: - // https://cloud.google.com/natural-language/docs/basics#sentiment_analysis - // For [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method, result will be in - // [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.message]. - // For [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] method, result will be in - // [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.AnalyzeContentResponse.message] - // For [Conversations.ListMessages][google.cloud.dialogflow.v2beta1.Conversations.ListMessages] method, result will be in - // [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.ListMessagesResponse.messages] - // If Pub/Sub notification is configured, result will be in - // [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.ConversationEvent.new_message_payload]. - bool enable_sentiment_analysis = 3; - } - - // Pub/Sub topic on which to publish new agent assistant events. - NotificationConfig notification_config = 2; - - // Configuration for agent assistance of human agent participant. - SuggestionConfig human_agent_suggestion_config = 3; - - // Configuration for agent assistance of end user participant. - // - // Currently, this feature is not general available, please contact Google - // to get access. - SuggestionConfig end_user_suggestion_config = 4; - - // Configuration for message analysis. - MessageAnalysisConfig message_analysis_config = 5; -} - -// Defines the hand off to a live agent, typically on which external agent -// service provider to connect to a conversation. -// -// Currently, this feature is not general available, please contact Google -// to get access. -message HumanAgentHandoffConfig { - // Configuration specific to LivePerson (https://www.liveperson.com). - message LivePersonConfig { - // Required. Account number of the LivePerson account to connect. This is - // the account number you input at the login page. - string account_number = 1 [(google.api.field_behavior) = REQUIRED]; - } - - // Configuration specific to Salesforce Live Agent. - message SalesforceLiveAgentConfig { - // Required. The organization ID of the Salesforce account. - string organization_id = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. Live Agent deployment ID. - string deployment_id = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. Live Agent chat button ID. - string button_id = 3 [(google.api.field_behavior) = REQUIRED]; - - // Required. Domain of the Live Agent endpoint for this agent. You can find - // the endpoint URL in the `Live Agent settings` page. For example if URL - // has the form https://d.la4-c2-phx.salesforceliveagent.com/..., - // you should fill in d.la4-c2-phx.salesforceliveagent.com. - string endpoint_domain = 4 [(google.api.field_behavior) = REQUIRED]; - } - - // Required. Specifies which agent service to connect for human agent handoff. - oneof agent_service { - // Uses LivePerson (https://www.liveperson.com). - LivePersonConfig live_person_config = 1; - - // Uses Salesforce Live Agent. - SalesforceLiveAgentConfig salesforce_live_agent_config = 2; - } -} - -// Defines notification behavior. -message NotificationConfig { - // Format of cloud pub/sub message. - enum MessageFormat { - // If it is unspecified, PROTO will be used. - MESSAGE_FORMAT_UNSPECIFIED = 0; - - // Pubsub message will be serialized proto. - PROTO = 1; - - // Pubsub message will be json. - JSON = 2; - } - - // Name of the Pub/Sub topic to publish conversation - // events like - // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] as - // serialized [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] protos. - // - // For telephony integration to receive notification, make sure either this - // topic is in the same project as the conversation or you grant - // `service-<Conversation Project - // Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service - // Agent` role in the topic project. - // - // For chat integration to receive notification, make sure API caller has been - // granted the `Dialogflow Service Agent` role for the topic. - // - // Format: `projects/<Project ID>/locations/<Location ID>/topics/<Topic ID>`. - string topic = 1; - - // Format of message. - MessageFormat message_format = 2; -} - -// Defines logging behavior for conversation lifecycle events. -message LoggingConfig { - // Whether to log conversation events like - // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] to - // Stackdriver in the conversation project as JSON format - // [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] protos. - bool enable_stackdriver_logging = 3; -} - -// The request message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. -message ListConversationProfilesRequest { - // Required. The project to list all conversation profiles from. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/ConversationProfile" - } - ]; - - // The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // The next_page_token value returned from a previous list request. - string page_token = 3; -} - -// The response message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. -message ListConversationProfilesResponse { - // The list of project conversation profiles. There is a maximum number - // of items returned based on the page_size field in the request. - repeated ConversationProfile conversation_profiles = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile]. -message GetConversationProfileRequest { - // Required. The resource name of the conversation profile. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/ConversationProfile" - } - ]; -} - -// The request message for [ConversationProfiles.CreateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.CreateConversationProfile]. -message CreateConversationProfileRequest { - // Required. The project to create a conversation profile for. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/ConversationProfile" - } - ]; - - // Required. The conversation profile to create. - ConversationProfile conversation_profile = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.UpdateConversationProfile]. -message UpdateConversationProfileRequest { - // Required. The conversation profile to update. - ConversationProfile conversation_profile = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to control which fields to update. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.DeleteConversationProfile]. -// -// This operation fails if the conversation profile is still referenced from -// a phone number. -message DeleteConversationProfileRequest { - // Required. The name of the conversation profile to delete. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/ConversationProfile" - } - ]; -} - -// The request message for -// [ConversationProfiles.SetSuggestionFeature][]. -message SetSuggestionFeatureConfigRequest { - // Required. The Conversation Profile to add or update the suggestion feature - // config. Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string conversation_profile = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The participant role to add or update the suggestion feature - // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The suggestion feature config to add or update. - HumanAgentAssistantConfig.SuggestionFeatureConfig suggestion_feature_config = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [ConversationProfiles.ClearFeature][]. -message ClearSuggestionFeatureConfigRequest { - // Required. The Conversation Profile to add or update the suggestion feature - // config. Format: `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>`. - string conversation_profile = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The participant role to remove the suggestion feature - // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The type of the suggestion feature to remove. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] -// operation. -message SetSuggestionFeatureConfigOperationMetadata { - // The resource name of the conversation profile. Format: - // `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>` - string conversation_profile = 1; - - // Required. The participant role to add or update the suggestion feature - // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The type of the suggestion feature to add or update. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; - - // Timestamp whe the request was created. The time is measured on server side. - google.protobuf.Timestamp create_time = 4; -} - -// Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] -// operation. -message ClearSuggestionFeatureConfigOperationMetadata { - // The resource name of the conversation profile. Format: - // `projects/<Project ID>/locations/<Location - // ID>/conversationProfiles/<Conversation Profile ID>` - string conversation_profile = 1; - - // Required. The participant role to remove the suggestion feature - // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The type of the suggestion feature to remove. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; - - // Timestamp whe the request was created. The time is measured on server side. - google.protobuf.Timestamp create_time = 4; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json b/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json deleted file mode 100755 index af87dcf..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json +++ /dev/null @@ -1,218 +0,0 @@ -{ - "methodConfig": [ - { - "name": [ - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamAdminTool" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamDatasets" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamDiscriminants" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamDiscriminantChanges" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamLabels" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamNotices" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamProjects" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamTasks" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamTopicClusters" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamTrainingRuns" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamTranscripts" - }, - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamUtterances" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Agents" - }, - { - "service": "google.cloud.dialogflow.v2beta1.AnswerRecords" - }, - { - "service": "google.cloud.dialogflow.v2beta1.AsynchronousFulfillment" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Contexts" - }, - { - "service": "google.cloud.dialogflow.v2beta1.ConversationProfiles" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Conversations" - }, - { - "service": "google.cloud.dialogflow.v2beta1.ConversationDatasets" - }, - { - "service": "google.cloud.dialogflow.v2beta1.ConversationModels" - }, - { - "service": "google.cloud.dialogflow.v2beta1.ConversationProfiles" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Documents" - }, - { - "service": "google.cloud.dialogflow.v2beta1.EntityTypes" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Environments" - }, - { - "service": "google.cloud.dialogflow.v2beta1.FeatureCreationFlows" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Fulfillments" - }, - { - "service": "google.cloud.dialogflow.v2beta1.HumanAgentAssistants" - }, - { - "service": "google.cloud.dialogflow.v2beta1.HumanAssistService" - }, - - { - "service": "google.cloud.dialogflow.v2beta1.Integrations" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Intents" - }, - { - "service": "google.cloud.dialogflow.v2beta1.IvrNodes" - }, - { - "service": "google.cloud.dialogflow.v2beta1.KnowledgeBases" - }, - { - "service": "google.cloud.dialogflow.v2beta1.ModelEvaluations" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Participants" - }, - { - "service": "google.cloud.dialogflow.v2beta1.PhoneNumbers" - }, - { - "service": "google.cloud.dialogflow.v2beta1.PhoneNumberOrders" - }, - { - "service": "google.cloud.dialogflow.v2beta1.SecuritySettingsService" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Sessions" - }, - { - "service": "google.cloud.dialogflow.v2beta1.SessionEntityTypes" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Versions" - }, - { - "service": "google.cloud.dialogflow.v2beta1.InternalDatasetService" - }, - { - "service": "google.cloud.dialogflow.v2beta1.IssueModelService" - }, - { - "service": "google.cloud.dialogflow.v2beta1.AogService" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Tiers" - } - ], - "timeout": "60s", - "retryPolicy": { - "initialBackoff": "0.100s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "UNAVAILABLE" - ] - } - }, - { - "name": [ - { - "service": "google.cloud.dialogflow.aam.v2beta1.AamAdminTool", - "method": "ExportIntent" - }, - { - "service": "google.cloud.dialogflow.v2beta1.AgentModeling", - "method": "CreateConversationGraph" - }, - { - "service": "google.cloud.dialogflow.v2beta1.SessionHistory", - "method": "SearchSessionConversations" - } - ], - "timeout": "180s", - "retryPolicy": { - "initialBackoff": "0.100s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "UNAVAILABLE" - ] - } - }, - { - "name": [ - { - "service": "google.cloud.dialogflow.v2beta1.Participants", - "method": "AnalyzeContent" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Sessions", - "method": "DetectIntent" - } - ], - "timeout": "220s", - "retryPolicy": { - "initialBackoff": "0.100s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "UNAVAILABLE" - ] - } - }, - { - "name": [ - { - "service": "google.cloud.dialogflow.v2beta1.Participants", - "method": "StreamingAnalyzeContent" - }, - { - "service": "google.cloud.dialogflow.v2beta1.Sessions", - "method": "StreamingDetectIntent" - } - ], - "timeout": "220s" - }, - { - "name": [ - { - "service": "google.cloud.dialogflow.v2beta1.Conversations", - "method": "StreamingListUpcomingCallCompanionEvents" - } - ], - "timeout": "600s" - } - ] -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_v2beta1.yaml b/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_v2beta1.yaml deleted file mode 100644 index 88c78ec..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/dialogflow_v2beta1.yaml +++ /dev/null @@ -1,234 +0,0 @@ -type: google.api.Service -config_version: 3 -name: dialogflow.googleapis.com -title: Dialogflow API - -apis: -- name: google.cloud.dialogflow.v2beta1.Agents -- name: google.cloud.dialogflow.v2beta1.AnswerRecords -- name: google.cloud.dialogflow.v2beta1.Contexts -- name: google.cloud.dialogflow.v2beta1.ConversationProfiles -- name: google.cloud.dialogflow.v2beta1.Conversations -- name: google.cloud.dialogflow.v2beta1.Documents -- name: google.cloud.dialogflow.v2beta1.EntityTypes -- name: google.cloud.dialogflow.v2beta1.Environments -- name: google.cloud.dialogflow.v2beta1.Fulfillments -- name: google.cloud.dialogflow.v2beta1.Intents -- name: google.cloud.dialogflow.v2beta1.KnowledgeBases -- name: google.cloud.dialogflow.v2beta1.Participants -- name: google.cloud.dialogflow.v2beta1.SessionEntityTypes -- name: google.cloud.dialogflow.v2beta1.Sessions -- name: google.cloud.dialogflow.v2beta1.Versions -- name: google.cloud.location.Locations -- name: google.longrunning.Operations - -types: -- name: google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse -- name: google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse -- name: google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata -- name: google.cloud.dialogflow.v2beta1.ConversationEvent -- name: google.cloud.dialogflow.v2beta1.ExportAgentResponse -- name: google.cloud.dialogflow.v2beta1.HumanAgentAssistantEvent -- name: google.cloud.dialogflow.v2beta1.ImportDocumentsResponse -- name: google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata -- name: google.cloud.dialogflow.v2beta1.OriginalDetectIntentRequest -- name: google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata -- name: google.cloud.dialogflow.v2beta1.WebhookRequest -- name: google.cloud.dialogflow.v2beta1.WebhookResponse - -documentation: - summary: |- - Builds conversational interfaces (for example, chatbots, and voice-powered - apps and devices). - overview: |- - <!-- mdformat off(presubmit failing, mdformat is as well) --> Dialogflow is - a natural language understanding platform that makes it easy - to design and integrate a conversational user interface into your mobile - app, web application, device, bot, interactive voice response system, and - so on. Using Dialogflow, you can provide new and engaging ways for - users to interact with your product. - - Dialogflow can analyze multiple types of input from your customers, - including text or audio inputs (like from a phone or voice recording). - It can also respond to your customers in a couple of ways, either through - text or with synthetic speech. - - For more information, see the - [Dialogflow documentation](https://cloud.google.com/dialogflow/docs). - rules: - - selector: google.cloud.location.Locations.GetLocation - description: Gets information about a location. - - - selector: google.cloud.location.Locations.ListLocations - description: Lists information about the supported locations for this service. - -backend: - rules: - - selector: 'google.cloud.dialogflow.v2beta1.Agents.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.AnswerRecords.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Contexts.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.ConversationProfiles.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Conversations.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Documents.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.EntityTypes.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Environments.*' - deadline: 60.0 - - selector: google.cloud.dialogflow.v2beta1.Fulfillments.GetFulfillment - deadline: 60.0 - - selector: google.cloud.dialogflow.v2beta1.Fulfillments.UpdateFulfillment - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Intents.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.KnowledgeBases.*' - deadline: 60.0 - - selector: 'google.cloud.dialogflow.v2beta1.Participants.*' - deadline: 60.0 - - selector: google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent - deadline: 220.0 - - selector: google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent - deadline: 220.0 - - selector: 'google.cloud.dialogflow.v2beta1.SessionEntityTypes.*' - deadline: 60.0 - - selector: google.cloud.dialogflow.v2beta1.Sessions.DetectIntent - deadline: 220.0 - - selector: google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent - deadline: 220.0 - - selector: 'google.cloud.dialogflow.v2beta1.Versions.*' - deadline: 60.0 - - selector: google.cloud.location.Locations.GetLocation - deadline: 60.0 - - selector: google.cloud.location.Locations.ListLocations - deadline: 60.0 - - selector: 'google.longrunning.Operations.*' - deadline: 60.0 - - selector: google.longrunning.Operations.ListOperations - deadline: 180.0 - -http: - rules: - - selector: google.cloud.location.Locations.GetLocation - get: '/v2beta1/{name=projects/*/locations/*}' - - selector: google.cloud.location.Locations.ListLocations - get: '/v2beta1/{name=projects/*}/locations' - - selector: google.longrunning.Operations.CancelOperation - post: '/v2beta1/{name=projects/*/operations/*}:cancel' - additional_bindings: - - post: '/v2beta1/{name=projects/*/locations/*/operations/*}:cancel' - - selector: google.longrunning.Operations.GetOperation - get: '/v2beta1/{name=projects/*/operations/*}' - additional_bindings: - - get: '/v2beta1/{name=projects/*/locations/*/operations/*}' - - selector: google.longrunning.Operations.ListOperations - get: '/v2beta1/{name=projects/*}/operations' - additional_bindings: - - get: '/v2beta1/{name=projects/*/locations/*}/operations' - -authentication: - rules: - - selector: 'google.cloud.dialogflow.v2beta1.Agents.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.AnswerRecords.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Contexts.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.ConversationProfiles.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Conversations.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Documents.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.EntityTypes.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Environments.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.dialogflow.v2beta1.Fulfillments.GetFulfillment - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.dialogflow.v2beta1.Fulfillments.UpdateFulfillment - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Intents.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.KnowledgeBases.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Participants.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.SessionEntityTypes.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.dialogflow.v2beta1.Sessions.DetectIntent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.cloud.dialogflow.v2beta1.Versions.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.location.Locations.GetLocation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: google.cloud.location.Locations.ListLocations - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow - - selector: 'google.longrunning.Operations.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform, - https://www.googleapis.com/auth/dialogflow diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/document.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/document.proto deleted file mode 100644 index 9ecdb5f..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/document.proto +++ /dev/null @@ -1,612 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/gcs.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/timestamp.proto"; -import "google/rpc/status.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "DocumentProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document]. -service Documents { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all documents of the knowledge base. - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documents" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified document. - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc GetDocument(GetDocumentRequest) returns (Document) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates a new document. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc CreateDocument(CreateDocumentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents" - body: "document" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents" - body: "document" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documents" - body: "document" - } - }; - option (google.api.method_signature) = "parent,document"; - option (google.longrunning.operation_info) = { - response_type: "Document" - metadata_type: "KnowledgeOperationMetadata" - }; - } - - // Create documents by importing data from external sources. - // Dialogflow supports up to 350 documents in each request. If you try to - // import more, Dialogflow will return an error. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] - rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents:import" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents:import" - body: "*" - } - }; - option (google.longrunning.operation_info) = { - response_type: "ImportDocumentsResponse" - metadata_type: "KnowledgeOperationMetadata" - }; - } - - // Deletes the specified document. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc DeleteDocument(DeleteDocumentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}" - } - }; - option (google.api.method_signature) = "name"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "KnowledgeOperationMetadata" - }; - } - - // Updates the specified document. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc UpdateDocument(UpdateDocumentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - patch: "/v2beta1/{document.name=projects/*/knowledgeBases/*/documents/*}" - body: "document" - additional_bindings { - patch: "/v2beta1/{document.name=projects/*/locations/*/knowledgeBases/*/documents/*}" - body: "document" - } - additional_bindings { - patch: "/v2beta1/{document.name=projects/*/agent/knowledgeBases/*/documents/*}" - body: "document" - } - }; - option (google.api.method_signature) = "document,update_mask"; - option (google.api.method_signature) = "document"; - option (google.longrunning.operation_info) = { - response_type: "Document" - metadata_type: "KnowledgeOperationMetadata" - }; - } - - // Reloads the specified document from its specified source, content_uri or - // content. The previously loaded content of the document will be deleted. - // Note: Even when the content of the document has not changed, there still - // may be side effects because of internal implementation changes. - // Note: If the document source is Google Cloud Storage URI, its metadata will - // be replaced with the custom metadata from Google Cloud Storage if the - // `import_gcs_custom_metadata` field is set to true in the request. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] - // - // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - // only use `projects.knowledgeBases.documents`. - rpc ReloadDocument(ReloadDocumentRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}:reload" - body: "*" - additional_bindings { - post: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}:reload" - body: "*" - } - additional_bindings { - post: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}:reload" - body: "*" - } - }; - option (google.api.method_signature) = "name,gcs_source"; - option (google.longrunning.operation_info) = { - response_type: "Document" - metadata_type: "KnowledgeOperationMetadata" - }; - } -} - -// A knowledge document to be used by a [KnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBase]. -// -// For more information, see the [knowledge base -// guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). -// -// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; -// only use `projects.knowledgeBases.documents`. -message Document { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Document" - pattern: "projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" - pattern: "projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}" - }; - - // The knowledge type of document content. - enum KnowledgeType { - option allow_alias = true; - - // The type is unspecified or arbitrary. - KNOWLEDGE_TYPE_UNSPECIFIED = 0; - - // The document content contains question and answer pairs as either HTML or - // CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats - // may fail to be parsed. - // - // CSV must have questions in the first column and answers in the second, - // with no header. Because of this explicit format, they are always parsed - // accurately. - FAQ = 1; - - // Documents for which unstructured text is extracted and used for - // question answering. - EXTRACTIVE_QA = 2; - - // The entire document content as a whole can be used for query results. - // Only for Contact Center Solutions on Dialogflow. - ARTICLE_SUGGESTION = 3; - - // The document contains agent-facing Smart Reply entries. - AGENT_FACING_SMART_REPLY = 4; - - // The legacy enum for agent-facing smart reply feature. - SMART_REPLY = 4; - } - - // The status of a reload attempt. - message ReloadStatus { - // Output only. The time of a reload attempt. - // This reload may have been triggered automatically or manually and may - // not have succeeded. - google.protobuf.Timestamp time = 1; - - // Output only. The status of a reload attempt or the initial load. - google.rpc.Status status = 2; - } - - // Possible states of the document - enum State { - // The document state is unspecified. - STATE_UNSPECIFIED = 0; - - // The document creation is in progress. - CREATING = 1; - - // The document is active and ready to use. - ACTIVE = 2; - - // The document updation is in progress. - UPDATING = 3; - - // The document is reloading. - RELOADING = 4; - - // The document deletion is in progress. - DELETING = 5; - } - - // Optional. The document resource name. - // The name must be empty when creating a document. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. - string name = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The display name of the document. The name must be 1024 bytes or - // less; otherwise, the creation request fails. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The MIME type of this document. - string mime_type = 3 [(google.api.field_behavior) = REQUIRED]; - - // Required. The knowledge type of document content. - repeated KnowledgeType knowledge_types = 4 [(google.api.field_behavior) = REQUIRED]; - - // The source of this document. - oneof source { - // The URI where the file content is located. - // - // For documents stored in Google Cloud Storage, these URIs must have - // the form `gs://<bucket-name>/<object-name>`. - // - // NOTE: External URLs must correspond to public webpages, i.e., they must - // be indexed by Google Search. In particular, URLs for showing documents in - // Google Cloud Storage (i.e. the URL in your browser) are not supported. - // Instead use the `gs://` format URI described above. - string content_uri = 5; - - // The raw content of the document. This field is only permitted for - // EXTRACTIVE_QA and FAQ knowledge types. - // Note: This field is in the process of being deprecated, please use - // raw_content instead. - string content = 6 [deprecated = true]; - - // The raw content of the document. This field is only permitted for - // EXTRACTIVE_QA and FAQ knowledge types. - bytes raw_content = 9; - } - - // Optional. If true, we try to automatically reload the document every day - // (at a time picked by the system). If false or unspecified, we don't try - // to automatically reload the document. - // - // Currently you can only enable automatic reload for documents sourced from - // a public url, see `source` field for the source types. - // - // Reload status can be tracked in `latest_reload_status`. If a reload - // fails, we will keep the document unchanged. - // - // If a reload fails with internal errors, the system will try to reload the - // document on the next day. - // If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the - // system will not try to reload the document anymore. You need to manually - // reload the document successfully by calling `ReloadDocument` and clear the - // errors. - bool enable_auto_reload = 11 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The time and status of the latest reload. - // This reload may have been triggered automatically or manually - // and may not have succeeded. - ReloadStatus latest_reload_status = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. Metadata for the document. The metadata supports arbitrary - // key-value pairs. Suggested use cases include storing a document's title, - // an external URL distinct from the document's content_uri, etc. - // The max size of a `key` or a `value` of the metadata is 1024 bytes. - map<string, string> metadata = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The current state of the document. - State state = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Request message for [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument]. -message GetDocumentRequest { - // Required. The name of the document to retrieve. - // Format `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - } - ]; -} - -// Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments]. -message ListDocumentsRequest { - // Required. The knowledge base to list all documents for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Document" - } - ]; - - // The maximum number of items to return in a single page. By - // default 10 and at most 100. - int32 page_size = 2; - - // The next_page_token value returned from a previous list request. - string page_token = 3; - - // The filter expression used to filter documents returned by the list method. - // The expression has the following syntax: - // - // <field> <operator> <value> [AND <field> <operator> <value>] ... - // - // The following fields and operators are supported: - // - // * knowledge_types with has(:) operator - // * display_name with has(:) operator - // * state with equals(=) operator - // - // Examples: - // - // * "knowledge_types:FAQ" matches documents with FAQ knowledge type. - // * "display_name:customer" matches documents whose display name contains - // "customer". - // * "state=ACTIVE" matches documents with ACTIVE state. - // * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 4; -} - -// Response message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments]. -message ListDocumentsResponse { - // The list of documents. - repeated Document documents = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// Request message for [Documents.CreateDocument][google.cloud.dialogflow.v2beta1.Documents.CreateDocument]. -message CreateDocumentRequest { - // Required. The knowledge base to create a document for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Document" - } - ]; - - // Required. The document to create. - Document document = 2 [(google.api.field_behavior) = REQUIRED]; - - // Whether to import custom metadata from Google Cloud Storage. - // Only valid when the document source is Google Cloud Storage URI. - bool import_gcs_custom_metadata = 3; -} - -// Request message for [Documents.ImportDocuments][google.cloud.dialogflow.v2beta1.Documents.ImportDocuments]. -message ImportDocumentsRequest { - // Required. The knowledge base to import documents into. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Document" - } - ]; - - // Required. The source to use for importing documents. - // - // If the source captures multiple objects, then multiple documents will be - // created, one corresponding to each object, and all of these documents will - // be created using the same document template. - // - // Dialogflow supports up to 350 documents in each request. If you try to - // import more, Dialogflow will return an error. - oneof source { - // The Google Cloud Storage location for the documents. - // The path can include a wildcard. - // - // These URIs may have the forms - // `gs://<bucket-name>/<object-name>`. - // `gs://<bucket-name>/<object-path>/*.<extension>`. - GcsSources gcs_source = 2; - } - - // Required. Document template used for importing all the documents. - ImportDocumentTemplate document_template = 3 [(google.api.field_behavior) = REQUIRED]; - - // Whether to import custom metadata from Google Cloud Storage. - // Only valid when the document source is Google Cloud Storage URI. - bool import_gcs_custom_metadata = 4; -} - -// The template used for importing documents. -message ImportDocumentTemplate { - // Required. The MIME type of the document. - string mime_type = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The knowledge type of document content. - repeated Document.KnowledgeType knowledge_types = 2 [(google.api.field_behavior) = REQUIRED]; - - // Metadata for the document. The metadata supports arbitrary - // key-value pairs. Suggested use cases include storing a document's title, - // an external URL distinct from the document's content_uri, etc. - // The max size of a `key` or a `value` of the metadata is 1024 bytes. - map<string, string> metadata = 3; -} - -// Response message for [Documents.ImportDocuments][google.cloud.dialogflow.v2beta1.Documents.ImportDocuments]. -message ImportDocumentsResponse { - // Includes details about skipped documents or any other warnings. - repeated google.rpc.Status warnings = 1; -} - -// Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument]. -message DeleteDocumentRequest { - // Required. The name of the document to delete. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - } - ]; -} - -// Request message for [Documents.UpdateDocument][google.cloud.dialogflow.v2beta1.Documents.UpdateDocument]. -message UpdateDocumentRequest { - // Required. The document to update. - Document document = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Not specified means `update all`. - // Currently, only `display_name` can be updated, an InvalidArgument will be - // returned for attempting to update other fields. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// Metadata related to the Export Data Operations (e.g. ExportDocument). -message ExportOperationMetadata { - // Cloud Storage file path of the exported data. - GcsDestination exported_gcs_destination = 1; -} - -// Metadata in google::longrunning::Operation for Knowledge operations. -message KnowledgeOperationMetadata { - // States of the operation. - enum State { - // State unspecified. - STATE_UNSPECIFIED = 0; - - // The operation has been created. - PENDING = 1; - - // The operation is currently running. - RUNNING = 2; - - // The operation is done, either cancelled or completed. - DONE = 3; - } - - // Required. Output only. The current state of this operation. - State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The name of the knowledge base interacted with during the operation. - string knowledge_base = 3; - - // Additional metadata for the Knowledge operation. - oneof operation_metadata { - // Metadata for the Export Data Operation such as the destination of export. - ExportOperationMetadata export_operation_metadata = 4; - } -} - -// Request message for [Documents.ReloadDocument][google.cloud.dialogflow.v2beta1.Documents.ReloadDocument]. -message ReloadDocumentRequest { - // Required. The name of the document to reload. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - } - ]; - - // The source for document reloading. - // Optional. If provided, the service will load the contents from the source - // and update document in the knowledge base. - oneof source { - // The path for a Cloud Storage source file for reloading document content. - // If not provided, the Document's existing source will be reloaded. - GcsSource gcs_source = 3; - } - - // Whether to import custom metadata from Google Cloud Storage. - // Only valid when the document source is Google Cloud Storage URI. - bool import_gcs_custom_metadata = 4; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/entity_type.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/entity_type.proto deleted file mode 100644 index 7bffded..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/entity_type.proto +++ /dev/null @@ -1,639 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "EntityTypeProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [EntityTypes][google.cloud.dialogflow.v2beta1.EntityType]. -service EntityTypes { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all entity types in the specified agent. - rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent}/entityTypes" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent}/entityTypes" - } - }; - option (google.api.method_signature) = "parent"; - option (google.api.method_signature) = "parent,language_code"; - } - - // Retrieves the specified entity type. - rpc GetEntityType(GetEntityTypeRequest) returns (EntityType) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/entityTypes/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/entityTypes/*}" - } - }; - option (google.api.method_signature) = "name"; - option (google.api.method_signature) = "name,language_code"; - } - - // Creates an entity type in the specified agent. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc CreateEntityType(CreateEntityTypeRequest) returns (EntityType) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/entityTypes" - body: "entity_type" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/entityTypes" - body: "entity_type" - } - }; - option (google.api.method_signature) = "parent,entity_type"; - option (google.api.method_signature) = "parent,entity_type,language_code"; - } - - // Updates the specified entity type. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) { - option (google.api.http) = { - patch: "/v2beta1/{entity_type.name=projects/*/agent/entityTypes/*}" - body: "entity_type" - additional_bindings { - patch: "/v2beta1/{entity_type.name=projects/*/locations/*/agent/entityTypes/*}" - body: "entity_type" - } - }; - option (google.api.method_signature) = "entity_type"; - option (google.api.method_signature) = "entity_type,language_code"; - option (google.api.method_signature) = "entity_type,language_code,update_mask"; - } - - // Deletes the specified entity type. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/entityTypes/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/entityTypes/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Updates/Creates multiple entity types in the specified agent. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse] - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchUpdateEntityTypes(BatchUpdateEntityTypesRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/entityTypes:batchUpdate" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/entityTypes:batchUpdate" - body: "*" - } - }; - option (google.longrunning.operation_info) = { - response_type: "google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse" - metadata_type: "google.protobuf.Struct" - }; - } - - // Deletes entity types in the specified agent. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchDeleteEntityTypes(BatchDeleteEntityTypesRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/entityTypes:batchDelete" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/entityTypes:batchDelete" - body: "*" - } - }; - option (google.api.method_signature) = "parent,entity_type_names"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Creates multiple new entities in the specified entity type. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchCreateEntities(BatchCreateEntitiesRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchCreate" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchCreate" - body: "*" - } - }; - option (google.api.method_signature) = "parent,entities"; - option (google.api.method_signature) = "parent,entities,language_code"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Updates or creates multiple entities in the specified entity type. This - // method does not affect entities in the entity type that aren't explicitly - // specified in the request. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - rpc BatchUpdateEntities(BatchUpdateEntitiesRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchUpdate" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchUpdate" - body: "*" - } - }; - option (google.api.method_signature) = "parent,entities"; - option (google.api.method_signature) = "parent,entities,language_code"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } - - // Deletes entities in the specified entity type. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchDeleteEntities(BatchDeleteEntitiesRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchDelete" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchDelete" - body: "*" - } - }; - option (google.api.method_signature) = "parent,entity_values"; - option (google.api.method_signature) = "parent,entity_values,language_code"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } -} - -// Each intent parameter has a type, called the entity type, which dictates -// exactly how data from an end-user expression is extracted. -// -// Dialogflow provides predefined system entities that can match many common -// types of data. For example, there are system entities for matching dates, -// times, colors, email addresses, and so on. You can also create your own -// custom entities for matching custom data. For example, you could define a -// vegetable entity that can match the types of vegetables available for -// purchase with a grocery store agent. -// -// For more information, see the -// [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). -message EntityType { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/EntityType" - pattern: "projects/{project}/agent/entityTypes/{entity_type}" - pattern: "projects/{project}/locations/{location}/agent/entityTypes/{entity_type}" - }; - - // Represents kinds of entities. - enum Kind { - // Not specified. This value should be never used. - KIND_UNSPECIFIED = 0; - - // Map entity types allow mapping of a group of synonyms to a reference - // value. - KIND_MAP = 1; - - // List entity types contain a set of entries that do not map to reference - // values. However, list entity types can contain references to other entity - // types (with or without aliases). - KIND_LIST = 2; - - // Regexp entity types allow to specify regular expressions in entries - // values. - KIND_REGEXP = 3; - } - - // Represents different entity type expansion modes. Automated expansion - // allows an agent to recognize values that have not been explicitly listed in - // the entity (for example, new kinds of shopping list items). - enum AutoExpansionMode { - // Auto expansion disabled for the entity. - AUTO_EXPANSION_MODE_UNSPECIFIED = 0; - - // Allows an agent to recognize values that have not been explicitly - // listed in the entity. - AUTO_EXPANSION_MODE_DEFAULT = 1; - } - - // An **entity entry** for an associated entity type. - message Entity { - // Required. The primary value associated with this entity entry. - // For example, if the entity type is *vegetable*, the value could be - // *scallions*. - // - // For `KIND_MAP` entity types: - // - // * A reference value to be used in place of synonyms. - // - // For `KIND_LIST` entity types: - // - // * A string that can contain references to other entity types (with or - // without aliases). - string value = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. A collection of value synonyms. For example, if the entity type - // is *vegetable*, and `value` is *scallions*, a synonym could be *green - // onions*. - // - // For `KIND_LIST` entity types: - // - // * This collection must contain exactly one synonym equal to `value`. - repeated string synonyms = 2; - } - - // The unique identifier of the entity type. - // Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType] and - // [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes] methods. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string name = 1; - - // Required. The name of the entity type. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. Indicates the kind of entity type. - Kind kind = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Indicates whether the entity type can be automatically - // expanded. - AutoExpansionMode auto_expansion_mode = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of entity entries associated with the entity type. - repeated Entity entities = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Enables fuzzy entity extraction during classification. - bool enable_fuzzy_extraction = 7 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. -message ListEntityTypesRequest { - // Required. The agent to list all entity types from. - // Supported formats: - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. -message ListEntityTypesResponse { - // The list of agent entity types. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated EntityType entity_types = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType]. -message GetEntityTypeRequest { - // Required. The name of the entity type. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.CreateEntityType]. -message CreateEntityTypeRequest { - // Required. The agent to create a entity type for. - // Supported formats: - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Required. The entity type to create. - EntityType entity_type = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType]. -message UpdateEntityTypeRequest { - // Required. The entity type to update. - EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.DeleteEntityType]. -message DeleteEntityTypeRequest { - // Required. The name of the entity type to delete. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/EntityType" - } - ]; -} - -// The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. -message BatchUpdateEntityTypesRequest { - // Required. The name of the agent to update or create entity types in. - // Supported formats: - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // The source of the entity type batch. - // - // For each entity type in the batch: - // - // * If `name` is specified, we update an existing entity type. - // * If `name` is not specified, we create a new entity type. - oneof entity_type_batch { - // The URI to a Google Cloud Storage file containing entity types to update - // or create. The file format can either be a serialized proto (of - // EntityBatch type) or a JSON object. Note: The URI must start with - // "gs://". - string entity_type_batch_uri = 2; - - // The collection of entity types to update or create. - EntityTypeBatch entity_type_batch_inline = 3; - } - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 5 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. -message BatchUpdateEntityTypesResponse { - // The collection of updated or created entity types. - repeated EntityType entity_types = 1; -} - -// The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntityTypes]. -message BatchDeleteEntityTypesRequest { - // Required. The name of the agent to delete all entities types for. - // Supported formats: - // - `projects/<Project ID>/agent`, - // - `projects/<Project ID>/locations/<Location ID>/agent`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Required. The names entity types to delete. All names must point to the - // same agent as `parent`. - repeated string entity_type_names = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities]. -message BatchCreateEntitiesRequest { - // Required. The name of the entity type to create entities in. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Required. The entities to create. - repeated EntityType.Entity entities = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [EntityTypes.BatchUpdateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntities]. -message BatchUpdateEntitiesRequest { - // Required. The name of the entity type to update or create entities in. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Required. The entities to update or create. - repeated EntityType.Entity entities = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 4; -} - -// The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntities]. -message BatchDeleteEntitiesRequest { - // Required. The name of the entity type to delete entries for. - // Supported formats: - // - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity - // Type ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/EntityType" - } - ]; - - // Required. The reference `values` of the entities to delete. Note that - // these are not fully-qualified names, i.e. they don't start with - // `projects/<Project ID>`. - repeated string entity_values = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// This message is a wrapper around a collection of entity types. -message EntityTypeBatch { - // A collection of entity types. - repeated EntityType entity_types = 1; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/environment.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/environment.proto deleted file mode 100644 index dd95cab..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/environment.proto +++ /dev/null @@ -1,372 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/audio_config.proto"; -import "google/cloud/dialogflow/v2beta1/fulfillment.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/timestamp.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "EnvironmentProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Environments][google.cloud.dialogflow.v2beta1.Environment]. -service Environments { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all non-draft environments of the specified agent. - rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent}/environments" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent}/environments" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified agent environment. - rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/environments/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/environments/*}" - } - }; - } - - // Creates an agent environment. - rpc CreateEnvironment(CreateEnvironmentRequest) returns (Environment) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/environments" - body: "environment" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/environments" - body: "environment" - } - }; - } - - // Updates the specified agent environment. - // - // This method allows you to deploy new agent versions into the environment. - // When an environment is pointed to a new agent version by setting - // `environment.agent_version`, the environment is temporarily set to the - // `LOADING` state. During that time, the environment keeps on serving the - // previous version of the agent. After the new agent version is done loading, - // the environment is set back to the `RUNNING` state. - // You can use "-" as Environment ID in environment name to update version - // in "draft" environment. WARNING: this will negate all recent changes to - // draft and can't be undone. You may want to save the draft to a version - // before calling this function. - rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (Environment) { - option (google.api.http) = { - patch: "/v2beta1/{environment.name=projects/*/agent/environments/*}" - body: "environment" - additional_bindings { - patch: "/v2beta1/{environment.name=projects/*/locations/*/agent/environments/*}" - body: "environment" - } - }; - } - - // Deletes the specified agent environment. - rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/environments/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/environments/*}" - } - }; - } - - // Gets the history of the specified environment. - rpc GetEnvironmentHistory(GetEnvironmentHistoryRequest) returns (EnvironmentHistory) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent/environments/*}/history" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*}/history" - } - }; - } -} - -// You can create multiple versions of your agent and publish them to separate -// environments. -// -// When you edit an agent, you are editing the draft agent. At any point, you -// can save the draft agent as an agent version, which is an immutable snapshot -// of your agent. -// -// When you save the draft agent, it is published to the default environment. -// When you create agent versions, you can publish them to custom environments. -// You can create a variety of custom environments for: -// -// - testing -// - development -// - production -// - etc. -// -// For more information, see the [versions and environments -// guide](https://cloud.google.com/dialogflow/docs/agents-versions). -message Environment { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Environment" - pattern: "projects/{project}/agent/environments/{environment}" - pattern: "projects/{project}/locations/{location}/agent/environments/{environment}" - }; - - // Represents an environment state. When an environment is pointed to a new - // agent version, the environment is temporarily set to the `LOADING` state. - // During that time, the environment keeps on serving the previous version of - // the agent. After the new agent version is done loading, the environment is - // set back to the `RUNNING` state. - enum State { - // Not specified. This value is not used. - STATE_UNSPECIFIED = 0; - - // Stopped. - STOPPED = 1; - - // Loading. - LOADING = 2; - - // Running. - RUNNING = 3; - } - - // Output only. The unique identifier of this agent environment. - // Supported formats: - // - `projects/<Project Number / ID>/agent/environments/<Environment ID>` - // - `projects/<Project Number / ID>/locations/<Location - // ID>/agent/environments/<Environment ID>` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. The developer-provided description for this environment. - // The maximum length is 500 characters. If exceeded, the request is rejected. - string description = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The agent version loaded into this environment. - // Supported formats: - // - `projects/<Project ID>/agent/versions/<Version ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version - // ID>` - string agent_version = 3 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Version" - } - ]; - - // Output only. The state of this environment. This field is read-only, i.e., it cannot be - // set by create and update methods. - State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The last update time of this environment. This field is read-only, i.e., it - // cannot be set by create and update methods. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. Text to speech settings for this environment. - TextToSpeechSettings text_to_speech_settings = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The fulfillment settings to use for this environment. - Fulfillment fulfillment = 8 [(google.api.field_behavior) = OPTIONAL]; -} - -// Instructs the speech synthesizer on how to generate the output audio content. -message TextToSpeechSettings { - // Optional. Indicates whether text to speech is enabled. Even when this field is false, - // other settings in this proto are still retained. - bool enable_text_to_speech = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Required. Audio encoding of the synthesized audio content. - OutputAudioEncoding output_audio_encoding = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then - // the synthesizer will use the default sample rate based on the audio - // encoding. If this is different from the voice's natural sample rate, then - // the synthesizer will honor this request by converting to the desired sample - // rate (which might result in worse audio quality). - int32 sample_rate_hertz = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Configuration of how speech should be synthesized, mapping from language - // (https://cloud.google.com/dialogflow/docs/reference/language) to - // SynthesizeSpeechConfig. - map<string, SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. -message ListEnvironmentsRequest { - // Required. The agent to list all environments from. - // Format: - // - `projects/<Project Number / ID>/agent` - // - `projects/<Project Number / ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Environment" - } - ]; - - // Optional. The maximum number of items to return in a single page. By default 100 and - // at most 1000. - int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. -message ListEnvironmentsResponse { - // The list of agent environments. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Environment environments = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Environments.GetEnvironment][google.cloud.dialogflow.v2beta1.Environments.GetEnvironment]. -message GetEnvironmentRequest { - // Required. The name of the environment. - // Supported formats: - // - `projects/<Project Number / ID>/agent/environments/<Environment ID>` - // - `projects/<Project Number / ID>/locations/<Location - // ID>/agent/environments/<Environment ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Environment" - } - ]; -} - -// The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.v2beta1.Environments.CreateEnvironment]. -message CreateEnvironmentRequest { - // Required. The agent to create an environment for. - // Supported formats: - // - `projects/<Project Number / ID>/agent` - // - `projects/<Project Number / ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Environment" - } - ]; - - // Required. The environment to create. - Environment environment = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The unique id of the new environment. - string environment_id = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.v2beta1.Environments.UpdateEnvironment]. -message UpdateEnvironmentRequest { - // Required. The environment to update. - Environment environment = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. This field is used to prevent accidental overwrite of the draft - // environment, which is an operation that cannot be undone. To confirm that - // the caller desires this overwrite, this field must be explicitly set to - // true when updating the draft environment (environment ID = `-`). - bool allow_load_to_draft_and_discard_changes = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.v2beta1.Environments.DeleteEnvironment]. -message DeleteEnvironmentRequest { - // Required. The name of the environment to delete. - // / Format: - // - `projects/<Project Number / ID>/agent/environments/<Environment ID>` - // - `projects/<Project Number / ID>/locations/<Location - // ID>/agent/environments/<Environment ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Environment" - } - ]; -} - -// The request message for [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. -message GetEnvironmentHistoryRequest { - // Required. The name of the environment to retrieve history for. - // Supported formats: - // - `projects/<Project Number / ID>/agent/environments/<Environment ID>` - // - `projects/<Project Number / ID>/locations/<Location - // ID>/agent/environments/<Environment ID>` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Environment" - } - ]; - - // Optional. The maximum number of items to return in a single page. By default 100 and - // at most 1000. - int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. -message EnvironmentHistory { - // Represents an environment history entry. - message Entry { - // The agent version loaded into this environment history entry. - string agent_version = 1; - - // The developer-provided description for this environment history entry. - string description = 2; - - // The creation time of this environment history entry. - google.protobuf.Timestamp create_time = 3; - } - - // Output only. The name of the environment this history is for. - // Supported formats: - // - `projects/<Project Number / ID>/agent/environments/<Environment ID>` - // - `projects/<Project Number / ID>/locations/<Location - // ID>/agent/environments/<Environment ID>` - string parent = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The list of agent environments. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Entry entries = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/fulfillment.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/fulfillment.proto deleted file mode 100644 index 8efe32a..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/fulfillment.proto +++ /dev/null @@ -1,180 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/field_mask.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "FulfillmentProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Fulfillments][google.cloud.dialogflow.v2beta1.Fulfillment]. -service Fulfillments { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Retrieves the fulfillment. - rpc GetFulfillment(GetFulfillmentRequest) returns (Fulfillment) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/fulfillment}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/fulfillment}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Updates the fulfillment. - rpc UpdateFulfillment(UpdateFulfillmentRequest) returns (Fulfillment) { - option (google.api.http) = { - patch: "/v2beta1/{fulfillment.name=projects/*/agent/fulfillment}" - body: "fulfillment" - additional_bindings { - patch: "/v2beta1/{fulfillment.name=projects/*/locations/*/agent/fulfillment}" - body: "fulfillment" - } - }; - option (google.api.method_signature) = "fulfillment,update_mask"; - } -} - -// By default, your agent responds to a matched intent with a static response. -// As an alternative, you can provide a more dynamic response by using -// fulfillment. When you enable fulfillment for an intent, Dialogflow responds -// to that intent by calling a service that you define. For example, if an -// end-user wants to schedule a haircut on Friday, your service can check your -// database and respond to the end-user with availability information for -// Friday. -// -// For more information, see the [fulfillment -// guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). -message Fulfillment { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Fulfillment" - pattern: "projects/{project}/agent/fulfillment" - pattern: "projects/{project}/locations/{location}/agent/fulfillment" - }; - - // Represents configuration for a generic web service. - // Dialogflow supports two mechanisms for authentications: - // - // - Basic authentication with username and password. - // - Authentication with additional authentication headers. - // - // More information could be found at: - // https://cloud.google.com/dialogflow/docs/fulfillment-configure. - message GenericWebService { - // Required. The fulfillment URI for receiving POST requests. - // It must use https protocol. - string uri = 1 [(google.api.field_behavior) = REQUIRED]; - - // The user name for HTTP Basic authentication. - string username = 2; - - // The password for HTTP Basic authentication. - string password = 3; - - // The HTTP request headers to send together with fulfillment requests. - map<string, string> request_headers = 4; - - // Optional. Indicates if generic web service is created through Cloud Functions - // integration. Defaults to false. - // - // is_cloud_function is deprecated. Cloud functions can be configured by - // its uri as a regular web service now. - bool is_cloud_function = 5 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; - } - - // Whether fulfillment is enabled for the specific feature. - message Feature { - // The type of the feature. - enum Type { - // Feature type not specified. - TYPE_UNSPECIFIED = 0; - - // Fulfillment is enabled for SmallTalk. - SMALLTALK = 1; - } - - // The type of the feature that enabled for fulfillment. - Type type = 1; - } - - // Required. The unique identifier of the fulfillment. - // Supported formats: - // - // - `projects/<Project ID>/agent/fulfillment` - // - `projects/<Project ID>/locations/<Location ID>/agent/fulfillment` - // - // This field is not used for Fulfillment in an Environment. - string name = 1 [(google.api.field_behavior) = REQUIRED]; - - // The human-readable name of the fulfillment, unique within the agent. - // - // This field is not used for Fulfillment in an Environment. - string display_name = 2; - - // Required. The fulfillment configuration. - oneof fulfillment { - // Configuration for a generic web service. - GenericWebService generic_web_service = 3; - } - - // Whether fulfillment is enabled. - bool enabled = 4; - - // The field defines whether the fulfillment is enabled for certain features. - repeated Feature features = 5; -} - -// The request message for [Fulfillments.GetFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.GetFulfillment]. -message GetFulfillmentRequest { - // Required. The name of the fulfillment. - // Supported formats: - // - // - `projects/<Project ID>/agent/fulfillment` - // - `projects/<Project ID>/locations/<Location ID>/agent/fulfillment` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Fulfillment" - } - ]; -} - -// The request message for [Fulfillments.UpdateFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.UpdateFulfillment]. -message UpdateFulfillmentRequest { - // Required. The fulfillment to update. - Fulfillment fulfillment = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to control which fields get updated. If the mask is not - // present, all fields will be updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/gcs.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/gcs.proto deleted file mode 100644 index debb578..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/gcs.proto +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/field_behavior.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "GcsProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Google Cloud Storage locations for the inputs. -message GcsSources { - // Required. Google Cloud Storage URIs for the inputs. A URI is of the - // form: - // gs://bucket/object-prefix-or-name - // Whether a prefix or name is used depends on the use case. - repeated string uris = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Google Cloud Storage location for single input. -message GcsSource { - // Required. The Google Cloud Storage URIs for the inputs. A URI is of the - // form: - // gs://bucket/object-prefix-or-name - // Whether a prefix or name is used depends on the use case. - string uri = 1; -} - -// Google Cloud Storage location for the output. -message GcsDestination { - // Required. The Google Cloud Storage URIs for the output. A URI is of the - // form: - // gs://bucket/object-prefix-or-name - // Whether a prefix or name is used depends on the use case. The requesting - // user must have "write-permission" to the bucket. - string uri = 1; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto deleted file mode 100644 index 9716f74..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/cloud/dialogflow/v2beta1/participant.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "HumanAgentAssistantEventProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Output only. Represents a notification sent to Pub/Sub subscribers for -// agent assistant events in a specific conversation. -message HumanAgentAssistantEvent { - // The conversation this notification refers to. - // Format: `projects/<Project ID>/conversations/<Conversation ID>`. - string conversation = 1; - - // The participant that the suggestion is compiled for. And This field is used - // to call [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] API. Format: - // `projects/<Project ID>/conversations/<Conversation - // ID>/participants/<Participant ID>`. - // It will not be set in legacy workflow. - // [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more - // information. - string participant = 3; - - // The suggestion results payload that this notification refers to. It will - // only be set when - // [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses] - // sets to true. - repeated SuggestionResult suggestion_results = 5; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/intent.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/intent.proto deleted file mode 100644 index 99e9caf..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/intent.proto +++ /dev/null @@ -1,1453 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/context.proto"; -import "google/longrunning/operations.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/struct.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "IntentProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Intents][google.cloud.dialogflow.v2beta1.Intent]. -service Intents { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all intents in the specified agent. - rpc ListIntents(ListIntentsRequest) returns (ListIntentsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent}/intents" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent}/intents" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/agent/environments/*}/intents" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*}/intents" - } - }; - option (google.api.method_signature) = "parent"; - option (google.api.method_signature) = "parent,language_code"; - } - - // Retrieves the specified intent. - rpc GetIntent(GetIntentRequest) returns (Intent) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/intents/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/intents/*}" - } - }; - option (google.api.method_signature) = "name"; - option (google.api.method_signature) = "name,language_code"; - } - - // Creates an intent in the specified agent. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc CreateIntent(CreateIntentRequest) returns (Intent) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/intents" - body: "intent" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/intents" - body: "intent" - } - }; - option (google.api.method_signature) = "parent,intent"; - option (google.api.method_signature) = "parent,intent,language_code"; - } - - // Updates the specified intent. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc UpdateIntent(UpdateIntentRequest) returns (Intent) { - option (google.api.http) = { - patch: "/v2beta1/{intent.name=projects/*/agent/intents/*}" - body: "intent" - additional_bindings { - patch: "/v2beta1/{intent.name=projects/*/locations/*/agent/intents/*}" - body: "intent" - } - }; - option (google.api.method_signature) = "intent,update_mask"; - option (google.api.method_signature) = "intent"; - option (google.api.method_signature) = "intent,language_code"; - option (google.api.method_signature) = "intent,language_code,update_mask"; - } - - // Deletes the specified intent and its direct or indirect followup intents. - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc DeleteIntent(DeleteIntentRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/intents/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/intents/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Updates/Creates multiple intents in the specified agent. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchUpdateIntents(BatchUpdateIntentsRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/intents:batchUpdate" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/intents:batchUpdate" - body: "*" - } - }; - option (google.api.method_signature) = "parent,intent_batch_uri"; - option (google.api.method_signature) = "parent,intent_batch_inline"; - option (google.longrunning.operation_info) = { - response_type: "google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse" - metadata_type: "google.protobuf.Struct" - }; - } - - // Deletes intents in the specified agent. - // - // This method is a [long-running - // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). - // The returned `Operation` type has the following method-specific fields: - // - // - `metadata`: An empty [Struct - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: An [Empty - // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - // - // Note: You should always train an agent prior to sending it queries. See the - // [training - // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchDeleteIntents(BatchDeleteIntentsRequest) returns (google.longrunning.Operation) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/intents:batchDelete" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/intents:batchDelete" - body: "*" - } - }; - option (google.api.method_signature) = "parent,intents"; - option (google.longrunning.operation_info) = { - response_type: "google.protobuf.Empty" - metadata_type: "google.protobuf.Struct" - }; - } -} - -// An intent categorizes an end-user's intention for one conversation turn. For -// each agent, you define many intents, where your combined intents can handle a -// complete conversation. When an end-user writes or says something, referred to -// as an end-user expression or end-user input, Dialogflow matches the end-user -// input to the best intent in your agent. Matching an intent is also known as -// intent classification. -// -// For more information, see the [intent -// guide](https://cloud.google.com/dialogflow/docs/intents-overview). -message Intent { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Intent" - pattern: "projects/{project}/agent/intents/{intent}" - pattern: "projects/{project}/locations/{location}/agent/intents/{intent}" - }; - - // Represents the different states that webhooks can be in. - enum WebhookState { - // Webhook is disabled in the agent and in the intent. - WEBHOOK_STATE_UNSPECIFIED = 0; - - // Webhook is enabled in the agent and in the intent. - WEBHOOK_STATE_ENABLED = 1; - - // Webhook is enabled in the agent and in the intent. Also, each slot - // filling prompt is forwarded to the webhook. - WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING = 2; - } - - // Represents an example that the agent is trained on. - message TrainingPhrase { - // Represents different types of training phrases. - enum Type { - // Not specified. This value should never be used. - TYPE_UNSPECIFIED = 0; - - // Examples do not contain @-prefixed entity type names, but example parts - // can be annotated with entity types. - EXAMPLE = 1; - - // Templates are not annotated with entity types, but they can contain - // @-prefixed entity type names as substrings. - // Note: Template mode has been deprecated. Example mode is the only - // supported way to create new training phrases. If you have existing - // training phrases in template mode, they will be removed during training - // and it can cause a drop in agent performance. - TEMPLATE = 2 [deprecated = true]; - } - - // Represents a part of a training phrase. - message Part { - // Required. The text for this part. - string text = 1; - - // Optional. The entity type name prefixed with `@`. - // This field is required for annotated parts of the training phrase. - string entity_type = 2; - - // Optional. The parameter name for the value extracted from the - // annotated part of the example. - // This field is required for annotated parts of the training phrase. - string alias = 3; - - // Optional. Indicates whether the text was manually annotated. - // This field is set to true when the Dialogflow Console is used to - // manually annotate the part. When creating an annotated part with the - // API, you must set this to true. - bool user_defined = 4; - } - - // Output only. The unique identifier of this training phrase. - string name = 1; - - // Required. The type of the training phrase. - Type type = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The ordered list of training phrase parts. - // The parts are concatenated in order to form the training phrase. - // - // Note: The API does not automatically annotate training phrases like the - // Dialogflow Console does. - // - // Note: Do not forget to include whitespace at part boundaries, - // so the training phrase is well formatted when the parts are concatenated. - // - // If the training phrase does not need to be annotated with parameters, - // you just need a single part with only the [Part.text][google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part.text] field set. - // - // If you want to annotate the training phrase, you must create multiple - // parts, where the fields of each part are populated in one of two ways: - // - // - `Part.text` is set to a part of the phrase that has no parameters. - // - `Part.text` is set to a part of the phrase that you want to annotate, - // and the `entity_type`, `alias`, and `user_defined` fields are all - // set. - repeated Part parts = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Indicates how many times this example was added to - // the intent. Each time a developer adds an existing sample by editing an - // intent or training, this counter is increased. - int32 times_added_count = 4 [(google.api.field_behavior) = OPTIONAL]; - } - - // Represents intent parameters. - message Parameter { - // The unique identifier of this parameter. - string name = 1; - - // Required. The name of the parameter. - string display_name = 2; - - // Optional. The definition of the parameter value. It can be: - // - // - a constant string, - // - a parameter value defined as `$parameter_name`, - // - an original parameter value defined as `$parameter_name.original`, - // - a parameter value from some context defined as - // `#context_name.parameter_name`. - string value = 3; - - // Optional. The default value to use when the `value` yields an empty - // result. - // Default values can be extracted from contexts by using the following - // syntax: `#context_name.parameter_name`. - string default_value = 4; - - // Optional. The name of the entity type, prefixed with `@`, that - // describes values of the parameter. If the parameter is - // required, this must be provided. - string entity_type_display_name = 5; - - // Optional. Indicates whether the parameter is required. That is, - // whether the intent cannot be completed without collecting the parameter - // value. - bool mandatory = 6; - - // Optional. The collection of prompts that the agent can present to the - // user in order to collect a value for the parameter. - repeated string prompts = 7; - - // Optional. Indicates whether the parameter represents a list of values. - bool is_list = 8; - } - - // Corresponds to the `Response` field in the Dialogflow console. - message Message { - // Represents different platforms that a rich message can be intended for. - enum Platform { - // Not specified. - PLATFORM_UNSPECIFIED = 0; - - // Facebook. - FACEBOOK = 1; - - // Slack. - SLACK = 2; - - // Telegram. - TELEGRAM = 3; - - // Kik. - KIK = 4; - - // Skype. - SKYPE = 5; - - // Line. - LINE = 6; - - // Viber. - VIBER = 7; - - // Google Assistant - // See [Dialogflow webhook - // format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - ACTIONS_ON_GOOGLE = 8; - - // Telephony Gateway. - TELEPHONY = 10; - - // Google Hangouts. - GOOGLE_HANGOUTS = 11; - } - - // The text response message. - message Text { - // Optional. The collection of the agent's responses. - repeated string text = 1; - } - - // The image response message. - message Image { - // Optional. The public URI to an image file. - string image_uri = 1; - - // A text description of the image to be used for accessibility, - // e.g., screen readers. Required if image_uri is set for CarouselSelect. - string accessibility_text = 2; - } - - // The quick replies response message. - message QuickReplies { - // Optional. The title of the collection of quick replies. - string title = 1; - - // Optional. The collection of quick replies. - repeated string quick_replies = 2; - } - - // The card response message. - message Card { - // Optional. Contains information about a button. - message Button { - // Optional. The text to show on the button. - string text = 1; - - // Optional. The text to send back to the Dialogflow API or a URI to - // open. - string postback = 2; - } - - // Optional. The title of the card. - string title = 1; - - // Optional. The subtitle of the card. - string subtitle = 2; - - // Optional. The public URI to an image file for the card. - string image_uri = 3; - - // Optional. The collection of card buttons. - repeated Button buttons = 4; - } - - // The simple response message containing speech or text. - message SimpleResponse { - // One of text_to_speech or ssml must be provided. The plain text of the - // speech output. Mutually exclusive with ssml. - string text_to_speech = 1; - - // One of text_to_speech or ssml must be provided. Structured spoken - // response to the user in the SSML format. Mutually exclusive with - // text_to_speech. - string ssml = 2; - - // Optional. The text to display. - string display_text = 3; - } - - // The collection of simple response candidates. - // This message in `QueryResult.fulfillment_messages` and - // `WebhookResponse.fulfillment_messages` should contain only one - // `SimpleResponse`. - message SimpleResponses { - // Required. The list of simple responses. - repeated SimpleResponse simple_responses = 1; - } - - // The basic card message. Useful for displaying information. - message BasicCard { - // The button object that appears at the bottom of a card. - message Button { - // Opens the given URI. - message OpenUriAction { - // Required. The HTTP or HTTPS scheme URI. - string uri = 1; - } - - // Required. The title of the button. - string title = 1; - - // Required. Action to take when a user taps on the button. - OpenUriAction open_uri_action = 2; - } - - // Optional. The title of the card. - string title = 1; - - // Optional. The subtitle of the card. - string subtitle = 2; - - // Required, unless image is present. The body text of the card. - string formatted_text = 3; - - // Optional. The image for the card. - Image image = 4; - - // Optional. The collection of card buttons. - repeated Button buttons = 5; - } - - // The suggestion chip message that the user can tap to quickly post a reply - // to the conversation. - message Suggestion { - // Required. The text shown the in the suggestion chip. - string title = 1; - } - - // The collection of suggestions. - message Suggestions { - // Required. The list of suggested replies. - repeated Suggestion suggestions = 1; - } - - // The suggestion chip message that allows the user to jump out to the app - // or website associated with this agent. - message LinkOutSuggestion { - // Required. The name of the app or site this chip is linking to. - string destination_name = 1; - - // Required. The URI of the app or site to open when the user taps the - // suggestion chip. - string uri = 2; - } - - // The card for presenting a list of options to select from. - message ListSelect { - // An item in the list. - message Item { - // Required. Additional information about this option. - SelectItemInfo info = 1; - - // Required. The title of the list item. - string title = 2; - - // Optional. The main text describing the item. - string description = 3; - - // Optional. The image to display. - Image image = 4; - } - - // Optional. The overall title of the list. - string title = 1; - - // Required. List items. - repeated Item items = 2; - - // Optional. Subtitle of the list. - string subtitle = 3 [(google.api.field_behavior) = OPTIONAL]; - } - - // The card for presenting a carousel of options to select from. - message CarouselSelect { - // An item in the carousel. - message Item { - // Required. Additional info about the option item. - SelectItemInfo info = 1; - - // Required. Title of the carousel item. - string title = 2; - - // Optional. The body text of the card. - string description = 3; - - // Optional. The image to display. - Image image = 4; - } - - // Required. Carousel items. - repeated Item items = 1; - } - - // Additional info about the select item for when it is triggered in a - // dialog. - message SelectItemInfo { - // Required. A unique key that will be sent back to the agent if this - // response is given. - string key = 1; - - // Optional. A list of synonyms that can also be used to trigger this - // item in dialog. - repeated string synonyms = 2; - } - - // Plays audio from a file in Telephony Gateway. - message TelephonyPlayAudio { - // Required. URI to a Google Cloud Storage object containing the audio to - // play, e.g., "gs://bucket/object". The object must contain a single - // channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. - // - // This object must be readable by the `service-<Project - // Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - // where <Project Number> is the number of the Telephony Gateway project - // (usually the same as the Dialogflow agent project). If the Google Cloud - // Storage bucket is in the Telephony Gateway project, this permission is - // added by default when enabling the Dialogflow V2 API. - // - // For audio from other sources, consider using the - // `TelephonySynthesizeSpeech` message with SSML. - string audio_uri = 1; - } - - // Synthesizes speech and plays back the synthesized audio to the caller in - // Telephony Gateway. - // - // Telephony Gateway takes the synthesizer settings from - // `DetectIntentResponse.output_audio_config` which can either be set - // at request-level or can come from the agent-level synthesizer config. - message TelephonySynthesizeSpeech { - // Required. The source to be synthesized. - oneof source { - // The raw text to be synthesized. - string text = 1; - - // The SSML to be synthesized. For more information, see - // [SSML](https://developers.google.com/actions/reference/ssml). - string ssml = 2; - } - } - - // Transfers the call in Telephony Gateway. - message TelephonyTransferCall { - // Required. The phone number to transfer the call to - // in [E.164 format](https://en.wikipedia.org/wiki/E.164). - // - // We currently only allow transferring to US numbers (+1xxxyyyzzzz). - string phone_number = 1; - } - - // Rich Business Messaging (RBM) text response with suggestions. - message RbmText { - // Required. Text sent and displayed to the user. - string text = 1; - - // Optional. One or more suggestions to show to the user. - repeated RbmSuggestion rbm_suggestion = 2; - } - - // Carousel Rich Business Messaging (RBM) rich card. - // - // Rich cards allow you to respond to users with more vivid content, e.g. - // with media and suggestions. - // - // If you want to show a single card with more control over the layout, - // please use [RbmStandaloneCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmStandaloneCard] instead. - message RbmCarouselCard { - // The width of the cards in the carousel. - enum CardWidth { - // Not specified. - CARD_WIDTH_UNSPECIFIED = 0; - - // 120 DP. Note that tall media cannot be used. - SMALL = 1; - - // 232 DP. - MEDIUM = 2; - } - - // Required. The width of the cards in the carousel. - CardWidth card_width = 1; - - // Required. The cards in the carousel. A carousel must have at least - // 2 cards and at most 10. - repeated RbmCardContent card_contents = 2; - } - - // Standalone Rich Business Messaging (RBM) rich card. - // - // Rich cards allow you to respond to users with more vivid content, e.g. - // with media and suggestions. - // - // You can group multiple rich cards into one using [RbmCarouselCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmCarouselCard] but - // carousel cards will give you less control over the card layout. - message RbmStandaloneCard { - // Orientation of the card. - enum CardOrientation { - // Not specified. - CARD_ORIENTATION_UNSPECIFIED = 0; - - // Horizontal layout. - HORIZONTAL = 1; - - // Vertical layout. - VERTICAL = 2; - } - - // Thumbnail preview alignment for standalone cards with horizontal - // layout. - enum ThumbnailImageAlignment { - // Not specified. - THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED = 0; - - // Thumbnail preview is left-aligned. - LEFT = 1; - - // Thumbnail preview is right-aligned. - RIGHT = 2; - } - - // Required. Orientation of the card. - CardOrientation card_orientation = 1; - - // Required if orientation is horizontal. - // Image preview alignment for standalone cards with horizontal layout. - ThumbnailImageAlignment thumbnail_image_alignment = 2; - - // Required. Card content. - RbmCardContent card_content = 3; - } - - // Rich Business Messaging (RBM) Card content - message RbmCardContent { - // Rich Business Messaging (RBM) Media displayed in Cards - // The following media-types are currently supported: - // - // Image Types - // - // * image/jpeg - // * image/jpg' - // * image/gif - // * image/png - // - // Video Types - // - // * video/h263 - // * video/m4v - // * video/mp4 - // * video/mpeg - // * video/mpeg4 - // * video/webm - message RbmMedia { - // Media height - enum Height { - // Not specified. - HEIGHT_UNSPECIFIED = 0; - - // 112 DP. - SHORT = 1; - - // 168 DP. - MEDIUM = 2; - - // 264 DP. Not available for rich card carousels when the card width - // is set to small. - TALL = 3; - } - - // Required. Publicly reachable URI of the file. The RBM platform - // determines the MIME type of the file from the content-type field in - // the HTTP headers when the platform fetches the file. The content-type - // field must be present and accurate in the HTTP response from the URL. - string file_uri = 1; - - // Optional. Publicly reachable URI of the thumbnail.If you don't - // provide a thumbnail URI, the RBM platform displays a blank - // placeholder thumbnail until the user's device downloads the file. - // Depending on the user's setting, the file may not download - // automatically and may require the user to tap a download button. - string thumbnail_uri = 2; - - // Required for cards with vertical orientation. The height of the media - // within a rich card with a vertical layout. - // For a standalone card with horizontal layout, height is not - // customizable, and this field is ignored. - Height height = 3; - } - - // Optional. Title of the card (at most 200 bytes). - // - // At least one of the title, description or media must be set. - string title = 1; - - // Optional. Description of the card (at most 2000 bytes). - // - // At least one of the title, description or media must be set. - string description = 2; - - // Optional. However at least one of the title, description or media must - // be set. Media (image, GIF or a video) to include in the card. - RbmMedia media = 3; - - // Optional. List of suggestions to include in the card. - repeated RbmSuggestion suggestions = 4; - } - - // Rich Business Messaging (RBM) suggestion. Suggestions allow user to - // easily select/click a predefined response or perform an action (like - // opening a web uri). - message RbmSuggestion { - // Predefined suggested response or action for user to choose - oneof suggestion { - // Predefined replies for user to select instead of typing - RbmSuggestedReply reply = 1; - - // Predefined client side actions that user can choose - RbmSuggestedAction action = 2; - } - } - - // Rich Business Messaging (RBM) suggested reply that the user can click - // instead of typing in their own response. - message RbmSuggestedReply { - // Suggested reply text. - string text = 1; - - // Opaque payload that the Dialogflow receives in a user event - // when the user taps the suggested reply. This data will be also - // forwarded to webhook to allow performing custom business logic. - string postback_data = 2; - } - - // Rich Business Messaging (RBM) suggested client-side action that the user - // can choose from the card. - message RbmSuggestedAction { - // Opens the user's default dialer app with the specified phone number - // but does not dial automatically. - message RbmSuggestedActionDial { - // Required. The phone number to fill in the default dialer app. - // This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) - // format. An example of a correctly formatted phone number: - // +15556767888. - string phone_number = 1; - } - - // Opens the user's default web browser app to the specified uri - // If the user has an app installed that is - // registered as the default handler for the URL, then this app will be - // opened instead, and its icon will be used in the suggested action UI. - message RbmSuggestedActionOpenUri { - // Required. The uri to open on the user device - string uri = 1; - } - - // Opens the device's location chooser so the user can pick a location - // to send back to the agent. - message RbmSuggestedActionShareLocation { - - } - - // Text to display alongside the action. - string text = 1; - - // Opaque payload that the Dialogflow receives in a user event - // when the user taps the suggested action. This data will be also - // forwarded to webhook to allow performing custom business logic. - string postback_data = 2; - - // Action that needs to be triggered. - oneof action { - // Suggested client side action: Dial a phone number - RbmSuggestedActionDial dial = 3; - - // Suggested client side action: Open a URI on device - RbmSuggestedActionOpenUri open_url = 4; - - // Suggested client side action: Share user location - RbmSuggestedActionShareLocation share_location = 5; - } - } - - // The media content card for Actions on Google. - message MediaContent { - // Format of response media type. - enum ResponseMediaType { - // Unspecified. - RESPONSE_MEDIA_TYPE_UNSPECIFIED = 0; - - // Response media type is audio. - AUDIO = 1; - } - - // Response media object for media content card. - message ResponseMediaObject { - // Required. Name of media card. - string name = 1; - - // Optional. Description of media card. - string description = 2; - - // Image to show with the media card. - oneof image { - // Optional. Image to display above media content. - Image large_image = 3; - - // Optional. Icon to display above media content. - Image icon = 4; - } - - // Required. Url where the media is stored. - string content_url = 5; - } - - // Optional. What type of media is the content (ie "audio"). - ResponseMediaType media_type = 1; - - // Required. List of media objects. - repeated ResponseMediaObject media_objects = 2; - } - - // Browse Carousel Card for Actions on Google. - // https://developers.google.com/actions/assistant/responses#browsing_carousel - message BrowseCarouselCard { - // Browsing carousel tile - message BrowseCarouselCardItem { - // Actions on Google action to open a given url. - message OpenUrlAction { - // Type of the URI. - enum UrlTypeHint { - // Unspecified - URL_TYPE_HINT_UNSPECIFIED = 0; - - // Url would be an amp action - AMP_ACTION = 1; - - // URL that points directly to AMP content, or to a canonical URL - // which refers to AMP content via <link rel="amphtml">. - AMP_CONTENT = 2; - } - - // Required. URL - string url = 1; - - // Optional. Specifies the type of viewer that is used when opening - // the URL. Defaults to opening via web browser. - UrlTypeHint url_type_hint = 3; - } - - // Required. Action to present to the user. - OpenUrlAction open_uri_action = 1; - - // Required. Title of the carousel item. Maximum of two lines of text. - string title = 2; - - // Optional. Description of the carousel item. Maximum of four lines of - // text. - string description = 3; - - // Optional. Hero image for the carousel item. - Image image = 4; - - // Optional. Text that appears at the bottom of the Browse Carousel - // Card. Maximum of one line of text. - string footer = 5; - } - - // Image display options for Actions on Google. This should be used for - // when the image's aspect ratio does not match the image container's - // aspect ratio. - enum ImageDisplayOptions { - // Fill the gaps between the image and the image container with gray - // bars. - IMAGE_DISPLAY_OPTIONS_UNSPECIFIED = 0; - - // Fill the gaps between the image and the image container with gray - // bars. - GRAY = 1; - - // Fill the gaps between the image and the image container with white - // bars. - WHITE = 2; - - // Image is scaled such that the image width and height match or exceed - // the container dimensions. This may crop the top and bottom of the - // image if the scaled image height is greater than the container - // height, or crop the left and right of the image if the scaled image - // width is greater than the container width. This is similar to "Zoom - // Mode" on a widescreen TV when playing a 4:3 video. - CROPPED = 3; - - // Pad the gaps between image and image frame with a blurred copy of the - // same image. - BLURRED_BACKGROUND = 4; - } - - // Required. List of items in the Browse Carousel Card. Minimum of two - // items, maximum of ten. - repeated BrowseCarouselCardItem items = 1; - - // Optional. Settings for displaying the image. Applies to every image in - // [items][google.cloud.dialogflow.v2beta1.Intent.Message.BrowseCarouselCard.items]. - ImageDisplayOptions image_display_options = 2; - } - - // Table card for Actions on Google. - message TableCard { - // Required. Title of the card. - string title = 1; - - // Optional. Subtitle to the title. - string subtitle = 2; - - // Optional. Image which should be displayed on the card. - Image image = 3; - - // Optional. Display properties for the columns in this table. - repeated ColumnProperties column_properties = 4; - - // Optional. Rows in this table of data. - repeated TableCardRow rows = 5; - - // Optional. List of buttons for the card. - repeated BasicCard.Button buttons = 6; - } - - // Column properties for [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. - message ColumnProperties { - // Text alignments within a cell. - enum HorizontalAlignment { - // Text is aligned to the leading edge of the column. - HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0; - - // Text is aligned to the leading edge of the column. - LEADING = 1; - - // Text is centered in the column. - CENTER = 2; - - // Text is aligned to the trailing edge of the column. - TRAILING = 3; - } - - // Required. Column heading. - string header = 1; - - // Optional. Defines text alignment for all cells in this column. - HorizontalAlignment horizontal_alignment = 2; - } - - // Row of [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. - message TableCardRow { - // Optional. List of cells that make up this row. - repeated TableCardCell cells = 1; - - // Optional. Whether to add a visual divider after this row. - bool divider_after = 2; - } - - // Cell of [TableCardRow][google.cloud.dialogflow.v2beta1.Intent.Message.TableCardRow]. - message TableCardCell { - // Required. Text in this cell. - string text = 1; - } - - // Required. The rich response message. - oneof message { - // Returns a text response. - Text text = 1; - - // Displays an image. - Image image = 2; - - // Displays quick replies. - QuickReplies quick_replies = 3; - - // Displays a card. - Card card = 4; - - // A custom platform-specific response. - google.protobuf.Struct payload = 5; - - // Returns a voice or text-only response for Actions on Google. - SimpleResponses simple_responses = 7; - - // Displays a basic card for Actions on Google. - BasicCard basic_card = 8; - - // Displays suggestion chips for Actions on Google. - Suggestions suggestions = 9; - - // Displays a link out suggestion chip for Actions on Google. - LinkOutSuggestion link_out_suggestion = 10; - - // Displays a list card for Actions on Google. - ListSelect list_select = 11; - - // Displays a carousel card for Actions on Google. - CarouselSelect carousel_select = 12; - - // Plays audio from a file in Telephony Gateway. - TelephonyPlayAudio telephony_play_audio = 13; - - // Synthesizes speech in Telephony Gateway. - TelephonySynthesizeSpeech telephony_synthesize_speech = 14; - - // Transfers the call in Telephony Gateway. - TelephonyTransferCall telephony_transfer_call = 15; - - // Rich Business Messaging (RBM) text response. - // - // RBM allows businesses to send enriched and branded versions of SMS. See - // https://jibe.google.com/business-messaging. - RbmText rbm_text = 18; - - // Standalone Rich Business Messaging (RBM) rich card response. - RbmStandaloneCard rbm_standalone_rich_card = 19; - - // Rich Business Messaging (RBM) carousel rich card response. - RbmCarouselCard rbm_carousel_rich_card = 20; - - // Browse carousel card for Actions on Google. - BrowseCarouselCard browse_carousel_card = 22; - - // Table card for Actions on Google. - TableCard table_card = 23; - - // The media content card for Actions on Google. - MediaContent media_content = 24; - } - - // Optional. The platform that this message is intended for. - Platform platform = 6 [(google.api.field_behavior) = OPTIONAL]; - } - - // Represents a single followup intent in the chain. - message FollowupIntentInfo { - // The unique identifier of the followup intent. - // Format: `projects/<Project ID>/agent/intents/<Intent ID>`. - string followup_intent_name = 1; - - // The unique identifier of the followup intent's parent. - // Format: `projects/<Project ID>/agent/intents/<Intent ID>`. - string parent_followup_intent_name = 2; - } - - // Optional. The unique identifier of this intent. - // Required for [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent] and [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents] - // methods. - // Supported formats: - // - // - `projects/<Project ID>/agent/intents/<Intent ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>` - string name = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The name of this intent. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Indicates whether webhooks are enabled for the intent. - WebhookState webhook_state = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The priority of this intent. Higher numbers represent higher - // priorities. - // - // - If the supplied value is unspecified or 0, the service - // translates the value to 500,000, which corresponds to the - // `Normal` priority in the console. - // - If the supplied value is negative, the intent is ignored - // in runtime detect intent requests. - int32 priority = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Indicates whether this is a fallback intent. - bool is_fallback = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Indicates whether Machine Learning is enabled for the intent. - // Note: If `ml_enabled` setting is set to false, then this intent is not - // taken into account during inference in `ML ONLY` match mode. Also, - // auto-markup in the UI is turned off. - // DEPRECATED! Please use `ml_disabled` field instead. - // NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, - // then the default value is determined as follows: - // - // - Before April 15th, 2018 the default is: - // ml_enabled = false / ml_disabled = true. - // - After April 15th, 2018 the default is: - // ml_enabled = true / ml_disabled = false. - bool ml_enabled = 5 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; - - // Optional. Indicates whether Machine Learning is disabled for the intent. - // Note: If `ml_disabled` setting is set to true, then this intent is not - // taken into account during inference in `ML ONLY` match mode. Also, - // auto-markup in the UI is turned off. - bool ml_disabled = 19 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Indicates that a live agent should be brought in to handle the - // interaction with the user. In most cases, when you set this flag to true, - // you would also want to set end_interaction to true as well. Default is - // false. - bool live_agent_handoff = 20 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Indicates that this intent ends an interaction. Some integrations - // (e.g., Actions on Google or Dialogflow phone gateway) use this information - // to close interaction with an end user. Default is false. - bool end_interaction = 21 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The list of context names required for this intent to be - // triggered. - // Formats: - // - // - `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>` - // - `projects/<Project ID>/locations/<Location - // ID>/agent/sessions/-/contexts/<Context ID>` - repeated string input_context_names = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of event names that trigger the intent. - // If the collection of input contexts is not empty, all of the contexts must - // be present in the active user session for an event to trigger this intent. - // Event names are limited to 150 characters. - repeated string events = 8 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of examples that the agent is - // trained on. - repeated TrainingPhrase training_phrases = 9 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The name of the action associated with the intent. - // Note: The action name must not contain whitespaces. - string action = 10 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of contexts that are activated when the intent - // is matched. Context messages in this collection should not set the - // parameters field. Setting the `lifespan_count` to 0 will reset the context - // when the intent is matched. - // Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. - repeated Context output_contexts = 11 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Indicates whether to delete all contexts in the current - // session when this intent is matched. - bool reset_contexts = 12 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of parameters associated with the intent. - repeated Parameter parameters = 13 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The collection of rich messages corresponding to the - // `Response` field in the Dialogflow console. - repeated Message messages = 14; - - // Optional. The list of platforms for which the first responses will be - // copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). - repeated Message.Platform default_response_platforms = 15 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The unique identifier of the root intent in the chain of - // followup intents. It identifies the correct followup intents chain for - // this intent. - // - // Format: `projects/<Project ID>/agent/intents/<Intent ID>`. - string root_followup_intent_name = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. The unique identifier of the parent intent in the - // chain of followup intents. You can set this field when creating an intent, - // for example with [CreateIntent][google.cloud.dialogflow.v2beta1.Intents.CreateIntent] or - // [BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents], in order to make this - // intent a followup intent. - // - // It identifies the parent followup intent. - // Format: `projects/<Project ID>/agent/intents/<Intent ID>`. - string parent_followup_intent_name = 17 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. Information about all followup intents that have this intent as - // a direct or indirect parent. We populate this field only in the output. - repeated FollowupIntentInfo followup_intent_info = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// The request message for [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents]. -message ListIntentsRequest { - // Required. The agent to list all intents from. - // Format: `projects/<Project ID>/agent` or `projects/<Project - // ID>/locations/<Location ID>/agent`. - // - // Alternatively, you can specify the environment to list intents for. - // Format: `projects/<Project ID>/agent/environments/<Environment ID>` - // or `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>`. - // Note: training phrases of the intents will not be returned for non-draft - // environment. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Intent" - } - ]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The resource view to apply to the returned intent. - IntentView intent_view = 3; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 4; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 5; -} - -// The response message for [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents]. -message ListIntentsResponse { - // The list of agent intents. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Intent intents = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Intents.GetIntent][google.cloud.dialogflow.v2beta1.Intents.GetIntent]. -message GetIntentRequest { - // Required. The name of the intent. - // Supported formats: - // - // - `projects/<Project ID>/agent/intents/<Intent ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Intent" - } - ]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The resource view to apply to the returned intent. - IntentView intent_view = 3; -} - -// The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2beta1.Intents.CreateIntent]. -message CreateIntentRequest { - // Required. The agent to create a intent for. - // Supported formats: - // - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Intent" - } - ]; - - // Required. The intent to create. - Intent intent = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The resource view to apply to the returned intent. - IntentView intent_view = 4; -} - -// The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent]. -message UpdateIntentRequest { - // Required. The intent to update. - Intent intent = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 3; - - // Optional. The resource view to apply to the returned intent. - IntentView intent_view = 4; -} - -// The request message for [Intents.DeleteIntent][google.cloud.dialogflow.v2beta1.Intents.DeleteIntent]. -message DeleteIntentRequest { - // Required. The name of the intent to delete. If this intent has direct or - // indirect followup intents, we also delete them. - // - // Supported formats: - // - // - `projects/<Project ID>/agent/intents/<Intent ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Intent" - } - ]; -} - -// The request message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents]. -message BatchUpdateIntentsRequest { - // Required. The name of the agent to update or create intents in. - // Supported formats: - // - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Intent" - } - ]; - - // Required. The source of the intent batch. - // - // For each intent in the batch: - // - // * If `name` is specified, we update an existing intent. - // * If `name` is not specified, we create a new intent. - oneof intent_batch { - // The URI to a Google Cloud Storage file containing intents to update or - // create. The file format can either be a serialized proto (of IntentBatch - // type) or JSON object. Note: The URI must start with "gs://". - string intent_batch_uri = 2; - - // The collection of intents to update or create. - IntentBatch intent_batch_inline = 3; - } - - // Optional. The language used to access language-specific data. - // If not specified, the agent's default language is used. - // For more information, see - // [Multilingual intent and entity - // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - string language_code = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 5; - - // Optional. The resource view to apply to the returned intent. - IntentView intent_view = 6; -} - -// The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents]. -message BatchUpdateIntentsResponse { - // The collection of updated or created intents. - repeated Intent intents = 1; -} - -// The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2beta1.Intents.BatchDeleteIntents]. -message BatchDeleteIntentsRequest { - // Required. The name of the agent to delete all entities types for. - // Supported formats: - // - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Intent" - } - ]; - - // Required. The collection of intents to delete. Only intent `name` must be - // filled in. - repeated Intent intents = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Represents the options for views of an intent. -// An intent can be a sizable object. Therefore, we provide a resource view that -// does not return training phrases in the response by default. -enum IntentView { - // Training phrases field is not populated in the response. - INTENT_VIEW_UNSPECIFIED = 0; - - // All fields are populated. - INTENT_VIEW_FULL = 1; -} - -// This message is a wrapper around a collection of intents. -message IntentBatch { - // A collection of intents. - repeated Intent intents = 1; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/knowledge_base.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/knowledge_base.proto deleted file mode 100644 index cf5c21d..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/knowledge_base.proto +++ /dev/null @@ -1,278 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "KnowledgeBaseProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [KnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBase]. -service KnowledgeBases { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all knowledge bases of the specified agent. - // - // Note: The `projects.agent.knowledgeBases` resource is deprecated; - // only use `projects.knowledgeBases`. - rpc ListKnowledgeBases(ListKnowledgeBasesRequest) returns (ListKnowledgeBasesResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*}/knowledgeBases" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*}/knowledgeBases" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/agent}/knowledgeBases" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified knowledge base. - // - // Note: The `projects.agent.knowledgeBases` resource is deprecated; - // only use `projects.knowledgeBases`. - rpc GetKnowledgeBase(GetKnowledgeBaseRequest) returns (KnowledgeBase) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/knowledgeBases/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/agent/knowledgeBases/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates a knowledge base. - // - // Note: The `projects.agent.knowledgeBases` resource is deprecated; - // only use `projects.knowledgeBases`. - rpc CreateKnowledgeBase(CreateKnowledgeBaseRequest) returns (KnowledgeBase) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*}/knowledgeBases" - body: "knowledge_base" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*}/knowledgeBases" - body: "knowledge_base" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/agent}/knowledgeBases" - body: "knowledge_base" - } - }; - option (google.api.method_signature) = "parent,knowledge_base"; - } - - // Deletes the specified knowledge base. - // - // Note: The `projects.agent.knowledgeBases` resource is deprecated; - // only use `projects.knowledgeBases`. - rpc DeleteKnowledgeBase(DeleteKnowledgeBaseRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/knowledgeBases/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/agent/knowledgeBases/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Updates the specified knowledge base. - // - // Note: The `projects.agent.knowledgeBases` resource is deprecated; - // only use `projects.knowledgeBases`. - rpc UpdateKnowledgeBase(UpdateKnowledgeBaseRequest) returns (KnowledgeBase) { - option (google.api.http) = { - patch: "/v2beta1/{knowledge_base.name=projects/*/knowledgeBases/*}" - body: "knowledge_base" - additional_bindings { - patch: "/v2beta1/{knowledge_base.name=projects/*/locations/*/knowledgeBases/*}" - body: "knowledge_base" - } - additional_bindings { - patch: "/v2beta1/{knowledge_base.name=projects/*/agent/knowledgeBases/*}" - body: "knowledge_base" - } - }; - option (google.api.method_signature) = "knowledge_base,update_mask"; - option (google.api.method_signature) = "knowledge_base"; - } -} - -// A knowledge base represents a collection of knowledge documents that you -// provide to Dialogflow. Your knowledge documents contain information that may -// be useful during conversations with end-users. Some Dialogflow features use -// knowledge bases when looking for a response to an end-user input. -// -// For more information, see the [knowledge base -// guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). -// -// Note: The `projects.agent.knowledgeBases` resource is deprecated; -// only use `projects.knowledgeBases`. -message KnowledgeBase { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/KnowledgeBase" - pattern: "projects/{project}/knowledgeBases/{knowledge_base}" - pattern: "projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}" - }; - - // The knowledge base resource name. - // The name must be empty when creating a knowledge base. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string name = 1; - - // Required. The display name of the knowledge base. The name must be 1024 - // bytes or less; otherwise, the creation request fails. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Language which represents the KnowledgeBase. When the KnowledgeBase is - // created/updated, this is populated for all non en-us languages. If not - // populated, the default language en-us applies. - string language_code = 4; -} - -// Request message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases]. -message ListKnowledgeBasesRequest { - // Required. The project to list of knowledge bases for. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/KnowledgeBase" - } - ]; - - // The maximum number of items to return in a single page. By - // default 10 and at most 100. - int32 page_size = 2; - - // The next_page_token value returned from a previous list request. - string page_token = 3; - - // The filter expression used to filter knowledge bases returned by the list - // method. The expression has the following syntax: - // - // <field> <operator> <value> [AND <field> <operator> <value>] ... - // - // The following fields and operators are supported: - // - // * display_name with has(:) operator - // * language_code with equals(=) operator - // - // Examples: - // - // * 'language_code=en-us' matches knowledge bases with en-us language code. - // * 'display_name:articles' matches knowledge bases whose display name - // contains "articles". - // * 'display_name:"Best Articles"' matches knowledge bases whose display - // name contains "Best Articles". - // * 'language_code=en-gb AND display_name=articles' matches all knowledge - // bases whose display name contains "articles" and whose language code is - // "en-gb". - // - // Note: An empty filter string (i.e. "") is a no-op and will result in no - // filtering. - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 4; -} - -// Response message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases]. -message ListKnowledgeBasesResponse { - // The list of knowledge bases. - repeated KnowledgeBase knowledge_bases = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// Request message for [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.GetKnowledgeBase]. -message GetKnowledgeBaseRequest { - // Required. The name of the knowledge base to retrieve. - // Format `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/KnowledgeBase" - } - ]; -} - -// Request message for [KnowledgeBases.CreateKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.CreateKnowledgeBase]. -message CreateKnowledgeBaseRequest { - // Required. The project to create a knowledge base for. - // Format: `projects/<Project ID>/locations/<Location ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/KnowledgeBase" - } - ]; - - // Required. The knowledge base to create. - KnowledgeBase knowledge_base = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.DeleteKnowledgeBase]. -message DeleteKnowledgeBaseRequest { - // Required. The name of the knowledge base to delete. - // Format: `projects/<Project ID>/locations/<Location - // ID>/knowledgeBases/<Knowledge Base ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/KnowledgeBase" - } - ]; - - // Optional. Force deletes the knowledge base. When set to true, any documents - // in the knowledge base are also deleted. - bool force = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// Request message for [KnowledgeBases.UpdateKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.UpdateKnowledgeBase]. -message UpdateKnowledgeBaseRequest { - // Required. The knowledge base to update. - KnowledgeBase knowledge_base = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Not specified means `update all`. - // Currently, only `display_name` can be updated, an InvalidArgument will be - // returned for attempting to update other fields. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/participant.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/participant.proto deleted file mode 100644 index 1f7309b..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/participant.proto +++ /dev/null @@ -1,1424 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/audio_config.proto"; -import "google/cloud/dialogflow/v2beta1/session.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/struct.proto"; -import "google/protobuf/timestamp.proto"; -import "google/rpc/status.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ParticipantProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant]. -service Participants { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Creates a new participant in a conversation. - rpc CreateParticipant(CreateParticipantRequest) returns (Participant) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*}/participants" - body: "participant" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/conversations/*}/participants" - body: "participant" - } - }; - option (google.api.method_signature) = "parent,participant"; - } - - // Retrieves a conversation participant. - rpc GetParticipant(GetParticipantRequest) returns (Participant) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/conversations/*/participants/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/conversations/*/participants/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Returns the list of all participants in the specified conversation. - rpc ListParticipants(ListParticipantsRequest) returns (ListParticipantsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/conversations/*}/participants" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/conversations/*}/participants" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Updates the specified participant. - rpc UpdateParticipant(UpdateParticipantRequest) returns (Participant) { - option (google.api.http) = { - patch: "/v2beta1/{participant.name=projects/*/conversations/*/participants/*}" - body: "participant" - additional_bindings { - patch: "/v2beta1/{participant.name=projects/*/locations/*/conversations/*/participants/*}" - body: "participant" - } - }; - option (google.api.method_signature) = "participant,update_mask"; - } - - // Adds a text (chat, for example), or audio (phone recording, for example) - // message from a participant into the conversation. - // - // Note: Always use agent versions for production traffic - // sent to virtual agents. See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - rpc AnalyzeContent(AnalyzeContentRequest) returns (AnalyzeContentResponse) { - option (google.api.http) = { - post: "/v2beta1/{participant=projects/*/conversations/*/participants/*}:analyzeContent" - body: "*" - additional_bindings { - post: "/v2beta1/{participant=projects/*/locations/*/conversations/*/participants/*}:analyzeContent" - body: "*" - } - }; - option (google.api.method_signature) = "participant,text_input"; - option (google.api.method_signature) = "participant,audio_input"; - option (google.api.method_signature) = "participant,event_input"; - } - - // Adds a text (e.g., chat) or audio (e.g., phone recording) message from a - // participant into the conversation. - // Note: This method is only available through the gRPC API (not REST). - // - // The top-level message sent to the client by the server is - // `StreamingAnalyzeContentResponse`. Multiple response messages can be - // returned in order. The first one or more messages contain the - // `recognition_result` field. Each result represents a more complete - // transcript of what the user said. The next message contains the - // `reply_text` field, and potentially the `reply_audio` and/or the - // `automated_agent_reply` fields. - // - // Note: Always use agent versions for production traffic - // sent to virtual agents. See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - rpc StreamingAnalyzeContent(stream StreamingAnalyzeContentRequest) returns (stream StreamingAnalyzeContentResponse) { - } - - // Gets suggested articles for a participant based on specific historical - // messages. - // - // Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated - // suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion - // based on the provided conversation context in the real time. - rpc SuggestArticles(SuggestArticlesRequest) returns (SuggestArticlesResponse) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestArticles" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestArticles" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Gets suggested faq answers for a participant based on specific historical - // messages. - rpc SuggestFaqAnswers(SuggestFaqAnswersRequest) returns (SuggestFaqAnswersResponse) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestFaqAnswers" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestFaqAnswers" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Gets smart replies for a participant based on specific historical - // messages. - rpc SuggestSmartReplies(SuggestSmartRepliesRequest) returns (SuggestSmartRepliesResponse) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestSmartReplies" - body: "*" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestSmartReplies" - body: "*" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Deprecated: Use inline suggestion, event based suggestion or - // Suggestion* API instead. - // See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more - // details. - // Removal Date: 2020-09-01. - // - // Retrieves suggestions for live agents. - // - // This method should be used by human agent client software to fetch auto - // generated suggestions in real-time, while the conversation with an end user - // is in progress. The functionality is implemented in terms of the - // [list - // pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) - // design pattern. The client app should use the `next_page_token` field - // to fetch the next batch of suggestions. `suggestions` are sorted by - // `create_time` in descending order. - // To fetch latest suggestion, just set `page_size` to 1. - // To fetch new suggestions without duplication, send request with filter - // `create_time_epoch_microseconds > [first item's create_time of previous - // request]` and empty page_token. - rpc ListSuggestions(ListSuggestionsRequest) returns (ListSuggestionsResponse) { - option deprecated = true; - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions" - }; - } - - // Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead. - // - // Gets suggestions for a participant based on specific historical - // messages. - // - // Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated - // suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion - // based on the provided conversation context in the real time. - rpc CompileSuggestion(CompileSuggestionRequest) returns (CompileSuggestionResponse) { - option deprecated = true; - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:compile" - body: "*" - }; - } -} - -// Represents a conversation participant (human agent, virtual agent, end-user). -message Participant { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Participant" - pattern: "projects/{project}/conversations/{conversation}/participants/{participant}" - pattern: "projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" - }; - - // Enumeration of the roles a participant can play in a conversation. - enum Role { - // Participant role not set. - ROLE_UNSPECIFIED = 0; - - // Participant is a human agent. - HUMAN_AGENT = 1; - - // Participant is an automated agent, such as a Dialogflow agent. - AUTOMATED_AGENT = 2; - - // Participant is an end user that has called or chatted with - // Dialogflow services. - END_USER = 3; - } - - // Optional. The unique identifier of this participant. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string name = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Immutable. The role this participant plays in the conversation. This field must be set - // during participant creation and is then immutable. - Role role = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Optional. Obfuscated user id that should be associated with the created participant. - // - // You can specify a user id as follows: - // - // 1. If you set this field in - // [CreateParticipantRequest][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant] or - // [UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant], - // Dialogflow adds the obfuscated user id with the participant. - // - // 2. If you set this field in - // [AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id] or - // [StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id], - // Dialogflow will update [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.Participant.obfuscated_external_user_id]. - // - // Dialogflow uses this user id for following purposes: - // 1) Billing and measurement. If user with the same - // obfuscated_external_user_id is created in a later conversation, dialogflow - // will know it's the same user. 2) Agent assist suggestion personalization. - // For example, Dialogflow can use it to provide personalized smart reply - // suggestions for this user. - // - // Note: - // - // * Please never pass raw user ids to Dialogflow. Always obfuscate your user - // id first. - // * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a - // hash function like SHA-512. - // * The length of the user id must be <= 256 characters. - string obfuscated_external_user_id = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Key-value filters on the metadata of documents returned by article - // suggestion. If specified, article suggestion only returns suggested - // documents that match all filters in their [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. Multiple - // values for a metadata key should be concatenated by comma. For example, - // filters to match all documents that have 'US' or 'CA' in their market - // metadata values and 'agent' in their user metadata values will be - // ``` - // documents_metadata_filters { - // key: "market" - // value: "US,CA" - // } - // documents_metadata_filters { - // key: "user" - // value: "agent" - // } - // ``` - map<string, string> documents_metadata_filters = 8 [(google.api.field_behavior) = OPTIONAL]; -} - -// Represents a message posted into a conversation. -message Message { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Message" - pattern: "projects/{project}/conversations/{conversation}/messages/{message}" - pattern: "projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}" - }; - - // Optional. The unique identifier of the message. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string name = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The message content. - string content = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The message language. - // This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - // language tag. Example: "en-US". - string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The participant that sends this message. - string participant = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The role of the participant. - Participant.Role participant_role = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The time when the message was created in Contact Center AI. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. The time when the message was sent. - google.protobuf.Timestamp send_time = 9 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The annotation for the message. - MessageAnnotation message_annotation = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The sentiment analysis result for the message. - SentimentAnalysisResult sentiment_analysis = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// The request message for [Participants.CreateParticipant][google.cloud.dialogflow.v2beta1.Participants.CreateParticipant]. -message CreateParticipantRequest { - // Required. Resource identifier of the conversation adding the participant. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Required. The participant to create. - Participant participant = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Participants.GetParticipant][google.cloud.dialogflow.v2beta1.Participants.GetParticipant]. -message GetParticipantRequest { - // Required. The name of the participant. Format: - // `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation - // ID>/participants/<Participant ID>`. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; -} - -// The request message for [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants]. -message ListParticipantsRequest { - // Required. The conversation to list all participants from. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants]. -message ListParticipantsResponse { - // The list of participants. There is a maximum number of items - // returned based on the page_size field in the request. - repeated Participant participants = 1; - - // Token to retrieve the next page of results or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Participants.UpdateParticipant][google.cloud.dialogflow.v2beta1.Participants.UpdateParticipant]. -message UpdateParticipantRequest { - // Required. The participant to update. - Participant participant = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to specify which fields to update. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Represents the natural language speech audio to be processed. -message AudioInput { - // Required. Instructs the speech recognizer how to process the speech audio. - InputAudioConfig config = 1; - - // Required. The natural language speech audio to be processed. - // A single request can contain up to 1 minute of speech audio data. - // The transcribed text cannot contain more than 256 bytes for virtual agent - // interactions. - bytes audio = 2; -} - -// Represents the natural language speech audio to be played to the end user. -message OutputAudio { - // Required. Instructs the speech synthesizer how to generate the speech - // audio. - OutputAudioConfig config = 1; - - // Required. The natural language speech audio. - bytes audio = 2; -} - -// Represents a response from an automated agent. -message AutomatedAgentReply { - // Represents different automated agent reply types. - enum AutomatedAgentReplyType { - // Not specified. This should never happen. - AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED = 0; - - // Partial reply. e.g. Aggregated responses in a `Fulfillment` that enables - // `return_partial_response` can be returned as partial reply. - // WARNING: partial reply is not eligible for barge-in. - PARTIAL = 1; - - // Final reply. - FINAL = 2; - } - - // Required. - oneof response { - // Response of the Dialogflow [Sessions.DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] call. - DetectIntentResponse detect_intent_response = 1; - } - - // Response messages from the automated agent. - repeated ResponseMessage response_messages = 3; - - // Info on the query match for the automated agent response. - oneof match { - // Name of the intent if an intent is matched for the query. - // For a V2 query, the value format is `projects/<Project ID>/locations/ - // <Location ID>/agent/intents/<Intent ID>`. - // For a V3 query, the value format is `projects/<Project ID>/locations/ - // <Location ID>/agents/<Agent ID>/intents/<Intent ID>`. - string intent = 4 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Intent" - }]; - - // Event name if an event is triggered for the query. - string event = 5; - } - - // The confidence of the match. Values range from 0.0 (completely uncertain) - // to 1.0 (completely certain). - // This value is for informational purpose only and is only used to help match - // the best intent within the classification threshold. This value may change - // for the same end-user expression at any time due to a model retraining or - // change in implementation. - float match_confidence = 9; - - // The collection of current parameters at the time of this response. - google.protobuf.Struct parameters = 10; - - // The collection of current Dialogflow CX agent session parameters at the - // time of this response. - // Deprecated: Use `parameters` instead. - google.protobuf.Struct cx_session_parameters = 6 [deprecated = true]; - - // AutomatedAgentReply type. - AutomatedAgentReplyType automated_agent_reply_type = 7; - - // Indicates whether the partial automated agent reply is interruptible when a - // later reply message arrives. e.g. if the agent specified some music as - // partial response, it can be cancelled. - bool allow_cancellation = 8; -} - -// The type of Human Agent Assistant API suggestion to perform, and the maximum -// number of results to return for that type. Multiple `Feature` objects can -// be specified in the `features` list. -message SuggestionFeature { - // Defines the type of Human Agent Assistant feature. - enum Type { - // Unspecified feature type. - TYPE_UNSPECIFIED = 0; - - // Run article suggestion model for chat. - ARTICLE_SUGGESTION = 1; - - // Run FAQ model. - FAQ = 2; - - // Run smart reply model for chat. - SMART_REPLY = 3; - - // Run conversation summarization model for chat. - CONVERSATION_SUMMARIZATION = 8; - } - - // Type of Human Agent Assistant API feature to request. - Type type = 1; -} - -// Represents the parameters of human assist query. -message AssistQueryParameters { - // Key-value filters on the metadata of documents returned by article - // suggestion. If specified, article suggestion only returns suggested - // documents that match all filters in their [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. Multiple - // values for a metadata key should be concatenated by comma. For example, - // filters to match all documents that have 'US' or 'CA' in their market - // metadata values and 'agent' in their user metadata values will be - // ``` - // documents_metadata_filters { - // key: "market" - // value: "US,CA" - // } - // documents_metadata_filters { - // key: "user" - // value: "agent" - // } - // ``` - map<string, string> documents_metadata_filters = 1; -} - -// The request message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent]. -message AnalyzeContentRequest { - // Required. The name of the participant this text comes from. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string participant = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Required. The input content. - oneof input { - // The natural language text to be processed. - TextInput text_input = 6; - - // The natural language speech audio to be processed. - AudioInput audio_input = 7; - - // An input event to send to Dialogflow. - EventInput event_input = 8; - } - - // Speech synthesis configuration. - // The speech synthesis settings for a virtual agent that may be configured - // for the associated conversation profile are not used when calling - // AnalyzeContent. If this configuration is not supplied, speech synthesis - // is disabled. - OutputAudioConfig reply_audio_config = 5; - - // Parameters for a Dialogflow virtual-agent query. - QueryParameters query_params = 9; - - // Parameters for a human assist query. - AssistQueryParameters assist_query_params = 14; - - // Additional parameters to be put into Dialogflow CX session parameters. To - // remove a parameter from the session, clients should explicitly set the - // parameter value to null. - // - // Note: this field should only be used if you are connecting to a Dialogflow - // CX agent. - google.protobuf.Struct cx_parameters = 18; - - // The unique identifier of the CX page to override the `current_page` in the - // session. - // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent - // ID>/flows/<Flow ID>/pages/<Page ID>`. - // - // If `cx_current_page` is specified, the previous state of the session will - // be ignored by Dialogflow CX, including the [previous - // page][QueryResult.current_page] and the [previous session - // parameters][QueryResult.parameters]. In most cases, `cx_current_page` and - // `cx_parameters` should be configured together to direct a session to a - // specific state. - // - // Note: this field should only be used if you are connecting to a Dialogflow - // CX agent. - string cx_current_page = 20; - - // Optional. The send time of the message from end user or human agent's - // perspective. It is used for identifying the same message under one - // participant. - // - // Given two messages under the same participant: - // - If send time are different regardless of whether the content of the - // messages are exactly the same, the conversation will regard them as - // two distinct messages sent by the participant. - // - If send time is the same regardless of whether the content of the - // messages are exactly the same, the conversation will regard them as - // same message, and ignore the message received later. - // - // If the value is not provided, a new request will always be regarded as a - // new message without any de-duplication. - google.protobuf.Timestamp message_send_time = 10; - - // A unique identifier for this request. Restricted to 36 ASCII characters. - // A random UUID is recommended. - // This request is only idempotent if a `request_id` is provided. - string request_id = 11; -} - -// The message in the response that indicates the parameters of DTMF. -message DtmfParameters { - // Indicates whether DTMF input can be handled in the next request. - bool accepts_dtmf_input = 1; -} - -// The response message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent]. -message AnalyzeContentResponse { - // Output only. The output text content. - // This field is set if the automated agent responded with text to show to - // the user. - string reply_text = 1; - - // Optional. The audio data bytes encoded as specified in the request. - // This field is set if: - // - // - `reply_audio_config` was specified in the request, or - // - The automated agent responded with audio to play to the user. In such - // case, `reply_audio.config` contains settings used to synthesize the - // speech. - // - // In some scenarios, multiple output audio fields may be present in the - // response structure. In these cases, only the top-most-level audio output - // has content. - OutputAudio reply_audio = 2; - - // Optional. Only set if a Dialogflow automated agent has responded. - // Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] - // and [AutomatedAgentReply.detect_intent_response.output_audio_config][] - // are always empty, use [reply_audio][google.cloud.dialogflow.v2beta1.AnalyzeContentResponse.reply_audio] instead. - AutomatedAgentReply automated_agent_reply = 3; - - // Output only. Message analyzed by CCAI. - Message message = 5; - - // The suggestions for most recent human agent. The order is the same as - // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of - // [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config]. - // - // Note that any failure of Agent Assist features will not lead to the overall - // failure of an AnalyzeContent API call. Instead, the features will - // fail silently with the error field set in the corresponding - // SuggestionResult. - repeated SuggestionResult human_agent_suggestion_results = 6; - - // The suggestions for end user. The order is the same as - // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of - // [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config]. - // - // Same as human_agent_suggestion_results, any failure of Agent Assist - // features will not lead to the overall failure of an AnalyzeContent API - // call. Instead, the features will fail silently with the error field set in - // the corresponding SuggestionResult. - repeated SuggestionResult end_user_suggestion_results = 7; - - // Indicates the parameters of DTMF. - DtmfParameters dtmf_parameters = 9; -} - -// Defines the language used in the input text. -message InputTextConfig { - // Required. The language of this conversational query. See [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. - string language_code = 1; -} - -// The top-level message sent by the client to the -// [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method. -// -// Multiple request messages should be sent in order: -// -// 1. The first message must contain -// [participant][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.participant], -// [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionally -// [query_params][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.query_params]. If you want -// to receive an audio response, it should also contain -// [reply_audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.reply_audio_config]. -// The message must not contain -// [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input]. -// -// 2. If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message -// was set to [audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.audio_config], -// all subsequent messages must contain -// [input_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_audio] to continue -// with Speech recognition. -// If you decide to rather analyze text input after you already started -// Speech recognition, please send a message with -// [StreamingAnalyzeContentRequest.input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text]. -// -// However, note that: -// -// * Dialogflow will bill you for the audio so far. -// * Dialogflow discards all Speech recognition results in favor of the -// text input. -// -// 3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set -// to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.text_config], then the second message -// must contain only [input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text]. -// Moreover, you must not send more than two messages. -// -// After you sent all input, you must half-close or abort the request stream. -message StreamingAnalyzeContentRequest { - // Required. The name of the participant this text comes from. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string participant = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Required. The input config. - oneof config { - // Instructs the speech recognizer how to process the speech audio. - InputAudioConfig audio_config = 2; - - // The natural language text to be processed. - InputTextConfig text_config = 3; - } - - // Speech synthesis configuration. - // The speech synthesis settings for a virtual agent that may be configured - // for the associated conversation profile are not used when calling - // StreamingAnalyzeContent. If this configuration is not supplied, speech - // synthesis is disabled. - OutputAudioConfig reply_audio_config = 4; - - // Required. The input. - oneof input { - // The input audio content to be recognized. Must be sent if `audio_config` - // is set in the first message. The complete audio over all streaming - // messages must not exceed 1 minute. - bytes input_audio = 5; - - // The UTF-8 encoded natural language text to be processed. Must be sent if - // `text_config` is set in the first message. Text length must not exceed - // 256 bytes for virtual agent interactions. The `input_text` field can be - // only sent once. - string input_text = 6; - - // The DTMF digits used to invoke intent and fill in parameter value. - // - // This input is ignored if the previous response indicated that DTMF input - // is not accepted. - TelephonyDtmfEvents input_dtmf = 9; - } - - // Parameters for a Dialogflow virtual-agent query. - QueryParameters query_params = 7; - - // Parameters for a human assist query. - AssistQueryParameters assist_query_params = 8; - - // Additional parameters to be put into Dialogflow CX session parameters. To - // remove a parameter from the session, clients should explicitly set the - // parameter value to null. - // - // Note: this field should only be used if you are connecting to a Dialogflow - // CX agent. - google.protobuf.Struct cx_parameters = 13; - - // The unique identifier of the CX page to override the `current_page` in the - // session. - // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent - // ID>/flows/<Flow ID>/pages/<Page ID>`. - // - // If `cx_current_page` is specified, the previous state of the session will - // be ignored by Dialogflow CX, including the [previous - // page][QueryResult.current_page] and the [previous session - // parameters][QueryResult.parameters]. In most cases, `cx_current_page` and - // `cx_parameters` should be configured together to direct a session to a - // specific state. - // - // Note: this field should only be used if you are connecting to a Dialogflow - // CX agent. - string cx_current_page = 15; - - // Enable partial virtual agent responses. If this flag is not enabled, - // response stream still contains only one final response even if some - // `Fulfillment`s in Dialogflow virtual agent have been configured to return - // partial responses. - bool enable_partial_automated_agent_reply = 12; -} - -// The top-level message returned from the `StreamingAnalyzeContent` method. -// -// Multiple response messages can be returned in order: -// -// 1. If the input was set to streaming audio, the first one or more messages -// contain `recognition_result`. Each `recognition_result` represents a more -// complete transcript of what the user said. The last `recognition_result` -// has `is_final` set to `true`. -// -// 2. In virtual agent stage: if `enable_partial_automated_agent_reply` is -// true, the following N (currently 1 <= N <= 4) messages -// contain `automated_agent_reply` and optionally `reply_audio` -// returned by the virtual agent. The first (N-1) -// `automated_agent_reply`s will have `automated_agent_reply_type` set to -// `PARTIAL`. The last `automated_agent_reply` has -// `automated_agent_reply_type` set to `FINAL`. -// If `enable_partial_automated_agent_reply` is not enabled, response stream -// only contains the final reply. -// -// In human assist stage: the following N (N >= 1) messages contain -// `human_agent_suggestion_results`, `end_user_suggestion_results` or -// `message`. -message StreamingAnalyzeContentResponse { - // The result of speech recognition. - StreamingRecognitionResult recognition_result = 1; - - // Optional. The output text content. - // This field is set if an automated agent responded with a text for the user. - string reply_text = 2; - - // Optional. The audio data bytes encoded as specified in the request. - // This field is set if: - // - // - The `reply_audio_config` field is specified in the request. - // - The automated agent, which this output comes from, responded with audio. - // In such case, the `reply_audio.config` field contains settings used to - // synthesize the speech. - // - // In some scenarios, multiple output audio fields may be present in the - // response structure. In these cases, only the top-most-level audio output - // has content. - OutputAudio reply_audio = 3; - - // Optional. Only set if a Dialogflow automated agent has responded. - // Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] - // and [AutomatedAgentReply.detect_intent_response.output_audio_config][] - // are always empty, use [reply_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.reply_audio] instead. - AutomatedAgentReply automated_agent_reply = 4; - - // Output only. Message analyzed by CCAI. - Message message = 6; - - // The suggestions for most recent human agent. The order is the same as - // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of - // [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config]. - repeated SuggestionResult human_agent_suggestion_results = 7; - - // The suggestions for end user. The order is the same as - // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of - // [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config]. - repeated SuggestionResult end_user_suggestion_results = 8; - - // Indicates the parameters of DTMF. - DtmfParameters dtmf_parameters = 10; -} - -// Represents a part of a message possibly annotated with an entity. The part -// can be an entity or purely a part of the message between two entities or -// message start/end. -message AnnotatedMessagePart { - // Required. A part of a message possibly annotated with an entity. - string text = 1; - - // Optional. The [Dialogflow system entity - // type](https://cloud.google.com/dialogflow/docs/reference/system-entities) - // of this message part. If this is empty, Dialogflow could not annotate the - // phrase part with a system entity. - string entity_type = 2; - - // Optional. The [Dialogflow system entity formatted value - // ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of - // this message part. For example for a system entity of type - // `@sys.unit-currency`, this may contain: - // <pre> - // { - // "amount": 5, - // "currency": "USD" - // } - // </pre> - google.protobuf.Value formatted_value = 3; -} - -// Represents the result of annotation for the message. -message MessageAnnotation { - // Optional. The collection of annotated message parts ordered by their - // position in the message. You can recover the annotated message by - // concatenating [AnnotatedMessagePart.text]. - repeated AnnotatedMessagePart parts = 1; - - // Required. Indicates whether the text message contains entities. - bool contain_entities = 2; -} - -// Represents article answer. -message ArticleAnswer { - // The article title. - string title = 1; - - // The article URI. - string uri = 2; - - // Output only. Article snippets. - repeated string snippets = 3; - - // A map that contains metadata about the answer and the - // document from which it originates. - map<string, string> metadata = 5; - - // The name of answer record, in the format of - // "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record - // ID>" - string answer_record = 6; -} - -// Represents answer from "frequently asked questions". -message FaqAnswer { - // The piece of text from the `source` knowledge base document. - string answer = 1; - - // The system's confidence score that this Knowledge answer is a good match - // for this conversational query, range from 0.0 (completely uncertain) - // to 1.0 (completely certain). - float confidence = 2; - - // The corresponding FAQ question. - string question = 3; - - // Indicates which Knowledge Document this answer was extracted - // from. - // Format: `projects/<Project ID>/locations/<Location - // ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. - string source = 4; - - // A map that contains metadata about the answer and the - // document from which it originates. - map<string, string> metadata = 5; - - // The name of answer record, in the format of - // "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record - // ID>" - string answer_record = 6; -} - -// Represents a smart reply answer. -message SmartReplyAnswer { - // The content of the reply. - string reply = 1; - - // Smart reply confidence. - // The system's confidence score that this reply is a good match for - // this conversation, as a value from 0.0 (completely uncertain) to 1.0 - // (completely certain). - float confidence = 2; - - // The name of answer record, in the format of - // "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record - // ID>" - string answer_record = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/AnswerRecord" - }]; -} - -// One response of different type of suggestion response which is used in -// the response of [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and -// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent], as well as [HumanAgentAssistantEvent][google.cloud.dialogflow.v2beta1.HumanAgentAssistantEvent]. -message SuggestionResult { - // Different type of suggestion response. - oneof suggestion_response { - // Error status if the request failed. - google.rpc.Status error = 1; - - // SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. - SuggestArticlesResponse suggest_articles_response = 2; - - // SuggestFaqAnswersResponse if request is for FAQ_ANSWER. - SuggestFaqAnswersResponse suggest_faq_answers_response = 3; - - // SuggestSmartRepliesResponse if request is for SMART_REPLY. - SuggestSmartRepliesResponse suggest_smart_replies_response = 4; - } -} - -// The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]. -message SuggestArticlesRequest { - // Required. The name of the participant to fetch suggestion for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Optional. The name of the latest conversation message to compile suggestion - // for. If empty, it will be the latest message of the conversation. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - } - ]; - - // Optional. Max number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.SuggestArticlesRequest.latest_message] to use as context - // when compiling the suggestion. By default 20 and at most 50. - int32 context_size = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Parameters for a human assist query. - AssistQueryParameters assist_query_params = 4 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]. -message SuggestArticlesResponse { - // Output only. Articles ordered by score in descending order. - repeated ArticleAnswer article_answers = 1; - - // The name of the latest conversation message used to compile - // suggestion for. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2; - - // Number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.SuggestArticlesResponse.latest_message] to compile the - // suggestion. It may be smaller than the - // [SuggestArticlesResponse.context_size][google.cloud.dialogflow.v2beta1.SuggestArticlesResponse.context_size] field in the request if there - // aren't that many messages in the conversation. - int32 context_size = 3; -} - -// The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]. -message SuggestFaqAnswersRequest { - // Required. The name of the participant to fetch suggestion for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; - - // Optional. The name of the latest conversation message to compile suggestion - // for. If empty, it will be the latest message of the conversation. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - } - ]; - - // Optional. Max number of messages prior to and including - // [latest_message] to use as context when compiling the - // suggestion. By default 20 and at most 50. - int32 context_size = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Parameters for a human assist query. - AssistQueryParameters assist_query_params = 4 [(google.api.field_behavior) = OPTIONAL]; -} - -// The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]. -message SuggestFaqAnswersResponse { - // Output only. Answers extracted from FAQ documents. - repeated FaqAnswer faq_answers = 1; - - // The name of the latest conversation message used to compile - // suggestion for. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2; - - // Number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.SuggestFaqAnswersResponse.latest_message] to compile the - // suggestion. It may be smaller than the - // [SuggestFaqAnswersRequest.context_size][google.cloud.dialogflow.v2beta1.SuggestFaqAnswersRequest.context_size] field in the request if there - // aren't that many messages in the conversation. - int32 context_size = 3; -} - -// The request message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies]. -message SuggestSmartRepliesRequest { - // Required. The name of the participant to fetch suggestion for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Participant" - } - ]; - - // The current natural language text segment to compile suggestion - // for. This provides a way for user to get follow up smart reply suggestion - // after a smart reply selection, without sending a text message. - TextInput current_text_input = 4; - - // The name of the latest conversation message to compile suggestion - // for. If empty, it will be the latest message of the conversation. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; - - // Optional. Max number of messages prior to and including - // [latest_message] to use as context when compiling the - // suggestion. By default 20 and at most 50. - int32 context_size = 3; -} - -// The response message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies]. -message SuggestSmartRepliesResponse { - // Output only. Multiple reply options provided by smart reply service. The - // order is based on the rank of the model prediction. - // The maximum number of the returned replies is set in SmartReplyConfig. - repeated SmartReplyAnswer smart_reply_answers = 1; - - // The name of the latest conversation message used to compile - // suggestion for. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; - - // Number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesResponse.latest_message] to compile the - // suggestion. It may be smaller than the - // [SuggestSmartRepliesRequest.context_size][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesRequest.context_size] field in the request if there - // aren't that many messages in the conversation. - int32 context_size = 3; -} - -// Represents a suggestion for a human agent. -message Suggestion { - option deprecated = true; - - // Represents suggested article. - message Article { - // Output only. The article title. - string title = 1; - - // Output only. The article URI. - string uri = 2; - - // Output only. Article snippets. - repeated string snippets = 3; - - // Output only. A map that contains metadata about the answer and the - // document from which it originates. - map<string, string> metadata = 5; - - // Output only. The name of answer record, in the format of - // "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer - // Record ID>" - string answer_record = 6; - } - - // Represents suggested answer from "frequently asked questions". - message FaqAnswer { - // Output only. The piece of text from the `source` knowledge base document. - string answer = 1; - - // The system's confidence score that this Knowledge answer is a good match - // for this conversational query, range from 0.0 (completely uncertain) - // to 1.0 (completely certain). - float confidence = 2; - - // Output only. The corresponding FAQ question. - string question = 3; - - // Output only. Indicates which Knowledge Document this answer was extracted - // from. - // Format: `projects/<Project ID>/locations/<Location - // ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. - string source = 4; - - // Output only. A map that contains metadata about the answer and the - // document from which it originates. - map<string, string> metadata = 5; - - // Output only. The name of answer record, in the format of - // "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer - // Record ID>" - string answer_record = 6; - } - - // Output only. The name of this suggestion. - // Format: - // `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation - // ID>/participants/*/suggestions/<Suggestion ID>`. - string name = 1; - - // Output only. Articles ordered by score in descending order. - repeated Article articles = 2; - - // Output only. Answers extracted from FAQ documents. - repeated FaqAnswer faq_answers = 4; - - // Output only. The time the suggestion was created. - google.protobuf.Timestamp create_time = 5; - - // Output only. Latest message used as context to compile this suggestion. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 7; -} - -// The request message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. -message ListSuggestionsRequest { - option deprecated = true; - - // Required. The name of the participant to fetch suggestions for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string parent = 1; - - // Optional. The maximum number of items to return in a single page. The - // default value is 100; the maximum value is 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; - - // Optional. Filter on suggestions fields. Currently predicates on - // `create_time` and `create_time_epoch_microseconds` are supported. - // `create_time` only support milliseconds accuracy. E.g., - // `create_time_epoch_microseconds > 1551790877964485` or - // `create_time > "2017-01-15T01:30:15.01Z"` - // - // For more information about filtering, see - // [API Filtering](https://aip.dev/160). - string filter = 4; -} - -// The response message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. -message ListSuggestionsResponse { - option deprecated = true; - - // Required. The list of suggestions. There will be a maximum number of items - // returned based on the page_size field in the request. `suggestions` is - // sorted by `create_time` in descending order. - repeated Suggestion suggestions = 1; - - // Optional. Token to retrieve the next page of results or empty if there are - // no more results in the list. - string next_page_token = 2; -} - -// The request message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. -message CompileSuggestionRequest { - option deprecated = true; - - // Required. The name of the participant to fetch suggestion for. - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/participants/<Participant ID>`. - string parent = 1; - - // Optional. The name of the latest conversation message to compile suggestion - // for. If empty, it will be the latest message of the conversation. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2; - - // Optional. Max number of messages prior to and including - // [latest_message] to use as context when compiling the - // suggestion. If zero or less than zero, 20 is used. - int32 context_size = 3; -} - -// The response message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. -message CompileSuggestionResponse { - option deprecated = true; - - // The compiled suggestion. - Suggestion suggestion = 1; - - // The name of the latest conversation message used to compile - // suggestion for. - // - // Format: `projects/<Project ID>/locations/<Location - // ID>/conversations/<Conversation ID>/messages/<Message ID>`. - string latest_message = 2; - - // Number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.CompileSuggestionResponse.latest_message] - // to compile the suggestion. It may be smaller than the - // [CompileSuggestionRequest.context_size][google.cloud.dialogflow.v2beta1.CompileSuggestionRequest.context_size] field in the request if - // there aren't that many messages in the conversation. - int32 context_size = 3; -} - -// Response messages from an automated agent. -message ResponseMessage { - // The text response message. - message Text { - // A collection of text responses. - repeated string text = 1; - } - - // Indicates that the conversation should be handed off to a human agent. - // - // Dialogflow only uses this to determine which conversations were handed off - // to a human agent for measurement purposes. What else to do with this signal - // is up to you and your handoff procedures. - // - // You may set this, for example: - // * In the entry fulfillment of a CX Page if entering the page indicates - // something went extremely wrong in the conversation. - // * In a webhook response when you determine that the customer issue can only - // be handled by a human. - message LiveAgentHandoff { - // Custom metadata for your handoff procedure. Dialogflow doesn't impose - // any structure on this. - google.protobuf.Struct metadata = 1; - } - - // Indicates that interaction with the Dialogflow agent has ended. - message EndInteraction { - - } - - // Represents an audio message that is composed of both segments - // synthesized from the Dialogflow agent prompts and ones hosted externally - // at the specified URIs. - message MixedAudio { - // Represents one segment of audio. - message Segment { - // Content of the segment. - oneof content { - // Raw audio synthesized from the Dialogflow agent's response using - // the output config specified in the request. - bytes audio = 1; - - // Client-specific URI that points to an audio clip accessible to the - // client. - string uri = 2; - } - - // Whether the playback of this segment can be interrupted by the end - // user's speech and the client should then start the next Dialogflow - // request. - bool allow_playback_interruption = 3; - } - - // Segments this audio response is composed of. - repeated Segment segments = 1; - } - - // Represents the signal that telles the client to transfer the phone call - // connected to the agent to a third-party endpoint. - message TelephonyTransferCall { - // Endpoint to transfer the call to. - oneof endpoint { - // Transfer the call to a phone number - // in [E.164 format](https://en.wikipedia.org/wiki/E.164). - string phone_number = 1; - - // Transfer the call to a SIP endpoint. - string sip_uri = 2; - } - } - - // Required. The rich response message. - oneof message { - // Returns a text response. - Text text = 1; - - // Returns a response containing a custom, platform-specific payload. - google.protobuf.Struct payload = 2; - - // Hands off conversation to a live agent. - LiveAgentHandoff live_agent_handoff = 3; - - // A signal that indicates the interaction with the Dialogflow agent has - // ended. - EndInteraction end_interaction = 4; - - // An audio response message composed of both the synthesized Dialogflow - // agent responses and the audios hosted in places known to the client. - MixedAudio mixed_audio = 5; - - // A signal that the client should transfer the phone call connected to - // this agent to a third-party endpoint. - TelephonyTransferCall telephony_transfer_call = 6; - } -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/session.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/session.proto deleted file mode 100644 index ac64e71..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/session.proto +++ /dev/null @@ -1,839 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/agent.proto"; -import "google/cloud/dialogflow/v2beta1/audio_config.proto"; -import "google/cloud/dialogflow/v2beta1/context.proto"; -import "google/cloud/dialogflow/v2beta1/intent.proto"; -import "google/cloud/dialogflow/v2beta1/session_entity_type.proto"; -import "google/protobuf/duration.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/struct.proto"; -import "google/rpc/status.proto"; -import "google/type/latlng.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "SessionProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; -option (google.api.resource_definition) = { - type: "dialogflow.googleapis.com/Session" - pattern: "projects/{project}/agent/sessions/{session}" - pattern: "projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}" - pattern: "projects/{project}/locations/{location}/agent/sessions/{session}" - pattern: "projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}" -}; - -// A service used for session interactions. -// -// For more information, see the [API interactions -// guide](https://cloud.google.com/dialogflow/docs/api-overview). -service Sessions { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Processes a natural language query and returns structured, actionable data - // as a result. This method is not idempotent, because it may cause contexts - // and session entity types to be updated, which in turn might affect - // results of future queries. - // - // If you might use - // [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) - // or other CCAI products now or in the future, consider using - // [AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] - // instead of `DetectIntent`. `AnalyzeContent` has additional - // functionality for Agent Assist and other CCAI products. - // - // Note: Always use agent versions for production traffic. - // See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - rpc DetectIntent(DetectIntentRequest) returns (DetectIntentResponse) { - option (google.api.http) = { - post: "/v2beta1/{session=projects/*/agent/sessions/*}:detectIntent" - body: "*" - additional_bindings { - post: "/v2beta1/{session=projects/*/agent/environments/*/users/*/sessions/*}:detectIntent" - body: "*" - } - additional_bindings { - post: "/v2beta1/{session=projects/*/locations/*/agent/sessions/*}:detectIntent" - body: "*" - } - additional_bindings { - post: "/v2beta1/{session=projects/*/locations/*/agent/environments/*/users/*/sessions/*}:detectIntent" - body: "*" - } - }; - option (google.api.method_signature) = "session,query_input"; - } - - // Processes a natural language query in audio format in a streaming fashion - // and returns structured, actionable data as a result. This method is only - // available via the gRPC API (not REST). - // - // If you might use - // [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) - // or other CCAI products now or in the future, consider using - // [StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] - // instead of `StreamingDetectIntent`. `StreamingAnalyzeContent` has - // additional functionality for Agent Assist and other CCAI products. - // - // Note: Always use agent versions for production traffic. - // See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - rpc StreamingDetectIntent(stream StreamingDetectIntentRequest) returns (stream StreamingDetectIntentResponse) { - } -} - -// The request to detect user's intent. -message DetectIntentRequest { - // Required. The name of the session this query is sent to. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment - // (`Environment ID` might be referred to as environment name at some places). - // If `User ID` is not specified, we are using "-". It's up to the API caller - // to choose an appropriate `Session ID` and `User Id`. They can be a random - // number or some type of user and session identifiers (preferably hashed). - // The length of the `Session ID` and `User ID` must not exceed 36 characters. - // For more information, see the [API interactions - // guide](https://cloud.google.com/dialogflow/docs/api-overview). - // - // Note: Always use agent versions for production traffic. - // See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - string session = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Session" - } - ]; - - // The parameters of this query. - QueryParameters query_params = 2; - - // Required. The input specification. It can be set to: - // - // 1. an audio config - // which instructs the speech recognizer how to process the speech audio, - // - // 2. a conversational query in the form of text, or - // - // 3. an event that specifies which intent to trigger. - QueryInput query_input = 3 [(google.api.field_behavior) = REQUIRED]; - - // Instructs the speech synthesizer how to generate the output - // audio. If this field is not set and agent-level speech synthesizer is not - // configured, no output audio is generated. - OutputAudioConfig output_audio_config = 4; - - // Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] indicating which settings in this - // request-level config should override speech synthesizer settings defined at - // agent-level. - // - // If unspecified or empty, [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] replaces the agent-level - // config in its entirety. - google.protobuf.FieldMask output_audio_config_mask = 7; - - // The natural language speech audio to be processed. This field - // should be populated iff `query_input` is set to an input audio config. - // A single request can contain up to 1 minute of speech audio data. - bytes input_audio = 5; -} - -// The message returned from the DetectIntent method. -message DetectIntentResponse { - // The unique identifier of the response. It can be used to - // locate a response in the training example set or for reporting issues. - string response_id = 1; - - // The selected results of the conversational query or event processing. - // See `alternative_query_results` for additional potential results. - QueryResult query_result = 2; - - // If Knowledge Connectors are enabled, there could be more than one result - // returned for a given query or event, and this field will contain all - // results except for the top one, which is captured in query_result. The - // alternative results are ordered by decreasing - // `QueryResult.intent_detection_confidence`. If Knowledge Connectors are - // disabled, this field will be empty until multiple responses for regular - // intents are supported, at which point those additional results will be - // surfaced here. - repeated QueryResult alternative_query_results = 5; - - // Specifies the status of the webhook request. - google.rpc.Status webhook_status = 3; - - // The audio data bytes encoded as specified in the request. - // Note: The output audio is generated based on the values of default platform - // text responses found in the `query_result.fulfillment_messages` field. If - // multiple default text responses exist, they will be concatenated when - // generating audio. If no default platform text responses exist, the - // generated audio content will be empty. - // - // In some scenarios, multiple output audio fields may be present in the - // response structure. In these cases, only the top-most-level audio output - // has content. - bytes output_audio = 4; - - // The config used by the speech synthesizer to generate the output audio. - OutputAudioConfig output_audio_config = 6; -} - -// Represents the parameters of the conversational query. -message QueryParameters { - // The time zone of this conversational query from the - // [time zone database](https://www.iana.org/time-zones), e.g., - // America/New_York, Europe/Paris. If not provided, the time zone specified in - // agent settings is used. - string time_zone = 1; - - // The geo location of this conversational query. - google.type.LatLng geo_location = 2; - - // The collection of contexts to be activated before this query is - // executed. - repeated Context contexts = 3; - - // Specifies whether to delete all contexts in the current session - // before the new ones are activated. - bool reset_contexts = 4; - - // Additional session entity types to replace or extend developer - // entity types with. The entity synonyms apply to all languages and persist - // for the session of this query. - repeated SessionEntityType session_entity_types = 5; - - // This field can be used to pass custom data to your webhook. - // Arbitrary JSON objects are supported. - // If supplied, the value is used to populate the - // `WebhookRequest.original_detect_intent_request.payload` - // field sent to your webhook. - google.protobuf.Struct payload = 6; - - // KnowledgeBases to get alternative results from. If not set, the - // KnowledgeBases enabled in the agent (through UI) will be used. - // Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. - repeated string knowledge_base_names = 12; - - // Configures the type of sentiment analysis to perform. If not - // provided, sentiment analysis is not performed. - // Note: Sentiment Analysis is only currently available for Essentials Edition - // agents. - SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10; - - // For mega agent query, directly specify which sub agents to query. - // If any specified sub agent is not linked to the mega agent, an error will - // be returned. If empty, Dialogflow will decide which sub agents to query. - // If specified for a non-mega-agent query, will be silently ignored. - repeated SubAgent sub_agents = 13; - - // This field can be used to pass HTTP headers for a webhook - // call. These headers will be sent to webhook along with the headers that - // have been configured through Dialogflow web console. The headers defined - // within this field will overwrite the headers configured through Dialogflow - // console if there is a conflict. Header names are case-insensitive. - // Google's specified headers are not allowed. Including: "Host", - // "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", - // "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. - map<string, string> webhook_headers = 14; -} - -// Represents the query input. It can contain either: -// -// 1. An audio config which -// instructs the speech recognizer how to process the speech audio. -// -// 2. A conversational query in the form of text. -// -// 3. An event that specifies which intent to trigger. -message QueryInput { - // Required. The input specification. - oneof input { - // Instructs the speech recognizer how to process the speech audio. - InputAudioConfig audio_config = 1; - - // The natural language text to be processed. - TextInput text = 2; - - // The event to be processed. - EventInput event = 3; - - // The DTMF digits used to invoke intent and fill in parameter value. - TelephonyDtmfEvents dtmf = 4; - } -} - -// Represents the result of conversational query or event processing. -message QueryResult { - // The original conversational query text: - // - // - If natural language text was provided as input, `query_text` contains - // a copy of the input. - // - If natural language speech audio was provided as input, `query_text` - // contains the speech recognition result. If speech recognizer produced - // multiple alternatives, a particular one is picked. - // - If automatic spell correction is enabled, `query_text` will contain the - // corrected user input. - string query_text = 1; - - // The language that was triggered during intent detection. - // See [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. - string language_code = 15; - - // The Speech recognition confidence between 0.0 and 1.0. A higher number - // indicates an estimated greater likelihood that the recognized words are - // correct. The default of 0.0 is a sentinel value indicating that confidence - // was not set. - // - // This field is not guaranteed to be accurate or set. In particular this - // field isn't set for StreamingDetectIntent since the streaming endpoint has - // separate confidence estimates per portion of the audio in - // StreamingRecognitionResult. - float speech_recognition_confidence = 2; - - // The action name from the matched intent. - string action = 3; - - // The collection of extracted parameters. - // - // Depending on your protocol or client library language, this is a - // map, associative array, symbol table, dictionary, or JSON object - // composed of a collection of (MapKey, MapValue) pairs: - // - // - MapKey type: string - // - MapKey value: parameter name - // - MapValue type: - // - If parameter's entity type is a composite entity: map - // - Else: depending on parameter value type, could be one of string, - // number, boolean, null, list or map - // - MapValue value: - // - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - // - Else: parameter value - google.protobuf.Struct parameters = 4; - - // This field is set to: - // - // - `false` if the matched intent has required parameters and not all of - // the required parameter values have been collected. - // - `true` if all required parameter values have been collected, or if the - // matched intent doesn't contain any required parameters. - bool all_required_params_present = 5; - - // Indicates whether the conversational query triggers a cancellation for slot - // filling. For more information, see the [cancel slot filling - // documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel). - bool cancels_slot_filling = 21; - - // The text to be pronounced to the user or shown on the screen. - // Note: This is a legacy field, `fulfillment_messages` should be preferred. - string fulfillment_text = 6; - - // The collection of rich messages to present to the user. - repeated Intent.Message fulfillment_messages = 7; - - // If the query was fulfilled by a webhook call, this field is set to the - // value of the `source` field returned in the webhook response. - string webhook_source = 8; - - // If the query was fulfilled by a webhook call, this field is set to the - // value of the `payload` field returned in the webhook response. - google.protobuf.Struct webhook_payload = 9; - - // The collection of output contexts. If applicable, - // `output_contexts.parameters` contains entries with name - // `<parameter name>.original` containing the original parameter values - // before the query. - repeated Context output_contexts = 10; - - // The intent that matched the conversational query. Some, not - // all fields are filled in this message, including but not limited to: - // `name`, `display_name`, `end_interaction` and `is_fallback`. - Intent intent = 11; - - // The intent detection confidence. Values range from 0.0 - // (completely uncertain) to 1.0 (completely certain). - // This value is for informational purpose only and is only used to - // help match the best intent within the classification threshold. - // This value may change for the same end-user expression at any time due to a - // model retraining or change in implementation. - // If there are `multiple knowledge_answers` messages, this value is set to - // the greatest `knowledgeAnswers.match_confidence` value in the list. - float intent_detection_confidence = 12; - - // Free-form diagnostic information for the associated detect intent request. - // The fields of this data can change without notice, so you should not write - // code that depends on its structure. - // The data may contain: - // - // - webhook call latency - // - webhook errors - google.protobuf.Struct diagnostic_info = 14; - - // The sentiment analysis result, which depends on the - // `sentiment_analysis_request_config` specified in the request. - SentimentAnalysisResult sentiment_analysis_result = 17; - - // The result from Knowledge Connector (if any), ordered by decreasing - // `KnowledgeAnswers.match_confidence`. - KnowledgeAnswers knowledge_answers = 18; -} - -// Represents the result of querying a Knowledge base. -message KnowledgeAnswers { - // An answer from Knowledge Connector. - message Answer { - // Represents the system's confidence that this knowledge answer is a good - // match for this conversational query. - enum MatchConfidenceLevel { - // Not specified. - MATCH_CONFIDENCE_LEVEL_UNSPECIFIED = 0; - - // Indicates that the confidence is low. - LOW = 1; - - // Indicates our confidence is medium. - MEDIUM = 2; - - // Indicates our confidence is high. - HIGH = 3; - } - - // Indicates which Knowledge Document this answer was extracted from. - // Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base - // ID>/documents/<Document ID>`. - string source = 1 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - }]; - - // The corresponding FAQ question if the answer was extracted from a FAQ - // Document, empty otherwise. - string faq_question = 2; - - // The piece of text from the `source` knowledge base document that answers - // this conversational query. - string answer = 3; - - // The system's confidence level that this knowledge answer is a good match - // for this conversational query. - // NOTE: The confidence level for a given `<query, answer>` pair may change - // without notice, as it depends on models that are constantly being - // improved. However, it will change less frequently than the confidence - // score below, and should be preferred for referencing the quality of an - // answer. - MatchConfidenceLevel match_confidence_level = 4; - - // The system's confidence score that this Knowledge answer is a good match - // for this conversational query. - // The range is from 0.0 (completely uncertain) to 1.0 (completely certain). - // Note: The confidence score is likely to vary somewhat (possibly even for - // identical requests), as the underlying model is under constant - // improvement. It may be deprecated in the future. We recommend using - // `match_confidence_level` which should be generally more stable. - float match_confidence = 5; - } - - // A list of answers from Knowledge Connector. - repeated Answer answers = 1; -} - -// The top-level message sent by the client to the -// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent] method. -// -// Multiple request messages should be sent in order: -// -// 1. The first message must contain -// [session][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.session], -// [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] plus optionally -// [query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. If the client -// wants to receive an audio response, it should also contain -// [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]. -// The message must not contain -// [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio]. -// 2. If [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] was set to -// [query_input.audio_config][google.cloud.dialogflow.v2beta1.InputAudioConfig], all subsequent -// messages must contain -// [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio] to continue with -// Speech recognition. -// If you decide to rather detect an intent from text input after you -// already started Speech recognition, please send a message with -// [query_input.text][google.cloud.dialogflow.v2beta1.QueryInput.text]. -// -// However, note that: -// -// * Dialogflow will bill you for the audio duration so far. -// * Dialogflow discards all Speech recognition results in favor of the -// input text. -// * Dialogflow will use the language code from the first message. -// -// After you sent all input, you must half-close or abort the request stream. -message StreamingDetectIntentRequest { - // Required. The name of the session the query is sent to. - // Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we are using "-". It's up to the API caller - // to choose an appropriate `Session ID` and `User Id`. They can be a random - // number or some type of user and session identifiers (preferably hashed). - // The length of the `Session ID` and `User ID` must not exceed 36 characters. - // - // For more information, see the [API interactions - // guide](https://cloud.google.com/dialogflow/docs/api-overview). - // - // Note: Always use agent versions for production traffic. - // See [Versions and - // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - string session = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Session" - } - ]; - - // The parameters of this query. - QueryParameters query_params = 2; - - // Required. The input specification. It can be set to: - // - // 1. an audio config which instructs the speech recognizer how to process - // the speech audio, - // - // 2. a conversational query in the form of text, or - // - // 3. an event that specifies which intent to trigger. - QueryInput query_input = 3 [(google.api.field_behavior) = REQUIRED]; - - // DEPRECATED. Please use [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance] instead. - // If `false` (default), recognition does not cease until the - // client closes the stream. - // If `true`, the recognizer will detect a single spoken utterance in input - // audio. Recognition ceases when it detects the audio's voice has - // stopped or paused. In this case, once a detected intent is received, the - // client should close the stream and start a new request with a new stream as - // needed. - // This setting is ignored when `query_input` is a piece of text or an event. - bool single_utterance = 4 [deprecated = true]; - - // Instructs the speech synthesizer how to generate the output - // audio. If this field is not set and agent-level speech synthesizer is not - // configured, no output audio is generated. - OutputAudioConfig output_audio_config = 5; - - // Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] indicating which settings in this - // request-level config should override speech synthesizer settings defined at - // agent-level. - // - // If unspecified or empty, [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level - // config in its entirety. - google.protobuf.FieldMask output_audio_config_mask = 7; - - // The input audio content to be recognized. Must be sent if - // `query_input` was set to a streaming input audio config. The complete audio - // over all streaming messages must not exceed 1 minute. - bytes input_audio = 6; -} - -// The top-level message returned from the -// `StreamingDetectIntent` method. -// -// Multiple response messages can be returned in order: -// -// 1. If the `StreamingDetectIntentRequest.input_audio` field was -// set, the `recognition_result` field is populated for one -// or more messages. -// See the [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] message for details -// about the result message sequence. -// -// 2. The next message contains `response_id`, `query_result`, -// `alternative_query_results` and optionally `webhook_status` if a WebHook -// was called. -// -// 3. If `output_audio_config` was specified in the request or agent-level -// speech synthesizer is configured, all subsequent messages contain -// `output_audio` and `output_audio_config`. -message StreamingDetectIntentResponse { - // The unique identifier of the response. It can be used to - // locate a response in the training example set or for reporting issues. - string response_id = 1; - - // The result of speech recognition. - StreamingRecognitionResult recognition_result = 2; - - // The selected results of the conversational query or event processing. - // See `alternative_query_results` for additional potential results. - QueryResult query_result = 3; - - // If Knowledge Connectors are enabled, there could be more than one result - // returned for a given query or event, and this field will contain all - // results except for the top one, which is captured in query_result. The - // alternative results are ordered by decreasing - // `QueryResult.intent_detection_confidence`. If Knowledge Connectors are - // disabled, this field will be empty until multiple responses for regular - // intents are supported, at which point those additional results will be - // surfaced here. - repeated QueryResult alternative_query_results = 7; - - // Specifies the status of the webhook request. - google.rpc.Status webhook_status = 4; - - // The audio data bytes encoded as specified in the request. - // Note: The output audio is generated based on the values of default platform - // text responses found in the `query_result.fulfillment_messages` field. If - // multiple default text responses exist, they will be concatenated when - // generating audio. If no default platform text responses exist, the - // generated audio content will be empty. - // - // In some scenarios, multiple output audio fields may be present in the - // response structure. In these cases, only the top-most-level audio output - // has content. - bytes output_audio = 5; - - // The config used by the speech synthesizer to generate the output audio. - OutputAudioConfig output_audio_config = 6; -} - -// Contains a speech recognition result corresponding to a portion of the audio -// that is currently being processed or an indication that this is the end -// of the single requested utterance. -// -// While end-user audio is being processed, Dialogflow sends a series of -// results. Each result may contain a `transcript` value. A transcript -// represents a portion of the utterance. While the recognizer is processing -// audio, transcript values may be interim values or finalized values. -// Once a transcript is finalized, the `is_final` value is set to true and -// processing continues for the next transcript. -// -// If `StreamingDetectIntentRequest.query_input.audio_config.single_utterance` -// was true, and the recognizer has completed processing audio, -// the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the -// following (last) result contains the last finalized transcript. -// -// The complete end-user utterance is determined by concatenating the -// finalized transcript values received for the series of results. -// -// In the following example, single utterance is enabled. In the case where -// single utterance is not enabled, result 7 would not occur. -// -// ``` -// Num | transcript | message_type | is_final -// --- | ----------------------- | ----------------------- | -------- -// 1 | "tube" | TRANSCRIPT | false -// 2 | "to be a" | TRANSCRIPT | false -// 3 | "to be" | TRANSCRIPT | false -// 4 | "to be or not to be" | TRANSCRIPT | true -// 5 | "that's" | TRANSCRIPT | false -// 6 | "that is | TRANSCRIPT | false -// 7 | unset | END_OF_SINGLE_UTTERANCE | unset -// 8 | " that is the question" | TRANSCRIPT | true -// ``` -// -// Concatenating the finalized transcripts with `is_final` set to true, -// the complete utterance becomes "to be or not to be that is the question". -message StreamingRecognitionResult { - // Type of the response message. - enum MessageType { - // Not specified. Should never be used. - MESSAGE_TYPE_UNSPECIFIED = 0; - - // Message contains a (possibly partial) transcript. - TRANSCRIPT = 1; - - // Message contains DTMF digits. When the client gets the message, it - // should stop sending additional data, half-close the gRPC connection, and - // wait for any additional results until the server closes the gRPC. - // connection. - DTMF_DIGITS = 3; - - // Event indicates that the server has detected the end of the user's speech - // utterance and expects no additional speech. Therefore, the server will - // not process additional audio (although it may subsequently return - // additional results). The client should stop sending additional audio - // data, half-close the gRPC connection, and wait for any additional results - // until the server closes the gRPC connection. This message is only sent if - // `single_utterance` was set to `true`, and is not used otherwise. - END_OF_SINGLE_UTTERANCE = 2; - - // Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, - // a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected - // up to the time of sending, which represents an intermediate result. - PARTIAL_DTMF_DIGITS = 4; - } - - // Type of the result message. - MessageType message_type = 1; - - // Transcript text representing the words that the user spoke. - // Populated if and only if `message_type` = `TRANSCRIPT`. - string transcript = 2; - - // If `false`, the `StreamingRecognitionResult` represents an - // interim result that may change. If `true`, the recognizer will not return - // any further hypotheses about this piece of the audio. May only be populated - // for `message_type` = `TRANSCRIPT`. - bool is_final = 3; - - // The Speech confidence between 0.0 and 1.0 for the current portion of audio. - // A higher number indicates an estimated greater likelihood that the - // recognized words are correct. The default of 0.0 is a sentinel value - // indicating that confidence was not set. - // - // This field is typically only provided if `is_final` is true and you should - // not rely on it being accurate or even set. - float confidence = 4; - - // An estimate of the likelihood that the speech recognizer will - // not change its guess about this interim recognition result: - // - // * If the value is unspecified or 0.0, Dialogflow didn't compute the - // stability. In particular, Dialogflow will only provide stability for - // `TRANSCRIPT` results with `is_final = false`. - // * Otherwise, the value is in (0.0, 1.0] where 0.0 means completely - // unstable and 1.0 means completely stable. - float stability = 6; - - // Word-specific information for the words recognized by Speech in - // [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript]. Populated if and only if `message_type` = `TRANSCRIPT` and - // [InputAudioConfig.enable_word_info] is set. - repeated SpeechWordInfo speech_word_info = 7; - - // Time offset of the end of this Speech recognition result relative to the - // beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`. - google.protobuf.Duration speech_end_offset = 8; - - // Detected language code for the transcript. - string language_code = 10; - - // DTMF digits. Populated if and only if `message_type` = `DTMF_DIGITS`. - TelephonyDtmfEvents dtmf_digits = 5; -} - -// Represents the natural language text to be processed. -message TextInput { - // Required. The UTF-8 encoded natural language text to be processed. - // Text length must not exceed 256 characters for virtual agent interactions. - string text = 1; - - // Required. The language of this conversational query. See [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. Note that queries in - // the same session do not necessarily need to specify the same language. - string language_code = 2; -} - -// Events allow for matching intents by event name instead of the natural -// language input. For instance, input `<event: { name: "welcome_event", -// parameters: { name: "Sam" } }>` can trigger a personalized welcome response. -// The parameter `name` may be used by the agent in the response: -// `"Hello #welcome_event.name! What can I do for you today?"`. -message EventInput { - // Required. The unique identifier of the event. - string name = 1; - - // The collection of parameters associated with the event. - // - // Depending on your protocol or client library language, this is a - // map, associative array, symbol table, dictionary, or JSON object - // composed of a collection of (MapKey, MapValue) pairs: - // - // - MapKey type: string - // - MapKey value: parameter name - // - MapValue type: - // - If parameter's entity type is a composite entity: map - // - Else: depending on parameter value type, could be one of string, - // number, boolean, null, list or map - // - MapValue value: - // - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - // - Else: parameter value - google.protobuf.Struct parameters = 2; - - // Required. The language of this query. See [Language - // Support](https://cloud.google.com/dialogflow/docs/reference/language) - // for a list of the currently supported language codes. Note that queries in - // the same session do not necessarily need to specify the same language. - // - // This field is ignored when used in the context of a - // [WebhookResponse.followup_event_input][google.cloud.dialogflow.v2beta1.WebhookResponse.followup_event_input] field, - // because the language was already defined in the originating detect - // intent request. - string language_code = 3; -} - -// Configures the types of sentiment analysis to perform. -message SentimentAnalysisRequestConfig { - // Instructs the service to perform sentiment analysis on - // `query_text`. If not provided, sentiment analysis is not performed on - // `query_text`. - bool analyze_query_text_sentiment = 1; -} - -// The result of sentiment analysis. Sentiment analysis inspects user input -// and identifies the prevailing subjective opinion, especially to determine a -// user's attitude as positive, negative, or neutral. -// For [Participants.DetectIntent][], it needs to be configured in -// [DetectIntentRequest.query_params][google.cloud.dialogflow.v2beta1.DetectIntentRequest.query_params]. For -// [Participants.StreamingDetectIntent][], it needs to be configured in -// [StreamingDetectIntentRequest.query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. -// And for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and -// [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent], it needs to be configured in -// [ConversationProfile.human_agent_assistant_config][google.cloud.dialogflow.v2beta1.ConversationProfile.human_agent_assistant_config] -message SentimentAnalysisResult { - // The sentiment analysis result for `query_text`. - Sentiment query_text_sentiment = 1; -} - -// The sentiment, such as positive/negative feeling or association, for a unit -// of analysis, such as the query text. -message Sentiment { - // Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - // sentiment). - float score = 1; - - // A non-negative number in the [0, +inf) range, which represents the absolute - // magnitude of sentiment, regardless of score (positive or negative). - float magnitude = 2; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/session_entity_type.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/session_entity_type.proto deleted file mode 100644 index 4b1c587..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/session_entity_type.proto +++ /dev/null @@ -1,351 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/dialogflow/v2beta1/entity_type.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "SessionEntityTypeProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType]. -service SessionEntityTypes { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all session entity types in the specified session. - // - // This method doesn't work with Google Assistant integration. - // Contact Dialogflow support if you need to use session entities - // with Google Assistant integration. - rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) returns (ListSessionEntityTypesResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent/sessions/*}/entityTypes" - additional_bindings { - get: "/v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/entityTypes" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/entityTypes" - } - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/entityTypes" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified session entity type. - // - // This method doesn't work with Google Assistant integration. - // Contact Dialogflow support if you need to use session entities - // with Google Assistant integration. - rpc GetSessionEntityType(GetSessionEntityTypeRequest) returns (SessionEntityType) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/sessions/*/entityTypes/*}" - } - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates a session entity type. - // - // If the specified session entity type already exists, overrides the - // session entity type. - // - // This method doesn't work with Google Assistant integration. - // Contact Dialogflow support if you need to use session entities - // with Google Assistant integration. - rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) returns (SessionEntityType) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent/sessions/*}/entityTypes" - body: "session_entity_type" - additional_bindings { - post: "/v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/entityTypes" - body: "session_entity_type" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/entityTypes" - body: "session_entity_type" - } - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/entityTypes" - body: "session_entity_type" - } - }; - option (google.api.method_signature) = "parent,session_entity_type"; - } - - // Updates the specified session entity type. - // - // This method doesn't work with Google Assistant integration. - // Contact Dialogflow support if you need to use session entities - // with Google Assistant integration. - rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) returns (SessionEntityType) { - option (google.api.http) = { - patch: "/v2beta1/{session_entity_type.name=projects/*/agent/sessions/*/entityTypes/*}" - body: "session_entity_type" - additional_bindings { - patch: "/v2beta1/{session_entity_type.name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - body: "session_entity_type" - } - additional_bindings { - patch: "/v2beta1/{session_entity_type.name=projects/*/locations/*/agent/sessions/*/entityTypes/*}" - body: "session_entity_type" - } - additional_bindings { - patch: "/v2beta1/{session_entity_type.name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - body: "session_entity_type" - } - }; - option (google.api.method_signature) = "session_entity_type"; - option (google.api.method_signature) = "session_entity_type,update_mask"; - } - - // Deletes the specified session entity type. - // - // This method doesn't work with Google Assistant integration. - // Contact Dialogflow support if you need to use session entities - // with Google Assistant integration. - rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/sessions/*/entityTypes/*}" - } - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}" - } - }; - option (google.api.method_signature) = "name"; - } -} - -// A session represents a conversation between a Dialogflow agent and an -// end-user. You can create special entities, called session entities, during a -// session. Session entities can extend or replace custom entity types and only -// exist during the session that they were created for. All session data, -// including session entities, is stored by Dialogflow for 20 minutes. -// -// For more information, see the [session entity -// guide](https://cloud.google.com/dialogflow/docs/entities-session). -message SessionEntityType { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/SessionEntityType" - pattern: "projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}" - pattern: "projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}" - pattern: "projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}" - pattern: "projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}" - }; - - // The types of modifications for a session entity type. - enum EntityOverrideMode { - // Not specified. This value should be never used. - ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0; - - // The collection of session entities overrides the collection of entities - // in the corresponding custom entity type. - ENTITY_OVERRIDE_MODE_OVERRIDE = 1; - - // The collection of session entities extends the collection of entities in - // the corresponding custom entity type. - // - // Note: Even in this override mode calls to `ListSessionEntityTypes`, - // `GetSessionEntityType`, `CreateSessionEntityType` and - // `UpdateSessionEntityType` only return the additional entities added in - // this session entity type. If you want to get the supplemented list, - // please call [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType] on the custom entity type - // and merge. - ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2; - } - - // Required. The unique identifier of this session entity type. Supported - // formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity - // Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/environments/ - // <Environment ID>/users/<User ID>/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - // `<Entity Type Display Name>` must be the display name of an existing entity - // type in the same agent that will be overridden or supplemented. - string name = 1; - - // Required. Indicates whether the additional data should override or - // supplement the custom entity type definition. - EntityOverrideMode entity_override_mode = 2; - - // Required. The collection of entities associated with this session entity - // type. - repeated EntityType.Entity entities = 3; -} - -// The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. -message ListSessionEntityTypesRequest { - // Required. The session to list all session entity types from. - // Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/SessionEntityType" - } - ]; - - // Optional. The maximum number of items to return in a single page. By - // default 100 and at most 1000. - int32 page_size = 2; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3; -} - -// The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. -message ListSessionEntityTypesResponse { - // The list of session entity types. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated SessionEntityType session_entity_types = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType]. -message GetSessionEntityTypeRequest { - // Required. The name of the session entity type. Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity - // Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/environments/ - // <Environment ID>/users/<User ID>/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/SessionEntityType" - } - ]; -} - -// The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.CreateSessionEntityType]. -message CreateSessionEntityTypeRequest { - // Required. The session to create a session entity type for. - // Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/SessionEntityType" - } - ]; - - // Required. The session entity type to create. - SessionEntityType session_entity_type = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.UpdateSessionEntityType]. -message UpdateSessionEntityTypeRequest { - // Required. The session entity type to update. - SessionEntityType session_entity_type = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2; -} - -// The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.DeleteSessionEntityType]. -message DeleteSessionEntityTypeRequest { - // Required. The name of the entity type to delete. - // Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity - // Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` - // - `projects/<Project ID>/locations/<Location ID>/agent/environments/ - // <Environment ID>/users/<User ID>/sessions/<Session - // ID>/entityTypes/<Entity Type Display Name>` - // - // If `Location ID` is not specified we assume default 'us' location. If - // `Environment ID` is not specified, we assume default 'draft' environment. - // If `User ID` is not specified, we assume default '-' user. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/SessionEntityType" - } - ]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/validation_result.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/validation_result.proto deleted file mode 100644 index d3882b9..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/validation_result.proto +++ /dev/null @@ -1,74 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "ValidationResultProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Represents a single validation error. -message ValidationError { - // Represents a level of severity. - enum Severity { - // Not specified. This value should never be used. - SEVERITY_UNSPECIFIED = 0; - - // The agent doesn't follow Dialogflow best practices. - INFO = 1; - - // The agent may not behave as expected. - WARNING = 2; - - // The agent may experience partial failures. - ERROR = 3; - - // The agent may completely fail. - CRITICAL = 4; - } - - // The severity of the error. - Severity severity = 1; - - // The names of the entries that the error is associated with. - // Format: - // - // - "projects/<Project ID>/agent", if the error is associated with the entire - // agent. - // - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is - // associated with certain intents. - // - "projects/<Project - // ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>", if the - // error is associated with certain intent training phrases. - // - "projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter - // ID>", if the error is associated with certain intent parameters. - // - "projects/<Project ID>/agent/entities/<Entity ID>", if the error is - // associated with certain entities. - repeated string entries = 3; - - // The detailed error message. - string error_message = 4; -} - -// Represents the output of agent validation. -message ValidationResult { - // Contains all validation errors. - repeated ValidationError validation_errors = 1; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/version.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/version.proto deleted file mode 100644 index 58b4b5b..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/version.proto +++ /dev/null @@ -1,261 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; -import "google/protobuf/timestamp.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "VersionProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// Service for managing [Versions][google.cloud.dialogflow.v2beta1.Version]. -service Versions { - option (google.api.default_host) = "dialogflow.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/dialogflow"; - - // Returns the list of all versions of the specified agent. - rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) { - option (google.api.http) = { - get: "/v2beta1/{parent=projects/*/agent}/versions" - additional_bindings { - get: "/v2beta1/{parent=projects/*/locations/*/agent}/versions" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Retrieves the specified agent version. - rpc GetVersion(GetVersionRequest) returns (Version) { - option (google.api.http) = { - get: "/v2beta1/{name=projects/*/agent/versions/*}" - additional_bindings { - get: "/v2beta1/{name=projects/*/locations/*/agent/versions/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Creates an agent version. - // - // The new version points to the agent instance in the "default" environment. - rpc CreateVersion(CreateVersionRequest) returns (Version) { - option (google.api.http) = { - post: "/v2beta1/{parent=projects/*/agent}/versions" - body: "version" - additional_bindings { - post: "/v2beta1/{parent=projects/*/locations/*/agent}/versions" - body: "version" - } - }; - option (google.api.method_signature) = "parent,version"; - } - - // Updates the specified agent version. - // - // Note that this method does not allow you to update the state of the agent - // the given version points to. It allows you to update only mutable - // properties of the version resource. - rpc UpdateVersion(UpdateVersionRequest) returns (Version) { - option (google.api.http) = { - patch: "/v2beta1/{version.name=projects/*/agent/versions/*}" - body: "version" - additional_bindings { - patch: "/v2beta1/{version.name=projects/*/locations/*/agent/versions/*}" - body: "version" - } - }; - option (google.api.method_signature) = "version,update_mask"; - } - - // Delete the specified agent version. - rpc DeleteVersion(DeleteVersionRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v2beta1/{name=projects/*/agent/versions/*}" - additional_bindings { - delete: "/v2beta1/{name=projects/*/locations/*/agent/versions/*}" - } - }; - option (google.api.method_signature) = "name"; - } -} - -// You can create multiple versions of your agent and publish them to separate -// environments. -// -// When you edit an agent, you are editing the draft agent. At any point, you -// can save the draft agent as an agent version, which is an immutable snapshot -// of your agent. -// -// When you save the draft agent, it is published to the default environment. -// When you create agent versions, you can publish them to custom environments. -// You can create a variety of custom environments for: -// -// - testing -// - development -// - production -// - etc. -// -// For more information, see the [versions and environments -// guide](https://cloud.google.com/dialogflow/docs/agents-versions). -message Version { - option (google.api.resource) = { - type: "dialogflow.googleapis.com/Version" - pattern: "projects/{project}/agent/versions/{version}" - pattern: "projects/{project}/locations/{location}/agent/versions/{version}" - }; - - // The status of a version. - enum VersionStatus { - // Not specified. This value is not used. - VERSION_STATUS_UNSPECIFIED = 0; - - // Version is not ready to serve (e.g. training is in progress). - IN_PROGRESS = 1; - - // Version is ready to serve. - READY = 2; - - // Version training failed. - FAILED = 3; - } - - // Output only. The unique identifier of this agent version. - // Supported formats: - // - `projects/<Project ID>/agent/versions/<Version ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version - // ID>` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. The developer-provided description of this version. - string description = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The sequential number of this version. This field is read-only which means - // it cannot be set by create and update methods. - int32 version_number = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The creation time of this version. This field is read-only, i.e., it cannot - // be set by create and update methods. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The status of this version. This field is read-only and cannot be set by - // create and update methods. - VersionStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// The request message for [Versions.ListVersions][google.cloud.dialogflow.v2beta1.Versions.ListVersions]. -message ListVersionsRequest { - // Required. The agent to list all versions from. - // Supported formats: - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Version" - } - ]; - - // Optional. The maximum number of items to return in a single page. By default 100 and - // at most 1000. - int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The next_page_token value returned from a previous list request. - string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; -} - -// The response message for [Versions.ListVersions][google.cloud.dialogflow.v2beta1.Versions.ListVersions]. -message ListVersionsResponse { - // The list of agent versions. There will be a maximum number of items - // returned based on the page_size field in the request. - repeated Version versions = 1; - - // Token to retrieve the next page of results, or empty if there are no - // more results in the list. - string next_page_token = 2; -} - -// The request message for [Versions.GetVersion][google.cloud.dialogflow.v2beta1.Versions.GetVersion]. -message GetVersionRequest { - // Required. The name of the version. - // Supported formats: - // - `projects/<Project ID>/agent/versions/<Version ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version - // ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Version" - } - ]; -} - -// The request message for [Versions.CreateVersion][google.cloud.dialogflow.v2beta1.Versions.CreateVersion]. -message CreateVersionRequest { - // Required. The agent to create a version for. - // Supported formats: - // - `projects/<Project ID>/agent` - // - `projects/<Project ID>/locations/<Location ID>/agent` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/Version" - } - ]; - - // Required. The version to create. - Version version = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Versions.UpdateVersion][google.cloud.dialogflow.v2beta1.Versions.UpdateVersion]. -message UpdateVersionRequest { - // Required. The version to update. - // Supported formats: - // - `projects/<Project ID>/agent/versions/<Version ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version - // ID>` - Version version = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// The request message for [Versions.DeleteVersion][google.cloud.dialogflow.v2beta1.Versions.DeleteVersion]. -message DeleteVersionRequest { - // Required. The name of the version to delete. - // Supported formats: - // - `projects/<Project ID>/agent/versions/<Version ID>` - // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version - // ID>` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Version" - } - ]; -} diff --git a/third_party/googleapis/google/cloud/dialogflow/v2beta1/webhook.proto b/third_party/googleapis/google/cloud/dialogflow/v2beta1/webhook.proto deleted file mode 100644 index a566c5c..0000000 --- a/third_party/googleapis/google/cloud/dialogflow/v2beta1/webhook.proto +++ /dev/null @@ -1,164 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.cloud.dialogflow.v2beta1; - -import "google/cloud/dialogflow/v2beta1/context.proto"; -import "google/cloud/dialogflow/v2beta1/intent.proto"; -import "google/cloud/dialogflow/v2beta1/session.proto"; -import "google/cloud/dialogflow/v2beta1/session_entity_type.proto"; -import "google/protobuf/struct.proto"; - -option cc_enable_arenas = true; -option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1"; -option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow"; -option java_multiple_files = true; -option java_outer_classname = "WebhookProto"; -option java_package = "com.google.cloud.dialogflow.v2beta1"; -option objc_class_prefix = "DF"; - -// The request message for a webhook call. -message WebhookRequest { - // The unique identifier of detectIntent request session. - // Can be used to identify end-user inside webhook implementation. - // Supported formats: - // - `projects/<Project ID>/agent/sessions/<Session ID>, - // - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session - // ID>`, - // - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User - // ID>/sessions/<Session ID>`, - // - `projects/<Project ID>/locations/<Location - // ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session - // ID>`, - string session = 4; - - // The unique identifier of the response. Contains the same value as - // `[Streaming]DetectIntentResponse.response_id`. - string response_id = 1; - - // The result of the conversational query or event processing. Contains the - // same value as `[Streaming]DetectIntentResponse.query_result`. - QueryResult query_result = 2; - - // Alternative query results from KnowledgeService. - repeated QueryResult alternative_query_results = 5; - - // Optional. The contents of the original request that was passed to - // `[Streaming]DetectIntent` call. - OriginalDetectIntentRequest original_detect_intent_request = 3; -} - -// The response message for a webhook call. -// -// This response is validated by the Dialogflow server. If validation fails, -// an error will be returned in the [QueryResult.diagnostic_info][google.cloud.dialogflow.v2beta1.QueryResult.diagnostic_info] field. -// Setting JSON fields to an empty value with the wrong type is a common error. -// To avoid this error: -// -// - Use `""` for empty strings -// - Use `{}` or `null` for empty objects -// - Use `[]` or `null` for empty arrays -// -// For more information, see the -// [Protocol Buffers Language -// Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). -message WebhookResponse { - // Optional. The text response message intended for the end-user. - // It is recommended to use `fulfillment_messages.text.text[0]` instead. - // When provided, Dialogflow uses this field to populate - // [QueryResult.fulfillment_text][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_text] sent to the integration or API caller. - string fulfillment_text = 1; - - // Optional. The rich response messages intended for the end-user. - // When provided, Dialogflow uses this field to populate - // [QueryResult.fulfillment_messages][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller. - repeated Intent.Message fulfillment_messages = 2; - - // Optional. A custom field used to identify the webhook source. - // Arbitrary strings are supported. - // When provided, Dialogflow uses this field to populate - // [QueryResult.webhook_source][google.cloud.dialogflow.v2beta1.QueryResult.webhook_source] sent to the integration or API caller. - string source = 3; - - // Optional. This field can be used to pass custom data from your webhook to the - // integration or API caller. Arbitrary JSON objects are supported. - // When provided, Dialogflow uses this field to populate - // [QueryResult.webhook_payload][google.cloud.dialogflow.v2beta1.QueryResult.webhook_payload] sent to the integration or API caller. - // This field is also used by the - // [Google Assistant - // integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - // for rich response messages. - // See the format definition at [Google Assistant Dialogflow webhook - // format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - google.protobuf.Struct payload = 4; - - // Optional. The collection of output contexts that will overwrite currently - // active contexts for the session and reset their lifespans. - // When provided, Dialogflow uses this field to populate - // [QueryResult.output_contexts][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller. - repeated Context output_contexts = 5; - - // Optional. Invokes the supplied events. - // When this field is set, Dialogflow ignores the `fulfillment_text`, - // `fulfillment_messages`, and `payload` fields. - EventInput followup_event_input = 6; - - // Indicates that a live agent should be brought in to handle the - // interaction with the user. In most cases, when you set this flag to true, - // you would also want to set end_interaction to true as well. Default is - // false. - bool live_agent_handoff = 7; - - // Optional. Indicates that this intent ends an interaction. Some integrations - // (e.g., Actions on Google or Dialogflow phone gateway) use this information - // to close interaction with an end user. Default is false. - bool end_interaction = 8; - - // Optional. Additional session entity types to replace or extend developer - // entity types with. The entity synonyms apply to all languages and persist - // for the session. Setting this data from a webhook overwrites - // the session entity types that have been set using `detectIntent`, - // `streamingDetectIntent` or [SessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods. - repeated SessionEntityType session_entity_types = 10; -} - -// Represents the contents of the original request that was passed to -// the `[Streaming]DetectIntent` call. -message OriginalDetectIntentRequest { - // The source of this request, e.g., `google`, `facebook`, `slack`. It is set - // by Dialogflow-owned servers. - string source = 1; - - // Optional. The version of the protocol used for this request. - // This field is AoG-specific. - string version = 2; - - // Optional. This field is set to the value of the `QueryParameters.payload` - // field passed in the request. Some integrations that query a Dialogflow - // agent may provide additional information in the payload. - // - // In particular, for the Dialogflow Phone Gateway integration, this field has - // the form: - // <pre>{ - // "telephony": { - // "caller_id": "+18558363987" - // } - // }</pre> - // Note: The caller ID field (`caller_id`) will be redacted for Trial - // Edition agents and populated with the caller ID in [E.164 - // format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. - google.protobuf.Struct payload = 3; -} |