The google-contactcenterinsights1 library allows access to all features of the Google Contactcenterinsights service.

This documentation was generated from Contactcenterinsights crate version 7.0.0+20251222, where 20251222 is the exact revision of the contactcenterinsights:v1 schema built by the mako code generator v7.0.0.

Everything else about the Contactcenterinsights v1 API can be found at the official documentation site.

Features

Handle the following Resources with ease from the central hub ...

• projects

• locations analysis rules create, locations analysis rules delete, locations analysis rules get, locations analysis rules list, locations analysis rules patch, locations assessment rules create, locations assessment rules delete, locations assessment rules get, locations assessment rules list, locations assessment rules patch, locations authorized view sets authorized views conversations assessments appeal, locations authorized view sets authorized views conversations assessments create, locations authorized view sets authorized views conversations assessments delete, locations authorized view sets authorized views conversations assessments finalize, locations authorized view sets authorized views conversations assessments get, locations authorized view sets authorized views conversations assessments list, locations authorized view sets authorized views conversations assessments notes create, locations authorized view sets authorized views conversations assessments notes delete, locations authorized view sets authorized views conversations assessments notes list, locations authorized view sets authorized views conversations assessments notes patch, locations authorized view sets authorized views conversations assessments publish, locations authorized view sets authorized views conversations calculate stats, locations authorized view sets authorized views conversations delete, locations authorized view sets authorized views conversations feedback labels create, locations authorized view sets authorized views conversations feedback labels delete, locations authorized view sets authorized views conversations feedback labels get, locations authorized view sets authorized views conversations feedback labels list, locations authorized view sets authorized views conversations feedback labels patch, locations authorized view sets authorized views conversations generate signed audio, locations authorized view sets authorized views conversations get, locations authorized view sets authorized views conversations list, locations authorized view sets authorized views create, locations authorized view sets authorized views delete, locations authorized view sets authorized views get, locations authorized view sets authorized views get iam policy, locations authorized view sets authorized views list, locations authorized view sets authorized views operations cancel, locations authorized view sets authorized views operations get, locations authorized view sets authorized views operations list, locations authorized view sets authorized views patch, locations authorized view sets authorized views query metrics, locations authorized view sets authorized views query performance overview, locations authorized view sets authorized views search, locations authorized view sets authorized views set iam policy, locations authorized view sets authorized views test iam permissions, locations authorized view sets create, locations authorized view sets delete, locations authorized view sets get, locations authorized view sets list, locations authorized view sets patch, locations bulk delete feedback labels, locations bulk download feedback labels, locations bulk upload feedback labels, locations conversations analyses create, locations conversations analyses delete, locations conversations analyses get, locations conversations analyses list, locations conversations assessments appeal, locations conversations assessments create, locations conversations assessments delete, locations conversations assessments finalize, locations conversations assessments get, locations conversations assessments list, locations conversations assessments notes create, locations conversations assessments notes delete, locations conversations assessments notes list, locations conversations assessments notes patch, locations conversations assessments publish, locations conversations bulk analyze, locations conversations bulk delete, locations conversations calculate stats, locations conversations create, locations conversations delete, locations conversations feedback labels create, locations conversations feedback labels delete, locations conversations feedback labels get, locations conversations feedback labels list, locations conversations feedback labels patch, locations conversations generate signed audio, locations conversations get, locations conversations ingest, locations conversations list, locations conversations patch, locations conversations sample, locations conversations segments bulk analyze, locations conversations upload, locations datasets bulk delete feedback labels, locations datasets bulk download feedback labels, locations datasets bulk upload feedback labels, locations datasets conversations bulk delete, locations datasets conversations calculate stats, locations datasets conversations delete, locations datasets conversations feedback labels create, locations datasets conversations feedback labels delete, locations datasets conversations feedback labels get, locations datasets conversations feedback labels list, locations datasets conversations feedback labels patch, locations datasets conversations generate signed audio, locations datasets conversations get, locations datasets conversations ingest, locations datasets conversations list, locations datasets conversations sample, locations datasets create, locations datasets delete, locations datasets get, locations datasets insightsdata export, locations datasets list, locations datasets list all feedback labels, locations datasets patch, locations encryption spec initialize, locations get encryption spec, locations get settings, locations insightsdata export, locations issue models calculate issue model stats, locations issue models create, locations issue models delete, locations issue models deploy, locations issue models export, locations issue models get, locations issue models import, locations issue models issues create, locations issue models issues delete, locations issue models issues get, locations issue models issues list, locations issue models issues patch, locations issue models list, locations issue models patch, locations issue models undeploy, locations list all feedback labels, locations operations cancel, locations operations get, locations operations list, locations phrase matchers create, locations phrase matchers delete, locations phrase matchers get, locations phrase matchers list, locations phrase matchers patch, locations qa question tags create, locations qa question tags delete, locations qa question tags get, locations qa question tags list, locations qa question tags patch, locations qa scorecards create, locations qa scorecards delete, locations qa scorecards get, locations qa scorecards list, locations qa scorecards patch, locations qa scorecards revisions create, locations qa scorecards revisions delete, locations qa scorecards revisions deploy, locations qa scorecards revisions get, locations qa scorecards revisions list, locations qa scorecards revisions qa questions create, locations qa scorecards revisions qa questions delete, locations qa scorecards revisions qa questions get, locations qa scorecards revisions qa questions list, locations qa scorecards revisions qa questions patch, locations qa scorecards revisions tune qa scorecard revision, locations qa scorecards revisions undeploy, locations query metrics, locations query performance overview, locations update settings, locations views create, locations views delete, locations views get, locations views list and locations views patch

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

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

