--- title: "POST /v1/{+parent}/schemaVersions:generate" method: POST path: "/v1/{+parent}/schemaVersions:generate" tags: ["projects"] --- # POST /v1/{+parent}/schemaVersions:generate `POST /v1/{+parent}/schemaVersions:generate` Generates a schema version. ## Path parameters - `parent` string, required ## Request body - GoogleCloudDocumentaiV1GenerateSchemaVersionRequest — Request message for GenerateSchemaVersion. - `inlineDocuments` GoogleCloudDocumentaiV1Documents — A set of inline documents. - `documents` GoogleCloudDocumentaiV1Document[] — The list of documents. - `documentLayout` GoogleCloudDocumentaiV1DocumentDocumentLayout — Represents the parsed layout of a document as a collection of blocks that the document is divided into. - `blocks` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[] — List of blocks in the document. - `tableBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock — Represents a table type block. - `bodyRows` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[] — Body rows containing main table content. - … - `caption` string — Table caption/title. - `headerRows` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[] — Header rows at the top of the table. - … - `annotations` GoogleCloudDocumentaiV1DocumentAnnotations — Represents the annotation of a block or a chunk. - … - `listBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock — Represents a list type block. - `listEntries` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[] — List entries that constitute a list block. - … - `type` string — Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - `boundingBox` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - `vertices` GoogleCloudDocumentaiV1Vertex[] — The bounding polygon vertices. - … - `normalizedVertices` GoogleCloudDocumentaiV1NormalizedVertex[] — The bounding polygon normalized vertices. - … - `blockId` string — ID of the block. - `textBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock — Represents a text type block. - `type` string — Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. - `annotations` GoogleCloudDocumentaiV1DocumentAnnotations — Represents the annotation of a block or a chunk. - … - `blocks` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[] — A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - `text` string — Text content stored in the block. - `imageBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock — Represents an image type block. - `blobAssetId` string — Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. - `annotations` GoogleCloudDocumentaiV1DocumentAnnotations — Represents the annotation of a block or a chunk. - … - `gcsUri` string — Optional. Google Cloud Storage URI of the image. - `mimeType` string — Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). - `imageText` string — Text extracted from the image using OCR or alt text describing the image. - `dataUri` string — Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - `pageSpan` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan — Represents where the block starts and ends in the document. - `pageEnd` integer — Page where block ends in the document. - `pageStart` integer — Page where block starts in the document. - `uri` string — Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). - `textStyles` GoogleCloudDocumentaiV1DocumentStyle[] — Styles for the Document.text. - `textDecoration` string — [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - `fontFamily` string — Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - `color` GoogleTypeColor — Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - `green` number, float — The amount of green in the color as a value in the interval [0, 1]. - `blue` number, float — The amount of blue in the color as a value in the interval [0, 1]. - `alpha` number, float — The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - `red` number, float — The amount of red in the color as a value in the interval [0, 1]. - `textStyle` string — [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - `backgroundColor` GoogleTypeColor — Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - `green` number, float — The amount of green in the color as a value in the interval [0, 1]. - `blue` number, float — The amount of blue in the color as a value in the interval [0, 1]. - `alpha` number, float — The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - `red` number, float — The amount of red in the color as a value in the interval [0, 1]. - `fontWeight` string — [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `content` string — Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - `fontSize` GoogleCloudDocumentaiV1DocumentStyleFontSize — Font size with unit. - `size` number, float — Font size for the text. - `unit` string — Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `text` string — Optional. UTF-8 encoded text in reading order from the document. - `pages` GoogleCloudDocumentaiV1DocumentPage[] — Visual page layout for the Document. - `paragraphs` GoogleCloudDocumentaiV1DocumentPageParagraph[] — A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `tables` GoogleCloudDocumentaiV1DocumentPageTable[] — A list of visually detected tables on the page. - `headerRows` GoogleCloudDocumentaiV1DocumentPageTableTableRow[] — Header rows of the table. - `cells` GoogleCloudDocumentaiV1DocumentPageTableTableCell[] — Cells that make up this row. - … - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `bodyRows` GoogleCloudDocumentaiV1DocumentPageTableTableRow[] — Body rows of the table. - `cells` GoogleCloudDocumentaiV1DocumentPageTableTableCell[] — Cells that make up this row. - … - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `symbols` GoogleCloudDocumentaiV1DocumentPageSymbol[] — A list of visually detected symbols on the page. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `dimension` GoogleCloudDocumentaiV1DocumentPageDimension — Dimension for the page. - `width` number, float — Page width. - `height` number, float — Page height. - `unit` string — Dimension unit. - `formFields` GoogleCloudDocumentaiV1DocumentPageFormField[] — A list of visually detected form fields on the page. - `fieldValue` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `valueDetectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages for value together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `fieldName` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `correctedKeyText` string — Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - `valueType` string — If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` - `nameDetectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages for name together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `correctedValueText` string — Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - `transforms` GoogleCloudDocumentaiV1DocumentPageMatrix[] — Transformation matrices that were applied to the original document image to produce Page.image. - `rows` integer — Number of rows in the matrix. - `cols` integer — Number of columns in the matrix. - `data` string, byte — The matrix data. - `type` integer — This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - `pageNumber` integer — 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `revision` integer — The index of the index into current revision's parent_ids list. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The ID of the parent provenance. - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `detectedBarcodes` GoogleCloudDocumentaiV1DocumentPageDetectedBarcode[] — A list of detected barcodes. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `barcode` GoogleCloudDocumentaiV1Barcode — Encodes the detailed information of a barcode. - `format` string — Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - `rawValue` string — Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - `valueFormat` string — Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. - `lines` GoogleCloudDocumentaiV1DocumentPageLine[] — A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `imageQualityScores` GoogleCloudDocumentaiV1DocumentPageImageQualityScores — Image quality scores for the page image. - `qualityScore` number, float — The overall quality score. Range `[0, 1]` where `1` is perfect quality. - `detectedDefects` GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect[] — A list of detected defects. - `type` string — Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` - `confidence` number, float — Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - `visualElements` GoogleCloudDocumentaiV1DocumentPageVisualElement[] — A list of detected non-text visual elements, for example, checkbox, signature etc. on the page. - `type` string — Type of the VisualElement. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - `vertices` GoogleCloudDocumentaiV1Vertex[] — The bounding polygon vertices. - … - `normalizedVertices` GoogleCloudDocumentaiV1NormalizedVertex[] — The bounding polygon normalized vertices. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - … - `content` string — Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `blocks` GoogleCloudDocumentaiV1DocumentPageBlock[] — A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `image` GoogleCloudDocumentaiV1DocumentPageImage — Rendered image contents for this page. - `content` string, byte — Raw byte content of the image. - `width` integer — Width of the image in pixels. - `height` integer — Height of the image in pixels. - `mimeType` string — Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - `tokens` GoogleCloudDocumentaiV1DocumentPageToken[] — A list of visually detected tokens on the page. - `detectedBreak` GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak — Detected break at the end of a Token. - `type` 'TYPE_UNSPECIFIED' | 'SPACE' | 'WIDE_SPACE' | 'HYPHEN' — Detected break type. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `confidence` number, float — Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `styleInfo` GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo — Font and other text style attributes. - `fontWeight` integer — TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - `fontSize` integer — Font size in points (`1` point is `¹⁄₇₂` inches). - `fontType` string — Name or style of the font. - `bold` boolean — Whether the text is bold (equivalent to font_weight is at least `700`). - `underlined` boolean — Whether the text is underlined. - `italic` boolean — Whether the text is italic. - `strikeout` boolean — Whether the text is strikethrough. This feature is not supported yet. - `textColor` GoogleTypeColor — Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - … - `pixelFontSize` number, double — Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - `smallcaps` boolean — Whether the text is in small caps. This feature is not supported yet. - `subscript` boolean — Whether the text is a subscript. This feature is not supported yet. - `letterSpacing` number, double — Letter spacing in points. - `handwritten` boolean — Whether the text is handwritten. - `superscript` boolean — Whether the text is a superscript. This feature is not supported yet. - `backgroundColor` GoogleTypeColor — Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `blobAssets` GoogleCloudDocumentaiV1DocumentBlobAsset[] — Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - `content` string, byte — Optional. The content of the blob asset, for example, image bytes. - `assetId` string — Optional. The ID of the blob asset. - `mimeType` string — The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - `docid` string — Optional. An internal identifier for document. Should be loggable (no PII). - `entitiesRevisions` GoogleCloudDocumentaiV1DocumentEntitiesRevision[] — A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `revision` integer — The index of the index into current revision's parent_ids list. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The ID of the parent provenance. - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `revisionId` string — The revision id. - `entities` GoogleCloudDocumentaiV1DocumentEntity[] — The entities in this revision. - `redacted` boolean — Optional. Whether the entity will be redacted for de-identification purposes. - `confidence` number, float — Optional. Confidence of detected Schema entity. Range `[0, 1]`. - `normalizedValue` GoogleCloudDocumentaiV1DocumentEntityNormalizedValue — Parsed and normalized entity value. - `integerValue` integer — Integer value. - `moneyValue` GoogleTypeMoney — Represents an amount of money with its currency type. - … - `signatureValue` boolean — A signature, which is a graphical representation of a person's name, often used to sign a document. - `dateValue` GoogleTypeDate — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - … - `addressValue` GoogleTypePostalAddress — Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. - … - `booleanValue` boolean — Boolean value. Can be used for entities with binary values, or for checkboxes. - `floatValue` number, float — Float value. - `datetimeValue` GoogleTypeDateTime — Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. - … - `text` string — Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. - `mentionId` string — Optional. Deprecated. Use `id` field instead. - `id` string — Optional. Canonical id. This will be a unique value in the entity list for this document. - `method` 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' — Optional. Specifies how the entity's value is obtained. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - … - `content` string — Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - `type` string — Required. Entity type from a schema, for example, `Address`. - `pageAnchor` GoogleCloudDocumentaiV1DocumentPageAnchor — Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - `pageRefs` GoogleCloudDocumentaiV1DocumentPageAnchorPageRef[] — One or more references to visual page elements - … - `mentionText` string — Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`. - `properties` GoogleCloudDocumentaiV1DocumentEntity[] — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `entityValidationOutput` GoogleCloudDocumentaiV1DocumentEntityValidationOutput — The output of the validation given the document and the validation rules. - `validationResults` GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[] — The result of each validation rule. - `ruleDescription` string — The description of the validation rule. - `validationResultType` 'VALIDATION_RESULT_TYPE_UNSPECIFIED' | 'VALIDATION_RESULT_TYPE_VALID' | 'VALIDATION_RESULT_TYPE_INVALID' | 'VALIDATION_RESULT_TYPE_SKIPPED' | 'VALIDATION_RESULT_TYPE_NOT_APPLICABLE' — The result of the validation rule. - `rule` string — Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` - `ruleName` string — The display name of the validation rule. - `validationDetails` string — The detailed information of the running the validation process using the entity from the document based on the validation rule. - `passAllRules` boolean — The overall result of the validation, true if all applicable rules are valid. - `entityRelations` GoogleCloudDocumentaiV1DocumentEntityRelation[] — Placeholder. Relationship among Document.entities. - `subjectId` string — Subject entity id. - `relation` string — Relationship description. - `objectId` string — Object entity id. - `revisions` GoogleCloudDocumentaiV1DocumentRevision[] — Placeholder. Revision history of this document. - `processor` string — If the annotation was made by processor identify the processor by its resource name. - `humanReview` GoogleCloudDocumentaiV1DocumentRevisionHumanReview — Human Review information of the document. - `state` string — Human review state. For example, `requested`, `succeeded`, `rejected`. - `stateMessage` string — A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - `parent` integer[] — The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. - `createTime` string, google-datetime — The time that the revision was created, internally generated by doc proto storage at the time of create. - `parentIds` string[] — The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. - `id` string — ID of the revision, internally generated by doc proto storage. Unique within the context of the document. - `agent` string — If the change was made by a person specify the name or ID of that person. - `entities` GoogleCloudDocumentaiV1DocumentEntity[] — A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - `redacted` boolean — Optional. Whether the entity will be redacted for de-identification purposes. - `confidence` number, float — Optional. Confidence of detected Schema entity. Range `[0, 1]`. - `normalizedValue` GoogleCloudDocumentaiV1DocumentEntityNormalizedValue — Parsed and normalized entity value. - `integerValue` integer — Integer value. - `moneyValue` GoogleTypeMoney — Represents an amount of money with its currency type. - `currencyCode` string — The three-letter currency code defined in ISO 4217. - `units` string, int64 — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - `nanos` integer — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - `signatureValue` boolean — A signature, which is a graphical representation of a person's name, often used to sign a document. - `dateValue` GoogleTypeDate — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `addressValue` GoogleTypePostalAddress — Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. - `recipients` string[] — Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `locality` string — Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. - `sublocality` string — Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. - `addressLines` string[] — Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `sortingCode` string — Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). - `regionCode` string — Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. - `administrativeArea` string — Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. - `languageCode` string — Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `postalCode` string — Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). - `organization` string — Optional. The name of the organization at the address. - `revision` integer — The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `booleanValue` boolean — Boolean value. Can be used for entities with binary values, or for checkboxes. - `floatValue` number, float — Float value. - `datetimeValue` GoogleTypeDateTime — Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. - `year` integer — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. - `seconds` integer — Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. - `hours` integer — Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. - `nanos` integer — Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. - `timeZone` GoogleTypeTimeZone — Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). - … - `minutes` integer — Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. - `month` integer — Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. - `utcOffset` string, google-duration — UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. - `day` integer — Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. - `text` string — Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. - `mentionId` string — Optional. Deprecated. Use `id` field instead. - `id` string — Optional. Canonical id. This will be a unique value in the entity list for this document. - `method` 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' — Optional. Specifies how the entity's value is obtained. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `content` string — Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - `type` string — Required. Entity type from a schema, for example, `Address`. - `pageAnchor` GoogleCloudDocumentaiV1DocumentPageAnchor — Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - `pageRefs` GoogleCloudDocumentaiV1DocumentPageAnchorPageRef[] — One or more references to visual page elements - `page` string, int64 — Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. - `layoutId` string — Optional. Deprecated. Use PageRef.bounding_poly instead. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `confidence` number, float — Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - `layoutType` 'LAYOUT_TYPE_UNSPECIFIED' | 'BLOCK' | 'PARAGRAPH' | 'LINE' | 'TOKEN' | 'VISUAL_ELEMENT' | 'TABLE' | 'FORM_FIELD' — Optional. The type of the layout element that is being referenced if any. - `mentionText` string — Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`. - `properties` GoogleCloudDocumentaiV1DocumentEntity[] — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `revision` integer — The index of the index into current revision's parent_ids list. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The ID of the parent provenance. - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `entitiesRevisionId` string — The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. - `mimeType` string — An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - `shardInfo` GoogleCloudDocumentaiV1DocumentShardInfo — For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. - `pageOffset` integer — The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter. - `shardIndex` string, int64 — The 0-based index of this shard. - `shardCount` string, int64 — Total number of shards. - `textOffset` string, int64 — The index of the first character in Document.text in the overall document global text. - `textChanges` GoogleCloudDocumentaiV1DocumentTextChange[] — Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `content` string — Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - `changedText` string — The text that replaces the text identified in the `text_anchor`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance[] — The history of this annotation. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `revision` integer — The index of the index into current revision's parent_ids list. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The ID of the parent provenance. - `revision` integer — The index of the revision that produced this element. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `id` integer — The ID of this operation. Needs to be unique within the scope of the revision. - `chunkedDocument` GoogleCloudDocumentaiV1DocumentChunkedDocument — Represents the chunks that the document is divided into. - `chunks` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[] — List of chunks. - `sourceBlockIds` string[] — Unused. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - `pageEnd` integer — Page where chunk ends in the document. - `pageStart` integer — Page where chunk starts in the document. - `pageFooters` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter[] — Page footers associated with the chunk. - `text` string — Footer in text format. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - … - `chunkId` string — ID of the chunk. - `pageHeaders` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader[] — Page headers associated with the chunk. - `text` string — Header in text format. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - … - `chunkFields` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField[] — Chunk fields inside this chunk. - `tableChunkField` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField — The table chunk field in the chunk. - … - `imageChunkField` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField — The image chunk field in the chunk. - … - `content` string — Text content of the chunk. - `content` string, byte — Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - `entityValidationOutput` GoogleCloudDocumentaiV1DocumentEntityValidationOutput — The output of the validation given the document and the validation rules. - `validationResults` GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[] — The result of each validation rule. - `ruleDescription` string — The description of the validation rule. - `validationResultType` 'VALIDATION_RESULT_TYPE_UNSPECIFIED' | 'VALIDATION_RESULT_TYPE_VALID' | 'VALIDATION_RESULT_TYPE_INVALID' | 'VALIDATION_RESULT_TYPE_SKIPPED' | 'VALIDATION_RESULT_TYPE_NOT_APPLICABLE' — The result of the validation rule. - `rule` string — Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` - `ruleName` string — The display name of the validation rule. - `validationDetails` string — The detailed information of the running the validation process using the entity from the document based on the validation rule. - `passAllRules` boolean — The overall result of the validation, true if all applicable rules are valid. - `baseSchemaVersion` string — The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` - `gcsPrefix` GoogleCloudDocumentaiV1GcsPrefix — Specifies all documents on Cloud Storage with a common prefix. - `gcsUriPrefix` string — The URI prefix. - `generateSchemaVersionParams` GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams — The parameters for the schema generation. - `prompt` string — Optional. The prompt used for the schema generation. - `history` GoogleCloudDocumentaiV1SchemaGenerationHistory — The history of schema generation iterations. - `iterations` GoogleCloudDocumentaiV1SchemaGenerationIteration[] — Required. Previous prompt-answers in a chronological order. - `prompt` string — Optional. The prompt used for the iteration. - `generatedSchema` GoogleCloudDocumentaiV1SchemaVersion — SchemaVersion is a version of the Schema which is created in SchemaGroup. - `displayName` string — Required. The user-defined name of the SchemaVersion. - `labels` object — Optional. The {{gcp_name_short}} labels for the SchemaVersion. - `schema` GoogleCloudDocumentaiV1DocumentSchema — The schema defines the output of the processed document by a processor. - `documentPrompt` string — Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. - `description` string — Description of the schema. - `entityTypes` GoogleCloudDocumentaiV1DocumentSchemaEntityType[] — Entity types of the schema. - … - `displayName` string — Display name to show users. - `metadata` GoogleCloudDocumentaiV1DocumentSchemaMetadata — Metadata for global schema behavior. - … - `name` string — Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` - `createTime` string, google-datetime — Output only. The time when the SchemaVersion was created. - `adjustedSchema` GoogleCloudDocumentaiV1SchemaVersion — SchemaVersion is a version of the Schema which is created in SchemaGroup. - `displayName` string — Required. The user-defined name of the SchemaVersion. - `labels` object — Optional. The {{gcp_name_short}} labels for the SchemaVersion. - `schema` GoogleCloudDocumentaiV1DocumentSchema — The schema defines the output of the processed document by a processor. - `documentPrompt` string — Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. - `description` string — Description of the schema. - `entityTypes` GoogleCloudDocumentaiV1DocumentSchemaEntityType[] — Entity types of the schema. - … - `displayName` string — Display name to show users. - `metadata` GoogleCloudDocumentaiV1DocumentSchemaMetadata — Metadata for global schema behavior. - … - `name` string — Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` - `createTime` string, google-datetime — Output only. The time when the SchemaVersion was created. - `rawDocuments` GoogleCloudDocumentaiV1RawDocuments — Specifies a set of raw documents. - `documents` GoogleCloudDocumentaiV1RawDocument[] — Specifies raw document content and mime type. - `displayName` string — The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated. - `content` string, byte — Inline document content. - `mimeType` string — An IANA MIME type (RFC6838) indicating the nature and format of the content. - `gcsDocuments` GoogleCloudDocumentaiV1GcsDocuments — Specifies a set of documents on Cloud Storage. - `documents` GoogleCloudDocumentaiV1GcsDocument[] — The list of documents. - `gcsUri` string — The Cloud Storage object uri. - `mimeType` string — An IANA MIME type (RFC6838) of the content. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/documentai.md) · [All operations](https://skmtc.dev/google/apis/documentai/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/documentai/revisions/88d43b76c9f3/schema)