Crate google_dialogflow2_beta1[−][src]
This documentation was generated from Dialogflow crate version 1.0.8+20181009, where 20181009 is the exact revision of the dialogflow:v2beta1 schema built by the mako code generator v1.0.8.
Everything else about the Dialogflow v2_beta1 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- projects
- agent entity types batch delete, agent entity types batch update, agent entity types create, agent entity types delete, agent entity types entities batch create, agent entity types entities batch delete, agent entity types entities batch update, agent entity types get, agent entity types list, agent entity types patch, agent environments users sessions contexts create, agent environments users sessions contexts delete, agent environments users sessions contexts get, agent environments users sessions contexts list, agent environments users sessions contexts patch, agent environments users sessions delete contexts, agent environments users sessions detect intent, agent environments users sessions entity types create, agent environments users sessions entity types delete, agent environments users sessions entity types get, agent environments users sessions entity types list, agent environments users sessions entity types patch, agent export, agent import, agent intents batch delete, agent intents batch update, agent intents create, agent intents delete, agent intents get, agent intents list, agent intents patch, agent knowledge bases create, agent knowledge bases delete, agent knowledge bases documents create, agent knowledge bases documents delete, agent knowledge bases documents get, agent knowledge bases documents list, agent knowledge bases get, agent knowledge bases list, agent restore, agent search, agent sessions contexts create, agent sessions contexts delete, agent sessions contexts get, agent sessions contexts list, agent sessions contexts patch, agent sessions delete contexts, agent sessions detect intent, agent sessions entity types create, agent sessions entity types delete, agent sessions entity types get, agent sessions entity types list, agent sessions entity types patch, agent train, conversation profiles create, conversation profiles delete, conversation profiles get, conversation profiles list, conversation profiles patch, conversations add conversation phone number, conversations complete, conversations create, conversations get, conversations list, conversations messages list, conversations participants analyze content, conversations participants create, conversations participants get, conversations participants list, conversations participants streaming analyze content, conversations participants suggestions list, environments users conversations contexts create, environments users conversations contexts delete, environments users conversations contexts get, environments users conversations contexts list, environments users conversations contexts patch, environments users conversations delete contexts, get agent, human agent assistants compile suggestions, human agent assistants create, human agent assistants delete, human agent assistants get, human agent assistants list, human agent assistants patch, knowledge bases create, knowledge bases delete, knowledge bases documents create, knowledge bases documents delete, knowledge bases documents get, knowledge bases documents list, knowledge bases get, knowledge bases list, operations get, phone number orders cancel, phone number orders create, phone number orders get, phone number orders list, phone number orders patch, phone numbers delete, phone numbers list, phone numbers patch and phone numbers undelete
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
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()
Or specifically ...
let r = hub.projects().agent_restore(...).doit() let r = hub.projects().agent_intents_batch_delete(...).doit() let r = hub.projects().knowledge_bases_documents_create(...).doit() let r = hub.projects().knowledge_bases_documents_delete(...).doit() let r = hub.projects().agent_entity_types_batch_delete(...).doit() let r = hub.projects().agent_train(...).doit() let r = hub.projects().agent_knowledge_bases_documents_delete(...).doit() let r = hub.projects().agent_import(...).doit() let r = hub.projects().agent_entity_types_batch_update(...).doit() let r = hub.projects().agent_export(...).doit() let r = hub.projects().agent_knowledge_bases_documents_create(...).doit() let r = hub.projects().agent_intents_batch_update(...).doit() let r = hub.projects().agent_entity_types_entities_batch_update(...).doit() let r = hub.projects().agent_entity_types_entities_batch_delete(...).doit() let r = hub.projects().operations_get(...).doit() let r = hub.projects().agent_entity_types_entities_batch_create(...).doit()
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-dialogflow2_beta1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"
A complete example
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_dialogflow2_beta1 as dialogflow2_beta1; use dialogflow2_beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest; use dialogflow2_beta1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use dialogflow2_beta1::Dialogflow; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate, hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), <MemoryStorage as Default>::default(), None); let mut hub = Dialogflow::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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 = GoogleCloudDialogflowV2beta1RestoreAgentRequest::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().agent_restore(req, "parent") .doit(); 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::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 enocodable 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.
Structs
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
Dialogflow |
Central instance to access all Dialogflow related resource activities |
ErrorResponse |
A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest |
The request message for Conversations.AddConversationPhoneNumber. |
GoogleCloudDialogflowV2beta1Agent |
Represents a conversational agent. |
GoogleCloudDialogflowV2beta1AnalyzeContentRequest |
The request message for Conversations.AnalyzeContent. |
GoogleCloudDialogflowV2beta1AnalyzeContentResponse |
The response message for Conversations.AnalyzeContent. |
GoogleCloudDialogflowV2beta1ArticleSuggestionConfig |
Defines article suggestions that a human agent assistant can provide. |
GoogleCloudDialogflowV2beta1AutomatedAgentConfig |
Defines the Automated Agent to connect to a conversation. |
GoogleCloudDialogflowV2beta1AutomatedAgentReply |
Represent a response from an automated agent. |
GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest |
The request message for EntityTypes.BatchCreateEntities. |
GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest |
The request message for EntityTypes.BatchDeleteEntities. |
GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest |
The request message for EntityTypes.BatchDeleteEntityTypes. |
GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest |
The request message for Intents.BatchDeleteIntents. |
GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest |
The request message for EntityTypes.BatchUpdateEntities. |
GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest |
The request message for EntityTypes.BatchUpdateEntityTypes. |
GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest |
The request message for Intents.BatchUpdateIntents. |
GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest |
The request message for PhoneNumberOrders.CancelPhoneNumberOrder. |
GoogleCloudDialogflowV2beta1CompileSuggestionsRequest |
The request message for HumanAgentAssistants.RequestCompileSuggestions. |
GoogleCloudDialogflowV2beta1CompileSuggestionsResponse |
The response message for HumanAgentAssistants.RequestCompileSuggestions |
GoogleCloudDialogflowV2beta1CompleteConversationRequest |
The request message for Conversations.CompleteConversation. |
GoogleCloudDialogflowV2beta1Context |
Represents a context. |
GoogleCloudDialogflowV2beta1Conversation |
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions. |
GoogleCloudDialogflowV2beta1ConversationPhoneNumber |
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. |
GoogleCloudDialogflowV2beta1ConversationProfile |
Defines the services to connect to incoming Dialogflow conversations. |
GoogleCloudDialogflowV2beta1DetectIntentRequest |
The request to detect user's intent. |
GoogleCloudDialogflowV2beta1DetectIntentResponse |
The message returned from the DetectIntent method. |
GoogleCloudDialogflowV2beta1Document |
A document resource. |
GoogleCloudDialogflowV2beta1EntityType |
Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. |
GoogleCloudDialogflowV2beta1EntityTypeBatch |
This message is a wrapper around a collection of entity types. |
GoogleCloudDialogflowV2beta1EntityTypeEntity |
Optional. Represents an entity. |
GoogleCloudDialogflowV2beta1EventInput |
Events allow for matching intents by event name instead of the natural
language input. For instance, input |
GoogleCloudDialogflowV2beta1ExportAgentRequest |
The request message for Agents.ExportAgent. |
GoogleCloudDialogflowV2beta1FaqAnswersConfig |
Defines FAQ responses that a human agent assistant can provide. |
GoogleCloudDialogflowV2beta1HumanAgentAssistant |
Represents a human agent assistant that provides suggestions to help human agents to resolve customer issues. This defines the types of content that the human agent assistant can present to a human agent. |
GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig |
Defines the Human Agent Assistant to connect to a conversation. |
GoogleCloudDialogflowV2beta1ImportAgentRequest |
The request message for Agents.ImportAgent. |
GoogleCloudDialogflowV2beta1InputAudio |
Represents the natural language speech audio to be processed. |
GoogleCloudDialogflowV2beta1InputAudioConfig |
Instructs the speech recognizer how to process the audio content. |
GoogleCloudDialogflowV2beta1InputText |
Represents the natural language text to be processed. |
GoogleCloudDialogflowV2beta1InputTextConfig |
Defines the language used in the input text. |
GoogleCloudDialogflowV2beta1Intent |
Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. |
GoogleCloudDialogflowV2beta1IntentBatch |
This message is a wrapper around a collection of intents. |
GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo |
Represents a single followup intent in the chain. |
GoogleCloudDialogflowV2beta1IntentMessage |
Corresponds to the |
GoogleCloudDialogflowV2beta1IntentMessageBasicCard |
The basic card message. Useful for displaying information. |
GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton |
The button object that appears at the bottom of a card. |
GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction |
Opens the given URI. |
GoogleCloudDialogflowV2beta1IntentMessageCard |
The card response message. |
GoogleCloudDialogflowV2beta1IntentMessageCardButton |
Optional. Contains information about a button. |
GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect |
The card for presenting a carousel of options to select from. |
GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem |
An item in the carousel. |
GoogleCloudDialogflowV2beta1IntentMessageImage |
The image response message. |
GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion |
The suggestion chip message that allows the user to jump out to the app or website associated with this agent. |
GoogleCloudDialogflowV2beta1IntentMessageListSelect |
The card for presenting a list of options to select from. |
GoogleCloudDialogflowV2beta1IntentMessageListSelectItem |
An item in the list. |
GoogleCloudDialogflowV2beta1IntentMessageQuickReplies |
The quick replies response message. |
GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo |
Additional info about the select item for when it is triggered in a dialog. |
GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse |
The simple response message containing speech or text. |
GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses |
The collection of simple response candidates.
This message in |
GoogleCloudDialogflowV2beta1IntentMessageSuggestion |
The suggestion chip message that the user can tap to quickly post a reply to the conversation. |
GoogleCloudDialogflowV2beta1IntentMessageSuggestions |
The collection of suggestions. |
GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio |
Plays audio from a file in Telephony Gateway. |
GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech |
Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. |
GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall |
Transfers the call in Telephony Gateway. |
GoogleCloudDialogflowV2beta1IntentMessageText |
The text response message. |
GoogleCloudDialogflowV2beta1IntentParameter |
Represents intent parameters. |
GoogleCloudDialogflowV2beta1IntentTrainingPhrase |
Represents an example or template that the agent is trained on. |
GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart |
Represents a part of a training phrase. |
GoogleCloudDialogflowV2beta1KnowledgeAnswers |
Represents the result of querying a Knowledge base. |
GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer |
An answer from Knowledge Connector. |
GoogleCloudDialogflowV2beta1KnowledgeBase |
Represents knowledge base resource. |
GoogleCloudDialogflowV2beta1ListContextsResponse |
The response message for Contexts.ListContexts. |
GoogleCloudDialogflowV2beta1ListConversationProfilesResponse |
The response message for ConversationProfiles.ListConversationProfiles. |
GoogleCloudDialogflowV2beta1ListConversationsResponse |
The response message for Conversations.ListConversations. |
GoogleCloudDialogflowV2beta1ListDocumentsResponse |
Response message for Documents.ListDocuments. |
GoogleCloudDialogflowV2beta1ListEntityTypesResponse |
The response message for EntityTypes.ListEntityTypes. |
GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse |
The response message for HumanAgentAssistants.ListHumanAgentAssistants. |
GoogleCloudDialogflowV2beta1ListIntentsResponse |
The response message for Intents.ListIntents. |
GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse |
Response message for KnowledgeBases.ListKnowledgeBases. |
GoogleCloudDialogflowV2beta1ListMessagesResponse |
The response message for Conversations.ListMessages. |
GoogleCloudDialogflowV2beta1ListParticipantsResponse |
The response message for Conversations.ListParticipants. |
GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse |
The response message for PhoneNumberOrders.ListPhoneNumberOrders. |
GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse |
The response message for PhoneNumbers.ListPhoneNumbers. |
GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse |
The response message for SessionEntityTypes.ListSessionEntityTypes. |
GoogleCloudDialogflowV2beta1ListSuggestionsResponse |
The response message for [Conversations.ListSuggestions] |
GoogleCloudDialogflowV2beta1LoggingConfig |
Defines logging behavior for conversation lifecycle events. |
GoogleCloudDialogflowV2beta1Message |
Represents a message posted into a conversation. |
GoogleCloudDialogflowV2beta1NotificationConfig |
Defines notification behavior for conversation lifecycle events. |
GoogleCloudDialogflowV2beta1OutputAudio |
Represents the natural language speech audio to be played to the end user. |
GoogleCloudDialogflowV2beta1OutputAudioConfig |
Instructs the speech synthesizer how to generate the output audio content. |
GoogleCloudDialogflowV2beta1Participant |
Represents a single side of the conversation. |
GoogleCloudDialogflowV2beta1PhoneNumber |
Represents a phone number.
|
GoogleCloudDialogflowV2beta1PhoneNumberOrder |
Represents a phone number order. Orders can assign phone numbers to projects. |
GoogleCloudDialogflowV2beta1PhoneNumberSpec |
Request for new numbers fitting a set of parameters. The country code for newly requested numbers defaults to 1 (US) until the service is available in other regions. |
GoogleCloudDialogflowV2beta1QueryInput |
Represents the query input. It can contain either: |
GoogleCloudDialogflowV2beta1QueryParameters |
Represents the parameters of the conversational query. |
GoogleCloudDialogflowV2beta1QueryResult |
Represents the result of conversational query or event processing. |
GoogleCloudDialogflowV2beta1RestoreAgentRequest |
The request message for Agents.RestoreAgent. |
GoogleCloudDialogflowV2beta1SearchAgentsResponse |
The response message for Agents.SearchAgents. |
GoogleCloudDialogflowV2beta1Sentiment |
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. |
GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig |
Configures the types of sentiment analysis to perform. |
GoogleCloudDialogflowV2beta1SentimentAnalysisResult |
The result of sentiment analysis as configured by
|
GoogleCloudDialogflowV2beta1SessionEntityType |
Represents a session entity type. |
GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest |
The top-level message sent by the client to the |
GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse |
The top-level message returned from the |
GoogleCloudDialogflowV2beta1StreamingRecognitionResult |
Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance. |
GoogleCloudDialogflowV2beta1Suggestion |
Represents a suggestion for a human agent. |
GoogleCloudDialogflowV2beta1SuggestionArticle |
Represents suggested article. |
GoogleCloudDialogflowV2beta1SuggestionFaqAnswer |
Represents suggested answer from "frequently asked questions". |
GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig |
Configuration of how speech should be synthesized. |
GoogleCloudDialogflowV2beta1TextInput |
Represents the natural language text to be processed. |
GoogleCloudDialogflowV2beta1TrainAgentRequest |
The request message for Agents.TrainAgent. |
GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest |
The request message for PhoneNumbers.UndeletePhoneNumber. |
GoogleCloudDialogflowV2beta1VoiceSelectionParams |
Description of which voice to use for speech synthesis. |
GoogleLongrunningOperation |
This resource represents a long-running operation that is the result of a network API call. |
GoogleProtobufEmpty |
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: |
GoogleRpcStatus |
The |
GoogleTypeLatLng |
An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. |
MethodInfo |
Contains information about an API request. |
MultiPartReader |
Provides a |
ProjectAgentEntityTypeBatchDeleteCall |
Deletes entity types in the specified agent. |
ProjectAgentEntityTypeBatchUpdateCall |
Updates/Creates multiple entity types in the specified agent. |
ProjectAgentEntityTypeCreateCall |
Creates an entity type in the specified agent. |
ProjectAgentEntityTypeDeleteCall |
Deletes the specified entity type. |
ProjectAgentEntityTypeEntityBatchCreateCall |
Creates multiple new entities in the specified entity type. |
ProjectAgentEntityTypeEntityBatchDeleteCall |
Deletes entities in the specified entity type. |
ProjectAgentEntityTypeEntityBatchUpdateCall |
Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. |
ProjectAgentEntityTypeGetCall |
Retrieves the specified entity type. |
ProjectAgentEntityTypeListCall |
Returns the list of all entity types in the specified agent. |
ProjectAgentEntityTypePatchCall |
Updates the specified entity type. |
ProjectAgentEnvironmentUserSessionContextCreateCall |
Creates a context. |
ProjectAgentEnvironmentUserSessionContextDeleteCall |
Deletes the specified context. |
ProjectAgentEnvironmentUserSessionContextGetCall |
Retrieves the specified context. |
ProjectAgentEnvironmentUserSessionContextListCall |
Returns the list of all contexts in the specified session. |
ProjectAgentEnvironmentUserSessionContextPatchCall |
Updates the specified context. |
ProjectAgentEnvironmentUserSessionDeleteContextCall |
Deletes all active contexts in the specified session. |
ProjectAgentEnvironmentUserSessionDetectIntentCall |
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. |
ProjectAgentEnvironmentUserSessionEntityTypeCreateCall |
Creates a session entity type. |
ProjectAgentEnvironmentUserSessionEntityTypeDeleteCall |
Deletes the specified session entity type. |
ProjectAgentEnvironmentUserSessionEntityTypeGetCall |
Retrieves the specified session entity type. |
ProjectAgentEnvironmentUserSessionEntityTypeListCall |
Returns the list of all session entity types in the specified session. |
ProjectAgentEnvironmentUserSessionEntityTypePatchCall |
Updates the specified session entity type. |
ProjectAgentExportCall |
Exports the specified agent to a ZIP file. |
ProjectAgentImportCall |
Imports the specified agent from a ZIP file. |
ProjectAgentIntentBatchDeleteCall |
Deletes intents in the specified agent. |
ProjectAgentIntentBatchUpdateCall |
Updates/Creates multiple intents in the specified agent. |
ProjectAgentIntentCreateCall |
Creates an intent in the specified agent. |
ProjectAgentIntentDeleteCall |
Deletes the specified intent and its direct or indirect followup intents. |
ProjectAgentIntentGetCall |
Retrieves the specified intent. |
ProjectAgentIntentListCall |
Returns the list of all intents in the specified agent. |
ProjectAgentIntentPatchCall |
Updates the specified intent. |
ProjectAgentKnowledgeBaseCreateCall |
Creates a knowledge base. |
ProjectAgentKnowledgeBaseDeleteCall |
Deletes the specified knowledge base. |
ProjectAgentKnowledgeBaseDocumentCreateCall |
Creates a new document. |
ProjectAgentKnowledgeBaseDocumentDeleteCall |
Deletes the specified document. |
ProjectAgentKnowledgeBaseDocumentGetCall |
Retrieves the specified document. |
ProjectAgentKnowledgeBaseDocumentListCall |
Returns the list of all documents of the knowledge base. |
ProjectAgentKnowledgeBaseGetCall |
Retrieves the specified knowledge base. |
ProjectAgentKnowledgeBaseListCall |
Returns the list of all knowledge bases of the specified agent. |
ProjectAgentRestoreCall |
Restores the specified agent from a ZIP file. |
ProjectAgentSearchCall |
Returns the list of agents. |
ProjectAgentSessionContextCreateCall |
Creates a context. |
ProjectAgentSessionContextDeleteCall |
Deletes the specified context. |
ProjectAgentSessionContextGetCall |
Retrieves the specified context. |
ProjectAgentSessionContextListCall |
Returns the list of all contexts in the specified session. |
ProjectAgentSessionContextPatchCall |
Updates the specified context. |
ProjectAgentSessionDeleteContextCall |
Deletes all active contexts in the specified session. |
ProjectAgentSessionDetectIntentCall |
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. |
ProjectAgentSessionEntityTypeCreateCall |
Creates a session entity type. |
ProjectAgentSessionEntityTypeDeleteCall |
Deletes the specified session entity type. |
ProjectAgentSessionEntityTypeGetCall |
Retrieves the specified session entity type. |
ProjectAgentSessionEntityTypeListCall |
Returns the list of all session entity types in the specified session. |
ProjectAgentSessionEntityTypePatchCall |
Updates the specified session entity type. |
ProjectAgentTrainCall |
Trains the specified agent. |
ProjectConversationAddConversationPhoneNumberCall |
Sets a phone number for this converstion to connect to. |
ProjectConversationCompleteCall |
Completes the specified conversation. Finished conversations are purged from the database after 30 days. |
ProjectConversationCreateCall |
Creates a new conversation. Conversation are auto-completed after 24 hours. |
ProjectConversationGetCall |
Retrieves the specific conversation. |
ProjectConversationListCall |
Returns the list of all conversations in the specified project. |
ProjectConversationMessageListCall |
Lists messages that belong to a given conversation. |
ProjectConversationParticipantAnalyzeContentCall |
Adds a text (chat, for example), or audio (phone recording, for example) message from a participan into the conversation. |
ProjectConversationParticipantCreateCall |
Creates a new participant in a conversation. |
ProjectConversationParticipantGetCall |
Retrieves a conversation participant. |
ProjectConversationParticipantListCall |
Returns the list of all participants in the specified conversation. |
ProjectConversationParticipantStreamingAnalyzeContentCall |
Adds a text (chat, for example), or audio (phone recording, for example) message from a participan into the conversation. Note: This method is only available through the gRPC API (not REST). |
ProjectConversationParticipantSuggestionListCall |
Retrieves suggestions for live agents. |
ProjectConversationProfileCreateCall |
Creates a conversation profile in the specified project. |
ProjectConversationProfileDeleteCall |
Deletes the specified conversation profile. |
ProjectConversationProfileGetCall |
Retrieves the specified conversation profile. |
ProjectConversationProfileListCall |
Returns the list of all conversation profiles in the specified project. |
ProjectConversationProfilePatchCall |
Updates the specified conversation profile. |
ProjectEnvironmentUserConversationContextCreateCall |
Creates a context. |
ProjectEnvironmentUserConversationContextDeleteCall |
Deletes the specified context. |
ProjectEnvironmentUserConversationContextGetCall |
Retrieves the specified context. |
ProjectEnvironmentUserConversationContextListCall |
Returns the list of all contexts in the specified session. |
ProjectEnvironmentUserConversationContextPatchCall |
Updates the specified context. |
ProjectEnvironmentUserConversationDeleteContextCall |
Deletes all active contexts in the specified session. |
ProjectGetAgentCall |
Retrieves the specified agent. |
ProjectHumanAgentAssistantCompileSuggestionCall |
Uses the specified human agent assistant to come up with suggestions (relevant articles and FAQs) on how to respond to a given conversation. |
ProjectHumanAgentAssistantCreateCall |
Creates a human agent assistant. |
ProjectHumanAgentAssistantDeleteCall |
Deletes the specified human agent assistant. |
ProjectHumanAgentAssistantGetCall |
Retrieves a human agent assistant. |
ProjectHumanAgentAssistantListCall |
Returns the list of all human agent assistants. |
ProjectHumanAgentAssistantPatchCall |
Updates the specified human agent assistant. |
ProjectKnowledgeBaseCreateCall |
Creates a knowledge base. |
ProjectKnowledgeBaseDeleteCall |
Deletes the specified knowledge base. |
ProjectKnowledgeBaseDocumentCreateCall |
Creates a new document. |
ProjectKnowledgeBaseDocumentDeleteCall |
Deletes the specified document. |
ProjectKnowledgeBaseDocumentGetCall |
Retrieves the specified document. |
ProjectKnowledgeBaseDocumentListCall |
Returns the list of all documents of the knowledge base. |
ProjectKnowledgeBaseGetCall |
Retrieves the specified knowledge base. |
ProjectKnowledgeBaseListCall |
Returns the list of all knowledge bases of the specified agent. |
ProjectMethods |
A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
ProjectOperationGetCall |
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
ProjectPhoneNumberDeleteCall |
Requests deletion of a |
ProjectPhoneNumberListCall |
Returns the list of all phone numbers in the specified project. |
ProjectPhoneNumberOrderCancelCall |
Cancels an |
ProjectPhoneNumberOrderCreateCall |
Creates an order to request phone numbers be added to a project.
The initial |
ProjectPhoneNumberOrderGetCall |
Returns a specific |
ProjectPhoneNumberOrderListCall |
Lists of all |
ProjectPhoneNumberOrderPatchCall |
Updates the specified |
ProjectPhoneNumberPatchCall |
Updates the specified |
ProjectPhoneNumberUndeleteCall |
Cancels the deletion request for a |
Enums
Error | |
Scope |
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
CallBuilder |
Identifies types which represent builders for a particular resource method |
Delegate |
A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
Hub |
Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
MethodsBuilder |
Identifies types for building methods of a particular resource type |
NestedType |
Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
Part |
Identifies types which are only used as part of other types, which
usually are carrying the |
ReadSeek |
A utility to specify reader types which provide seeking capabilities too |
RequestValue |
Identifies types which are used in API requests. |
Resource |
Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
ResponseResult |
Identifies types which are used in API responses. |
ToParts |
A trait for all types that can convert themselves into a parts string |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |