docs: clarified wording around document_correctness

Google APIs · copybara-github · commit 8dc944f48aaa · 2025-02-27T10:27:18.000-08:00
docs: clarified wording around use_timeout_based_endpointing
docs: clarified wording around BoostSpec and filter_specs
docs: clarified wording around send_time

PiperOrigin-RevId: 731775764
diff --git a/google/cloud/dialogflow/v2beta1/answer_record.proto b/google/cloud/dialogflow/v2beta1/answer_record.proto
@@ -298,7 +298,7 @@ message AgentAssistantFeedback {
   // * Suggested document says: "Items must be returned/exchanged within 60
   //   days of the purchase date."
   // * Ground truth: "No return or exchange is allowed."
-  // * [document_correctness]: INCORRECT
+  // * [document_correctness][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_correctness]: [INCORRECT][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.DocumentCorrectness.INCORRECT]
   DocumentCorrectness document_correctness = 2;
 
   // Optional. Whether or not the suggested document is efficient. For example,
diff --git a/google/cloud/dialogflow/v2beta1/audio_config.proto b/google/cloud/dialogflow/v2beta1/audio_config.proto
@@ -376,7 +376,7 @@ message SpeechToTextConfig {
   // information.
   bool enable_word_info = 9;
 
-  // Use timeout based endpointing, interpreting endpointer sensitivy as
+  // Use timeout based endpointing, interpreting endpointer sensitivity as
   // seconds of timeout value.
   bool use_timeout_based_endpointing = 11;
 }
diff --git a/google/cloud/dialogflow/v2beta1/conversation.proto b/google/cloud/dialogflow/v2beta1/conversation.proto
@@ -775,6 +775,10 @@ message SearchKnowledgeRequest {
   // Configuration specific to search queries with data stores.
   message SearchConfig {
     // Boost specifications for data stores.
+    //
+    // Maps from datastore name to their boost configuration. Do not specify
+    // more than one BoostSpecs for each datastore name. If multiple BoostSpecs
+    // are provided for the same datastore name, the behavior is undefined.
     message BoostSpecs {
       // Boost specification to boost certain documents.
       // A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
@@ -900,7 +904,7 @@ message SearchKnowledgeRequest {
         }
 
         // Optional. Condition boost specifications. If a document matches
-        // multiple conditions in the specifictions, boost scores from these
+        // multiple conditions in the specifications, boost scores from these
         // specifications are all applied and combined in a non-linear way.
         // Maximum number of specifications is 20.
         repeated ConditionBoostSpec condition_boost_specs = 1
@@ -941,6 +945,11 @@ message SearchKnowledgeRequest {
         [(google.api.field_behavior) = OPTIONAL];
 
     // Optional. Filter specification for data store queries.
+    //
+    // Maps from datastore name to the filter expression for that datastore. Do
+    // not specify more than one FilterSpecs for each datastore name. If
+    // multiple FilterSpecs are provided for the same datastore name, the
+    // behavior is undefined.
     repeated FilterSpecs filter_specs = 2
         [(google.api.field_behavior) = OPTIONAL];
   }
diff --git a/google/cloud/dialogflow/v2beta1/participant.proto b/google/cloud/dialogflow/v2beta1/participant.proto
@@ -373,7 +373,8 @@ message Message {
   google.protobuf.Timestamp create_time = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Optional. The time when the message was sent.
+  // Optional. The time when the message was sent. For voice messages, this is
+  // the time when an utterance started.
   google.protobuf.Timestamp send_time = 9
       [(google.api.field_behavior) = OPTIONAL];
 
@@ -725,8 +726,8 @@ message AnalyzeContentRequest {
   // CX agent.
   google.protobuf.Struct cx_parameters = 18;
 
-  // The unique identifier of the CX page to override the `current_page` in the
-  // session.
+  // The unique identifier of the Dialogflow CX page to override the
+  // `current_page` in the session.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   // ID>/flows/<Flow ID>/pages/<Page ID>`.
   //
@@ -952,8 +953,8 @@ message StreamingAnalyzeContentRequest {
   // CX agent.
   google.protobuf.Struct cx_parameters = 13;
 
-  // The unique identifier of the CX page to override the `current_page` in the
-  // session.
+  // The unique identifier of the Dialogflow CX page to override the
+  // `current_page` in the session.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   // ID>/flows/<Flow ID>/pages/<Page ID>`.
   //
@@ -989,11 +990,12 @@ message StreamingAnalyzeContentRequest {
   // https://cloud.google.com/agent-assist/docs/extended-streaming
   bool enable_extended_streaming = 11 [(google.api.field_behavior) = OPTIONAL];
 
-  // Enable partial virtual agent responses. If this flag is not enabled,
-  // response stream still contains only one final response even if some
-  // `Fulfillment`s in Dialogflow virtual agent have been configured to return
-  // partial responses.
-  bool enable_partial_automated_agent_reply = 12;
+  // Optional. Enable partial responses from Dialogflow CX agent. If this flag
+  // is not enabled, response stream still contains only one final response even
+  // if some `Fulfillment`s in Dialogflow CX agent have been configured to
+  // return partial responses.
+  bool enable_partial_automated_agent_reply = 12
+      [(google.api.field_behavior) = OPTIONAL];
 
   // if true, `StreamingAnalyzeContentResponse.debugging_info` will get
   // populated.
@@ -1631,7 +1633,8 @@ message ResponseMessage {
   //
   // You may set this, for example:
   //
-  // * In the entry fulfillment of a CX Page if entering the page indicates
+  // * In the entry fulfillment of a Dialogflow CX Page if entering the page
+  // indicates
   //   something went extremely wrong in the conversation.
   // * In a webhook response when you determine that the customer issue can only
   //   be handled by a human.
@@ -1741,7 +1744,7 @@ message SuggestKnowledgeAssistRequest {
   int32 context_size = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The previously suggested query for the given conversation. This
-  // helps identify whether the next suggestion we generate is resonably
+  // helps identify whether the next suggestion we generate is reasonably
   // different from the previous one. This is useful to avoid similar
   // suggestions within the conversation.
   string previous_suggested_query = 4 [(google.api.field_behavior) = OPTIONAL];

Original file line number	Diff line number	Diff line change
`@@ -376,7 +376,7 @@ message SpeechToTextConfig {`
`376`	`376`	`// information.`
`377`	`377`	`bool enable_word_info = 9;`
`378`	`378`
`379`		`- // Use timeout based endpointing, interpreting endpointer sensitivy as`
	`379`	`+ // Use timeout based endpointing, interpreting endpointer sensitivity as`
`380`	`380`	`// seconds of timeout value.`
`381`	`381`	`bool use_timeout_based_endpointing = 11;`
`382`	`382`	`}`