Skip to content

Commit 6989f67

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: properly mark TrainingPhrase name field output-only
docs: fixed the references to proto method / fields PiperOrigin-RevId: 702736565
1 parent 673721b commit 6989f67

8 files changed

Lines changed: 53 additions & 37 deletions

File tree

‎google/cloud/dialogflow/v2/answer_record.proto‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,9 @@ service AnswerRecords {
9393
// returned to the customers.
9494
// 2. The customer uses the
9595
// [AnswerRecord.name][google.cloud.dialogflow.v2.AnswerRecord.name] to call the
96-
// [UpdateAnswerRecord][] method to send feedback about a specific answer
97-
// that they believe is wrong.
96+
// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2.AnswerRecords.UpdateAnswerRecord]
97+
// method to send feedback about a specific answer that they believe is
98+
// wrong.
9899
message AnswerRecord {
99100
option (google.api.resource) = {
100101
type: "dialogflow.googleapis.com/AnswerRecord"

‎google/cloud/dialogflow/v2/audio_config.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,8 @@ enum SpeechModelVariant {
445445
// USE_BEST_AVAILABLE.
446446
SPEECH_MODEL_VARIANT_UNSPECIFIED = 0;
447447

448-
// Use the best available variant of the [Speech
449-
// model][InputAudioConfig.model] that the caller is eligible for.
448+
// Use the best available variant of the [Speech model][model] that the caller
449+
// is eligible for.
450450
//
451451
// Please see the [Dialogflow
452452
// docs](https://cloud.google.com/dialogflow/docs/data-logging) for

‎google/cloud/dialogflow/v2/conversation.proto‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -515,9 +515,11 @@ message SuggestConversationSummaryResponse {
515515
}];
516516

517517
// Number of messages prior to and including
518-
// [last_conversation_message][] used to compile the suggestion. It may be
519-
// smaller than the [SuggestSummaryRequest.context_size][] field in the
520-
// request if there weren't that many messages in the conversation.
518+
// [latest_message][google.cloud.dialogflow.v2.SuggestConversationSummaryResponse.latest_message]
519+
// used to compile the suggestion. It may be smaller than the
520+
// [SuggestConversationSummaryRequest.context_size][google.cloud.dialogflow.v2.SuggestConversationSummaryRequest.context_size]
521+
// field in the request if there weren't that many messages in the
522+
// conversation.
521523
int32 context_size = 3;
522524
}
523525

@@ -601,9 +603,11 @@ message GenerateStatelessSummaryResponse {
601603
}];
602604

603605
// Number of messages prior to and including
604-
// [last_conversation_message][] used to compile the suggestion. It may be
605-
// smaller than the [GenerateStatelessSummaryRequest.context_size][] field in
606-
// the request if there weren't that many messages in the conversation.
606+
// [latest_message][google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse.latest_message]
607+
// used to compile the suggestion. It may be smaller than the
608+
// [GenerateStatelessSummaryRequest.max_context_size][google.cloud.dialogflow.v2.GenerateStatelessSummaryRequest.max_context_size]
609+
// field in the request if there weren't that many messages in the
610+
// conversation.
607611
int32 context_size = 3;
608612
}
609613

‎google/cloud/dialogflow/v2/conversation_dataset.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ message ImportConversationDataOperationResponse {
330330
int32 import_count = 3;
331331
}
332332

333-
// Metadata for [ConversationDatasets][CreateConversationDataset].
333+
// Metadata for [CreateConversationDataset][].
334334
message CreateConversationDatasetOperationMetadata {
335335
// The resource name of the conversation dataset that will be created. Format:
336336
// `projects/<Project ID>/locations/<Location
@@ -340,5 +340,5 @@ message CreateConversationDatasetOperationMetadata {
340340
}];
341341
}
342342

343-
// Metadata for [ConversationDatasets][DeleteConversationDataset].
343+
// Metadata for [DeleteConversationDataset][].
344344
message DeleteConversationDatasetOperationMetadata {}

