[][src]Crate google_documentai1_beta2

This documentation was generated from Document crate version 1.0.14+20200619, where 20200619 is the exact revision of the documentai:v1beta2 schema built by the mako code generator v1.0.14.

Everything else about the Document v1_beta2 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

  • Hub
    • a central object to maintain state and allow accessing all Activities
    • creates Method Builders which in turn allow access to individual Call Builders
  • Resources
    • primary types that you can apply Activities to
    • a collection of properties and Parts
    • Parts
      • a collection of properties
      • never directly used in Activities
  • Activities
    • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

This example is not tested
let r = hub.projects().operations_get(...).doit()
let r = hub.projects().documents_batch_process(...).doit()
let r = hub.projects().locations_operations_get(...).doit()
let r = hub.projects().locations_documents_batch_process(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-documentai1_beta2 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_documentai1_beta2 as documentai1_beta2;
use documentai1_beta2::GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest;
use documentai1_beta2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use documentai1_beta2::Document;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Document::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().documents_batch_process(req, "parent")
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

Chunk
ContentRange

Implements the Content-Range header, for serialization only

DefaultDelegate

A delegate with a conservative default implementation, which is used if no other delegate is set.

Document

Central instance to access all Document related resource activities

DummyNetworkStream
ErrorResponse

A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound

GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest

Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the Document format.

GoogleCloudDocumentaiV1beta2DocumentStyle

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment

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

GoogleCloudDocumentaiV1beta2DocumentPageBlock

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

GoogleCloudDocumentaiV1beta2DocumentLabel

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.

GoogleCloudDocumentaiV1beta2DocumentShardInfo

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.

GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage

Detected language for a structural component.

GoogleCloudDocumentaiV1beta2TableBoundHint

A hint for a table bounding box on the page for table parsing.

GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak

Detected break at the end of a Token.

GoogleCloudDocumentaiV1beta2DocumentPageParagraph

A collection of lines that a human would perceive as a paragraph.

GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow

A row of table cells.

GoogleCloudDocumentaiV1beta2DocumentEntity

A phrase in the text that is a known entity type, such as a person, an organization, or location.

GoogleCloudDocumentaiV1beta2FormExtractionParams

Parameters to control form extraction behavior.

GoogleCloudDocumentaiV1beta2OcrParams

Parameters to control Optical Character Recognition (OCR) behavior.

GoogleCloudDocumentaiV1beta2GcsDestination

The Google Cloud Storage location where the output file will be written to.

GoogleCloudDocumentaiV1beta2DocumentPageToken

A detected token.

GoogleCloudDocumentaiV1beta2KeyValuePairHint

Reserved for future use.

GoogleCloudDocumentaiV1beta2DocumentPageLayout

Visual element describing a layout unit on a page.

GoogleCloudDocumentaiV1beta2DocumentPageFormField

A form field detected on the page.

GoogleCloudDocumentaiV1beta2NormalizedVertex

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.

GoogleCloudDocumentaiV1beta2DocumentPageLine

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

GoogleCloudDocumentaiV1beta2ProcessDocumentRequest

Request to process one document.

GoogleCloudDocumentaiV1beta2OutputConfig

The desired output location and metadata.

GoogleCloudDocumentaiV1beta2DocumentPage

A page in a Document.

GoogleCloudDocumentaiV1beta2DocumentEntityRelation

Relationship between Entities.

GoogleCloudDocumentaiV1beta2BoundingPoly

A bounding polygon for the detected image annotation.

GoogleCloudDocumentaiV1beta2InputConfig

The desired input location and metadata.

GoogleCloudDocumentaiV1beta2DocumentTranslation

A translation of the text segment.

GoogleCloudDocumentaiV1beta2TableExtractionParams

Parameters to control table extraction behavior.

GoogleCloudDocumentaiV1beta2Document

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.

GoogleCloudDocumentaiV1beta2DocumentPageTable

A table representation similar to HTML table structure.

GoogleCloudDocumentaiV1beta2DocumentTextAnchor

Text reference indexing into the Document.text.

GoogleCloudDocumentaiV1beta2Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

GoogleCloudDocumentaiV1beta2DocumentStyleFontSize

Font size with unit.

GoogleCloudDocumentaiV1beta2EntityExtractionParams

Parameters to control entity extraction behavior.

GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell

A cell representation inside the table.

GoogleCloudDocumentaiV1beta2DocumentPageVisualElement

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

GoogleCloudDocumentaiV1beta2DocumentPageDimension

Dimension for the page.

GoogleCloudDocumentaiV1beta2GcsSource

The Google Cloud Storage location where the input file will be read from.

GoogleCloudDocumentaiV1beta2AutoMlParams

Parameters to control AutoML model prediction behavior.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

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. Each Status message contains three pieces of data: error code, error message, and error details.

GoogleTypeColor

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 "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, as well.

JsonServerError

A utility type which can decode a server response that indicates error

MethodInfo

Contains information about an API request.

MultiPartReader

Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.

ProjectDocumentBatchProcesCall

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the Document format.

ProjectDocumentProcesCall

Processes a single document.

ProjectLocationDocumentBatchProcesCall

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the Document format.

ProjectLocationDocumentProcesCall

Processes a single document.

ProjectLocationOperationGetCall

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.

ProjectMethods

A builder providing access to all methods supported on project resources. It is not used directly, but through the Document hub.

ProjectOperationGetCall

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.

RangeResponseHeader
ResumableUploadHelper

A utility type to perform a resumable upload from start to end.

ServerError
ServerMessage
XUploadContentType

The X-Upload-Content-Type header.

Enums

Error
Scope

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder

Identifies types which represent builders for a particular resource method

Delegate

A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.

Hub

Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.

MethodsBuilder

Identifies types for building methods of a particular resource type

NestedType

Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.

Part

Identifies types which are only used as part of other types, which usually are carrying the Resource trait.

ReadSeek

A utility to specify reader types which provide seeking capabilities too

RequestValue

Identifies types which are used in API requests.

Resource

Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.

ResponseResult

Identifies types which are used in API responses.

ToParts

A trait for all types that can convert themselves into a parts string

UnusedType

Identifies types which are not actually used by the API This might be a bug within the google API schema.

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.