docs: Clarify comments of ConversationView enum

Google APIs · copybara-github · commit 13a3c9e5f413 · 2022-01-19T07:35:47.000-08:00
PiperOrigin-RevId: 422809895
diff --git a/google/cloud/contactcenterinsights/v1/contact_center_insights.proto b/google/cloud/contactcenterinsights/v1/contact_center_insights.proto
@@ -355,6 +355,21 @@ service ContactCenterInsights {
   }
 }
 
+// Represents the options for viewing a conversation.
+enum ConversationView {
+  // The conversation view is not specified.
+  //
+  // * Defaults to `FULL` in `GetConversationRequest`.
+  // * Defaults to `BASIC` in `ListConversationsRequest`.
+  CONVERSATION_VIEW_UNSPECIFIED = 0;
+
+  // Populates all fields in the conversation.
+  FULL = 2;
+
+  // Populates all fields in the conversation except the transcript.
+  BASIC = 1;
+}
+
 // The request for calculating conversation statistics.
 message CalculateStatsRequest {
   // Required. The location of the conversations.
@@ -370,20 +385,6 @@ message CalculateStatsRequest {
   string filter = 2;
 }
 
-// Represents the options for views of a conversation.
-enum ConversationView {
-  // Not specified. Defaults to FULL on GetConversationRequest and BASIC for
-  // ListConversationsRequest.
-  CONVERSATION_VIEW_UNSPECIFIED = 0;
-
-  // Transcript field is not populated in the response for Insights
-  // conversation.
-  BASIC = 1;
-
-  // All fields are populated for Insights conversation.
-  FULL = 2;
-}
-
 // The response for calculating conversation statistics.
 message CalculateStatsResponse {
   // A time series representing conversations over time.
