feat: [dialogflow] properly mark TrainingPhrase name field output-only (

#5862) * feat: properly mark TrainingPhrase name field output-only docs: fixed the references to proto method / fields PiperOrigin-RevId: 702736565 Source-Link: googleapis/googleapis@6989f67 Source-Link: googleapis/googleapis-gen@5036471 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpYWxvZ2Zsb3cvLk93bEJvdC55YW1sIiwiaCI6IjUwMzY0NzE4YWYwNDg2ZWFhNWMyZmEyOTI1NDE0YmU4NThkMGNmN2QifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: d-goog <[email protected]>
googleapis · Dec 9, 2024 · 522c389 · 522c389
1 parent 9f8c0c2
commit 522c389
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 44 deletions.
diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/answer_record.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/answer_record.proto
@@ -93,8 +93,9 @@ service AnswerRecords {
 //    returned to the customers.
 // 2. The customer uses the
 // [AnswerRecord.name][google.cloud.dialogflow.v2.AnswerRecord.name] to call the
-//    [UpdateAnswerRecord][] method to send feedback about a specific answer
-//    that they believe is wrong.
+//    [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2.AnswerRecords.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"

diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/audio_config.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/audio_config.proto
@@ -445,8 +445,8 @@ enum SpeechModelVariant {
   // 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.
+  // Use the best available variant of the [Speech model][model] that the caller
+  // is eligible for.
   //
   // Please see the [Dialogflow
   // docs](https://cloud.google.com/dialogflow/docs/data-logging) for

diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation.proto
@@ -515,9 +515,11 @@ message SuggestConversationSummaryResponse {
   }];
 
   // 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.
+  // [latest_message][google.cloud.dialogflow.v2.SuggestConversationSummaryResponse.latest_message]
+  // used to compile the suggestion. It may be smaller than the
+  // [SuggestConversationSummaryRequest.context_size][google.cloud.dialogflow.v2.SuggestConversationSummaryRequest.context_size]
+  // field in the request if there weren't that many messages in the
+  // conversation.
   int32 context_size = 3;
 }
 
@@ -601,9 +603,11 @@ message GenerateStatelessSummaryResponse {
   }];
 
   // Number of messages prior to and including
-  // [last_conversation_message][] used to compile the suggestion. It may be
-  // smaller than the [GenerateStatelessSummaryRequest.context_size][] field in
-  // the request if there weren't that many messages in the conversation.
+  // [latest_message][google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse.latest_message]
+  // used to compile the suggestion. It may be smaller than the
+  // [GenerateStatelessSummaryRequest.max_context_size][google.cloud.dialogflow.v2.GenerateStatelessSummaryRequest.max_context_size]
+  // field in the request if there weren't that many messages in the
+  // conversation.
   int32 context_size = 3;
 }
 

diff --git a/...ages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation_dataset.proto b/...ages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation_dataset.proto
@@ -330,7 +330,7 @@ message ImportConversationDataOperationResponse {
   int32 import_count = 3;
 }
 
-// Metadata for [ConversationDatasets][CreateConversationDataset].
+// Metadata for [CreateConversationDataset][].
 message CreateConversationDatasetOperationMetadata {
   // The resource name of the conversation dataset that will be created. Format:
   // `projects/<Project ID>/locations/<Location
@@ -340,5 +340,5 @@ message CreateConversationDatasetOperationMetadata {
   }];
 }
 
-// Metadata for [ConversationDatasets][DeleteConversationDataset].
+// Metadata for [DeleteConversationDataset][].
 message DeleteConversationDatasetOperationMetadata {}
