Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::WebhookRequest (v0.8.1)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::WebhookRequest.

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#detect_intent_response_id

def detect_intent_response_id() -> ::String

Returns

(::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

#detect_intent_response_id=

def detect_intent_response_id=(value) -> ::String

Parameter

value (::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

Returns

(::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

#fulfillment_info

def fulfillment_info() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo) — Always present. Information about the fulfillment that triggered this webhook call.

#fulfillment_info=

def fulfillment_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo) — Always present. Information about the fulfillment that triggered this webhook call.

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo) — Always present. Information about the fulfillment that triggered this webhook call.

#intent_info

def intent_info() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo) — Information about the last matched intent.

#intent_info=

def intent_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo) — Information about the last matched intent.

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo) — Information about the last matched intent.

#language_code

def language_code() -> ::String

Returns

(::String) — The language code specified in the [original request][QueryInput.language_code].

#language_code=

def language_code=(value) -> ::String

Parameter

value (::String) — The language code specified in the [original request][QueryInput.language_code].

Returns

(::String) — The language code specified in the [original request][QueryInput.language_code].

#messages

def messages() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

#messages=

def messages=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>) — The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

#page_info

def page_info() -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status.

#page_info=

def page_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status.

Returns

(::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status.

#payload

def payload() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) — Custom data set in QueryParameters.payload.

#payload=

def payload=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) — Custom data set in QueryParameters.payload.

Returns

(::Google::Protobuf::Struct) — Custom data set in QueryParameters.payload.

#sentiment_analysis_result

def sentiment_analysis_result() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult) — The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

#sentiment_analysis_result=

def sentiment_analysis_result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult) — The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult) — The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

#session_info

def session_info() -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status.

#session_info=

def session_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status.

#text

def text() -> ::String

Returns

(::String) — If natural language text was provided as input, this field will contain a copy of the text.

#text=

def text=(value) -> ::String

Parameter

value (::String) — If natural language text was provided as input, this field will contain a copy of the text.

Returns

(::String) — If natural language text was provided as input, this field will contain a copy of the text.

#transcript

def transcript() -> ::String

Returns

(::String) — If natural language speech audio was provided as input, this field will contain the transcript for the audio.

#transcript=

def transcript=(value) -> ::String

Parameter

value (::String) — If natural language speech audio was provided as input, this field will contain the transcript for the audio.

Returns

(::String) — If natural language speech audio was provided as input, this field will contain the transcript for the audio.

#trigger_event

def trigger_event() -> ::String

Returns

(::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_event=

def trigger_event=(value) -> ::String

Parameter

value (::String) — If an event was provided as input, this field will contain the name of the event.

Returns

(::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_intent

def trigger_intent() -> ::String

Returns

(::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#trigger_intent=

def trigger_intent=(value) -> ::String

Parameter

value (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Returns

(::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.