Skip to main content

ConversationModels

Struct ConversationModels 

Source
pub struct ConversationModels { /* private fields */ }
Available on crate feature conversation-models only.
Expand description

Implements a client for the Dialogflow API.

§Example

use google_cloud_gax::paginator::ItemPaginator as _;
    let client = ConversationModels::builder().build().await?;
    let parent = "parent_value";
    let mut list = client.list_conversation_models()
        .set_parent(parent)
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }

§Service Description

Manages a collection of models for human agent assistant.

§Configuration

To configure ConversationModels use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

  • with_endpoint(): by default this client uses the global default endpoint (https://dialogflow.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
  • with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

§Pooling and Cloning

ConversationModels holds a connection pool internally, it is advised to create one and reuse it. You do not need to wrap ConversationModels in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations§

Source§

impl ConversationModels

Source

pub fn builder() -> ClientBuilder

Returns a builder for ConversationModels.

let client = ConversationModels::builder().build().await?;
Source

pub fn from_stub<T>(stub: T) -> Self
where T: ConversationModels + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

Source

pub fn create_conversation_model(&self) -> CreateConversationModel

Creates a model.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

§Example
use google_cloud_lro::Poller;
use google_cloud_dialogflow_v2::model::ConversationModel;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels, parent: &str
) -> Result<()> {
    let response = client.create_conversation_model()
        .set_parent(parent)
        .set_conversation_model(
            ConversationModel::new()/* set fields */
        )
        .poller().until_done().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn get_conversation_model(&self) -> GetConversationModel

Gets conversation model.

§Example
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let response = client.get_conversation_model()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_conversation_models(&self) -> ListConversationModels

Lists conversation models.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels, parent: &str
) -> Result<()> {
    let mut list = client.list_conversation_models()
        .set_parent(parent)
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn delete_conversation_model(&self) -> DeleteConversationModel

Deletes a model.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

§Example
use google_cloud_lro::Poller;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    client.delete_conversation_model()
        /* set fields */
        .poller().until_done().await?;
    Ok(())
}
Source

pub fn deploy_conversation_model(&self) -> DeployConversationModel

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

§Example
use google_cloud_lro::Poller;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    client.deploy_conversation_model()
        /* set fields */
        .poller().until_done().await?;
    Ok(())
}
Source

pub fn undeploy_conversation_model(&self) -> UndeployConversationModel

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used:

  • For article suggestion, article suggestion will fallback to the default model if model is undeployed.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

§Example
use google_cloud_lro::Poller;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    client.undeploy_conversation_model()
        /* set fields */
        .poller().until_done().await?;
    Ok(())
}
Source

pub fn get_conversation_model_evaluation( &self, ) -> GetConversationModelEvaluation

Gets an evaluation of conversation model.

§Example
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let response = client.get_conversation_model_evaluation()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_conversation_model_evaluations( &self, ) -> ListConversationModelEvaluations

Lists evaluations of a conversation model.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels, parent: &str
) -> Result<()> {
    let mut list = client.list_conversation_model_evaluations()
        .set_parent(parent)
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn create_conversation_model_evaluation( &self, ) -> CreateConversationModelEvaluation

Creates evaluation of a conversation model.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

§Example
use google_cloud_lro::Poller;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let response = client.create_conversation_model_evaluation()
        /* set fields */
        .poller().until_done().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field:

  • Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.

For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let mut list = client.list_locations()
        /* set fields */
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn get_location(&self) -> GetLocation

Gets information about a location.

§Example
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let response = client.get_location()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let mut list = client.list_operations()
        /* set fields */
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

§Example
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    let response = client.get_operation()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

§Example
use google_cloud_dialogflow_v2::Result;
async fn sample(
   client: &ConversationModels
) -> Result<()> {
    client.cancel_operation()
        /* set fields */
        .send().await?;
    Ok(())
}

Trait Implementations§

Source§

impl Clone for ConversationModels

Source§

fn clone(&self) -> ConversationModels

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ConversationModels

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more