Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Commit

Permalink
docs: clarified wording for restore APIs and query input (#48)
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 336725904

Source-Author: Google APIs <noreply@google.com>
Source-Date: Mon Oct 12 13:01:55 2020 -0700
Source-Repo: googleapis/googleapis
Source-Sha: 6ae1443d1eb0c17bcdbeaa1890960cbcd3b70010
Source-Link: googleapis/googleapis@6ae1443
  • Loading branch information
yoshi-automation committed Oct 14, 2020
1 parent 7678a11 commit aac888c
Show file tree
Hide file tree
Showing 8 changed files with 130 additions and 117 deletions.
Expand Up @@ -654,7 +654,7 @@ public final UnaryCallable<DeleteAgentRequest, Empty> deleteAgentCallable() {

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

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

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Exports the specified agent to a ZIP file.
* Exports the specified agent to a binary file.
*
* <p>Sample code:
*
Expand All @@ -726,10 +726,10 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Restores the specified agent from a ZIP file.
* Restores the specified agent from a binary file.
*
* <p>Note that all existing intents, intent routes, entity types, pages and webhooks in the agent
* will be deleted.
* <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
* intents, entity types, flows) will be removed.
*
* <p>Sample code:
*
Expand All @@ -754,10 +754,10 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Restores the specified agent from a ZIP file.
* Restores the specified agent from a binary file.
*
* <p>Note that all existing intents, intent routes, entity types, pages and webhooks in the agent
* will be deleted.
* <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
* intents, entity types, flows) will be removed.
*
* <p>Sample code:
*
Expand All @@ -781,10 +781,10 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Restores the specified agent from a ZIP file.
* Restores the specified agent from a binary file.
*
* <p>Note that all existing intents, intent routes, entity types, pages and webhooks in the agent
* will be deleted.
* <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
* intents, entity types, flows) will be removed.
*
* <p>Sample code:
*
Expand Down
Expand Up @@ -474,7 +474,7 @@ public void deleteAgent(
*
*
* <pre>
* Exports the specified agent to a ZIP file.
* Exports the specified agent to a binary file.
* </pre>
*/
public void exportAgent(
Expand All @@ -487,9 +487,9 @@ public void exportAgent(
*
*
* <pre>
* 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.
* </pre>
*/
public void restoreAgent(
Expand Down Expand Up @@ -649,7 +649,7 @@ public void deleteAgent(
*
*
* <pre>
* Exports the specified agent to a ZIP file.
* Exports the specified agent to a binary file.
* </pre>
*/
public void exportAgent(
Expand All @@ -665,9 +665,9 @@ public void exportAgent(
*
*
* <pre>
* 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.
* </pre>
*/
public void restoreAgent(
Expand Down Expand Up @@ -762,7 +762,7 @@ public com.google.protobuf.Empty deleteAgent(
*
*
* <pre>
* Exports the specified agent to a ZIP file.
* Exports the specified agent to a binary file.
* </pre>
*/
public com.google.longrunning.Operation exportAgent(
Expand All @@ -774,9 +774,9 @@ public com.google.longrunning.Operation exportAgent(
*
*
* <pre>
* 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.
* </pre>
*/
public com.google.longrunning.Operation restoreAgent(
Expand Down Expand Up @@ -875,7 +875,7 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
*
*
* <pre>
* Exports the specified agent to a ZIP file.
* Exports the specified agent to a binary file.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand All @@ -888,9 +888,9 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
*
*
* <pre>
* 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.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand Down
Expand Up @@ -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"
+ "</v3beta1/{flow.name=projects/*/location"
+ "s/*/agents/*/flows/*}:\004flow\332A\020flow,updat"
+ "e_mask\022\344\001\n\tTrainFlow\0224.google.cloud.dial"
+ "ogflow.cx.v3beta1.TrainFlowRequest\032\035.goo"
+ "gle.longrunning.Operation\"\201\001\202\323\344\223\002B\"=/v3b"
+ "eta1/{name=projects/*/locations/*/agents"
+ "/*/flows/*}:train:\001*\332A\004name\312A/\n\025google.p"
+ "rotobuf.Empty\022\026google.protobuf.Struct\032x\312"
+ "A\031dialogflow.googleapis.com\322AYhttps://ww"
+ "w.googleapis.com/auth/cloud-platform,htt"
+ "ps://www.googleapis.com/auth/dialogflowB"
+ "\250\001\n&com.google.cloud.dialogflow.cx.v3bet"
+ "a1B\tFlowProtoP\001ZDgoogle.golang.org/genpr"
+ "oto/googleapis/cloud/dialogflow/cx/v3bet"
+ "a1;cx\370\001\001\242\002\002DF\252\002\"Google.Cloud.Dialogflow."
+ "Cx.V3Beta1b\006proto3"
+ "protobuf/field_mask.proto\032\037google/protob"
+ "uf/timestamp.proto\"\266\003\n\013NluSettings\022M\n\nmo"
+ "del_type\030\001 \001(\01629.google.cloud.dialogflow"
+ ".cx.v3beta1.NluSettings.ModelType\022 \n\030cla"
+ "ssification_threshold\030\003 \001(\002\022^\n\023model_tra"
+ "ining_mode\030\004 \001(\0162A.google.cloud.dialogfl"
+ "ow.cx.v3beta1.NluSettings.ModelTrainingM"
+ "ode\"Y\n\tModelType\022\032\n\026MODEL_TYPE_UNSPECIFI"
+ "ED\020\000\022\027\n\023MODEL_TYPE_STANDARD\020\001\022\027\n\023MODEL_T"
+ "YPE_ADVANCED\020\003\"{\n\021ModelTrainingMode\022#\n\037M"
+ "ODEL_TRAINING_MODE_UNSPECIFIED\020\000\022!\n\035MODE"
+ "L_TRAINING_MODE_AUTOMATIC\020\001\022\036\n\032MODEL_TRA"
+ "INING_MODE_MANUAL\020\002\"\217\003\n\004Flow\022\014\n\004name\030\001 \001"
+ "(\t\022\031\n\014display_name\030\002 \001(\tB\003\340A\002\022\023\n\013descrip"
+ "tion\030\003 \001(\t\022N\n\021transition_routes\030\004 \003(\01323."
+ "google.cloud.dialogflow.cx.v3beta1.Trans"
+ "itionRoute\022H\n\016event_handlers\030\n \003(\01320.goo"
+ "gle.cloud.dialogflow.cx.v3beta1.EventHan"
+ "dler\022E\n\014nlu_settings\030\013 \001(\0132/.google.clou"
+ "d.dialogflow.cx.v3beta1.NluSettings:h\352Ae"
+ "\n\036dialogflow.googleapis.com/Flow\022Cprojec"
+ "ts/{project}/locations/{location}/agents"
+ "/{agent}/flows/{flow}\"\237\001\n\021CreateFlowRequ"
+ "est\0226\n\006parent\030\001 \001(\tB&\340A\002\372A \022\036dialogflow."
+ "googleapis.com/Flow\022;\n\004flow\030\002 \001(\0132(.goog"
+ "le.cloud.dialogflow.cx.v3beta1.FlowB\003\340A\002"
+ "\022\025\n\rlanguage_code\030\003 \001(\t\"X\n\021DeleteFlowReq"
+ "uest\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036dialogflow.g"
+ "oogleapis.com/Flow\022\r\n\005force\030\002 \001(\010\"\210\001\n\020Li"
+ "stFlowsRequest\0226\n\006parent\030\001 \001(\tB&\340A\002\372A \022\036"
+ "dialogflow.googleapis.com/Flow\022\021\n\tpage_s"
+ "ize\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\022\025\n\rlanguag"
+ "e_code\030\004 \001(\t\"e\n\021ListFlowsResponse\0227\n\005flo"
+ "ws\030\001 \003(\0132(.google.cloud.dialogflow.cx.v3"
+ "beta1.Flow\022\027\n\017next_page_token\030\002 \001(\t\"]\n\016G"
+ "etFlowRequest\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036dia"
+ "logflow.googleapis.com/Flow\022\025\n\rlanguage_"
+ "code\030\002 \001(\t\"\235\001\n\021UpdateFlowRequest\022;\n\004flow"
+ "\030\001 \001(\0132(.google.cloud.dialogflow.cx.v3be"
+ "ta1.FlowB\003\340A\002\0224\n\013update_mask\030\002 \001(\0132\032.goo"
+ "gle.protobuf.FieldMaskB\003\340A\002\022\025\n\rlanguage_"
+ "code\030\003 \001(\t\"H\n\020TrainFlowRequest\0224\n\004name\030\001"
+ " \001(\tB&\340A\002\372A \n\036dialogflow.googleapis.com/"
+ "Flow2\231\n\n\005Flows\022\302\001\n\nCreateFlow\0225.google.c"
+ "loud.dialogflow.cx.v3beta1.CreateFlowReq"
+ "uest\032(.google.cloud.dialogflow.cx.v3beta"
+ "1.Flow\"S\202\323\344\223\002?\"7/v3beta1/{parent=project"
+ "s/*/locations/*/agents/*}/flows:\004flow\332A\013"
+ "parent,flow\022\243\001\n\nDeleteFlow\0225.google.clou"
+ "d.dialogflow.cx.v3beta1.DeleteFlowReques"
+ "t\032\026.google.protobuf.Empty\"F\202\323\344\223\0029*7/v3be"
+ "ta1/{name=projects/*/locations/*/agents/"
+ "*/flows/*}\332A\004name\022\302\001\n\tListFlows\0224.google"
+ ".cloud.dialogflow.cx.v3beta1.ListFlowsRe"
+ "quest\0325.google.cloud.dialogflow.cx.v3bet"
+ "a1.ListFlowsResponse\"H\202\323\344\223\0029\0227/v3beta1/{"
+ "parent=projects/*/locations/*/agents/*}/"
+ "flows\332A\006parent\022\257\001\n\007GetFlow\0222.google.clou"
+ "d.dialogflow.cx.v3beta1.GetFlowRequest\032("
+ ".google.cloud.dialogflow.cx.v3beta1.Flow"
+ "\"F\202\323\344\223\0029\0227/v3beta1/{name=projects/*/loca"
+ "tions/*/agents/*/flows/*}\332A\004name\022\314\001\n\nUpd"
+ "ateFlow\0225.google.cloud.dialogflow.cx.v3b"
+ "eta1.UpdateFlowRequest\032(.google.cloud.di"
+ "alogflow.cx.v3beta1.Flow\"]\202\323\344\223\002D2</v3bet"
+ "a1/{flow.name=projects/*/locations/*/age"
+ "nts/*/flows/*}:\004flow\332A\020flow,update_mask\022"
+ "\344\001\n\tTrainFlow\0224.google.cloud.dialogflow."
+ "cx.v3beta1.TrainFlowRequest\032\035.google.lon"
+ "grunning.Operation\"\201\001\202\323\344\223\002B\"=/v3beta1/{n"
+ "ame=projects/*/locations/*/agents/*/flow"
+ "s/*}:train:\001*\332A\004name\312A/\n\025google.protobuf"
+ ".Empty\022\026google.protobuf.Struct\032x\312A\031dialo"
+ "gflow.googleapis.com\322AYhttps://www.googl"
+ "eapis.com/auth/cloud-platform,https://ww"
+ "w.googleapis.com/auth/dialogflowB\250\001\n&com"
+ ".google.cloud.dialogflow.cx.v3beta1B\tFlo"
+ "wProtoP\001ZDgoogle.golang.org/genproto/goo"
+ "gleapis/cloud/dialogflow/cx/v3beta1;cx\370\001"
+ "\001\242\002\002DF\252\002\"Google.Cloud.Dialogflow.Cx.V3Be"
+ "ta1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
Expand All @@ -173,6 +174,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
com.google.longrunning.OperationsProto.getDescriptor(),
com.google.protobuf.EmptyProto.getDescriptor(),
com.google.protobuf.FieldMaskProto.getDescriptor(),
com.google.protobuf.TimestampProto.getDescriptor(),
});
internal_static_google_cloud_dialogflow_cx_v3beta1_NluSettings_descriptor =
getDescriptor().getMessageTypes().get(0);
Expand Down Expand Up @@ -271,6 +273,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
com.google.longrunning.OperationsProto.getDescriptor();
com.google.protobuf.EmptyProto.getDescriptor();
com.google.protobuf.FieldMaskProto.getDescriptor();
com.google.protobuf.TimestampProto.getDescriptor();
}

// @@protoc_insertion_point(outer_class_scope)
Expand Down
Expand Up @@ -22,9 +22,11 @@
*
*
* <pre>
* 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.
* </pre>
*
* Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.QueryInput}
Expand Down Expand Up @@ -728,9 +730,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* 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.
* </pre>
*
* Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.QueryInput}
Expand Down
Expand Up @@ -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"
Expand All @@ -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"
Expand Down

0 comments on commit aac888c

Please sign in to comment.