fix doc style

Author: dlarocque

common/api-review/vertexai.api.md

@@ -28,11 +28,9 @@ export interface BaseParams {
 
 // @public
 export enum BlockReason {
-    // (undocumented)
     BLOCKLIST = "BLOCKLIST",
     // (undocumented)
     OTHER = "OTHER",
-    // (undocumented)
     PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
     // (undocumented)
     SAFETY = "SAFETY"
@@ -161,21 +159,17 @@ export interface FileDataPart {
 
 // @public
 export enum FinishReason {
-    // (undocumented)
     BLOCKLIST = "BLOCKLIST",
-    // (undocumented)
     MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL",
     // (undocumented)
     MAX_TOKENS = "MAX_TOKENS",
     // (undocumented)
     OTHER = "OTHER",
-    // (undocumented)
     PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
     // (undocumented)
     RECITATION = "RECITATION",
     // (undocumented)
     SAFETY = "SAFETY",
-    // (undocumented)
     SPII = "SPII",
     // (undocumented)
     STOP = "STOP"

docs-devsite/vertexai.md

@@ -231,9 +231,9 @@ export declare enum BlockReason
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> |  |
+|  BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> | Content was blocked because it contained terms from the terminology blocklist. |
 |  OTHER | <code>&quot;OTHER&quot;</code> |  |
-|  PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> |  |
+|  PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> | Content was blocked due to prohibited content. |
 |  SAFETY | <code>&quot;SAFETY&quot;</code> |  |
 
 ## FinishReason
@@ -250,14 +250,14 @@ export declare enum FinishReason
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> |  |
-|  MALFORMED\_FUNCTION\_CALL | <code>&quot;MALFORMED_FUNCTION_CALL&quot;</code> |  |
+|  BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> | The candidate content contained forbidden terms. |
+|  MALFORMED\_FUNCTION\_CALL | <code>&quot;MALFORMED_FUNCTION_CALL&quot;</code> | The function call generated by the model was invalid. |
 |  MAX\_TOKENS | <code>&quot;MAX_TOKENS&quot;</code> |  |
 |  OTHER | <code>&quot;OTHER&quot;</code> |  |
-|  PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> |  |
+|  PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> | The candidate content potentially contained prohibited content. |
 |  RECITATION | <code>&quot;RECITATION&quot;</code> |  |
 |  SAFETY | <code>&quot;SAFETY&quot;</code> |  |
-|  SPII | <code>&quot;SPII&quot;</code> |  |
+|  SPII | <code>&quot;SPII&quot;</code> | The candidate content potentially contained Sensitive Personally Identifiable Information (SPII). |
 |  STOP | <code>&quot;STOP&quot;</code> |  |
 
 ## FunctionCallingMode

packages/vertexai/src/types/enums.ts

@@ -102,9 +102,13 @@ export enum BlockReason {
   SAFETY = 'SAFETY',
   // Content was blocked, but the reason is uncategorized.
   OTHER = 'OTHER',
-  // Content was blocked because it contained terms from the terminology blocklist.
+  /**
+   * Content was blocked because it contained terms from the terminology blocklist.
+   */
   BLOCKLIST = 'BLOCKLIST',
-  // Content was blocked due to prohibited content.
+  /**
+   * Content was blocked due to prohibited content.
+   */
   PROHIBITED_CONTENT = 'PROHIBITED_CONTENT'
 }
 
@@ -123,13 +127,21 @@ export enum FinishReason {
   RECITATION = 'RECITATION',
   // Unknown reason.
   OTHER = 'OTHER',
-  // The candidate content contained forbidden terms.
+  /**
+   * The candidate content contained forbidden terms.
+   */
   BLOCKLIST = 'BLOCKLIST',
-  // The candidate content potentially contained prohibited content.
+  /**
+   * The candidate content potentially contained prohibited content.
+   */
   PROHIBITED_CONTENT = 'PROHIBITED_CONTENT',
-  // The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
+  /**
+   * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
+   */
   SPII = 'SPII',
-  // The function call generated by the model was invalid.
+  /**
+   * The function call generated by the model was invalid.
+   */
   MALFORMED_FUNCTION_CALL = 'MALFORMED_FUNCTION_CALL'
 }