#google-cloud #google #protocols #google-api #videointelligence #web #web-api

google-videointelligence1

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

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

5.0.5+20240614 2024年6月27日
5.0.4+20240118 2024年3月5日
5.0.3+20230119 2023年8月23日
5.0.2+20230119 2023年3月16日
1.0.8+20180920 2018年10月14日

#2526 in 网页编程


用于 google-videointelligence1…

MIT 许可证

225KB
3K SLoC

google-videointelligence1 库允许访问 Google Cloud Video Intelligence 服务(协议 v1)的所有功能。

本文档由 Cloud Video Intelligence 版本 5.0.5+20240614 生成,其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 videointelligence:v1 架构的确切版本。

有关 Cloud Video Intelligence v1 API 的其他信息,请参阅官方文档网站

功能

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

该库的结构

API 结构如下主要项目

  • 枢纽
  • 资源
    • 你可以将其应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 未直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标有适用特征,以进一步分类它们并简化浏览。

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

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

或者具体来说...

let r = hub.operations().projects_locations_operations_cancel(...).doit().await
let r = hub.operations().projects_locations_operations_delete(...).doit().await
let r = hub.projects().locations_operations_cancel(...).doit().await
let r = hub.projects().locations_operations_delete(...).doit().await

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

使用方法

设置您的项目

要使用此库,您需要在您的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_videointelligence1 as videointelligence1;
use videointelligence1::api::GoogleLongrunning_CancelOperationRequest;
use videointelligence1::{Result, Error};
use std::default::Default;
use videointelligence1::{CloudVideoIntelligence, 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 = CloudVideoIntelligence::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 = GoogleLongrunning_CancelOperationRequest::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_operations_cancel(req, "name")
             .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")

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受单个参数,以下是一些关于该参数的说明。

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

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

Cargo功能

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

许可证

videointelligence1库是由Sebastian Thiel生成的,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–23MB
~343K SLoC