feat: Support Chunk header and footer in Doc AI external proto

Google APIs · copybara-github · commit caad330c676f · 2024-04-22T11:24:05.000-07:00
docs: Keep the API doc up-to-date with recent changes

PiperOrigin-RevId: 627100297
diff --git a/google/cloud/documentai/v1beta3/document.proto b/google/cloud/documentai/v1beta3/document.proto
@@ -286,16 +286,16 @@ message Document {
         // Whether the text is underlined.
         bool underlined = 7;
 
-        // Whether the text is strikethrough.
+        // Whether the text is strikethrough. This feature is not supported yet.
         bool strikeout = 8;
 
-        // Whether the text is a subscript.
+        // Whether the text is a subscript. This feature is not supported yet.
         bool subscript = 9;
 
-        // Whether the text is a superscript.
+        // Whether the text is a superscript. This feature is not supported yet.
         bool superscript = 10;
 
-        // Whether the text is in small caps.
+        // Whether the text is in small caps. This feature is not supported yet.
         bool smallcaps = 11;
 
         // TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
@@ -1010,9 +1010,28 @@ message Document {
         int32 page_end = 2;
       }
 
+      // Represents the page header associated with the chunk.
+      message ChunkPageHeader {
+        // Header in text format.
+        string text = 1;
+
+        // Page span of the header.
+        ChunkPageSpan page_span = 2;
+      }
+
+      // Represents the page footer associated with the chunk.
+      message ChunkPageFooter {
+        // Footer in text format.
+        string text = 1;
+
+        // Page span of the footer.
+        ChunkPageSpan page_span = 2;
+      }
+
       // ID of the chunk.
       string chunk_id = 1;
 
+      // DO NOT USE.
       // List of all parsed documents layout source blocks used to generate the
       // chunk.
       repeated string source_block_ids = 2;
@@ -1022,6 +1041,12 @@ message Document {
 
       // Page span of the chunk.
       ChunkPageSpan page_span = 4;
+
+      // Page headers associated with the chunk.
+      repeated ChunkPageHeader page_headers = 5;
+
+      // Page footers associated with the chunk.
+      repeated ChunkPageFooter page_footers = 6;
     }
 
     // List of chunks.
