The google-dialogflow3 library allows access to all features of the Google Dialogflow service.

This documentation was generated from Dialogflow crate version 6.0.0+20240614, where 20240614 is the exact revision of the dialogflow:v3 schema built by the mako code generator v6.0.0.

Everything else about the Dialogflow v3 API can be found at the official documentation site.

Features

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

• projects
• locations agents changelogs get, locations agents changelogs list, locations agents create, locations agents delete, locations agents entity types create, locations agents entity types delete, locations agents entity types export, locations agents entity types get, locations agents entity types import, locations agents entity types list, locations agents entity types patch, locations agents environments continuous test results list, locations agents environments create, locations agents environments delete, locations agents environments deploy flow, locations agents environments deployments get, locations agents environments deployments list, locations agents environments experiments create, locations agents environments experiments delete, locations agents environments experiments get, locations agents environments experiments list, locations agents environments experiments patch, locations agents environments experiments start, locations agents environments experiments stop, locations agents environments get, locations agents environments list, locations agents environments lookup environment history, locations agents environments patch, locations agents environments run continuous test, locations agents environments sessions detect intent, locations agents environments sessions entity types create, locations agents environments sessions entity types delete, locations agents environments sessions entity types get, locations agents environments sessions entity types list, locations agents environments sessions entity types patch, locations agents environments sessions fulfill intent, locations agents environments sessions match intent, locations agents environments sessions server streaming detect intent, locations agents export, locations agents flows create, locations agents flows delete, locations agents flows export, locations agents flows get, locations agents flows get validation result, locations agents flows import, locations agents flows list, locations agents flows pages create, locations agents flows pages delete, locations agents flows pages get, locations agents flows pages list, locations agents flows pages patch, locations agents flows patch, locations agents flows train, locations agents flows transition route groups create, locations agents flows transition route groups delete, locations agents flows transition route groups get, locations agents flows transition route groups list, locations agents flows transition route groups patch, locations agents flows validate, locations agents flows versions compare versions, locations agents flows versions create, locations agents flows versions delete, locations agents flows versions get, locations agents flows versions list, locations agents flows versions load, locations agents flows versions patch, locations agents generators create, locations agents generators delete, locations agents generators get, locations agents generators list, locations agents generators patch, locations agents get, locations agents get generative settings, locations agents get validation result, locations agents intents create, locations agents intents delete, locations agents intents export, locations agents intents get, locations agents intents import, locations agents intents list, locations agents intents patch, locations agents list, locations agents patch, locations agents restore, locations agents sessions detect intent, locations agents sessions entity types create, locations agents sessions entity types delete, locations agents sessions entity types get, locations agents sessions entity types list, locations agents sessions entity types patch, locations agents sessions fulfill intent, locations agents sessions match intent, locations agents sessions server streaming detect intent, locations agents sessions submit answer feedback, locations agents test cases batch delete, locations agents test cases batch run, locations agents test cases calculate coverage, locations agents test cases create, locations agents test cases export, locations agents test cases get, locations agents test cases import, locations agents test cases list, locations agents test cases patch, locations agents test cases results get, locations agents test cases results list, locations agents test cases run, locations agents transition route groups create, locations agents transition route groups delete, locations agents transition route groups get, locations agents transition route groups list, locations agents transition route groups patch, locations agents update generative settings, locations agents validate, locations agents webhooks create, locations agents webhooks delete, locations agents webhooks get, locations agents webhooks list, locations agents webhooks patch, locations get, locations list, locations operations cancel, locations operations get, locations operations list, locations security settings create, locations security settings delete, locations security settings get, locations security settings list, locations security settings patch, operations cancel, operations get and operations list

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_agents_entity_types_export(...).doit().await
let r = hub.projects().locations_agents_entity_types_import(...).doit().await
let r = hub.projects().locations_agents_environments_create(...).doit().await
let r = hub.projects().locations_agents_environments_deploy_flow(...).doit().await
let r = hub.projects().locations_agents_environments_patch(...).doit().await
let r = hub.projects().locations_agents_environments_run_continuous_test(...).doit().await
let r = hub.projects().locations_agents_flows_versions_create(...).doit().await
let r = hub.projects().locations_agents_flows_versions_load(...).doit().await
let r = hub.projects().locations_agents_flows_export(...).doit().await
let r = hub.projects().locations_agents_flows_import(...).doit().await
let r = hub.projects().locations_agents_flows_train(...).doit().await
let r = hub.projects().locations_agents_intents_export(...).doit().await
let r = hub.projects().locations_agents_intents_import(...).doit().await
let r = hub.projects().locations_agents_test_cases_batch_run(...).doit().await
let r = hub.projects().locations_agents_test_cases_export(...).doit().await
let r = hub.projects().locations_agents_test_cases_import(...).doit().await
let r = hub.projects().locations_agents_test_cases_run(...).doit().await
let r = hub.projects().locations_agents_export(...).doit().await
let r = hub.projects().locations_agents_restore(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().operations_get(...).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-dialogflow3 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dialogflow3 as dialogflow3;
use dialogflow3::api::GoogleCloudDialogflowCxV3Environment;
use dialogflow3::{Result, Error};
use dialogflow3::{Dialogflow, 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 auth = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).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_http1()
        .build()
);
let mut hub = Dialogflow::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 = GoogleCloudDialogflowCxV3Environment::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_agents_environments_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 dialogflow3 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.