diff --git a/...ages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation_profile.proto b/...ages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/conversation_profile.proto
@@ -73,7 +73,9 @@ service ConversationProfiles {
 
   // Creates a conversation profile in the specified project.
   //
-  // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][]
+  // [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time]
+  // and
+  // [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time]
   // aren't populated in the response. You can retrieve them via
   // [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile]
   // API.
@@ -92,7 +94,9 @@ service ConversationProfiles {
 
   // Updates the specified conversation profile.
   //
-  // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][]
+  // [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time]
+  // and
+  // [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time]
   // aren't populated in the response. You can retrieve them via
   // [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile]
   // API.
@@ -867,7 +871,7 @@ message SuggestionFeature {
 }
 
 // The request message for
-// [ConversationProfiles.SetSuggestionFeature][].
+// [ConversationProfiles.SetSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.SetSuggestionFeatureConfig].
 message SetSuggestionFeatureConfigRequest {
   // Required. The Conversation Profile to add or update the suggestion feature
   // config. Format: `projects/<Project ID>/locations/<Location
@@ -884,7 +888,8 @@ message SetSuggestionFeatureConfigRequest {
       3 [(google.api.field_behavior) = REQUIRED];
 }
 
-// The request message for [ConversationProfiles.ClearFeature][].
+// The request message for
+// [ConversationProfiles.ClearSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.ClearSuggestionFeatureConfig].
 message ClearSuggestionFeatureConfigRequest {
   // Required. The Conversation Profile to add or update the suggestion feature
   // config. Format: `projects/<Project ID>/locations/<Location
@@ -901,7 +906,8 @@ message ClearSuggestionFeatureConfigRequest {
       [(google.api.field_behavior) = REQUIRED];
 }
 
-// Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][]
+// Metadata for a
+// [ConversationProfiles.SetSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.SetSuggestionFeatureConfig]
 // operation.
 message SetSuggestionFeatureConfigOperationMetadata {
   // The resource name of the conversation profile. Format:
@@ -922,7 +928,8 @@ message SetSuggestionFeatureConfigOperationMetadata {
   google.protobuf.Timestamp create_time = 4;
 }
 
-// Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][]
+// Metadata for a
+// [ConversationProfiles.ClearSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.ClearSuggestionFeatureConfig]
 // operation.
 message ClearSuggestionFeatureConfigOperationMetadata {
   // The resource name of the conversation profile. Format:

diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/intent.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/intent.proto
@@ -256,7 +256,7 @@ message Intent {
     }
 
     // Output only. The unique identifier of this training phrase.
-    string name = 1;
+    string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
     // Required. The type of the training phrase.
     Type type = 2 [(google.api.field_behavior) = REQUIRED];

diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/participant.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/participant.proto
@@ -236,9 +236,9 @@ message Participant {
   //    Dialogflow adds the obfuscated user id with the participant.
   //
   // 2. If you set this field in
-  //    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
+  //    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.participant]
   //    or
-  //    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
+  //    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant],
   //    Dialogflow will update
   //    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].
   //
@@ -481,8 +481,9 @@ message AnalyzeContentResponse {
   OutputAudio reply_audio = 2;
 
   // 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][]
+  // Note that in [AutomatedAgentReply.DetectIntentResponse][],
+  // [Sessions.DetectIntentResponse.output_audio][]
+  // and [Sessions.DetectIntentResponse.output_audio_config][]
   // are always empty, use
   // [reply_audio][google.cloud.dialogflow.v2.AnalyzeContentResponse.reply_audio]
   // instead.
@@ -629,7 +630,8 @@ message StreamingAnalyzeContentRequest {
   // and
   // [AudioEncoding.AUDIO_ENCODING_MULAW][google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_MULAW]
   // - Lifecycle: conversation should be in `Assist Stage`, go to
-  //   [Conversation.CreateConversation][] for more information.
+  //   [Conversations.CreateConversation][google.cloud.dialogflow.v2.Conversations.CreateConversation]
+  //   for more information.
   //
   // InvalidArgument Error will be returned if the one of restriction checks
   // failed.
@@ -692,9 +694,9 @@ message StreamingAnalyzeContentResponse {
   // has content.
   OutputAudio reply_audio = 3;
 
-  // 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][]
+  // Note that in [AutomatedAgentReply.DetectIntentResponse][],
+  // [Sessions.DetectIntentResponse.output_audio][]
+  // and [Sessions.DetectIntentResponse.output_audio_config][]
   // are always empty, use
   // [reply_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio]
   // instead.

diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/session.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2/session.proto
@@ -168,7 +168,7 @@ message DetectIntentRequest {
   bytes input_audio = 5;
 }
 
-// The message returned from the DetectIntent method.
+// 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.
@@ -299,8 +299,8 @@ message QueryResult {
   // 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
+  // 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;
 
@@ -387,8 +387,7 @@ message QueryResult {
 }
 
 // The top-level message sent by the client to the
-// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]
-// method.
+// [StreamingDetectIntent][] method.
 //
 // Multiple request messages should be sent in order:
 //
@@ -562,11 +561,13 @@ message CloudConversationDebuggingInfo {
 }
 
 // The top-level message returned from the
-// `StreamingDetectIntent` method.
+// [StreamingDetectIntent][] method.
 //
 // Multiple response messages can be returned in order:
 //
-// 1.  If the `StreamingDetectIntentRequest.input_audio` field was
+// 1.  If the
+// [StreamingDetectIntentRequest.input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio]
+// field was
 //     set, the `recognition_result` field is populated for one
 //     or more messages.
 //     See the
@@ -605,7 +606,8 @@ message StreamingDetectIntentResponse {
   OutputAudioConfig output_audio_config = 6;
 
   // Debugging info that would get populated when
-  // `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
+  // [StreamingDetectIntentRequest.enable_debugging_info][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.enable_debugging_info]
+  // is set to true.
   CloudConversationDebuggingInfo debugging_info = 8;
 }
 
@@ -765,9 +767,9 @@ message SentimentAnalysisRequestConfig {
 // 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
+// For [DetectIntent][], it needs to be configured in
 // [DetectIntentRequest.query_params][google.cloud.dialogflow.v2.DetectIntentRequest.query_params].
-// For [Participants.StreamingDetectIntent][], it needs to be configured in
+// For [StreamingDetectIntent][], it needs to be configured in
 // [StreamingDetectIntentRequest.query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params].
 // And for
 // [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]

diff --git a/packages/google-cloud-dialogflow/protos/protos.json b/packages/google-cloud-dialogflow/protos/protos.json
diff --git a/...es/google-cloud-dialogflow/samples/generated/v2/participants.streaming_analyze_content.js b/...es/google-cloud-dialogflow/samples/generated/v2/participants.streaming_analyze_content.js
@@ -96,7 +96,8 @@ function main(participant) {
    *  and
    *  AudioEncoding.AUDIO_ENCODING_MULAW google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_MULAW 
    *  - Lifecycle: conversation should be in `Assist Stage`, go to
-   *    Conversation.CreateConversation   for more information.
+   *    Conversations.CreateConversation google.cloud.dialogflow.v2.Conversations.CreateConversation 
+   *    for more information.
    *  InvalidArgument Error will be returned if the one of restriction checks
    *  failed.
    *  You can find more details in

diff --git a/...le-cloud-dialogflow/samples/generated/v2/snippet_metadata_google.cloud.dialogflow.v2.json b/...le-cloud-dialogflow/samples/generated/v2/snippet_metadata_google.cloud.dialogflow.v2.json
@@ -1451,7 +1451,7 @@
             "regionTag": "dialogflow_v2_generated_ConversationProfiles_CreateConversationProfile_async",
             "title": "dialogflow createConversationProfile Sample",
             "origin": "API_DEFINITION",
-            "description": " 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.v2.ConversationProfiles.GetConversationProfile] API.",
+            "description": " Creates a conversation profile in the specified project. [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time] and [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.",
             "canonical": true,
             "file": "conversation_profiles.create_conversation_profile.js",
             "language": "JAVASCRIPT",
@@ -1495,7 +1495,7 @@
             "regionTag": "dialogflow_v2_generated_ConversationProfiles_UpdateConversationProfile_async",
             "title": "dialogflow updateConversationProfile Sample",
             "origin": "API_DEFINITION",
-            "description": " 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.v2.ConversationProfiles.GetConversationProfile] API.",
+            "description": " Updates the specified conversation profile. [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time] and [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.",
             "canonical": true,
             "file": "conversation_profiles.update_conversation_profile.js",
             "language": "JAVASCRIPT",
@@ -4486,7 +4486,7 @@
             "segments": [
                 {
                     "start": 25,
-                    "end": 140,
+                    "end": 141,
                     "type": "FULL"
                 }
             ],

diff --git a/packages/google-cloud-dialogflow/src/v2/conversation_profiles_client.ts b/packages/google-cloud-dialogflow/src/v2/conversation_profiles_client.ts
@@ -733,7 +733,9 @@ export class ConversationProfilesClient {
   /**
    * Creates a conversation profile in the specified project.
    *
-   * {@link protos.|ConversationProfile.CreateTime} and {@link protos.|ConversationProfile.UpdateTime}
+   * {@link protos.google.cloud.dialogflow.v2.ConversationProfile.create_time|ConversationProfile.create_time}
+   * and
+   * {@link protos.google.cloud.dialogflow.v2.ConversationProfile.update_time|ConversationProfile.update_time}
    * aren't populated in the response. You can retrieve them via
    * {@link protos.google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile|GetConversationProfile}
    * API.
@@ -841,7 +843,9 @@ export class ConversationProfilesClient {
   /**
    * Updates the specified conversation profile.
    *
-   * {@link protos.|ConversationProfile.CreateTime} and {@link protos.|ConversationProfile.UpdateTime}
+   * {@link protos.google.cloud.dialogflow.v2.ConversationProfile.create_time|ConversationProfile.create_time}
+   * and
+   * {@link protos.google.cloud.dialogflow.v2.ConversationProfile.update_time|ConversationProfile.update_time}
    * aren't populated in the response. You can retrieve them via
    * {@link protos.google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile|GetConversationProfile}
    * API.