该 google-datalabeling1_beta1 库允许访问 Google 数据标记服务的所有功能。

本文档是从版本 5.0.5+20240207 的 Data Labeling crate 生成的，其中 20240207 是由 mako 代码生成器 v5.0.5 构建的 datalabeling:v1beta1 架构的确切修订版。

关于数据标记 v1_beta1 API 的其他信息可以在 官方文档站点 找到。

功能

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

• 项目
• annotation spec sets create, annotation spec sets delete, annotation spec sets get, annotation spec sets list, datasets annotated datasets data items get, datasets annotated datasets data items list, datasets annotated datasets delete, datasets annotated datasets examples get, datasets annotated datasets examples list, datasets annotated datasets feedback threads delete, datasets annotated datasets feedback threads feedback messages create, datasets annotated datasets feedback threads feedback messages delete, datasets annotated datasets feedback threads feedback messages get, datasets annotated datasets feedback threads feedback messages list, datasets annotated datasets feedback threads get, datasets annotated datasets feedback threads list, datasets annotated datasets get, datasets annotated datasets list, datasets create, datasets data items get, datasets data items list, datasets delete, datasets evaluations example comparisons search, datasets evaluations get, datasets export data, datasets get, datasets image label, datasets import data, datasets list, datasets text label, datasets video label, evaluation jobs create, evaluation jobs delete, evaluation jobs get, evaluation jobs list, evaluation jobs patch, evaluation jobs pause, evaluation jobs resume, evaluations search, instructions create, instructions delete, instructions get, instructions list, operations cancel, operations delete, operations get and operations list

本库的结构

API 被结构化为以下主要项

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

所有 结构 都带有适用的特质，以进一步分类它们并简化浏览。

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

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

或者具体地...

let r = hub.projects().annotation_spec_sets_delete(...).doit().await
let r = hub.projects().datasets_annotated_datasets_feedback_threads_feedback_messages_delete(...).doit().await
let r = hub.projects().datasets_annotated_datasets_feedback_threads_delete(...).doit().await
let r = hub.projects().datasets_annotated_datasets_delete(...).doit().await
let r = hub.projects().datasets_delete(...).doit().await
let r = hub.projects().evaluation_jobs_delete(...).doit().await
let r = hub.projects().evaluation_jobs_pause(...).doit().await
let r = hub.projects().evaluation_jobs_resume(...).doit().await
let r = hub.projects().instructions_delete(...).doit().await
let r = hub.projects().operations_cancel(...).doit().await
let r = hub.projects().operations_delete(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datalabeling1_beta1 as datalabeling1_beta1;
use datalabeling1_beta1::api::GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest;
use datalabeling1_beta1::{Result, Error};
use std::default::Default;
use datalabeling1_beta1::{DataLabeling, 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 = DataLabeling::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 = GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest::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().evaluation_jobs_pause(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 Delegate 或 Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

delegate trait 默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

本库提供的所有结构都是设计为可以通过 编码 和 解码 来使用 json 格式。使用可选参数（Optionals）来表示部分请求或响应是有效的。大多数可选参数都是 部分（Parts），可以通过名称识别，这些部分将被发送到服务器以指示请求的集合部分或响应中期望的部分。

构建器参数

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

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

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

Cargo 特性

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

许可证

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