Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::AnalyzeContentRequest (v1.12.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::AnalyzeContentRequest.

The request message for Participants.AnalyzeContent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#assist_query_params

def assist_query_params() -> ::Google::Cloud::Dialogflow::V2::AssistQueryParameters
Returns

#assist_query_params=

def assist_query_params=(value) -> ::Google::Cloud::Dialogflow::V2::AssistQueryParameters
Parameter
Returns

#audio_input

def audio_input() -> ::Google::Cloud::Dialogflow::V2::AudioInput
Returns
  • (::Google::Cloud::Dialogflow::V2::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio_input, text_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#audio_input=

def audio_input=(value) -> ::Google::Cloud::Dialogflow::V2::AudioInput
Parameter
  • value (::Google::Cloud::Dialogflow::V2::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio_input, text_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio_input, text_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cx_parameters

def cx_parameters() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

    Note: this field should only be used if you are connecting to a Dialogflow CX agent.

#cx_parameters=

def cx_parameters=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

    Note: this field should only be used if you are connecting to a Dialogflow CX agent.

Returns
  • (::Google::Protobuf::Struct) — Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

    Note: this field should only be used if you are connecting to a Dialogflow CX agent.

#event_input

def event_input() -> ::Google::Cloud::Dialogflow::V2::EventInput
Returns
  • (::Google::Cloud::Dialogflow::V2::EventInput) — An input event to send to Dialogflow.

    Note: The following fields are mutually exclusive: event_input, text_input, audio_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#event_input=

def event_input=(value) -> ::Google::Cloud::Dialogflow::V2::EventInput
Parameter
  • value (::Google::Cloud::Dialogflow::V2::EventInput) — An input event to send to Dialogflow.

    Note: The following fields are mutually exclusive: event_input, text_input, audio_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::EventInput) — An input event to send to Dialogflow.

    Note: The following fields are mutually exclusive: event_input, text_input, audio_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#participant

def participant() -> ::String
Returns
  • (::String) — Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

#participant=

def participant=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
Returns
  • (::String) — Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

#query_params

def query_params() -> ::Google::Cloud::Dialogflow::V2::QueryParameters
Returns

#query_params=

def query_params=(value) -> ::Google::Cloud::Dialogflow::V2::QueryParameters
Parameter
Returns

#reply_audio_config

def reply_audio_config() -> ::Google::Cloud::Dialogflow::V2::OutputAudioConfig
Returns
  • (::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

#reply_audio_config=

def reply_audio_config=(value) -> ::Google::Cloud::Dialogflow::V2::OutputAudioConfig
Parameter
  • value (::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.
Returns
  • (::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

#request_id

def request_id() -> ::String
Returns
  • (::String) — A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.
Returns
  • (::String) — A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

#suggestion_input

def suggestion_input() -> ::Google::Cloud::Dialogflow::V2::SuggestionInput
Returns
  • (::Google::Cloud::Dialogflow::V2::SuggestionInput) — An input representing the selection of a suggestion.

    Note: The following fields are mutually exclusive: suggestion_input, text_input, audio_input, event_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#suggestion_input=

def suggestion_input=(value) -> ::Google::Cloud::Dialogflow::V2::SuggestionInput
Parameter
  • value (::Google::Cloud::Dialogflow::V2::SuggestionInput) — An input representing the selection of a suggestion.

    Note: The following fields are mutually exclusive: suggestion_input, text_input, audio_input, event_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::SuggestionInput) — An input representing the selection of a suggestion.

    Note: The following fields are mutually exclusive: suggestion_input, text_input, audio_input, event_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_input

def text_input() -> ::Google::Cloud::Dialogflow::V2::TextInput
Returns
  • (::Google::Cloud::Dialogflow::V2::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_input, audio_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_input=

def text_input=(value) -> ::Google::Cloud::Dialogflow::V2::TextInput
Parameter
  • value (::Google::Cloud::Dialogflow::V2::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_input, audio_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_input, audio_input, event_input, suggestion_input. If a field in that set is populated, all other fields in the set will automatically be cleared.