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

namespace Google\Cloud\Dialogflow\V2\KnowledgeAssistDebugInfo;

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

/**
 * Configured behaviors for Knowedge Assist.
 *
 * Generated from protobuf message <code>google.cloud.dialogflow.v2.KnowledgeAssistDebugInfo.KnowledgeAssistBehavior</code>
 */
class KnowledgeAssistBehavior extends \Google\Protobuf\Internal\Message
{
    /**
     * Whether data store agent rewriter was turned off for the request.
     *
     * Generated from protobuf field <code>bool answer_generation_rewriter_on = 1;</code>
     */
    protected $answer_generation_rewriter_on = false;
    /**
     * Whether end_user_metadata is included in the data store agent call.
     *
     * Generated from protobuf field <code>bool end_user_metadata_included = 2;</code>
     */
    protected $end_user_metadata_included = false;
    /**
     * Whether customers configured to return query only in the
     * conversation profile.
     *
     * Generated from protobuf field <code>bool return_query_only = 4;</code>
     */
    protected $return_query_only = false;
    /**
     * Whether customers configured to use pubsub to deliver.
     *
     * Generated from protobuf field <code>bool use_pubsub_delivery = 5;</code>
     */
    protected $use_pubsub_delivery = false;
    /**
     * Whether customers configured to disable the synchronous delivery of
     * Knowedge Assist response.
     *
     * Generated from protobuf field <code>bool disable_sync_delivery = 6;</code>
     */
    protected $disable_sync_delivery = false;
    /**
     * Whether previously suggested queries are included in the query generation
     * process.
     *
     * Generated from protobuf field <code>bool previous_queries_included = 7;</code>
     */
    protected $previous_queries_included = false;
    /**
     * Translated message is included in query generation process.
     *
     * Generated from protobuf field <code>bool use_translated_message = 8;</code>
     */
    protected $use_translated_message = false;
    /**
     * Safety filter is adjusted by user.
     *
     * Generated from protobuf field <code>bool use_custom_safety_filter_level = 9;</code>
     */
    protected $use_custom_safety_filter_level = false;
    /**
     * Conversation transcript has mixed languages.
     *
     * Generated from protobuf field <code>bool conversation_transcript_has_mixed_languages = 10;</code>
     */
    protected $conversation_transcript_has_mixed_languages = false;
    /**
     * Whether the agent language from the translation generator mismatches the
     * end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_agent_language_mismatch = 11;</code>
     */
    protected $query_generation_agent_language_mismatch = false;
    /**
     * Whether the end-user language from the translation generator mismatches
     * the end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_end_user_language_mismatch = 12;</code>
     */
    protected $query_generation_end_user_language_mismatch = false;
    /**
     * This field indicates whether third party connectors are enabled for the
     * project
     *
     * Generated from protobuf field <code>bool third_party_connector_allowed = 13;</code>
     */
    protected $third_party_connector_allowed = false;
    /**
     * Indicates that the query generation model generated multiple queries.
     *
     * Generated from protobuf field <code>bool multiple_queries_generated = 14;</code>
     */
    protected $multiple_queries_generated = false;
    /**
     * Indicates that the generated query contains search context.
     *
     * Generated from protobuf field <code>bool query_contained_search_context = 15;</code>
     */
    protected $query_contained_search_context = false;
    /**
     * Indicates that invalid items were skipped when parsing the LLM response.
     *
     * Generated from protobuf field <code>bool invalid_items_query_suggestion_skipped = 16;</code>
     */
    protected $invalid_items_query_suggestion_skipped = false;
    /**
     * True if the primary suggested query was redacted and replaced by an
     * additional query.
     *
     * Generated from protobuf field <code>bool primary_query_redacted_and_replaced = 17;</code>
     */
    protected $primary_query_redacted_and_replaced = false;
    /**
     * The number of search contexts appended to the query.
     *
     * Generated from protobuf field <code>int32 appended_search_context_count = 18;</code>
     */
    protected $appended_search_context_count = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type bool $answer_generation_rewriter_on
     *           Whether data store agent rewriter was turned off for the request.
     *     @type bool $end_user_metadata_included
     *           Whether end_user_metadata is included in the data store agent call.
     *     @type bool $return_query_only
     *           Whether customers configured to return query only in the
     *           conversation profile.
     *     @type bool $use_pubsub_delivery
     *           Whether customers configured to use pubsub to deliver.
     *     @type bool $disable_sync_delivery
     *           Whether customers configured to disable the synchronous delivery of
     *           Knowedge Assist response.
     *     @type bool $previous_queries_included
     *           Whether previously suggested queries are included in the query generation
     *           process.
     *     @type bool $use_translated_message
     *           Translated message is included in query generation process.
     *     @type bool $use_custom_safety_filter_level
     *           Safety filter is adjusted by user.
     *     @type bool $conversation_transcript_has_mixed_languages
     *           Conversation transcript has mixed languages.
     *     @type bool $query_generation_agent_language_mismatch
     *           Whether the agent language from the translation generator mismatches the
     *           end-user language.
     *     @type bool $query_generation_end_user_language_mismatch
     *           Whether the end-user language from the translation generator mismatches
     *           the end-user language.
     *     @type bool $third_party_connector_allowed
     *           This field indicates whether third party connectors are enabled for the
     *           project
     *     @type bool $multiple_queries_generated
     *           Indicates that the query generation model generated multiple queries.
     *     @type bool $query_contained_search_context
     *           Indicates that the generated query contains search context.
     *     @type bool $invalid_items_query_suggestion_skipped
     *           Indicates that invalid items were skipped when parsing the LLM response.
     *     @type bool $primary_query_redacted_and_replaced
     *           True if the primary suggested query was redacted and replaced by an
     *           additional query.
     *     @type int $appended_search_context_count
     *           The number of search contexts appended to the query.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Dialogflow\V2\Participant::initOnce();
        parent::__construct($data);
    }

    /**
     * Whether data store agent rewriter was turned off for the request.
     *
     * Generated from protobuf field <code>bool answer_generation_rewriter_on = 1;</code>
     * @return bool
     */
    public function getAnswerGenerationRewriterOn()
    {
        return $this->answer_generation_rewriter_on;
    }

    /**
     * Whether data store agent rewriter was turned off for the request.
     *
     * Generated from protobuf field <code>bool answer_generation_rewriter_on = 1;</code>
     * @param bool $var
     * @return $this
     */
    public function setAnswerGenerationRewriterOn($var)
    {
        GPBUtil::checkBool($var);
        $this->answer_generation_rewriter_on = $var;

        return $this;
    }

    /**
     * Whether end_user_metadata is included in the data store agent call.
     *
     * Generated from protobuf field <code>bool end_user_metadata_included = 2;</code>
     * @return bool
     */
    public function getEndUserMetadataIncluded()
    {
        return $this->end_user_metadata_included;
    }

    /**
     * Whether end_user_metadata is included in the data store agent call.
     *
     * Generated from protobuf field <code>bool end_user_metadata_included = 2;</code>
     * @param bool $var
     * @return $this
     */
    public function setEndUserMetadataIncluded($var)
    {
        GPBUtil::checkBool($var);
        $this->end_user_metadata_included = $var;

        return $this;
    }

    /**
     * Whether customers configured to return query only in the
     * conversation profile.
     *
     * Generated from protobuf field <code>bool return_query_only = 4;</code>
     * @return bool
     */
    public function getReturnQueryOnly()
    {
        return $this->return_query_only;
    }

    /**
     * Whether customers configured to return query only in the
     * conversation profile.
     *
     * Generated from protobuf field <code>bool return_query_only = 4;</code>
     * @param bool $var
     * @return $this
     */
    public function setReturnQueryOnly($var)
    {
        GPBUtil::checkBool($var);
        $this->return_query_only = $var;

        return $this;
    }

    /**
     * Whether customers configured to use pubsub to deliver.
     *
     * Generated from protobuf field <code>bool use_pubsub_delivery = 5;</code>
     * @return bool
     */
    public function getUsePubsubDelivery()
    {
        return $this->use_pubsub_delivery;
    }

    /**
     * Whether customers configured to use pubsub to deliver.
     *
     * Generated from protobuf field <code>bool use_pubsub_delivery = 5;</code>
     * @param bool $var
     * @return $this
     */
    public function setUsePubsubDelivery($var)
    {
        GPBUtil::checkBool($var);
        $this->use_pubsub_delivery = $var;

        return $this;
    }

    /**
     * Whether customers configured to disable the synchronous delivery of
     * Knowedge Assist response.
     *
     * Generated from protobuf field <code>bool disable_sync_delivery = 6;</code>
     * @return bool
     */
    public function getDisableSyncDelivery()
    {
        return $this->disable_sync_delivery;
    }

    /**
     * Whether customers configured to disable the synchronous delivery of
     * Knowedge Assist response.
     *
     * Generated from protobuf field <code>bool disable_sync_delivery = 6;</code>
     * @param bool $var
     * @return $this
     */
    public function setDisableSyncDelivery($var)
    {
        GPBUtil::checkBool($var);
        $this->disable_sync_delivery = $var;

        return $this;
    }

    /**
     * Whether previously suggested queries are included in the query generation
     * process.
     *
     * Generated from protobuf field <code>bool previous_queries_included = 7;</code>
     * @return bool
     */
    public function getPreviousQueriesIncluded()
    {
        return $this->previous_queries_included;
    }

    /**
     * Whether previously suggested queries are included in the query generation
     * process.
     *
     * Generated from protobuf field <code>bool previous_queries_included = 7;</code>
     * @param bool $var
     * @return $this
     */
    public function setPreviousQueriesIncluded($var)
    {
        GPBUtil::checkBool($var);
        $this->previous_queries_included = $var;

        return $this;
    }

    /**
     * Translated message is included in query generation process.
     *
     * Generated from protobuf field <code>bool use_translated_message = 8;</code>
     * @return bool
     */
    public function getUseTranslatedMessage()
    {
        return $this->use_translated_message;
    }

    /**
     * Translated message is included in query generation process.
     *
     * Generated from protobuf field <code>bool use_translated_message = 8;</code>
     * @param bool $var
     * @return $this
     */
    public function setUseTranslatedMessage($var)
    {
        GPBUtil::checkBool($var);
        $this->use_translated_message = $var;

        return $this;
    }

    /**
     * Safety filter is adjusted by user.
     *
     * Generated from protobuf field <code>bool use_custom_safety_filter_level = 9;</code>
     * @return bool
     */
    public function getUseCustomSafetyFilterLevel()
    {
        return $this->use_custom_safety_filter_level;
    }

    /**
     * Safety filter is adjusted by user.
     *
     * Generated from protobuf field <code>bool use_custom_safety_filter_level = 9;</code>
     * @param bool $var
     * @return $this
     */
    public function setUseCustomSafetyFilterLevel($var)
    {
        GPBUtil::checkBool($var);
        $this->use_custom_safety_filter_level = $var;

        return $this;
    }

    /**
     * Conversation transcript has mixed languages.
     *
     * Generated from protobuf field <code>bool conversation_transcript_has_mixed_languages = 10;</code>
     * @return bool
     */
    public function getConversationTranscriptHasMixedLanguages()
    {
        return $this->conversation_transcript_has_mixed_languages;
    }

    /**
     * Conversation transcript has mixed languages.
     *
     * Generated from protobuf field <code>bool conversation_transcript_has_mixed_languages = 10;</code>
     * @param bool $var
     * @return $this
     */
    public function setConversationTranscriptHasMixedLanguages($var)
    {
        GPBUtil::checkBool($var);
        $this->conversation_transcript_has_mixed_languages = $var;

        return $this;
    }

    /**
     * Whether the agent language from the translation generator mismatches the
     * end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_agent_language_mismatch = 11;</code>
     * @return bool
     */
    public function getQueryGenerationAgentLanguageMismatch()
    {
        return $this->query_generation_agent_language_mismatch;
    }

    /**
     * Whether the agent language from the translation generator mismatches the
     * end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_agent_language_mismatch = 11;</code>
     * @param bool $var
     * @return $this
     */
    public function setQueryGenerationAgentLanguageMismatch($var)
    {
        GPBUtil::checkBool($var);
        $this->query_generation_agent_language_mismatch = $var;

        return $this;
    }

    /**
     * Whether the end-user language from the translation generator mismatches
     * the end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_end_user_language_mismatch = 12;</code>
     * @return bool
     */
    public function getQueryGenerationEndUserLanguageMismatch()
    {
        return $this->query_generation_end_user_language_mismatch;
    }

    /**
     * Whether the end-user language from the translation generator mismatches
     * the end-user language.
     *
     * Generated from protobuf field <code>bool query_generation_end_user_language_mismatch = 12;</code>
     * @param bool $var
     * @return $this
     */
    public function setQueryGenerationEndUserLanguageMismatch($var)
    {
        GPBUtil::checkBool($var);
        $this->query_generation_end_user_language_mismatch = $var;

        return $this;
    }

    /**
     * This field indicates whether third party connectors are enabled for the
     * project
     *
     * Generated from protobuf field <code>bool third_party_connector_allowed = 13;</code>
     * @return bool
     */
    public function getThirdPartyConnectorAllowed()
    {
        return $this->third_party_connector_allowed;
    }

    /**
     * This field indicates whether third party connectors are enabled for the
     * project
     *
     * Generated from protobuf field <code>bool third_party_connector_allowed = 13;</code>
     * @param bool $var
     * @return $this
     */
    public function setThirdPartyConnectorAllowed($var)
    {
        GPBUtil::checkBool($var);
        $this->third_party_connector_allowed = $var;

        return $this;
    }

    /**
     * Indicates that the query generation model generated multiple queries.
     *
     * Generated from protobuf field <code>bool multiple_queries_generated = 14;</code>
     * @return bool
     */
    public function getMultipleQueriesGenerated()
    {
        return $this->multiple_queries_generated;
    }

    /**
     * Indicates that the query generation model generated multiple queries.
     *
     * Generated from protobuf field <code>bool multiple_queries_generated = 14;</code>
     * @param bool $var
     * @return $this
     */
    public function setMultipleQueriesGenerated($var)
    {
        GPBUtil::checkBool($var);
        $this->multiple_queries_generated = $var;

        return $this;
    }

    /**
     * Indicates that the generated query contains search context.
     *
     * Generated from protobuf field <code>bool query_contained_search_context = 15;</code>
     * @return bool
     */
    public function getQueryContainedSearchContext()
    {
        return $this->query_contained_search_context;
    }

    /**
     * Indicates that the generated query contains search context.
     *
     * Generated from protobuf field <code>bool query_contained_search_context = 15;</code>
     * @param bool $var
     * @return $this
     */
    public function setQueryContainedSearchContext($var)
    {
        GPBUtil::checkBool($var);
        $this->query_contained_search_context = $var;

        return $this;
    }

    /**
     * Indicates that invalid items were skipped when parsing the LLM response.
     *
     * Generated from protobuf field <code>bool invalid_items_query_suggestion_skipped = 16;</code>
     * @return bool
     */
    public function getInvalidItemsQuerySuggestionSkipped()
    {
        return $this->invalid_items_query_suggestion_skipped;
    }

    /**
     * Indicates that invalid items were skipped when parsing the LLM response.
     *
     * Generated from protobuf field <code>bool invalid_items_query_suggestion_skipped = 16;</code>
     * @param bool $var
     * @return $this
     */
    public function setInvalidItemsQuerySuggestionSkipped($var)
    {
        GPBUtil::checkBool($var);
        $this->invalid_items_query_suggestion_skipped = $var;

        return $this;
    }

    /**
     * True if the primary suggested query was redacted and replaced by an
     * additional query.
     *
     * Generated from protobuf field <code>bool primary_query_redacted_and_replaced = 17;</code>
     * @return bool
     */
    public function getPrimaryQueryRedactedAndReplaced()
    {
        return $this->primary_query_redacted_and_replaced;
    }

    /**
     * True if the primary suggested query was redacted and replaced by an
     * additional query.
     *
     * Generated from protobuf field <code>bool primary_query_redacted_and_replaced = 17;</code>
     * @param bool $var
     * @return $this
     */
    public function setPrimaryQueryRedactedAndReplaced($var)
    {
        GPBUtil::checkBool($var);
        $this->primary_query_redacted_and_replaced = $var;

        return $this;
    }

    /**
     * The number of search contexts appended to the query.
     *
     * Generated from protobuf field <code>int32 appended_search_context_count = 18;</code>
     * @return int
     */
    public function getAppendedSearchContextCount()
    {
        return $this->appended_search_context_count;
    }

    /**
     * The number of search contexts appended to the query.
     *
     * Generated from protobuf field <code>int32 appended_search_context_count = 18;</code>
     * @param int $var
     * @return $this
     */
    public function setAppendedSearchContextCount($var)
    {
        GPBUtil::checkInt32($var);
        $this->appended_search_context_count = $var;

        return $this;
    }

}

