From ca78142e6f312c6e009b83c1e9db9a32aa91b63e Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Mon, 12 Oct 2020 15:18:08 -0700 Subject: [PATCH] docs: clarified wording for restore APIs and query input PiperOrigin-RevId: 336725904 Source-Author: Google APIs Source-Date: Mon Oct 12 13:01:55 2020 -0700 Source-Repo: googleapis/googleapis Source-Sha: 6ae1443d1eb0c17bcdbeaa1890960cbcd3b70010 Source-Link: https://github.com/googleapis/googleapis/commit/6ae1443d1eb0c17bcdbeaa1890960cbcd3b70010 --- .../dialogflow/cx/v3beta1/AgentsClient.java | 24 +-- .../dialogflow/cx/v3beta1/AgentsGrpc.java | 32 ++-- .../dialogflow/cx/v3beta1/FlowProto.java | 163 +++++++++--------- .../dialogflow/cx/v3beta1/QueryInput.java | 8 +- .../cloud/dialogflow/cx/v3beta1/agent.proto | 8 +- .../cloud/dialogflow/cx/v3beta1/flow.proto | 1 + .../cloud/dialogflow/cx/v3beta1/session.proto | 7 +- synth.metadata | 6 +- 8 files changed, 131 insertions(+), 118 deletions(-) diff --git a/google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java b/google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java index 169f393a7..fc0a047d1 100644 --- a/google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java +++ b/google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java @@ -654,7 +654,7 @@ public final UnaryCallable deleteAgentCallable() { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Exports the specified agent to a ZIP file. + * Exports the specified agent to a binary file. * *

