docs: clarified some LRO types docs: fixed some wrong update mask des…

…criptions (#172)

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 393365899

Source-Link: googleapis/googleapis@4309574

Source-Link: googleapis/googleapis-gen@4878f59

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/agent.proto

@@ -94,6 +94,13 @@ service Agents {
   }
 
   // Exports the specified agent to a binary file.
+  // 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`: An empty [Struct
+  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+  // - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
   rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3/{name=projects/*/locations/*/agents/*}:export"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/audio_config.proto

@@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option cc_enable_arenas = true;
@@ -30,31 +31,6 @@ option java_package = "com.google.cloud.dialogflow.cx.v3";
 option objc_class_prefix = "DF";
 option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
 
-// 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;
-}
-
 // Audio encoding of the audio content sent in the conversational query request.
 // Refer to the
 // [Cloud Speech API
@@ -104,6 +80,31 @@ enum AudioEncoding {
   AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7;
 }
 
+// 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.

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/flow.proto

@@ -420,9 +420,9 @@ message UpdateFlowRequest {
   // Required. The flow to update.
   Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The mask to control which fields get updated. If `update_mask` is not
-  // specified, an error will be returned.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = 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;
 
   // The language of the following fields in `flow`:
   //

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/test_case.proto

@@ -94,6 +94,12 @@ service TestCases {
   }
 
   // Kicks off a test case run.
+  // 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`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
+  // - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
   rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@@ -284,7 +290,7 @@ message ConversationTurn {
 
     // Required. Input only. The diagnostic
     // [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
-    // output for the turn.
+    // output for the turn. Required to calculate the testing coverage.
     google.protobuf.Struct diagnostic_info = 6 [
       (google.api.field_behavior) = REQUIRED,
       (google.api.field_behavior) = INPUT_ONLY
@@ -635,6 +641,7 @@ message RunTestCaseResponse {
 }
 
 // Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation.
+// This message currently has no fields.
 message RunTestCaseMetadata {
 
 }

packages/google-cloud-dialogflow-cx/src/v3/agents_client.ts

@@ -1041,6 +1041,13 @@ export class AgentsClient {
   ): void;
   /**
    * Exports the specified agent to a binary file.
+   * 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`: An empty [Struct
+   *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: {@link google.cloud.dialogflow.cx.v3.ExportAgentResponse|ExportAgentResponse}
    *
    * @param {Object} request
    *   The request object that will be sent.

packages/google-cloud-dialogflow-cx/src/v3/flows_client.ts

@@ -797,8 +797,8 @@ export class FlowsClient {
    * @param {google.cloud.dialogflow.cx.v3.Flow} request.flow
    *   Required. The flow to update.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The mask to control which fields get updated. If `update_mask` is not
-   *   specified, an error will be returned.
+   *   The mask to control which fields get updated. If the mask is not present,
+   *   all fields will be updated.
    * @param {string} request.languageCode
    *   The language of the following fields in `flow`:
    *

packages/google-cloud-dialogflow-cx/src/v3/test_cases_client.ts

@@ -1078,6 +1078,12 @@ export class TestCasesClient {
   ): void;
   /**
    * Kicks off a test case run.
+   * 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`: {@link google.cloud.dialogflow.cx.v3.RunTestCaseMetadata|RunTestCaseMetadata}
+   * - `response`: {@link google.cloud.dialogflow.cx.v3.RunTestCaseResponse|RunTestCaseResponse}
    *
    * @param {Object} request
    *   The request object that will be sent.