Package com.google.cloud.dialogflow.v2beta1

Class AnalyzeContentRequest

  • All Implemented Interfaces:
    AnalyzeContentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnalyzeContentRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnalyzeContentRequestOrBuilder
     The request message for
 [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent].
    Protobuf type google.cloud.dialogflow.v2beta1.AnalyzeContentRequest
    See Also:
    Serialized Form

    • Field Detail

      • PARTICIPANT_FIELD_NUMBER

        public static final int PARTICIPANT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_INPUT_FIELD_NUMBER

        public static final int TEXT_INPUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUDIO_INPUT_FIELD_NUMBER

        public static final int AUDIO_INPUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVENT_INPUT_FIELD_NUMBER

        public static final int EVENT_INPUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUGGESTION_INPUT_FIELD_NUMBER

        public static final int SUGGESTION_INPUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPLY_AUDIO_CONFIG_FIELD_NUMBER

        public static final int REPLY_AUDIO_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_PARAMS_FIELD_NUMBER

        public static final int QUERY_PARAMS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ASSIST_QUERY_PARAMS_FIELD_NUMBER

        public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CX_PARAMETERS_FIELD_NUMBER

        public static final int CX_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CX_CURRENT_PAGE_FIELD_NUMBER

        public static final int CX_CURRENT_PAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MESSAGE_SEND_TIME_FIELD_NUMBER

        public static final int MESSAGE_SEND_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParticipant

        public 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) = { ... }
        Specified by:
        getParticipant in interface AnalyzeContentRequestOrBuilder
        Returns:
        The participant.

      • getParticipantBytes

        public 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) = { ... }
        Specified by:
        getParticipantBytes in interface AnalyzeContentRequestOrBuilder
        Returns:
        The bytes for participant.

      • hasTextInput

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

      • hasAudioInput

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

      • hasEventInput

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

      • hasSuggestionInput

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

      • hasReplyAudioConfig

        public 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;
        Specified by:
        hasReplyAudioConfig in interface AnalyzeContentRequestOrBuilder
        Returns:
        Whether the replyAudioConfig field is set.

      • getReplyAudioConfig

        public 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;
        Specified by:
        getReplyAudioConfig in interface AnalyzeContentRequestOrBuilder
        Returns:
        The replyAudioConfig.

      • getReplyAudioConfigOrBuilder

        public 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;
        Specified by:
        getReplyAudioConfigOrBuilder in interface AnalyzeContentRequestOrBuilder

      • hasQueryParams

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

      • hasAssistQueryParams

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

      • hasCxParameters

        public 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;
        Specified by:
        hasCxParameters in interface AnalyzeContentRequestOrBuilder
        Returns:
        Whether the cxParameters field is set.

      • getCxParameters

        public 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;
        Specified by:
        getCxParameters in interface AnalyzeContentRequestOrBuilder
        Returns:
        The cxParameters.

      • getCxParametersOrBuilder

        public 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;
        Specified by:
        getCxParametersOrBuilder in interface AnalyzeContentRequestOrBuilder

      • getCxCurrentPage

        public String getCxCurrentPage()
         The unique identifier of the 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;
        Specified by:
        getCxCurrentPage in interface AnalyzeContentRequestOrBuilder
        Returns:
        The cxCurrentPage.

      • getCxCurrentPageBytes

        public com.google.protobuf.ByteString getCxCurrentPageBytes()
         The unique identifier of the 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;
        Specified by:
        getCxCurrentPageBytes in interface AnalyzeContentRequestOrBuilder
        Returns:
        The bytes for cxCurrentPage.

      • hasMessageSendTime

        public 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.

 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;
        Specified by:
        hasMessageSendTime in interface AnalyzeContentRequestOrBuilder
        Returns:
        Whether the messageSendTime field is set.

      • getMessageSendTime

        public 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.

 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;
        Specified by:
        getMessageSendTime in interface AnalyzeContentRequestOrBuilder
        Returns:
        The messageSendTime.

      • getMessageSendTimeOrBuilder

        public 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.

 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;
        Specified by:
        getMessageSendTimeOrBuilder in interface AnalyzeContentRequestOrBuilder

      • getRequestId

        public 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;
        Specified by:
        getRequestId in interface AnalyzeContentRequestOrBuilder
        Returns:
        The requestId.

      • getRequestIdBytes

        public 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;
        Specified by:
        getRequestIdBytes in interface AnalyzeContentRequestOrBuilder
        Returns:
        The bytes for requestId.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnalyzeContentRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AnalyzeContentRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AnalyzeContentRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AnalyzeContentRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AnalyzeContentRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AnalyzeContentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder