#google #protocols #google-api #web #web-api #api #recommendation-engine

google-recommendationengine1_beta1

一个完整的库,用于与推荐AI(协议v1beta1)交互

11个稳定版本 (3个主要版本)

5.0.5+20240618 2024年6月27日
5.0.4+20240229 2024年3月5日
5.0.3+20230105 2023年8月24日
5.0.2+20230105 2023年3月17日
2.0.4+20210319 2021年4月15日

#75#web-api


用于 google-recommendationengi…

MIT 许可证

480KB
5.5K SLoC

google-recommendationengine1_beta1 库允许访问Google推荐AI服务的所有功能。

本文档由推荐AI crate版本5.0.5+20240618生成,其中20240618mako代码生成器v5.0.5构建的recommendationengine:v1beta1模式的精确修订版本。

有关推荐AI v1_beta1 API的更多信息,请参阅官方文档网站

功能

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

该库的结构

API结构如下主要项目

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

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

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

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

或者具体来说...

let r = hub.projects().locations_catalogs_catalog_items_import(...).doit().await
let r = hub.projects().locations_catalogs_event_stores_operations_get(...).doit().await
let r = hub.projects().locations_catalogs_event_stores_user_events_import(...).doit().await
let r = hub.projects().locations_catalogs_event_stores_user_events_purge(...).doit().await
let r = hub.projects().locations_catalogs_event_stores_user_events_rejoin(...).doit().await
let r = hub.projects().locations_catalogs_operations_get(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_recommendationengine1_beta1 as recommendationengine1_beta1;
use recommendationengine1_beta1::api::GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest;
use recommendationengine1_beta1::{Result, Error};
use std::default::Default;
use recommendationengine1_beta1::{RecommendationsAI, 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 = RecommendationsAI::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 = GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest::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_catalogs_catalog_items_import(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方法表示,分别命名为uploadupload_resumable

定制和回调

您可以通过向doit方法提供委托来修改调用方式,在最终调用doit之前将其提供给Method Builder。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

使用 方法构建器,您可以通过重复调用其方法来准备操作调用。这些方法始终接受一个参数,以下语句对该参数成立。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–22MB
~343K SLoC