Package com.google.cloud.dialogflow.v2beta1

Interface AnalyzeContentRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AnalyzeContentRequest, AnalyzeContentRequest.Builder
@Generated public interface AnalyzeContentRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParticipant

      String getParticipant()
       Required. The name of the participant this text comes from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
      string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The participant.

    • getParticipantBytes

      com.google.protobuf.ByteString getParticipantBytes()
       Required. The name of the participant this text comes from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
      string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for participant.

    • hasTextInput

      boolean hasTextInput()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
      Returns:
      Whether the textInput field is set.

    • getTextInput

      TextInput getTextInput()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
      Returns:
      The textInput.

    • getTextInputOrBuilder

      TextInputOrBuilder getTextInputOrBuilder()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;

    • hasAudioInput

      boolean hasAudioInput()
       The natural language speech audio to be processed.
      .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
      Returns:
      Whether the audioInput field is set.

    • getAudioInput

      AudioInput getAudioInput()
       The natural language speech audio to be processed.
      .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
      Returns:
      The audioInput.

    • getAudioInputOrBuilder

      AudioInputOrBuilder getAudioInputOrBuilder()
       The natural language speech audio to be processed.
      .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;

    • hasEventInput

      boolean hasEventInput()
       An input event to send to Dialogflow.
      .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
      Returns:
      Whether the eventInput field is set.

    • getEventInput

      EventInput getEventInput()
       An input event to send to Dialogflow.
      .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
      Returns:
      The eventInput.

    • getEventInputOrBuilder

      EventInputOrBuilder getEventInputOrBuilder()
       An input event to send to Dialogflow.
      .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;

    • hasSuggestionInput

      boolean hasSuggestionInput()
       An input representing the selection of a suggestion.
      .google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;
      Returns:
      Whether the suggestionInput field is set.

    • getSuggestionInput

      SuggestionInput getSuggestionInput()
       An input representing the selection of a suggestion.
      .google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;
      Returns:
      The suggestionInput.

    • getSuggestionInputOrBuilder

      SuggestionInputOrBuilder getSuggestionInputOrBuilder()
       An input representing the selection of a suggestion.
      .google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;

    • hasIntentInput

      boolean hasIntentInput()
       The intent to be triggered on V3 agent.
      .google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;
      Returns:
      Whether the intentInput field is set.

    • getIntentInput

      IntentInput getIntentInput()
       The intent to be triggered on V3 agent.
      .google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;
      Returns:
      The intentInput.

    • getIntentInputOrBuilder

      IntentInputOrBuilder getIntentInputOrBuilder()
       The intent to be triggered on V3 agent.
      .google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;

    • hasReplyAudioConfig

      boolean hasReplyAudioConfig()
       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.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
      Returns:
      Whether the replyAudioConfig field is set.

    • getReplyAudioConfig

      OutputAudioConfig getReplyAudioConfig()
       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.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
      Returns:
      The replyAudioConfig.

    • getReplyAudioConfigOrBuilder

      OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder()
       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.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;

    • hasQueryParams

      boolean hasQueryParams()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
      Returns:
      Whether the queryParams field is set.

    • getQueryParams

      QueryParameters getQueryParams()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
      Returns:
      The queryParams.

    • getQueryParamsOrBuilder

      QueryParametersOrBuilder getQueryParamsOrBuilder()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;

    • hasAssistQueryParams

      boolean hasAssistQueryParams()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
      Returns:
      Whether the assistQueryParams field is set.

    • getAssistQueryParams

      AssistQueryParameters getAssistQueryParams()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
      Returns:
      The assistQueryParams.

    • getAssistQueryParamsOrBuilder

      AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;

    • hasCxParameters

      boolean hasCxParameters()
       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.
      .google.protobuf.Struct cx_parameters = 18;
      Returns:
      Whether the cxParameters field is set.

    • getCxParameters

      com.google.protobuf.Struct getCxParameters()
       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.
      .google.protobuf.Struct cx_parameters = 18;
      Returns:
      The cxParameters.

    • getCxParametersOrBuilder

      com.google.protobuf.StructOrBuilder getCxParametersOrBuilder()
       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.
      .google.protobuf.Struct cx_parameters = 18;

    • getCxCurrentPage

      String getCxCurrentPage()
       The unique identifier of the Dialogflow CX page to override the
 `current_page` in the session.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

 If `cx_current_page` is specified, the previous state of the session will
 be ignored by Dialogflow CX, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
 `cx_parameters` should be configured together to direct a session to a
 specific state.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      string cx_current_page = 20;
      Returns:
      The cxCurrentPage.

    • getCxCurrentPageBytes

      com.google.protobuf.ByteString getCxCurrentPageBytes()
       The unique identifier of the Dialogflow CX page to override the
 `current_page` in the session.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

 If `cx_current_page` is specified, the previous state of the session will
 be ignored by Dialogflow CX, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
 `cx_parameters` should be configured together to direct a session to a
 specific state.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      string cx_current_page = 20;
      Returns:
      The bytes for cxCurrentPage.

    • hasMessageSendTime

      boolean hasMessageSendTime()
       Optional. The send time of the message from end user or human agent's
 perspective. It is used for identifying the same message under one
 participant.

 For BatchCreateMessages API only:
 Given two messages under the same participant:
 * If send time are different regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 two distinct messages sent by the participant.
 * If send time is the same regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 same message, and ignore the message received later.

 If the value is not provided, a new request will always be regarded as a
 new message without any de-duplication.
      .google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the messageSendTime field is set.

    • getMessageSendTime

      com.google.protobuf.Timestamp getMessageSendTime()
       Optional. The send time of the message from end user or human agent's
 perspective. It is used for identifying the same message under one
 participant.

 For BatchCreateMessages API only:
 Given two messages under the same participant:
 * If send time are different regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 two distinct messages sent by the participant.
 * If send time is the same regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 same message, and ignore the message received later.

 If the value is not provided, a new request will always be regarded as a
 new message without any de-duplication.
      .google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The messageSendTime.

    • getMessageSendTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getMessageSendTimeOrBuilder()
       Optional. The send time of the message from end user or human agent's
 perspective. It is used for identifying the same message under one
 participant.

 For BatchCreateMessages API only:
 Given two messages under the same participant:
 * If send time are different regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 two distinct messages sent by the participant.
 * If send time is the same regardless of whether the content of the
 messages are exactly the same, the conversation will regard them as
 same message, and ignore the message received later.

 If the value is not provided, a new request will always be regarded as a
 new message without any de-duplication.
      .google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getRequestId

      String getRequestId()
       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.
      string request_id = 11;
      Returns:
      The requestId.

    • getRequestIdBytes

      com.google.protobuf.ByteString getRequestIdBytes()
       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.
      string request_id = 11;
      Returns:
      The bytes for requestId.

    • getInputCase

      AnalyzeContentRequest.InputCase getInputCase()