Sample code: * @@ -680,7 +680,7 @@ public final OperationFuture exportAgentAsync( // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Exports the specified agent to a ZIP file. + * Exports the specified agent to a binary file. * *

Sample code: * @@ -704,7 +704,7 @@ public final OperationFuture exportAgentAsync( // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Exports the specified agent to a ZIP file. + * Exports the specified agent to a binary file. * *

Sample code: * @@ -726,10 +726,10 @@ public final UnaryCallable exportAgentCallable() // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Restores the specified agent from a ZIP file. + * Restores the specified agent from a binary file. * - *

Note that all existing intents, intent routes, entity types, pages and webhooks in the agent - * will be deleted. + *

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. + * intents, entity types, flows) will be removed. * *

Sample code: * @@ -754,10 +754,10 @@ public final OperationFuture restoreAgentAsync(RestoreAgentReques // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Restores the specified agent from a ZIP file. + * Restores the specified agent from a binary file. * - *

Note that all existing intents, intent routes, entity types, pages and webhooks in the agent - * will be deleted. + *

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. + * intents, entity types, flows) will be removed. * *

Sample code: * @@ -781,10 +781,10 @@ public final OperationFuture restoreAgentAsync(RestoreAgentReques // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Restores the specified agent from a ZIP file. + * Restores the specified agent from a binary file. * - *

Note that all existing intents, intent routes, entity types, pages and webhooks in the agent - * will be deleted. + *

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. + * intents, entity types, flows) will be removed. * *

Sample code: * diff --git a/grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java b/grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java index 1d8e090e1..b1ed19b8f 100644 --- a/grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java +++ b/grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java @@ -474,7 +474,7 @@ public void deleteAgent( * * * 

-     * Exports the specified agent to a ZIP file.
+     * Exports the specified agent to a binary file.
      *
*/ public void exportAgent( @@ -487,9 +487,9 @@ public void exportAgent( * * * 
-     * Restores the specified agent from a ZIP file.
-     * Note that all existing intents, intent routes, entity types, pages and
-     * webhooks in the agent will be deleted.
+     * Restores the specified agent from a binary file.
+     * Replaces the current agent with a new one. Note that all existing resources
+     * in agent (e.g. intents, entity types, flows) will be removed.
      *
*/ public void restoreAgent( @@ -649,7 +649,7 @@ public void deleteAgent( * * * 
-     * Exports the specified agent to a ZIP file.
+     * Exports the specified agent to a binary file.
      *
*/ public void exportAgent( @@ -665,9 +665,9 @@ public void exportAgent( * * * 
-     * Restores the specified agent from a ZIP file.
-     * Note that all existing intents, intent routes, entity types, pages and
-     * webhooks in the agent will be deleted.
+     * Restores the specified agent from a binary file.
+     * Replaces the current agent with a new one. Note that all existing resources
+     * in agent (e.g. intents, entity types, flows) will be removed.
      *
*/ public void restoreAgent( @@ -762,7 +762,7 @@ public com.google.protobuf.Empty deleteAgent( * * * 
-     * Exports the specified agent to a ZIP file.
+     * Exports the specified agent to a binary file.
      *
*/ public com.google.longrunning.Operation exportAgent( @@ -774,9 +774,9 @@ public com.google.longrunning.Operation exportAgent( * * * 
-     * Restores the specified agent from a ZIP file.
-     * Note that all existing intents, intent routes, entity types, pages and
-     * webhooks in the agent will be deleted.
+     * Restores the specified agent from a binary file.
+     * Replaces the current agent with a new one. Note that all existing resources
+     * in agent (e.g. intents, entity types, flows) will be removed.
      *
*/ public com.google.longrunning.Operation restoreAgent( @@ -875,7 +875,7 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca * * * 
-     * Exports the specified agent to a ZIP file.
+     * Exports the specified agent to a binary file.
      *
*/ public com.google.common.util.concurrent.ListenableFuture @@ -888,9 +888,9 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca * * * 
-     * Restores the specified agent from a ZIP file.
-     * Note that all existing intents, intent routes, entity types, pages and
-     * webhooks in the agent will be deleted.
+     * Restores the specified agent from a binary file.
+     * Replaces the current agent with a new one. Note that all existing resources
+     * in agent (e.g. intents, entity types, flows) will be removed.
      *
*/ public com.google.common.util.concurrent.ListenableFuture diff --git a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowProto.java b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowProto.java index 85a6844bc..cf6dc7203 100644 --- a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowProto.java +++ b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowProto.java @@ -80,86 +80,87 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() { + "google/cloud/dialogflow/cx/v3beta1/page." + "proto\032#google/longrunning/operations.pro" + "to\032\033google/protobuf/empty.proto\032 google/" - + "protobuf/field_mask.proto\"\266\003\n\013NluSetting" - + "s\022M\n\nmodel_type\030\001 \001(\01629.google.cloud.dia" - + "logflow.cx.v3beta1.NluSettings.ModelType" - + "\022 \n\030classification_threshold\030\003 \001(\002\022^\n\023mo" - + "del_training_mode\030\004 \001(\0162A.google.cloud.d" - + "ialogflow.cx.v3beta1.NluSettings.ModelTr" - + "ainingMode\"Y\n\tModelType\022\032\n\026MODEL_TYPE_UN" - + "SPECIFIED\020\000\022\027\n\023MODEL_TYPE_STANDARD\020\001\022\027\n\023" - + "MODEL_TYPE_ADVANCED\020\003\"{\n\021ModelTrainingMo" - + "de\022#\n\037MODEL_TRAINING_MODE_UNSPECIFIED\020\000\022" - + "!\n\035MODEL_TRAINING_MODE_AUTOMATIC\020\001\022\036\n\032MO" - + "DEL_TRAINING_MODE_MANUAL\020\002\"\217\003\n\004Flow\022\014\n\004n" - + "ame\030\001 \001(\t\022\031\n\014display_name\030\002 \001(\tB\003\340A\002\022\023\n\013" - + "description\030\003 \001(\t\022N\n\021transition_routes\030\004" - + " \003(\01323.google.cloud.dialogflow.cx.v3beta" - + "1.TransitionRoute\022H\n\016event_handlers\030\n \003(" - + "\01320.google.cloud.dialogflow.cx.v3beta1.E" - + "ventHandler\022E\n\014nlu_settings\030\013 \001(\0132/.goog" - + "le.cloud.dialogflow.cx.v3beta1.NluSettin" - + "gs:h\352Ae\n\036dialogflow.googleapis.com/Flow\022" - + "Cprojects/{project}/locations/{location}" - + "/agents/{agent}/flows/{flow}\"\237\001\n\021CreateF" - + "lowRequest\0226\n\006parent\030\001 \001(\tB&\340A\002\372A \022\036dial" - + "ogflow.googleapis.com/Flow\022;\n\004flow\030\002 \001(\013" - + "2(.google.cloud.dialogflow.cx.v3beta1.Fl" - + "owB\003\340A\002\022\025\n\rlanguage_code\030\003 \001(\t\"X\n\021Delete" - + "FlowRequest\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036dialo" - + "gflow.googleapis.com/Flow\022\r\n\005force\030\002 \001(\010" - + "\"\210\001\n\020ListFlowsRequest\0226\n\006parent\030\001 \001(\tB&\340" - + "A\002\372A \022\036dialogflow.googleapis.com/Flow\022\021\n" - + "\tpage_size\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\022\025\n\r" - + "language_code\030\004 \001(\t\"e\n\021ListFlowsResponse" - + "\0227\n\005flows\030\001 \003(\0132(.google.cloud.dialogflo" - + "w.cx.v3beta1.Flow\022\027\n\017next_page_token\030\002 \001" - + "(\t\"]\n\016GetFlowRequest\0224\n\004name\030\001 \001(\tB&\340A\002\372" - + "A \n\036dialogflow.googleapis.com/Flow\022\025\n\rla" - + "nguage_code\030\002 \001(\t\"\235\001\n\021UpdateFlowRequest\022" - + ";\n\004flow\030\001 \001(\0132(.google.cloud.dialogflow." - + "cx.v3beta1.FlowB\003\340A\002\0224\n\013update_mask\030\002 \001(" - + "\0132\032.google.protobuf.FieldMaskB\003\340A\002\022\025\n\rla" - + "nguage_code\030\003 \001(\t\"H\n\020TrainFlowRequest\0224\n" - + "\004name\030\001 \001(\tB&\340A\002\372A \n\036dialogflow.googleap" - + "is.com/Flow2\231\n\n\005Flows\022\302\001\n\nCreateFlow\0225.g" - + "oogle.cloud.dialogflow.cx.v3beta1.Create" - + "FlowRequest\032(.google.cloud.dialogflow.cx" - + ".v3beta1.Flow\"S\202\323\344\223\002?\"7/v3beta1/{parent=" - + "projects/*/locations/*/agents/*}/flows:\004" - + "flow\332A\013parent,flow\022\243\001\n\nDeleteFlow\0225.goog" - + "le.cloud.dialogflow.cx.v3beta1.DeleteFlo" - + "wRequest\032\026.google.protobuf.Empty\"F\202\323\344\223\0029" - + "*7/v3beta1/{name=projects/*/locations/*/" - + "agents/*/flows/*}\332A\004name\022\302\001\n\tListFlows\0224" - + ".google.cloud.dialogflow.cx.v3beta1.List" - + "FlowsRequest\0325.google.cloud.dialogflow.c" - + "x.v3beta1.ListFlowsResponse\"H\202\323\344\223\0029\0227/v3" - + "beta1/{parent=projects/*/locations/*/age" - + "nts/*}/flows\332A\006parent\022\257\001\n\007GetFlow\0222.goog" - + "le.cloud.dialogflow.cx.v3beta1.GetFlowRe" - + "quest\032(.google.cloud.dialogflow.cx.v3bet" - + "a1.Flow\"F\202\323\344\223\0029\0227/v3beta1/{name=projects" - + "/*/locations/*/agents/*/flows/*}\332A\004name\022" - + "\314\001\n\nUpdateFlow\0225.google.cloud.dialogflow" - + ".cx.v3beta1.UpdateFlowRequest\032(.google.c" - + "loud.dialogflow.cx.v3beta1.Flow\"]\202\323\344\223\002D2" - + " - * Represents the query input. It can contain either: + * Represents the query input. It can contain one of: * 1. A conversational query in the form of text. * 2. An intent query that specifies which intent to trigger. + * 3. Natural language speech audio to be processed. + * 4. An event to be triggered. * * * Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.QueryInput} @@ -728,9 +730,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build * * * 
-   * Represents the query input. It can contain either:
+   * Represents the query input. It can contain one of:
    * 1.  A conversational query in the form of text.
    * 2.  An intent query that specifies which intent to trigger.
+   * 3.  Natural language speech audio to be processed.
+   * 4.  An event to be triggered.
    *
* * Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.QueryInput} diff --git a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/agent.proto b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/agent.proto index e0bf899a1..c6ffbca71 100644 --- a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/agent.proto +++ b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/agent.proto @@ -82,7 +82,7 @@ service Agents { option (google.api.method_signature) = "name"; } - // Exports the specified agent to a ZIP file. + // Exports the specified agent to a binary file. rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v3beta1/{name=projects/*/locations/*/agents/*}:export" @@ -94,10 +94,10 @@ service Agents { }; } - // Restores the specified agent from a ZIP file. + // Restores the specified agent from a binary file. // - // Note that all existing intents, intent routes, entity types, pages and - // webhooks in the agent will be deleted. + // Replaces the current agent with a new one. Note that all existing resources + // in agent (e.g. intents, entity types, flows) will be removed. rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v3beta1/{name=projects/*/locations/*/agents/*}:restore" diff --git a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/flow.proto b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/flow.proto index 313055f40..fefd0abe4 100644 --- a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/flow.proto +++ b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/flow.proto @@ -24,6 +24,7 @@ import "google/cloud/dialogflow/cx/v3beta1/page.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.Cx.V3Beta1"; diff --git a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/session.proto b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/session.proto index e3de731c1..27fdeb15a 100644 --- a/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/session.proto +++ b/proto-google-cloud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/session.proto @@ -376,11 +376,16 @@ message QueryParameters { bool analyze_query_text_sentiment = 8; } -// Represents the query input. It can contain either: +// Represents the query input. It can contain one of: // // 1. A conversational query in the form of text. // // 2. An intent query that specifies which intent to trigger. +// +// 3. Natural language speech audio to be processed. +// +// 4. An event to be triggered. +// message QueryInput { // Required. The input specification. oneof input { diff --git a/synth.metadata b/synth.metadata index af02e78fe..084b42b46 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,15 +4,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-dialogflow-cx.git", - "sha": "8d7f23b953cb9f5468a77a72c493ac5fa1ed080d" + "sha": "77f66504b74069e65eca3e2afddd495565c064af" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "f7a34a4b51edcb758ee36e5fc580ac89ba2417fd", - "internalRef": "336005205" + "sha": "6ae1443d1eb0c17bcdbeaa1890960cbcd3b70010", + "internalRef": "336725904" } }, {