Skip to content

Commit

Permalink
feat: properly mark TrainingPhrase name field output-only
Browse files Browse the repository at this point in the history
docs: fixed the references to proto method / fields

PiperOrigin-RevId: 702736565
  • Loading branch information
Google APIs authored and copybara-github committed Dec 4, 2024
1 parent 673721b commit 6989f67
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 37 deletions.
5 changes: 3 additions & 2 deletions google/cloud/dialogflow/v2/answer_record.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/dialogflow/v2/audio_config.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 10 additions & 6 deletions google/cloud/dialogflow/v2/conversation.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}

Expand Down
4 changes: 2 additions & 2 deletions google/cloud/dialogflow/v2/conversation_dataset.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -340,5 +340,5 @@ message CreateConversationDatasetOperationMetadata {
}];
}

// Metadata for [ConversationDatasets][DeleteConversationDataset].
// Metadata for [DeleteConversationDataset][].
message DeleteConversationDatasetOperationMetadata {}
19 changes: 13 additions & 6 deletions google/cloud/dialogflow/v2/conversation_profile.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/dialogflow/v2/intent.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
18 changes: 10 additions & 8 deletions google/cloud/dialogflow/v2/participant.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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].
//
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
22 changes: 12 additions & 10 deletions google/cloud/dialogflow/v2/session.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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:
//
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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;
}

Expand Down Expand Up @@ -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]
Expand Down

0 comments on commit 6989f67

Please sign in to comment.