Or specifically ...

let r = hub.projects().locations_authorized_view_sets_authorized_views_operations_get(...).doit().await
let r = hub.projects().locations_authorized_view_sets_authorized_views_query_metrics(...).doit().await
let r = hub.projects().locations_authorized_view_sets_authorized_views_query_performance_overview(...).doit().await
let r = hub.projects().locations_conversations_analyses_create(...).doit().await
let r = hub.projects().locations_conversations_segments_bulk_analyze(...).doit().await
let r = hub.projects().locations_conversations_bulk_analyze(...).doit().await
let r = hub.projects().locations_conversations_bulk_delete(...).doit().await
let r = hub.projects().locations_conversations_ingest(...).doit().await
let r = hub.projects().locations_conversations_sample(...).doit().await
let r = hub.projects().locations_conversations_upload(...).doit().await
let r = hub.projects().locations_datasets_conversations_bulk_delete(...).doit().await
let r = hub.projects().locations_datasets_conversations_ingest(...).doit().await
let r = hub.projects().locations_datasets_conversations_sample(...).doit().await
let r = hub.projects().locations_datasets_insightsdata_export(...).doit().await
let r = hub.projects().locations_datasets_bulk_delete_feedback_labels(...).doit().await
let r = hub.projects().locations_datasets_bulk_download_feedback_labels(...).doit().await
let r = hub.projects().locations_datasets_bulk_upload_feedback_labels(...).doit().await
let r = hub.projects().locations_datasets_delete(...).doit().await
let r = hub.projects().locations_encryption_spec_initialize(...).doit().await
let r = hub.projects().locations_insightsdata_export(...).doit().await
let r = hub.projects().locations_issue_models_issues_create(...).doit().await
let r = hub.projects().locations_issue_models_create(...).doit().await
let r = hub.projects().locations_issue_models_delete(...).doit().await
let r = hub.projects().locations_issue_models_deploy(...).doit().await
let r = hub.projects().locations_issue_models_export(...).doit().await
let r = hub.projects().locations_issue_models_import(...).doit().await
let r = hub.projects().locations_issue_models_undeploy(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_qa_question_tags_delete(...).doit().await
let r = hub.projects().locations_qa_question_tags_patch(...).doit().await
let r = hub.projects().locations_qa_scorecards_revisions_tune_qa_scorecard_revision(...).doit().await
let r = hub.projects().locations_bulk_delete_feedback_labels(...).doit().await
let r = hub.projects().locations_bulk_download_feedback_labels(...).doit().await
let r = hub.projects().locations_bulk_upload_feedback_labels(...).doit().await
let r = hub.projects().locations_query_metrics(...).doit().await
let r = hub.projects().locations_query_performance_overview(...).doit().await

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-contactcenterinsights1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_contactcenterinsights1 as contactcenterinsights1;
use contactcenterinsights1::api::GoogleCloudContactcenterinsightsV1QaQuestionTag;
use contactcenterinsights1::{Result, Error};
use contactcenterinsights1::{Contactcenterinsights, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_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 connector = hyper_rustls::HttpsConnectorBuilder::new()
    .with_native_roots()
    .unwrap()
    .https_only()
    .enable_http2()
    .build();

let executor = hyper_util::rt::TokioExecutor::new();
let auth = yup_oauth2::InstalledFlowAuthenticator::with_client(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    yup_oauth2::client::CustomHyperClientBuilder::from(
        hyper_util::client::legacy::Client::builder(executor).build(connector),
    ),
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http2()
        .build()
);
let mut hub = Contactcenterinsights::new(client, 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 = GoogleCloudContactcenterinsightsV1QaQuestionTag::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_qa_question_tags_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Cargo Features

• utoipa - Add support for utoipa and derive utoipa::ToSchema on all the types. You'll have to import and register the required types in #[openapi(schemas(...))], otherwise the generated openapi spec would be invalid.

License

The contactcenterinsights1 library was generated by Sebastian Thiel, and is placed under the MIT license. You can read the full text at the repository's license file.