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

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

关于 Document v1 API 的其他所有信息都可以在 官方文档网站 找到。

功能

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

• 操作
• 删除
• 项目
• 获取位置处理程序类型，获取位置，位置列表，取消位置操作，获取位置操作，位置操作列表，获取位置处理程序类型，位置处理程序类型列表，位置处理器批量处理，创建位置处理器，删除位置处理器，禁用位置处理器，启用位置处理器，获取位置处理器，位置处理器人工审核配置审查文档，位置处理器列表，位置处理器处理，位置处理器版本批量处理，删除位置处理器版本，部署位置处理器版本，评估位置处理器版本，获取位置处理器版本评估，位置处理器版本评估列表，获取位置处理器版本，位置处理器版本列表，位置处理器版本处理，训练位置处理器版本，卸载位置处理器版本，设置默认处理器版本和获取操作

此库的结构

API结构分为以下主要项目

• 中心
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于这些类型
  • 属性集合和部件的集合
  • 部件
    • 属性集合
    • 从未在活动中直接使用
• 活动
  • 应用于资源的操作

所有结构都带有相应的属性，以进一步分类并简化浏览。

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

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

或者具体...

let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_processors_human_review_config_review_document(...).doit().await
let r = hub.projects().locations_processors_processor_versions_batch_process(...).doit().await
let r = hub.projects().locations_processors_processor_versions_delete(...).doit().await
let r = hub.projects().locations_processors_processor_versions_deploy(...).doit().await
let r = hub.projects().locations_processors_processor_versions_evaluate_processor_version(...).doit().await
let r = hub.projects().locations_processors_processor_versions_train(...).doit().await
let r = hub.projects().locations_processors_processor_versions_undeploy(...).doit().await
let r = hub.projects().locations_processors_batch_process(...).doit().await
let r = hub.projects().locations_processors_delete(...).doit().await
let r = hub.projects().locations_processors_disable(...).doit().await
let r = hub.projects().locations_processors_enable(...).doit().await
let r = hub.projects().locations_processors_set_default_processor_version(...).doit().await
let r = hub.projects().operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_documentai1 as documentai1;
use documentai1::api::GoogleCloudDocumentaiV1ReviewDocumentRequest;
use documentai1::{Result, Error};
use std::default::Default;
use documentai1::{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 = GoogleCloudDocumentaiV1ReviewDocumentRequest::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().locations_processors_human_review_config_review_document(req, "humanReviewConfig")
             .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 Delegate或Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

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

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

自定义和回调

您可以通过在执行最终的 doit() 调用之前，向 Delegate 提供一个 方法构建器 来改变 doit() 方法的调用方式。将调用相应的方法以提供进度信息，以及确定系统是否在失败时应该重试。

代理 trait 默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是为通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求和响应是有效的。大多数可选部分被视为可标识的 部分，它们将被发送到服务器，以指示请求的设置部分或响应中期望的部分。

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述是正确的。

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

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

Cargo 功能

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

许可证

documentai1 库由 Sebastian Thiel 创建，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。