OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-27 20:30:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_documentai1_beta2/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

76 lines
33 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_documentai1_beta2`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_documentai1_beta2::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_documentai1_beta2/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_documentai1_beta2</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_documentai1_beta2</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_documentai1_beta2/api.rs.html#1-3227" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.Document.html" title="google_documentai1_beta2::api::Document struct">Document</a></td><td class="docblock-short"><p>Central instance to access all Document related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2AutoMlParams.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2AutoMlParams struct">GoogleCloudDocumentaiV1beta2AutoMlParams</a></td><td class="docblock-short"><p>Parameters to control AutoML model prediction behavior.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest struct">GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest</a></td><td class="docblock-short"><p>Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the <a href="../../google_documentai1_beta2/api/struct.Document.html" title="Document">Document</a> format.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2BoundingPoly.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2BoundingPoly struct">GoogleCloudDocumentaiV1beta2BoundingPoly</a></td><td class="docblock-short"><p>A bounding polygon for the detected image annotation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2Document.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2Document struct">GoogleCloudDocumentaiV1beta2Document</a></td><td class="docblock-short"><p>Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentEntity.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentEntity struct">GoogleCloudDocumentaiV1beta2DocumentEntity</a></td><td class="docblock-short"><p>A phrase in the text that is a known entity type, such as a person, an organization, or location.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue struct">GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue</a></td><td class="docblock-short"><p>Parsed and normalized entity value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentEntityRelation.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentEntityRelation struct">GoogleCloudDocumentaiV1beta2DocumentEntityRelation</a></td><td class="docblock-short"><p>Relationship between Entities.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentLabel.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentLabel struct">GoogleCloudDocumentaiV1beta2DocumentLabel</a></td><td class="docblock-short"><p>Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPage.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPage struct">GoogleCloudDocumentaiV1beta2DocumentPage</a></td><td class="docblock-short"><p>A page in a Document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageAnchor.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageAnchor struct">GoogleCloudDocumentaiV1beta2DocumentPageAnchor</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef struct">GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef</a></td><td class="docblock-short"><p>Represents a weak reference to a page element within a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageBlock.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageBlock struct">GoogleCloudDocumentaiV1beta2DocumentPageBlock</a></td><td class="docblock-short"><p>A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage struct">GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage</a></td><td class="docblock-short"><p>Detected language for a structural component.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageDimension.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageDimension struct">GoogleCloudDocumentaiV1beta2DocumentPageDimension</a></td><td class="docblock-short"><p>Dimension for the page.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageFormField.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageFormField struct">GoogleCloudDocumentaiV1beta2DocumentPageFormField</a></td><td class="docblock-short"><p>A form field detected on the page.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageImage.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageImage struct">GoogleCloudDocumentaiV1beta2DocumentPageImage</a></td><td class="docblock-short"><p>Rendered image contents for this page.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageLayout.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageLayout struct">GoogleCloudDocumentaiV1beta2DocumentPageLayout</a></td><td class="docblock-short"><p>Visual element describing a layout unit on a page.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageLine.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageLine struct">GoogleCloudDocumentaiV1beta2DocumentPageLine</a></td><td class="docblock-short"><p>A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageMatrix.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageMatrix struct">GoogleCloudDocumentaiV1beta2DocumentPageMatrix</a></td><td class="docblock-short"><p>Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageParagraph.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageParagraph struct">GoogleCloudDocumentaiV1beta2DocumentPageParagraph</a></td><td class="docblock-short"><p>A collection of lines that a human would perceive as a paragraph.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageTable.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageTable struct">GoogleCloudDocumentaiV1beta2DocumentPageTable</a></td><td class="docblock-short"><p>A table representation similar to HTML table structure.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell struct">GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell</a></td><td class="docblock-short"><p>A cell representation inside the table.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow struct">GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow</a></td><td class="docblock-short"><p>A row of table cells.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageToken.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageToken struct">GoogleCloudDocumentaiV1beta2DocumentPageToken</a></td><td class="docblock-short"><p>A detected token.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak struct">GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak</a></td><td class="docblock-short"><p>Detected break at the end of a Token.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentPageVisualElement.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentPageVisualElement struct">GoogleCloudDocumentaiV1beta2DocumentPageVisualElement</a></td><td class="docblock-short"><p>Detected non-text visual elements e.g. checkbox, signature etc. on the page.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentProvenance.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentProvenance struct">GoogleCloudDocumentaiV1beta2DocumentProvenance</a></td><td class="docblock-short"><p>Structure to identify provenance relationships between annotations in different revisions.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentProvenanceParent.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentProvenanceParent struct">GoogleCloudDocumentaiV1beta2DocumentProvenanceParent</a></td><td class="docblock-short"><p>Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentRevision.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentRevision struct">GoogleCloudDocumentaiV1beta2DocumentRevision</a></td><td class="docblock-short"><p>Contains past or forward revisions of this document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview struct">GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview</a></td><td class="docblock-short"><p>Human Review information of the document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentShardInfo.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentShardInfo struct">GoogleCloudDocumentaiV1beta2DocumentShardInfo</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentStyle.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentStyle struct">GoogleCloudDocumentaiV1beta2DocumentStyle</a></td><td class="docblock-short"><p>Annotation for common text style attributes. This adheres to CSS conventions as much as possible.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentStyleFontSize.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentStyleFontSize struct">GoogleCloudDocumentaiV1beta2DocumentStyleFontSize</a></td><td class="docblock-short"><p>Font size with unit.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentTextAnchor.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentTextAnchor struct">GoogleCloudDocumentaiV1beta2DocumentTextAnchor</a></td><td class="docblock-short"><p>Text reference indexing into the Document.text.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment struct">GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment</a></td><td class="docblock-short"><p>A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2DocumentTextChange.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2DocumentTextChange struct">GoogleCloudDocumentaiV1beta2DocumentTextChange</a></td><td class="docblock-short"><p>This message is used for text changes aka. OCR corrections.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2EntityExtractionParams.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2EntityExtractionParams struct">GoogleCloudDocumentaiV1beta2EntityExtractionParams</a></td><td class="docblock-short"><p>Parameters to control entity extraction behavior.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2FormExtractionParams.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2FormExtractionParams struct">GoogleCloudDocumentaiV1beta2FormExtractionParams</a></td><td class="docblock-short"><p>Parameters to control form extraction behavior.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2GcsDestination.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2GcsDestination struct">GoogleCloudDocumentaiV1beta2GcsDestination</a></td><td class="docblock-short"><p>The Google Cloud Storage location where the output file will be written to.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2GcsSource.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2GcsSource struct">GoogleCloudDocumentaiV1beta2GcsSource</a></td><td class="docblock-short"><p>The Google Cloud Storage location where the input file will be read from.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2InputConfig.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2InputConfig struct">GoogleCloudDocumentaiV1beta2InputConfig</a></td><td class="docblock-short"><p>The desired input location and metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2KeyValuePairHint.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2KeyValuePairHint struct">GoogleCloudDocumentaiV1beta2KeyValuePairHint</a></td><td class="docblock-short"><p>Reserved for future use.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2NormalizedVertex.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2NormalizedVertex struct">GoogleCloudDocumentaiV1beta2NormalizedVertex</a></td><td class="docblock-short"><p>A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2OcrParams.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2OcrParams struct">GoogleCloudDocumentaiV1beta2OcrParams</a></td><td class="docblock-short"><p>Parameters to control Optical Character Recognition (OCR) behavior.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2OutputConfig.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2OutputConfig struct">GoogleCloudDocumentaiV1beta2OutputConfig</a></td><td class="docblock-short"><p>The desired output location and metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2ProcessDocumentRequest.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2ProcessDocumentRequest struct">GoogleCloudDocumentaiV1beta2ProcessDocumentRequest</a></td><td class="docblock-short"><p>Request to process one document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2TableBoundHint.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2TableBoundHint struct">GoogleCloudDocumentaiV1beta2TableBoundHint</a></td><td class="docblock-short"><p>A hint for a table bounding box on the page for table parsing.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2TableExtractionParams.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2TableExtractionParams struct">GoogleCloudDocumentaiV1beta2TableExtractionParams</a></td><td class="docblock-short"><p>Parameters to control table extraction behavior.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleCloudDocumentaiV1beta2Vertex.html" title="google_documentai1_beta2::api::GoogleCloudDocumentaiV1beta2Vertex struct">GoogleCloudDocumentaiV1beta2Vertex</a></td><td class="docblock-short"><p>A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleLongrunningOperation.html" title="google_documentai1_beta2::api::GoogleLongrunningOperation struct">GoogleLongrunningOperation</a></td><td class="docblock-short"><p>This resource represents a long-running operation that is the result of a network API call.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleRpcStatus.html" title="google_documentai1_beta2::api::GoogleRpcStatus struct">GoogleRpcStatus</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> 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 <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypeColor.html" title="google_documentai1_beta2::api::GoogleTypeColor struct">GoogleTypeColor</a></td><td class="docblock-short"><p>Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of <code>java.awt.Color</code> in Java; it can also be trivially provided to UIColor's <code>+colorWithRed:green:blue:alpha</code> method in iOS; and, with just a little work, it can be easily formatted into a CSS <code>rgba()</code> string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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:&amp;red green:&amp;green blue:&amp;blue alpha:&amp;alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha &lt;= 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 &lt;&lt; 16) | (green &lt;&lt; 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i &lt; missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypeDate.html" title="google_documentai1_beta2::api::GoogleTypeDate struct">GoogleTypeDate</a></td><td class="docblock-short"><p>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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and <code>google.protobuf.Timestamp</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypeDateTime.html" title="google_documentai1_beta2::api::GoogleTypeDateTime struct">GoogleTypeDateTime</a></td><td class="docblock-short"><p>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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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 <code>time_offset</code> oneof is set. Consider using <code>Timestamp</code> 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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypeMoney.html" title="google_documentai1_beta2::api::GoogleTypeMoney struct">GoogleTypeMoney</a></td><td class="docblock-short"><p>Represents an amount of money with its currency type.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypePostalAddress.html" title="google_documentai1_beta2::api::GoogleTypePostalAddress struct">GoogleTypePostalAddress</a></td><td class="docblock-short"><p>Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-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, please see: https://support.google.com/business/answer/6397478</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleTypeTimeZone.html" title="google_documentai1_beta2::api::GoogleTypeTimeZone struct">GoogleTypeTimeZone</a></td><td class="docblock-short"><p>Represents a time zone from the <a href="https://www.iana.org/time-zones">IANA Time Zone Database</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDocumentBatchProcesCall.html" title="google_documentai1_beta2::api::ProjectDocumentBatchProcesCall struct">ProjectDocumentBatchProcesCall</a></td><td class="docblock-short"><p>LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the <a href="../../google_documentai1_beta2/api/struct.Document.html" title="Document">Document</a> format.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDocumentProcesCall.html" title="google_documentai1_beta2::api::ProjectDocumentProcesCall struct">ProjectDocumentProcesCall</a></td><td class="docblock-short"><p>Processes a single document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationDocumentBatchProcesCall.html" title="google_documentai1_beta2::api::ProjectLocationDocumentBatchProcesCall struct">ProjectLocationDocumentBatchProcesCall</a></td><td class="docblock-short"><p>LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the <a href="../../google_documentai1_beta2/api/struct.Document.html" title="Document">Document</a> format.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationDocumentProcesCall.html" title="google_documentai1_beta2::api::ProjectLocationDocumentProcesCall struct">ProjectLocationDocumentProcesCall</a></td><td class="docblock-short"><p>Processes a single document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationGetCall.html" title="google_documentai1_beta2::api::ProjectLocationOperationGetCall struct">ProjectLocationOperationGetCall</a></td><td class="docblock-short"><p>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_documentai1_beta2::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
It is not used directly, but through the <code>Document</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectOperationGetCall.html" title="google_documentai1_beta2::api::ProjectOperationGetCall struct">ProjectOperationGetCall</a></td><td class="docblock-short"><p>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_documentai1_beta2::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
A scope is needed when requesting an
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_documentai1_beta2"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink