Struct googapis::google::cloud::dialogflow::v2beta1::WebhookResponse [−][src]
pub struct WebhookResponse {
pub fulfillment_text: String,
pub fulfillment_messages: Vec<Message>,
pub source: String,
pub payload: Option<Struct>,
pub output_contexts: Vec<Context>,
pub followup_event_input: Option<EventInput>,
pub live_agent_handoff: bool,
pub end_interaction: bool,
pub session_entity_types: Vec<SessionEntityType>,
}
Expand description
The response message for a webhook call.
This response is validated by the Dialogflow server. If validation fails, an error will be returned in the [QueryResult.diagnostic_info][google.cloud.dialogflow.v2beta1.QueryResult.diagnostic_info] field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use
{}
ornull
for empty objects - Use
[]
ornull
for empty arrays
For more information, see the Protocol Buffers Language Guide.
Fields
fulfillment_text: String
Optional. The text response message intended for the end-user.
It is recommended to use fulfillment_messages.text.text\[0\]
instead.
When provided, Dialogflow uses this field to populate
[QueryResult.fulfillment_text][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_text] sent to the integration or API caller.
fulfillment_messages: Vec<Message>
Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate [QueryResult.fulfillment_messages][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.
source: String
Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate [QueryResult.webhook_source][google.cloud.dialogflow.v2beta1.QueryResult.webhook_source] sent to the integration or API caller.
payload: Option<Struct>
Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate [QueryResult.webhook_payload][google.cloud.dialogflow.v2beta1.QueryResult.webhook_payload] sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format
output_contexts: Vec<Context>
Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate [QueryResult.output_contexts][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
followup_event_input: Option<EventInput>
Optional. Invokes the supplied events.
When this field is set, Dialogflow ignores the fulfillment_text
,
fulfillment_messages
, and payload
fields.
live_agent_handoff: bool
Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
end_interaction: bool
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
session_entity_types: Vec<SessionEntityType>
Optional. Additional session entity types to replace or extend developer
entity types with. The entity synonyms apply to all languages and persist
for the session. Setting this data from a webhook overwrites
the session entity types that have been set using detectIntent
,
streamingDetectIntent
or [SessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for WebhookResponse
impl Send for WebhookResponse
impl Sync for WebhookResponse
impl Unpin for WebhookResponse
impl UnwindSafe for WebhookResponse
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more