12 个稳定版本 (4 个主要版本)

5.0.5+20240619 2024 年 6 月 27 日
5.0.4+20240223 2024 年 3 月 5 日
5.0.3+20230117 2023 年 8 月 23 日
5.0.2+20230117 2023 年 3 月 16 日
1.0.14+20200619 2020 年 7 月 10 日

#2537 in 网络编程


用于 google-documentai1_beta2-…

MIT 许可证

270KB
3K SLoC

google-documentai1_beta2 库允许访问 Google Document 服务的所有功能。

本文档是从 Document crate 版本 5.0.5+20240619 生成的,其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 documentai:v1beta2 架构的确切修订版。

关于 Document v1_beta2 API 的其他内容,请参阅 官方文档网站

特性

轻松从中央 枢纽 处理以下 资源 ...

库结构

API 结构如下

  • 枢纽
  • 资源
    • 主要类型,可以将 活动 应用于这些类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都使用适用的特性和标记,以便进一步分类和便于浏览。

一般来说,您可以这样调用 活动

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

或具体来说 ...

let r = hub.projects().documents_batch_process(...).doit().await
let r = hub.projects().locations_documents_batch_process(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().operations_get(...).doit().await

资源(resource)和活动(activity)调用创建了构建器。第二个处理Activities,支持配置即将进行的操作的各种方法(此处未展示)。它是这样设计的,即所有必需的参数都必须立即指定(即 (...)),而所有可选的则可以按需构建doit()方法执行与服务器实际通信并返回相应的结果。

使用方法

设置您的项目

要使用此库,您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-documentai1_beta2 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_documentai1_beta2 as documentai1_beta2;
use documentai1_beta2::api::GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest;
use documentai1_beta2::{Result, Error};
use std::default::Default;
use documentai1_beta2::{Document, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::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 = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Document::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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().await;

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::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都作为Result枚举提供,作为doit()方法的返回值,或者作为可能的中继结果传递给Hub DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统对各种错误具有潜在的抗性。

上传和下载

如果方法支持下载,则响应体(它是Result的一部分)应由您读取以获取媒体。如果该方法还支持Response Result,则它将默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单和可恢复。每种协议的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过在执行最后的doit()调用之前向Method Builder提供一个代理来更改doit()方法被调用的方式。相应的方晚会调用以提供进度信息,并确定系统在失败时是否应该重试。

delegate trait具有默认实现,允许您以最少的努力进行定制。

服务器请求中的可选部分

本库中提供的所有结构都是设计成可以通过json进行编码解码的。使用可选值来表示部分请求或响应是有效的。大多数可选值都是被视为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求或响应中所需的组件。

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它适用。

  • POD通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数始终会被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。

Cargo功能

  • utoipa - 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema。您必须在#[openapi(schemas(...))]中导入并注册所需类型,否则生成的openapi规范将无效。

许可证

documentai1_beta2库由Sebastian Thiel生成,并置于MIT许可证下。您可以在仓库的许可证文件中阅读全文。

依赖关系

~12–23MB
~343K SLoC