#vision #google #protocols #google-api #web #web-api

google-vision1

一个完整的库,用于与 Vision (协议 v1) 交互

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

5.0.5+20240614 2024年6月27日
5.0.4+20240223 2024年3月5日
5.0.3+20230113 2023年8月24日
5.0.2+20230113 2023年3月17日
1.0.7+20171107 2018年2月1日

#2319 in Web 编程

每月下载量 39
google-vision1-cli 中使用

MIT 许可证

730KB
9K SLoC

google-vision1 库允许访问 Google Vision 服务所有功能。

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

关于 Vision v1 API 的其他内容可以在 官方文档网站 找到。

功能

从中央 中心 简单地处理以下 资源...

该库的结构

API结构如下主要项目

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有活动
    • 创建方法构建器,这些构建器反过来允许访问单个调用构建器
  • 资源
    • 主要类型,可以应用于活动
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都被标记了相应的属性,以便进一步分类并便于浏览。

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

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

或者具体来说...

let r = hub.files().async_batch_annotate(...).doit().await
let r = hub.images().async_batch_annotate(...).doit().await
let r = hub.locations().operations_get(...).doit().await
let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.projects().files_async_batch_annotate(...).doit().await
let r = hub.projects().images_async_batch_annotate(...).doit().await
let r = hub.projects().locations_files_async_batch_annotate(...).doit().await
let r = hub.projects().locations_images_async_batch_annotate(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_product_sets_import(...).doit().await
let r = hub.projects().locations_products_purge(...).doit().await
let r = hub.projects().operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_vision1 as vision1;
use vision1::{Result, Error};
use std::default::Default;
use vision1::{Vision, 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 = Vision::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.operations().list("name")
             .page_token("magna")
             .page_size(-11)
             .filter("ipsum")
             .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(...)

自定义和回调

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

代理特质默认实现,让您可以以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都设计成可以通过json进行编码解码。可选部分用于表示部分请求和响应是有效的。大多数可选部分都是可以命名的部分,这些部分将被发送到服务器,以指示请求中的设置部分或响应中期望的部分。

构建器参数

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

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

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

Cargo 功能

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

许可

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

依赖关系

~12–23MB
~343K SLoC