<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/dialogflow/v2/conversation_profile.proto

namespace Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Configuration for analyses to run on each conversation message.
 *
 * Generated from protobuf message <code>google.cloud.dialogflow.v2.HumanAgentAssistantConfig.MessageAnalysisConfig</code>
 */
class MessageAnalysisConfig extends \Google\Protobuf\Internal\Message
{
    /**
     * Enable entity extraction in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false.
     * Currently, this feature is not general available, please contact Google
     * to get access.
     *
     * Generated from protobuf field <code>bool enable_entity_extraction = 2;</code>
     */
    protected $enable_entity_extraction = false;
    /**
     * Enable sentiment analysis in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false. Sentiment analysis inspects user input
     * and identifies the prevailing subjective opinion, especially to determine
     * a user's attitude as positive, negative, or neutral:
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis = 3;</code>
     */
    protected $enable_sentiment_analysis = false;
    /**
     * Optional. Enables sentiment analysis for audio input and conversation
     * messages. If unspecified, defaults to false. If this flag is set to true,
     * other 'enable_sentiment_analysis' fields will be ignored.
     * Sentiment analysis inspects user input and identifies the prevailing
     * subjective opinion, especially to determine a user's attitude as
     * positive, negative, or neutral.
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis_v3 = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $enable_sentiment_analysis_v3 = false;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type bool $enable_entity_extraction
     *           Enable entity extraction in conversation messages on [agent assist
     *           stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     *           If unspecified, defaults to false.
     *           Currently, this feature is not general available, please contact Google
     *           to get access.
     *     @type bool $enable_sentiment_analysis
     *           Enable sentiment analysis in conversation messages on [agent assist
     *           stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     *           If unspecified, defaults to false. Sentiment analysis inspects user input
     *           and identifies the prevailing subjective opinion, especially to determine
     *           a user's attitude as positive, negative, or neutral:
     *           https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     *           For
     *           [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     *           method, result will be in
     *           [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     *           For
     *           [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     *           method, result will be in
     *           [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     *           For
     *           [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     *           method, result will be in
     *           [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     *           If Pub/Sub notification is configured, result will be in
     *           [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *     @type bool $enable_sentiment_analysis_v3
     *           Optional. Enables sentiment analysis for audio input and conversation
     *           messages. If unspecified, defaults to false. If this flag is set to true,
     *           other 'enable_sentiment_analysis' fields will be ignored.
     *           Sentiment analysis inspects user input and identifies the prevailing
     *           subjective opinion, especially to determine a user's attitude as
     *           positive, negative, or neutral.
     *           https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     *           For
     *           [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     *           method, result will be in
     *           [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     *           For
     *           [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     *           method, result will be in
     *           [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     *           For
     *           [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     *           method, result will be in
     *           [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     *           If Pub/Sub notification is configured, result will be in
     *           [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Dialogflow\V2\ConversationProfile::initOnce();
        parent::__construct($data);
    }

    /**
     * Enable entity extraction in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false.
     * Currently, this feature is not general available, please contact Google
     * to get access.
     *
     * Generated from protobuf field <code>bool enable_entity_extraction = 2;</code>
     * @return bool
     */
    public function getEnableEntityExtraction()
    {
        return $this->enable_entity_extraction;
    }

    /**
     * Enable entity extraction in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false.
     * Currently, this feature is not general available, please contact Google
     * to get access.
     *
     * Generated from protobuf field <code>bool enable_entity_extraction = 2;</code>
     * @param bool $var
     * @return $this
     */
    public function setEnableEntityExtraction($var)
    {
        GPBUtil::checkBool($var);
        $this->enable_entity_extraction = $var;

        return $this;
    }

    /**
     * Enable sentiment analysis in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false. Sentiment analysis inspects user input
     * and identifies the prevailing subjective opinion, especially to determine
     * a user's attitude as positive, negative, or neutral:
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis = 3;</code>
     * @return bool
     */
    public function getEnableSentimentAnalysis()
    {
        return $this->enable_sentiment_analysis;
    }

    /**
     * Enable sentiment analysis in conversation messages on [agent assist
     * stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
     * If unspecified, defaults to false. Sentiment analysis inspects user input
     * and identifies the prevailing subjective opinion, especially to determine
     * a user's attitude as positive, negative, or neutral:
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis = 3;</code>
     * @param bool $var
     * @return $this
     */
    public function setEnableSentimentAnalysis($var)
    {
        GPBUtil::checkBool($var);
        $this->enable_sentiment_analysis = $var;

        return $this;
    }

    /**
     * Optional. Enables sentiment analysis for audio input and conversation
     * messages. If unspecified, defaults to false. If this flag is set to true,
     * other 'enable_sentiment_analysis' fields will be ignored.
     * Sentiment analysis inspects user input and identifies the prevailing
     * subjective opinion, especially to determine a user's attitude as
     * positive, negative, or neutral.
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis_v3 = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return bool
     */
    public function getEnableSentimentAnalysisV3()
    {
        return $this->enable_sentiment_analysis_v3;
    }

    /**
     * Optional. Enables sentiment analysis for audio input and conversation
     * messages. If unspecified, defaults to false. If this flag is set to true,
     * other 'enable_sentiment_analysis' fields will be ignored.
     * Sentiment analysis inspects user input and identifies the prevailing
     * subjective opinion, especially to determine a user's attitude as
     * positive, negative, or neutral.
     * https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
     * For
     * [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
     * method, result will be in
     * [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
     * For
     * [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
     * method, result will be in
     * [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.AnalyzeContentResponse.message]
     * For
     * [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages]
     * method, result will be in
     * [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2.ListMessagesResponse.messages]
     * If Pub/Sub notification is configured, result will be in
     * [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2.ConversationEvent.new_message_payload].
     *
     * Generated from protobuf field <code>bool enable_sentiment_analysis_v3 = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param bool $var
     * @return $this
     */
    public function setEnableSentimentAnalysisV3($var)
    {
        GPBUtil::checkBool($var);
        $this->enable_sentiment_analysis_v3 = $var;

        return $this;
    }

}