‎google/cloud/dialogflow/v2/conversation_profile.proto‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ service ConversationProfiles {
7373

7474
// Creates a conversation profile in the specified project.
7575
//
76-
// [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][]
76+
// [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time]
77+
// and
78+
// [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time]
7779
// aren't populated in the response. You can retrieve them via
7880
// [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile]
7981
// API.
@@ -92,7 +94,9 @@ service ConversationProfiles {
9294

9395
// Updates the specified conversation profile.
9496
//
95-
// [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][]
97+
// [ConversationProfile.create_time][google.cloud.dialogflow.v2.ConversationProfile.create_time]
98+
// and
99+
// [ConversationProfile.update_time][google.cloud.dialogflow.v2.ConversationProfile.update_time]
96100
// aren't populated in the response. You can retrieve them via
97101
// [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile]
98102
// API.
@@ -867,7 +871,7 @@ message SuggestionFeature {
867871
}
868872

869873
// The request message for
870-
// [ConversationProfiles.SetSuggestionFeature][].
874+
// [ConversationProfiles.SetSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.SetSuggestionFeatureConfig].
871875
message SetSuggestionFeatureConfigRequest {
872876
// Required. The Conversation Profile to add or update the suggestion feature
873877
// config. Format: `projects/<Project ID>/locations/<Location
@@ -884,7 +888,8 @@ message SetSuggestionFeatureConfigRequest {
884888
3 [(google.api.field_behavior) = REQUIRED];
885889
}
886890

887-
// The request message for [ConversationProfiles.ClearFeature][].
891+
// The request message for
892+
// [ConversationProfiles.ClearSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.ClearSuggestionFeatureConfig].
888893
message ClearSuggestionFeatureConfigRequest {
889894
// Required. The Conversation Profile to add or update the suggestion feature
890895
// config. Format: `projects/<Project ID>/locations/<Location
@@ -901,7 +906,8 @@ message ClearSuggestionFeatureConfigRequest {
901906
[(google.api.field_behavior) = REQUIRED];
902907
}
903908

904-
// Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][]
909+
// Metadata for a
910+
// [ConversationProfiles.SetSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.SetSuggestionFeatureConfig]
905911
// operation.
906912
message SetSuggestionFeatureConfigOperationMetadata {
907913
// The resource name of the conversation profile. Format:
@@ -922,7 +928,8 @@ message SetSuggestionFeatureConfigOperationMetadata {
922928
google.protobuf.Timestamp create_time = 4;
923929
}
924930

925-
// Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][]
931+
// Metadata for a
932+
// [ConversationProfiles.ClearSuggestionFeatureConfig][google.cloud.dialogflow.v2.ConversationProfiles.ClearSuggestionFeatureConfig]
926933
// operation.
927934
message ClearSuggestionFeatureConfigOperationMetadata {
928935
// The resource name of the conversation profile. Format:

‎google/cloud/dialogflow/v2/intent.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ message Intent {
256256
}
257257

258258
// Output only. The unique identifier of this training phrase.
259-
string name = 1;
259+
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
260260

261261
// Required. The type of the training phrase.
262262
Type type = 2 [(google.api.field_behavior) = REQUIRED];

‎google/cloud/dialogflow/v2/participant.proto‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -236,9 +236,9 @@ message Participant {
236236
// Dialogflow adds the obfuscated user id with the participant.
237237
//
238238
// 2. If you set this field in
239-
// [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
239+
// [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.participant]
240240
// or
241-
// [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
241+
// [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant],
242242
// Dialogflow will update
243243
// [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].
244244
//
@@ -481,8 +481,9 @@ message AnalyzeContentResponse {
481481
OutputAudio reply_audio = 2;
482482

483483
// Only set if a Dialogflow automated agent has responded.
484-
// Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
485-
// and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
484+
// Note that in [AutomatedAgentReply.DetectIntentResponse][],
485+
// [Sessions.DetectIntentResponse.output_audio][]
486+
// and [Sessions.DetectIntentResponse.output_audio_config][]
486487
// are always empty, use
487488
// [reply_audio][google.cloud.dialogflow.v2.AnalyzeContentResponse.reply_audio]
488489
// instead.
@@ -629,7 +630,8 @@ message StreamingAnalyzeContentRequest {
629630
// and
630631
// [AudioEncoding.AUDIO_ENCODING_MULAW][google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_MULAW]
631632
// - Lifecycle: conversation should be in `Assist Stage`, go to
632-
// [Conversation.CreateConversation][] for more information.
633+
// [Conversations.CreateConversation][google.cloud.dialogflow.v2.Conversations.CreateConversation]
634+
// for more information.
633635
//
634636
// InvalidArgument Error will be returned if the one of restriction checks
635637
// failed.
@@ -692,9 +694,9 @@ message StreamingAnalyzeContentResponse {
692694
// has content.
693695
OutputAudio reply_audio = 3;
694696

695-
// Only set if a Dialogflow automated agent has responded.
696-
// Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
697-
// and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
697+
// Note that in [AutomatedAgentReply.DetectIntentResponse][],
698+
// [Sessions.DetectIntentResponse.output_audio][]
699+
// and [Sessions.DetectIntentResponse.output_audio_config][]
698700
// are always empty, use
699701
// [reply_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio]
700702
// instead.

‎google/cloud/dialogflow/v2/session.proto‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ message DetectIntentRequest {
168168
bytes input_audio = 5;
169169
}
170170

171-
// The message returned from the DetectIntent method.
171+
// The message returned from the [DetectIntent][] method.
172172
message DetectIntentResponse {
173173
// The unique identifier of the response. It can be used to
174174
// locate a response in the training example set or for reporting issues.
@@ -299,8 +299,8 @@ message QueryResult {
299299
// was not set.
300300
//
301301
// This field is not guaranteed to be accurate or set. In particular this
302-
// field isn't set for StreamingDetectIntent since the streaming endpoint has
303-
// separate confidence estimates per portion of the audio in
302+
// field isn't set for [StreamingDetectIntent][] since the streaming endpoint
303+
// has separate confidence estimates per portion of the audio in
304304
// StreamingRecognitionResult.
305305
float speech_recognition_confidence = 2;
306306

@@ -387,8 +387,7 @@ message QueryResult {
387387
}
388388

389389
// The top-level message sent by the client to the
390-
// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]
391-
// method.
390+
// [StreamingDetectIntent][] method.
392391
//
393392
// Multiple request messages should be sent in order:
394393
//
@@ -562,11 +561,13 @@ message CloudConversationDebuggingInfo {
562561
}
563562

564563
// The top-level message returned from the
565-
// `StreamingDetectIntent` method.
564+
// [StreamingDetectIntent][] method.
566565
//
567566
// Multiple response messages can be returned in order:
568567
//
569-
// 1. If the `StreamingDetectIntentRequest.input_audio` field was
568+
// 1. If the
569+
// [StreamingDetectIntentRequest.input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio]
570+
// field was
570571
// set, the `recognition_result` field is populated for one
571572
// or more messages.
572573
// See the
@@ -605,7 +606,8 @@ message StreamingDetectIntentResponse {
605606
OutputAudioConfig output_audio_config = 6;
606607

607608
// Debugging info that would get populated when
608-
// `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
609+
// [StreamingDetectIntentRequest.enable_debugging_info][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.enable_debugging_info]
610+
// is set to true.
609611
CloudConversationDebuggingInfo debugging_info = 8;
610612
}
611613

@@ -765,9 +767,9 @@ message SentimentAnalysisRequestConfig {
765767
// The result of sentiment analysis. Sentiment analysis inspects user input
766768
// and identifies the prevailing subjective opinion, especially to determine a
767769
// user's attitude as positive, negative, or neutral.
768-
// For [Participants.DetectIntent][], it needs to be configured in
770+
// For [DetectIntent][], it needs to be configured in
769771
// [DetectIntentRequest.query_params][google.cloud.dialogflow.v2.DetectIntentRequest.query_params].
770-
// For [Participants.StreamingDetectIntent][], it needs to be configured in
772+
// For [StreamingDetectIntent][], it needs to be configured in
771773
// [StreamingDetectIntentRequest.query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params].
772774
// And for
773775
// [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]

0 commit comments

Comments
 (0)