diff --git a/DialogflowCx/metadata/V3/AdvancedSettings.php b/DialogflowCx/metadata/V3/AdvancedSettings.php index c48431c45e09..12b1a373f4a6 100644 --- a/DialogflowCx/metadata/V3/AdvancedSettings.php +++ b/DialogflowCx/metadata/V3/AdvancedSettings.php @@ -16,22 +16,36 @@ public static function initOnce() { } \GPBMetadata\Google\Api\FieldBehavior::initOnce(); \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Gcs::initOnce(); + \GPBMetadata\Google\Protobuf\Duration::initOnce(); $pool->internalAddGeneratedFile( ' - -5google/cloud/dialogflow/cx/v3/advanced_settings.protogoogle.cloud.dialogflow.cx.v3\'google/cloud/dialogflow/cx/v3/gcs.proto" + + +5google/cloud/dialogflow/cx/v3/advanced_settings.protogoogle.cloud.dialogflow.cx.v3\'google/cloud/dialogflow/cx/v3/gcs.protogoogle/protobuf/duration.proto" AdvancedSettingsS -audio_export_gcs_destination ( 2-.google.cloud.dialogflow.cx.v3.GcsDestinationS +audio_export_gcs_destination ( 2-.google.cloud.dialogflow.cx.v3.GcsDestinationW +speech_settings ( 2>.google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettingsS dtmf_settings ( 2<.google.cloud.dialogflow.cx.v3.AdvancedSettings.DtmfSettingsY -logging_settings ( 2?.google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettingsI +logging_settings ( 2?.google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings +SpeechSettings +endpointer_sensitivity (4 +no_speech_timeout ( 2.google.protobuf.Duration% +use_timeout_based_endpointing (Z +models ( 2J.google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettings.ModelsEntry- + ModelsEntry +key (  +value ( :8 DtmfSettings enabled ( max_digits ( - finish_digit ( Y + finish_digit ( > +interdigit_timeout_duration ( 2.google.protobuf.Duration? +endpointing_timeout_duration ( 2.google.protobuf.Duration LoggingSettings" enable_stackdriver_logging (" -enable_interaction_logging (B +enable_interaction_logging (& +enable_consent_based_redaction (B !com.google.cloud.dialogflow.cx.v3BAdvancedSettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbDFGoogle.Cloud.Dialogflow.Cx.V3!Google::Cloud::Dialogflow::CX::V3bproto3' , true); diff --git a/DialogflowCx/metadata/V3/Agent.php b/DialogflowCx/metadata/V3/Agent.php index a651636ae1df..6f49d64ae289 100644 Binary files a/DialogflowCx/metadata/V3/Agent.php and b/DialogflowCx/metadata/V3/Agent.php differ diff --git a/DialogflowCx/metadata/V3/DataStoreConnection.php b/DialogflowCx/metadata/V3/DataStoreConnection.php index aaea48045058..259eb0c7eebc 100644 Binary files a/DialogflowCx/metadata/V3/DataStoreConnection.php and b/DialogflowCx/metadata/V3/DataStoreConnection.php differ diff --git a/DialogflowCx/metadata/V3/Flow.php b/DialogflowCx/metadata/V3/Flow.php index ffc112f26040..f83739cb1bc3 100644 Binary files a/DialogflowCx/metadata/V3/Flow.php and b/DialogflowCx/metadata/V3/Flow.php differ diff --git a/DialogflowCx/metadata/V3/SecuritySettings.php b/DialogflowCx/metadata/V3/SecuritySettings.php index 6e1fe9913410..c6e8d501d6ca 100644 Binary files a/DialogflowCx/metadata/V3/SecuritySettings.php and b/DialogflowCx/metadata/V3/SecuritySettings.php differ diff --git a/DialogflowCx/metadata/V3/Session.php b/DialogflowCx/metadata/V3/Session.php index e0dbe4ca4daf..7cf1792a81ce 100644 Binary files a/DialogflowCx/metadata/V3/Session.php and b/DialogflowCx/metadata/V3/Session.php differ diff --git a/DialogflowCx/metadata/V3/Webhook.php b/DialogflowCx/metadata/V3/Webhook.php index 0535eb049965..c0e6a78502ae 100644 Binary files a/DialogflowCx/metadata/V3/Webhook.php and b/DialogflowCx/metadata/V3/Webhook.php differ diff --git a/DialogflowCx/src/V3/AdvancedSettings.php b/DialogflowCx/src/V3/AdvancedSettings.php index efe22330ada5..c7b11834998f 100644 --- a/DialogflowCx/src/V3/AdvancedSettings.php +++ b/DialogflowCx/src/V3/AdvancedSettings.php @@ -33,6 +33,17 @@ class AdvancedSettings extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.GcsDestination audio_export_gcs_destination = 2; */ protected $audio_export_gcs_destination = null; + /** + * Settings for speech to text detection. + * Exposed at the following levels: + * - Agent level + * - Flow level + * - Page level + * - Parameter level + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettings speech_settings = 3; + */ + protected $speech_settings = null; /** * Settings for DTMF. * Exposed at the following levels: @@ -67,6 +78,13 @@ class AdvancedSettings extends \Google\Protobuf\Internal\Message * Exposed at the following levels: * - Agent level * - Flow level + * @type \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\SpeechSettings $speech_settings + * Settings for speech to text detection. + * Exposed at the following levels: + * - Agent level + * - Flow level + * - Page level + * - Parameter level * @type \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\DtmfSettings $dtmf_settings * Settings for DTMF. * Exposed at the following levels: @@ -131,6 +149,52 @@ public function setAudioExportGcsDestination($var) return $this; } + /** + * Settings for speech to text detection. + * Exposed at the following levels: + * - Agent level + * - Flow level + * - Page level + * - Parameter level + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettings speech_settings = 3; + * @return \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\SpeechSettings|null + */ + public function getSpeechSettings() + { + return $this->speech_settings; + } + + public function hasSpeechSettings() + { + return isset($this->speech_settings); + } + + public function clearSpeechSettings() + { + unset($this->speech_settings); + } + + /** + * Settings for speech to text detection. + * Exposed at the following levels: + * - Agent level + * - Flow level + * - Page level + * - Parameter level + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettings speech_settings = 3; + * @param \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\SpeechSettings $var + * @return $this + */ + public function setSpeechSettings($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\SpeechSettings::class); + $this->speech_settings = $var; + + return $this; + } + /** * Settings for DTMF. * Exposed at the following levels: diff --git a/DialogflowCx/src/V3/AdvancedSettings/DtmfSettings.php b/DialogflowCx/src/V3/AdvancedSettings/DtmfSettings.php index 0b5d912a9773..d01b87fc2c21 100644 --- a/DialogflowCx/src/V3/AdvancedSettings/DtmfSettings.php +++ b/DialogflowCx/src/V3/AdvancedSettings/DtmfSettings.php @@ -38,6 +38,18 @@ class DtmfSettings extends \Google\Protobuf\Internal\Message * Generated from protobuf field string finish_digit = 3; */ protected $finish_digit = ''; + /** + * Interdigit timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration interdigit_timeout_duration = 6; + */ + protected $interdigit_timeout_duration = null; + /** + * Endpoint timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration endpointing_timeout_duration = 7; + */ + protected $endpointing_timeout_duration = null; /** * Constructor. @@ -56,6 +68,10 @@ class DtmfSettings extends \Google\Protobuf\Internal\Message * Max length of DTMF digits. * @type string $finish_digit * The digit that terminates a DTMF digit sequence. + * @type \Google\Protobuf\Duration $interdigit_timeout_duration + * Interdigit timeout setting for matching dtmf input to regex. + * @type \Google\Protobuf\Duration $endpointing_timeout_duration + * Endpoint timeout setting for matching dtmf input to regex. * } */ public function __construct($data = NULL) { @@ -151,6 +167,78 @@ public function setFinishDigit($var) return $this; } + /** + * Interdigit timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration interdigit_timeout_duration = 6; + * @return \Google\Protobuf\Duration|null + */ + public function getInterdigitTimeoutDuration() + { + return $this->interdigit_timeout_duration; + } + + public function hasInterdigitTimeoutDuration() + { + return isset($this->interdigit_timeout_duration); + } + + public function clearInterdigitTimeoutDuration() + { + unset($this->interdigit_timeout_duration); + } + + /** + * Interdigit timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration interdigit_timeout_duration = 6; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setInterdigitTimeoutDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->interdigit_timeout_duration = $var; + + return $this; + } + + /** + * Endpoint timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration endpointing_timeout_duration = 7; + * @return \Google\Protobuf\Duration|null + */ + public function getEndpointingTimeoutDuration() + { + return $this->endpointing_timeout_duration; + } + + public function hasEndpointingTimeoutDuration() + { + return isset($this->endpointing_timeout_duration); + } + + public function clearEndpointingTimeoutDuration() + { + unset($this->endpointing_timeout_duration); + } + + /** + * Endpoint timeout setting for matching dtmf input to regex. + * + * Generated from protobuf field .google.protobuf.Duration endpointing_timeout_duration = 7; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setEndpointingTimeoutDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->endpointing_timeout_duration = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php b/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php index 217364b71858..92f4573527f8 100644 --- a/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php +++ b/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php @@ -16,17 +16,25 @@ class LoggingSettings extends \Google\Protobuf\Internal\Message { /** - * If true, StackDriver logging is currently enabled. + * Enables StackDriver logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; */ protected $enable_stackdriver_logging = false; /** - * If true, DF Interaction logging is currently enabled. + * Enables DF Interaction logging. * * Generated from protobuf field bool enable_interaction_logging = 3; */ protected $enable_interaction_logging = false; + /** + * Enables consent-based end-user input redaction, if true, a pre-defined + * session parameter `$session.params.conversation-redaction` will be + * used to determine if the utterance should be redacted. + * + * Generated from protobuf field bool enable_consent_based_redaction = 4; + */ + protected $enable_consent_based_redaction = false; /** * Constructor. @@ -35,9 +43,13 @@ class LoggingSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $enable_stackdriver_logging - * If true, StackDriver logging is currently enabled. + * Enables StackDriver logging. * @type bool $enable_interaction_logging - * If true, DF Interaction logging is currently enabled. + * Enables DF Interaction logging. + * @type bool $enable_consent_based_redaction + * Enables consent-based end-user input redaction, if true, a pre-defined + * session parameter `$session.params.conversation-redaction` will be + * used to determine if the utterance should be redacted. * } */ public function __construct($data = NULL) { @@ -46,7 +58,7 @@ public function __construct($data = NULL) { } /** - * If true, StackDriver logging is currently enabled. + * Enables StackDriver logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; * @return bool @@ -57,7 +69,7 @@ public function getEnableStackdriverLogging() } /** - * If true, StackDriver logging is currently enabled. + * Enables StackDriver logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; * @param bool $var @@ -72,7 +84,7 @@ public function setEnableStackdriverLogging($var) } /** - * If true, DF Interaction logging is currently enabled. + * Enables DF Interaction logging. * * Generated from protobuf field bool enable_interaction_logging = 3; * @return bool @@ -83,7 +95,7 @@ public function getEnableInteractionLogging() } /** - * If true, DF Interaction logging is currently enabled. + * Enables DF Interaction logging. * * Generated from protobuf field bool enable_interaction_logging = 3; * @param bool $var @@ -97,6 +109,36 @@ public function setEnableInteractionLogging($var) return $this; } + /** + * Enables consent-based end-user input redaction, if true, a pre-defined + * session parameter `$session.params.conversation-redaction` will be + * used to determine if the utterance should be redacted. + * + * Generated from protobuf field bool enable_consent_based_redaction = 4; + * @return bool + */ + public function getEnableConsentBasedRedaction() + { + return $this->enable_consent_based_redaction; + } + + /** + * Enables consent-based end-user input redaction, if true, a pre-defined + * session parameter `$session.params.conversation-redaction` will be + * used to determine if the utterance should be redacted. + * + * Generated from protobuf field bool enable_consent_based_redaction = 4; + * @param bool $var + * @return $this + */ + public function setEnableConsentBasedRedaction($var) + { + GPBUtil::checkBool($var); + $this->enable_consent_based_redaction = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/AdvancedSettings/SpeechSettings.php b/DialogflowCx/src/V3/AdvancedSettings/SpeechSettings.php new file mode 100644 index 000000000000..b52a81dca803 --- /dev/null +++ b/DialogflowCx/src/V3/AdvancedSettings/SpeechSettings.php @@ -0,0 +1,204 @@ +google.cloud.dialogflow.cx.v3.AdvancedSettings.SpeechSettings + */ +class SpeechSettings extends \Google\Protobuf\Internal\Message +{ + /** + * Sensitivity of the speech model that detects the end of speech. + * Scale from 0 to 100. + * + * Generated from protobuf field int32 endpointer_sensitivity = 1; + */ + protected $endpointer_sensitivity = 0; + /** + * Timeout before detecting no speech. + * + * Generated from protobuf field .google.protobuf.Duration no_speech_timeout = 2; + */ + protected $no_speech_timeout = null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as + * seconds of timeout value. + * + * Generated from protobuf field bool use_timeout_based_endpointing = 3; + */ + protected $use_timeout_based_endpointing = false; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text + * model will be selected for requests from its corresponding language. + * For more information, see + * [Speech + * models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + * + * Generated from protobuf field map models = 5; + */ + private $models; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $endpointer_sensitivity + * Sensitivity of the speech model that detects the end of speech. + * Scale from 0 to 100. + * @type \Google\Protobuf\Duration $no_speech_timeout + * Timeout before detecting no speech. + * @type bool $use_timeout_based_endpointing + * Use timeout based endpointing, interpreting endpointer sensitivy as + * seconds of timeout value. + * @type array|\Google\Protobuf\Internal\MapField $models + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text + * model will be selected for requests from its corresponding language. + * For more information, see + * [Speech + * models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings::initOnce(); + parent::__construct($data); + } + + /** + * Sensitivity of the speech model that detects the end of speech. + * Scale from 0 to 100. + * + * Generated from protobuf field int32 endpointer_sensitivity = 1; + * @return int + */ + public function getEndpointerSensitivity() + { + return $this->endpointer_sensitivity; + } + + /** + * Sensitivity of the speech model that detects the end of speech. + * Scale from 0 to 100. + * + * Generated from protobuf field int32 endpointer_sensitivity = 1; + * @param int $var + * @return $this + */ + public function setEndpointerSensitivity($var) + { + GPBUtil::checkInt32($var); + $this->endpointer_sensitivity = $var; + + return $this; + } + + /** + * Timeout before detecting no speech. + * + * Generated from protobuf field .google.protobuf.Duration no_speech_timeout = 2; + * @return \Google\Protobuf\Duration|null + */ + public function getNoSpeechTimeout() + { + return $this->no_speech_timeout; + } + + public function hasNoSpeechTimeout() + { + return isset($this->no_speech_timeout); + } + + public function clearNoSpeechTimeout() + { + unset($this->no_speech_timeout); + } + + /** + * Timeout before detecting no speech. + * + * Generated from protobuf field .google.protobuf.Duration no_speech_timeout = 2; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setNoSpeechTimeout($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->no_speech_timeout = $var; + + return $this; + } + + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as + * seconds of timeout value. + * + * Generated from protobuf field bool use_timeout_based_endpointing = 3; + * @return bool + */ + public function getUseTimeoutBasedEndpointing() + { + return $this->use_timeout_based_endpointing; + } + + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as + * seconds of timeout value. + * + * Generated from protobuf field bool use_timeout_based_endpointing = 3; + * @param bool $var + * @return $this + */ + public function setUseTimeoutBasedEndpointing($var) + { + GPBUtil::checkBool($var); + $this->use_timeout_based_endpointing = $var; + + return $this; + } + + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text + * model will be selected for requests from its corresponding language. + * For more information, see + * [Speech + * models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + * + * Generated from protobuf field map models = 5; + * @return \Google\Protobuf\Internal\MapField + */ + public function getModels() + { + return $this->models; + } + + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text + * model will be selected for requests from its corresponding language. + * For more information, see + * [Speech + * models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + * + * Generated from protobuf field map models = 5; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setModels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->models = $arr; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/Agent.php b/DialogflowCx/src/V3/Agent.php index a7645db10672..9a52d873ce1d 100644 --- a/DialogflowCx/src/V3/Agent.php +++ b/DialogflowCx/src/V3/Agent.php @@ -97,8 +97,7 @@ class Agent extends \Google\Protobuf\Internal\Message * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by * deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start - * flow with id "00000000-0000-0000-0000-000000000000" is allowed. + * ID>/agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { */ @@ -129,6 +128,13 @@ class Agent extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool enable_spell_correction = 20; */ protected $enable_spell_correction = false; + /** + * Optional. Enable training multi-lingual models for this agent. These models + * will be trained on all the languages supported by the agent. + * + * Generated from protobuf field bool enable_multi_language_training = 40 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_multi_language_training = false; /** * Indicates whether the agent is locked for changes. If the agent is locked, * modifications to the agent will be rejected except for [RestoreAgent][]. @@ -168,6 +174,12 @@ class Agent extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL]; */ protected $answer_feedback_settings = null; + /** + * Optional. Settings for end user personalization. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $personalization_settings = null; /** * Constructor. @@ -214,8 +226,7 @@ class Agent extends \Google\Protobuf\Internal\Message * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by * deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start - * flow with id "00000000-0000-0000-0000-000000000000" is allowed. + * ID>/agents//flows/`. * @type string $security_settings * Name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] @@ -229,6 +240,9 @@ class Agent extends \Google\Protobuf\Internal\Message * @type bool $enable_spell_correction * Indicates if automatic spell correction is enabled in detect intent * requests. + * @type bool $enable_multi_language_training + * Optional. Enable training multi-lingual models for this agent. These models + * will be trained on all the languages supported by the agent. * @type bool $locked * Indicates whether the agent is locked for changes. If the agent is locked, * modifications to the agent will be rejected except for [RestoreAgent][]. @@ -244,6 +258,8 @@ class Agent extends \Google\Protobuf\Internal\Message * Gen App Builder-related agent-level settings. * @type \Google\Cloud\Dialogflow\Cx\V3\Agent\AnswerFeedbackSettings $answer_feedback_settings * Optional. Answer feedback collection settings. + * @type \Google\Cloud\Dialogflow\Cx\V3\Agent\PersonalizationSettings $personalization_settings + * Optional. Settings for end user personalization. * } */ public function __construct($data = NULL) { @@ -511,8 +527,7 @@ public function setSpeechToTextSettings($var) * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by * deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start - * flow with id "00000000-0000-0000-0000-000000000000" is allowed. + * ID>/agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * @return string @@ -526,8 +541,7 @@ public function getStartFlow() * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by * deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start - * flow with id "00000000-0000-0000-0000-000000000000" is allowed. + * ID>/agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * @param string $var @@ -637,6 +651,34 @@ public function setEnableSpellCorrection($var) return $this; } + /** + * Optional. Enable training multi-lingual models for this agent. These models + * will be trained on all the languages supported by the agent. + * + * Generated from protobuf field bool enable_multi_language_training = 40 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableMultiLanguageTraining() + { + return $this->enable_multi_language_training; + } + + /** + * Optional. Enable training multi-lingual models for this agent. These models + * will be trained on all the languages supported by the agent. + * + * Generated from protobuf field bool enable_multi_language_training = 40 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableMultiLanguageTraining($var) + { + GPBUtil::checkBool($var); + $this->enable_multi_language_training = $var; + + return $this; + } + /** * Indicates whether the agent is locked for changes. If the agent is locked, * modifications to the agent will be rejected except for [RestoreAgent][]. @@ -849,5 +891,41 @@ public function setAnswerFeedbackSettings($var) return $this; } + /** + * Optional. Settings for end user personalization. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\Agent\PersonalizationSettings|null + */ + public function getPersonalizationSettings() + { + return $this->personalization_settings; + } + + public function hasPersonalizationSettings() + { + return isset($this->personalization_settings); + } + + public function clearPersonalizationSettings() + { + unset($this->personalization_settings); + } + + /** + * Optional. Settings for end user personalization. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\Agent\PersonalizationSettings $var + * @return $this + */ + public function setPersonalizationSettings($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Agent\PersonalizationSettings::class); + $this->personalization_settings = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/Agent/PersonalizationSettings.php b/DialogflowCx/src/V3/Agent/PersonalizationSettings.php new file mode 100644 index 000000000000..f91907603c1d --- /dev/null +++ b/DialogflowCx/src/V3/Agent/PersonalizationSettings.php @@ -0,0 +1,106 @@ +google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings + */ +class PersonalizationSettings extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Default end user metadata, used when processing DetectIntent + * requests. Recommended to be filled as a template instead of hard-coded + * value, for example { "age": "$session.params.age" }. The data will be + * merged with the + * [QueryParameters.end_user_metadata][google.cloud.dialogflow.cx.v3.QueryParameters.end_user_metadata] + * in + * [DetectIntentRequest.query_params][google.cloud.dialogflow.cx.v3.DetectIntentRequest.query_params] + * during query processing. + * + * Generated from protobuf field .google.protobuf.Struct default_end_user_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $default_end_user_metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Struct $default_end_user_metadata + * Optional. Default end user metadata, used when processing DetectIntent + * requests. Recommended to be filled as a template instead of hard-coded + * value, for example { "age": "$session.params.age" }. The data will be + * merged with the + * [QueryParameters.end_user_metadata][google.cloud.dialogflow.cx.v3.QueryParameters.end_user_metadata] + * in + * [DetectIntentRequest.query_params][google.cloud.dialogflow.cx.v3.DetectIntentRequest.query_params] + * during query processing. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Agent::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Default end user metadata, used when processing DetectIntent + * requests. Recommended to be filled as a template instead of hard-coded + * value, for example { "age": "$session.params.age" }. The data will be + * merged with the + * [QueryParameters.end_user_metadata][google.cloud.dialogflow.cx.v3.QueryParameters.end_user_metadata] + * in + * [DetectIntentRequest.query_params][google.cloud.dialogflow.cx.v3.DetectIntentRequest.query_params] + * during query processing. + * + * Generated from protobuf field .google.protobuf.Struct default_end_user_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Struct|null + */ + public function getDefaultEndUserMetadata() + { + return $this->default_end_user_metadata; + } + + public function hasDefaultEndUserMetadata() + { + return isset($this->default_end_user_metadata); + } + + public function clearDefaultEndUserMetadata() + { + unset($this->default_end_user_metadata); + } + + /** + * Optional. Default end user metadata, used when processing DetectIntent + * requests. Recommended to be filled as a template instead of hard-coded + * value, for example { "age": "$session.params.age" }. The data will be + * merged with the + * [QueryParameters.end_user_metadata][google.cloud.dialogflow.cx.v3.QueryParameters.end_user_metadata] + * in + * [DetectIntentRequest.query_params][google.cloud.dialogflow.cx.v3.DetectIntentRequest.query_params] + * during query processing. + * + * Generated from protobuf field .google.protobuf.Struct default_end_user_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Struct $var + * @return $this + */ + public function setDefaultEndUserMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class); + $this->default_end_user_metadata = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals.php b/DialogflowCx/src/V3/DataStoreConnectionSignals.php new file mode 100644 index 000000000000..67df54bb0610 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals.php @@ -0,0 +1,394 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals + */ +class DataStoreConnectionSignals extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Diagnostic info related to the rewriter model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $rewriter_model_call_signals = null; + /** + * Optional. Rewritten string query used for search. + * + * Generated from protobuf field string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $rewritten_query = ''; + /** + * Optional. Search snippets included in the answer generation prompt. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $search_snippets; + /** + * Optional. Diagnostic info related to the answer generation model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $answer_generation_model_call_signals = null; + /** + * Optional. The final compiled answer. + * + * Generated from protobuf field string answer = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $answer = ''; + /** + * Optional. Answer parts with relevant citations. + * Concatenation of texts should add up the `answer` (not counting + * whitespaces). + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $answer_parts; + /** + * Optional. Snippets cited by the answer generation model from the most to + * least relevant. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $cited_snippets; + /** + * Optional. Grounding signals. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $grounding_signals = null; + /** + * Optional. Safety check result. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $safety_signals = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\RewriterModelCallSignals $rewriter_model_call_signals + * Optional. Diagnostic info related to the rewriter model call. + * @type string $rewritten_query + * Optional. Rewritten string query used for search. + * @type array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet>|\Google\Protobuf\Internal\RepeatedField $search_snippets + * Optional. Search snippets included in the answer generation prompt. + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerGenerationModelCallSignals $answer_generation_model_call_signals + * Optional. Diagnostic info related to the answer generation model call. + * @type string $answer + * Optional. The final compiled answer. + * @type array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerPart>|\Google\Protobuf\Internal\RepeatedField $answer_parts + * Optional. Answer parts with relevant citations. + * Concatenation of texts should add up the `answer` (not counting + * whitespaces). + * @type array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\CitedSnippet>|\Google\Protobuf\Internal\RepeatedField $cited_snippets + * Optional. Snippets cited by the answer generation model from the most to + * least relevant. + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals $grounding_signals + * Optional. Grounding signals. + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals $safety_signals + * Optional. Safety check result. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Diagnostic info related to the rewriter model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\RewriterModelCallSignals|null + */ + public function getRewriterModelCallSignals() + { + return $this->rewriter_model_call_signals; + } + + public function hasRewriterModelCallSignals() + { + return isset($this->rewriter_model_call_signals); + } + + public function clearRewriterModelCallSignals() + { + unset($this->rewriter_model_call_signals); + } + + /** + * Optional. Diagnostic info related to the rewriter model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\RewriterModelCallSignals $var + * @return $this + */ + public function setRewriterModelCallSignals($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\RewriterModelCallSignals::class); + $this->rewriter_model_call_signals = $var; + + return $this; + } + + /** + * Optional. Rewritten string query used for search. + * + * Generated from protobuf field string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRewrittenQuery() + { + return $this->rewritten_query; + } + + /** + * Optional. Rewritten string query used for search. + * + * Generated from protobuf field string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRewrittenQuery($var) + { + GPBUtil::checkString($var, True); + $this->rewritten_query = $var; + + return $this; + } + + /** + * Optional. Search snippets included in the answer generation prompt. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSearchSnippets() + { + return $this->search_snippets; + } + + /** + * Optional. Search snippets included in the answer generation prompt. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSearchSnippets($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet::class); + $this->search_snippets = $arr; + + return $this; + } + + /** + * Optional. Diagnostic info related to the answer generation model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerGenerationModelCallSignals|null + */ + public function getAnswerGenerationModelCallSignals() + { + return $this->answer_generation_model_call_signals; + } + + public function hasAnswerGenerationModelCallSignals() + { + return isset($this->answer_generation_model_call_signals); + } + + public function clearAnswerGenerationModelCallSignals() + { + unset($this->answer_generation_model_call_signals); + } + + /** + * Optional. Diagnostic info related to the answer generation model call. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerGenerationModelCallSignals $var + * @return $this + */ + public function setAnswerGenerationModelCallSignals($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerGenerationModelCallSignals::class); + $this->answer_generation_model_call_signals = $var; + + return $this; + } + + /** + * Optional. The final compiled answer. + * + * Generated from protobuf field string answer = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getAnswer() + { + return $this->answer; + } + + /** + * Optional. The final compiled answer. + * + * Generated from protobuf field string answer = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setAnswer($var) + { + GPBUtil::checkString($var, True); + $this->answer = $var; + + return $this; + } + + /** + * Optional. Answer parts with relevant citations. + * Concatenation of texts should add up the `answer` (not counting + * whitespaces). + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAnswerParts() + { + return $this->answer_parts; + } + + /** + * Optional. Answer parts with relevant citations. + * Concatenation of texts should add up the `answer` (not counting + * whitespaces). + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerPart>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAnswerParts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\AnswerPart::class); + $this->answer_parts = $arr; + + return $this; + } + + /** + * Optional. Snippets cited by the answer generation model from the most to + * least relevant. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCitedSnippets() + { + return $this->cited_snippets; + } + + /** + * Optional. Snippets cited by the answer generation model from the most to + * least relevant. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\CitedSnippet>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCitedSnippets($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\CitedSnippet::class); + $this->cited_snippets = $arr; + + return $this; + } + + /** + * Optional. Grounding signals. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals|null + */ + public function getGroundingSignals() + { + return $this->grounding_signals; + } + + public function hasGroundingSignals() + { + return isset($this->grounding_signals); + } + + public function clearGroundingSignals() + { + unset($this->grounding_signals); + } + + /** + * Optional. Grounding signals. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals $var + * @return $this + */ + public function setGroundingSignals($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals::class); + $this->grounding_signals = $var; + + return $this; + } + + /** + * Optional. Safety check result. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals|null + */ + public function getSafetySignals() + { + return $this->safety_signals; + } + + public function hasSafetySignals() + { + return isset($this->safety_signals); + } + + public function clearSafetySignals() + { + unset($this->safety_signals); + } + + /** + * Optional. Safety check result. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals $var + * @return $this + */ + public function setSafetySignals($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals::class); + $this->safety_signals = $var; + + return $this; + } + +} + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerGenerationModelCallSignals.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerGenerationModelCallSignals.php new file mode 100644 index 000000000000..519faf4f2f46 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerGenerationModelCallSignals.php @@ -0,0 +1,140 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals + */ +class AnswerGenerationModelCallSignals extends \Google\Protobuf\Internal\Message +{ + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + */ + protected $rendered_prompt = ''; + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + */ + protected $model_output = ''; + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + */ + protected $model = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $rendered_prompt + * Prompt as sent to the model. + * @type string $model_output + * Output of the generative model. + * @type string $model + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + * @return string + */ + public function getRenderedPrompt() + { + return $this->rendered_prompt; + } + + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + * @param string $var + * @return $this + */ + public function setRenderedPrompt($var) + { + GPBUtil::checkString($var, True); + $this->rendered_prompt = $var; + + return $this; + } + + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + * @return string + */ + public function getModelOutput() + { + return $this->model_output; + } + + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + * @param string $var + * @return $this + */ + public function setModelOutput($var) + { + GPBUtil::checkString($var, True); + $this->model_output = $var; + + return $this; + } + + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + * @return string + */ + public function getModel() + { + return $this->model; + } + + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + * @param string $var + * @return $this + */ + public function setModel($var) + { + GPBUtil::checkString($var, True); + $this->model = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerPart.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerPart.php new file mode 100644 index 000000000000..34b9f683bb96 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/AnswerPart.php @@ -0,0 +1,102 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart + */ +class AnswerPart extends \Google\Protobuf\Internal\Message +{ + /** + * Substring of the answer. + * + * Generated from protobuf field string text = 1; + */ + protected $text = ''; + /** + * Citations for this answer part. Indices of `search_snippets`. + * + * Generated from protobuf field repeated int32 supporting_indices = 2; + */ + private $supporting_indices; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text + * Substring of the answer. + * @type array|\Google\Protobuf\Internal\RepeatedField $supporting_indices + * Citations for this answer part. Indices of `search_snippets`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Substring of the answer. + * + * Generated from protobuf field string text = 1; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Substring of the answer. + * + * Generated from protobuf field string text = 1; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + + /** + * Citations for this answer part. Indices of `search_snippets`. + * + * Generated from protobuf field repeated int32 supporting_indices = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSupportingIndices() + { + return $this->supporting_indices; + } + + /** + * Citations for this answer part. Indices of `search_snippets`. + * + * Generated from protobuf field repeated int32 supporting_indices = 2; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSupportingIndices($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); + $this->supporting_indices = $arr; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/CitedSnippet.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/CitedSnippet.php new file mode 100644 index 000000000000..a5d0a82582ae --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/CitedSnippet.php @@ -0,0 +1,112 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet + */ +class CitedSnippet extends \Google\Protobuf\Internal\Message +{ + /** + * Details of the snippet. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippet = 1; + */ + protected $search_snippet = null; + /** + * Index of the snippet in `search_snippets` field. + * + * Generated from protobuf field int32 snippet_index = 2; + */ + protected $snippet_index = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet $search_snippet + * Details of the snippet. + * @type int $snippet_index + * Index of the snippet in `search_snippets` field. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Details of the snippet. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippet = 1; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet|null + */ + public function getSearchSnippet() + { + return $this->search_snippet; + } + + public function hasSearchSnippet() + { + return isset($this->search_snippet); + } + + public function clearSearchSnippet() + { + unset($this->search_snippet); + } + + /** + * Details of the snippet. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippet = 1; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet $var + * @return $this + */ + public function setSearchSnippet($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SearchSnippet::class); + $this->search_snippet = $var; + + return $this; + } + + /** + * Index of the snippet in `search_snippets` field. + * + * Generated from protobuf field int32 snippet_index = 2; + * @return int + */ + public function getSnippetIndex() + { + return $this->snippet_index; + } + + /** + * Index of the snippet in `search_snippets` field. + * + * Generated from protobuf field int32 snippet_index = 2; + * @param int $var + * @return $this + */ + public function setSnippetIndex($var) + { + GPBUtil::checkInt32($var); + $this->snippet_index = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals.php new file mode 100644 index 000000000000..b9fc45d569f0 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals.php @@ -0,0 +1,102 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals + */ +class GroundingSignals extends \Google\Protobuf\Internal\Message +{ + /** + * Represents the decision of the grounding check. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingDecision decision = 1; + */ + protected $decision = 0; + /** + * Grounding score bucket setting. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket score = 2; + */ + protected $score = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $decision + * Represents the decision of the grounding check. + * @type int $score + * Grounding score bucket setting. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Represents the decision of the grounding check. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingDecision decision = 1; + * @return int + */ + public function getDecision() + { + return $this->decision; + } + + /** + * Represents the decision of the grounding check. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingDecision decision = 1; + * @param int $var + * @return $this + */ + public function setDecision($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals\GroundingDecision::class); + $this->decision = $var; + + return $this; + } + + /** + * Grounding score bucket setting. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket score = 2; + * @return int + */ + public function getScore() + { + return $this->score; + } + + /** + * Grounding score bucket setting. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket score = 2; + * @param int $var + * @return $this + */ + public function setScore($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\GroundingSignals\GroundingScoreBucket::class); + $this->score = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingDecision.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingDecision.php new file mode 100644 index 000000000000..d8a22bf58b5f --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingDecision.php @@ -0,0 +1,62 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingDecision + */ +class GroundingDecision +{ + /** + * Decision not specified. + * + * Generated from protobuf enum GROUNDING_DECISION_UNSPECIFIED = 0; + */ + const GROUNDING_DECISION_UNSPECIFIED = 0; + /** + * Grounding have accepted the answer. + * + * Generated from protobuf enum ACCEPTED_BY_GROUNDING = 1; + */ + const ACCEPTED_BY_GROUNDING = 1; + /** + * Grounding have rejected the answer. + * + * Generated from protobuf enum REJECTED_BY_GROUNDING = 2; + */ + const REJECTED_BY_GROUNDING = 2; + + private static $valueToName = [ + self::GROUNDING_DECISION_UNSPECIFIED => 'GROUNDING_DECISION_UNSPECIFIED', + self::ACCEPTED_BY_GROUNDING => 'ACCEPTED_BY_GROUNDING', + self::REJECTED_BY_GROUNDING => 'REJECTED_BY_GROUNDING', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingScoreBucket.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingScoreBucket.php new file mode 100644 index 000000000000..d21a9941a76f --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/GroundingSignals/GroundingScoreBucket.php @@ -0,0 +1,83 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket + */ +class GroundingScoreBucket +{ + /** + * Score not specified. + * + * Generated from protobuf enum GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0; + */ + const GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0; + /** + * We have very low confidence that the answer is grounded. + * + * Generated from protobuf enum VERY_LOW = 1; + */ + const VERY_LOW = 1; + /** + * We have low confidence that the answer is grounded. + * + * Generated from protobuf enum LOW = 3; + */ + const LOW = 3; + /** + * We have medium confidence that the answer is grounded. + * + * Generated from protobuf enum MEDIUM = 4; + */ + const MEDIUM = 4; + /** + * We have high confidence that the answer is grounded. + * + * Generated from protobuf enum HIGH = 5; + */ + const HIGH = 5; + /** + * We have very high confidence that the answer is grounded. + * + * Generated from protobuf enum VERY_HIGH = 6; + */ + const VERY_HIGH = 6; + + private static $valueToName = [ + self::GROUNDING_SCORE_BUCKET_UNSPECIFIED => 'GROUNDING_SCORE_BUCKET_UNSPECIFIED', + self::VERY_LOW => 'VERY_LOW', + self::LOW => 'LOW', + self::MEDIUM => 'MEDIUM', + self::HIGH => 'HIGH', + self::VERY_HIGH => 'VERY_HIGH', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/RewriterModelCallSignals.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/RewriterModelCallSignals.php new file mode 100644 index 000000000000..9dc56fe28e1b --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/RewriterModelCallSignals.php @@ -0,0 +1,140 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals + */ +class RewriterModelCallSignals extends \Google\Protobuf\Internal\Message +{ + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + */ + protected $rendered_prompt = ''; + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + */ + protected $model_output = ''; + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + */ + protected $model = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $rendered_prompt + * Prompt as sent to the model. + * @type string $model_output + * Output of the generative model. + * @type string $model + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + * @return string + */ + public function getRenderedPrompt() + { + return $this->rendered_prompt; + } + + /** + * Prompt as sent to the model. + * + * Generated from protobuf field string rendered_prompt = 1; + * @param string $var + * @return $this + */ + public function setRenderedPrompt($var) + { + GPBUtil::checkString($var, True); + $this->rendered_prompt = $var; + + return $this; + } + + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + * @return string + */ + public function getModelOutput() + { + return $this->model_output; + } + + /** + * Output of the generative model. + * + * Generated from protobuf field string model_output = 2; + * @param string $var + * @return $this + */ + public function setModelOutput($var) + { + GPBUtil::checkString($var, True); + $this->model_output = $var; + + return $this; + } + + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + * @return string + */ + public function getModel() + { + return $this->model; + } + + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", + * "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + * + * Generated from protobuf field string model = 3; + * @param string $var + * @return $this + */ + public function setModel($var) + { + GPBUtil::checkString($var, True); + $this->model = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals.php new file mode 100644 index 000000000000..a0bd47021b70 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals.php @@ -0,0 +1,136 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals + */ +class SafetySignals extends \Google\Protobuf\Internal\Message +{ + /** + * Safety decision. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.SafetyDecision decision = 1; + */ + protected $decision = 0; + /** + * Specifies banned phrase match subject. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch banned_phrase_match = 2; + */ + protected $banned_phrase_match = 0; + /** + * The matched banned phrase if there was a match. + * + * Generated from protobuf field string matched_banned_phrase = 3; + */ + protected $matched_banned_phrase = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $decision + * Safety decision. + * @type int $banned_phrase_match + * Specifies banned phrase match subject. + * @type string $matched_banned_phrase + * The matched banned phrase if there was a match. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Safety decision. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.SafetyDecision decision = 1; + * @return int + */ + public function getDecision() + { + return $this->decision; + } + + /** + * Safety decision. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.SafetyDecision decision = 1; + * @param int $var + * @return $this + */ + public function setDecision($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals\SafetyDecision::class); + $this->decision = $var; + + return $this; + } + + /** + * Specifies banned phrase match subject. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch banned_phrase_match = 2; + * @return int + */ + public function getBannedPhraseMatch() + { + return $this->banned_phrase_match; + } + + /** + * Specifies banned phrase match subject. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch banned_phrase_match = 2; + * @param int $var + * @return $this + */ + public function setBannedPhraseMatch($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals\SafetySignals\BannedPhraseMatch::class); + $this->banned_phrase_match = $var; + + return $this; + } + + /** + * The matched banned phrase if there was a match. + * + * Generated from protobuf field string matched_banned_phrase = 3; + * @return string + */ + public function getMatchedBannedPhrase() + { + return $this->matched_banned_phrase; + } + + /** + * The matched banned phrase if there was a match. + * + * Generated from protobuf field string matched_banned_phrase = 3; + * @param string $var + * @return $this + */ + public function setMatchedBannedPhrase($var) + { + GPBUtil::checkString($var, True); + $this->matched_banned_phrase = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/BannedPhraseMatch.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/BannedPhraseMatch.php new file mode 100644 index 000000000000..83fe9b616af6 --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/BannedPhraseMatch.php @@ -0,0 +1,69 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch + */ +class BannedPhraseMatch +{ + /** + * No banned phrase check was executed. + * + * Generated from protobuf enum BANNED_PHRASE_MATCH_UNSPECIFIED = 0; + */ + const BANNED_PHRASE_MATCH_UNSPECIFIED = 0; + /** + * All banned phrase checks led to no match. + * + * Generated from protobuf enum BANNED_PHRASE_MATCH_NONE = 1; + */ + const BANNED_PHRASE_MATCH_NONE = 1; + /** + * A banned phrase matched the query. + * + * Generated from protobuf enum BANNED_PHRASE_MATCH_QUERY = 2; + */ + const BANNED_PHRASE_MATCH_QUERY = 2; + /** + * A banned phrase matched the response. + * + * Generated from protobuf enum BANNED_PHRASE_MATCH_RESPONSE = 3; + */ + const BANNED_PHRASE_MATCH_RESPONSE = 3; + + private static $valueToName = [ + self::BANNED_PHRASE_MATCH_UNSPECIFIED => 'BANNED_PHRASE_MATCH_UNSPECIFIED', + self::BANNED_PHRASE_MATCH_NONE => 'BANNED_PHRASE_MATCH_NONE', + self::BANNED_PHRASE_MATCH_QUERY => 'BANNED_PHRASE_MATCH_QUERY', + self::BANNED_PHRASE_MATCH_RESPONSE => 'BANNED_PHRASE_MATCH_RESPONSE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/SafetyDecision.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/SafetyDecision.php new file mode 100644 index 000000000000..5a7a1b2299fc --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/SafetySignals/SafetyDecision.php @@ -0,0 +1,64 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals.SafetyDecision + */ +class SafetyDecision +{ + /** + * Decision not specified. + * + * Generated from protobuf enum SAFETY_DECISION_UNSPECIFIED = 0; + */ + const SAFETY_DECISION_UNSPECIFIED = 0; + /** + * No manual or automatic safety check fired. + * + * Generated from protobuf enum ACCEPTED_BY_SAFETY_CHECK = 1; + */ + const ACCEPTED_BY_SAFETY_CHECK = 1; + /** + * One ore more safety checks fired. + * + * Generated from protobuf enum REJECTED_BY_SAFETY_CHECK = 2; + */ + const REJECTED_BY_SAFETY_CHECK = 2; + + private static $valueToName = [ + self::SAFETY_DECISION_UNSPECIFIED => 'SAFETY_DECISION_UNSPECIFIED', + self::ACCEPTED_BY_SAFETY_CHECK => 'ACCEPTED_BY_SAFETY_CHECK', + self::REJECTED_BY_SAFETY_CHECK => 'REJECTED_BY_SAFETY_CHECK', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/DataStoreConnectionSignals/SearchSnippet.php b/DialogflowCx/src/V3/DataStoreConnectionSignals/SearchSnippet.php new file mode 100644 index 000000000000..c4405d9227da --- /dev/null +++ b/DialogflowCx/src/V3/DataStoreConnectionSignals/SearchSnippet.php @@ -0,0 +1,136 @@ +google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet + */ +class SearchSnippet extends \Google\Protobuf\Internal\Message +{ + /** + * Title of the enclosing document. + * + * Generated from protobuf field string document_title = 1; + */ + protected $document_title = ''; + /** + * Uri for the document. Present if specified for the document. + * + * Generated from protobuf field string document_uri = 2; + */ + protected $document_uri = ''; + /** + * Text included in the prompt. + * + * Generated from protobuf field string text = 3; + */ + protected $text = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $document_title + * Title of the enclosing document. + * @type string $document_uri + * Uri for the document. Present if specified for the document. + * @type string $text + * Text included in the prompt. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection::initOnce(); + parent::__construct($data); + } + + /** + * Title of the enclosing document. + * + * Generated from protobuf field string document_title = 1; + * @return string + */ + public function getDocumentTitle() + { + return $this->document_title; + } + + /** + * Title of the enclosing document. + * + * Generated from protobuf field string document_title = 1; + * @param string $var + * @return $this + */ + public function setDocumentTitle($var) + { + GPBUtil::checkString($var, True); + $this->document_title = $var; + + return $this; + } + + /** + * Uri for the document. Present if specified for the document. + * + * Generated from protobuf field string document_uri = 2; + * @return string + */ + public function getDocumentUri() + { + return $this->document_uri; + } + + /** + * Uri for the document. Present if specified for the document. + * + * Generated from protobuf field string document_uri = 2; + * @param string $var + * @return $this + */ + public function setDocumentUri($var) + { + GPBUtil::checkString($var, True); + $this->document_uri = $var; + + return $this; + } + + /** + * Text included in the prompt. + * + * Generated from protobuf field string text = 3; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Text included in the prompt. + * + * Generated from protobuf field string text = 3; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/Flow.php b/DialogflowCx/src/V3/Flow.php index 606337f75981..64f35ad728b9 100644 --- a/DialogflowCx/src/V3/Flow.php +++ b/DialogflowCx/src/V3/Flow.php @@ -115,6 +115,19 @@ class Flow extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL]; */ protected $knowledge_connector_settings = null; + /** + * Optional. Multi-lingual agent settings for this flow. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $multi_language_settings = null; + /** + * Indicates whether the flow is locked for changes. If the flow is locked, + * modifications to the flow will be rejected. + * + * Generated from protobuf field bool locked = 30; + */ + protected $locked = false; /** * Constructor. @@ -175,6 +188,11 @@ class Flow extends \Google\Protobuf\Internal\Message * lower level overrides the settings exposed at the higher level. * @type \Google\Cloud\Dialogflow\Cx\V3\KnowledgeConnectorSettings $knowledge_connector_settings * Optional. Knowledge connector configuration. + * @type \Google\Cloud\Dialogflow\Cx\V3\Flow\MultiLanguageSettings $multi_language_settings + * Optional. Multi-lingual agent settings for this flow. + * @type bool $locked + * Indicates whether the flow is locked for changes. If the flow is locked, + * modifications to the flow will be rejected. * } */ public function __construct($data = NULL) { @@ -516,5 +534,69 @@ public function setKnowledgeConnectorSettings($var) return $this; } + /** + * Optional. Multi-lingual agent settings for this flow. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\Flow\MultiLanguageSettings|null + */ + public function getMultiLanguageSettings() + { + return $this->multi_language_settings; + } + + public function hasMultiLanguageSettings() + { + return isset($this->multi_language_settings); + } + + public function clearMultiLanguageSettings() + { + unset($this->multi_language_settings); + } + + /** + * Optional. Multi-lingual agent settings for this flow. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\Flow\MultiLanguageSettings $var + * @return $this + */ + public function setMultiLanguageSettings($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Flow\MultiLanguageSettings::class); + $this->multi_language_settings = $var; + + return $this; + } + + /** + * Indicates whether the flow is locked for changes. If the flow is locked, + * modifications to the flow will be rejected. + * + * Generated from protobuf field bool locked = 30; + * @return bool + */ + public function getLocked() + { + return $this->locked; + } + + /** + * Indicates whether the flow is locked for changes. If the flow is locked, + * modifications to the flow will be rejected. + * + * Generated from protobuf field bool locked = 30; + * @param bool $var + * @return $this + */ + public function setLocked($var) + { + GPBUtil::checkBool($var); + $this->locked = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/Flow/MultiLanguageSettings.php b/DialogflowCx/src/V3/Flow/MultiLanguageSettings.php new file mode 100644 index 000000000000..29afb48c7f7a --- /dev/null +++ b/DialogflowCx/src/V3/Flow/MultiLanguageSettings.php @@ -0,0 +1,138 @@ +google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings + */ +class MultiLanguageSettings extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Enable multi-language detection for this flow. This can be set + * only if [agent level multi language + * setting][Agent.enable_multi_language_training] is enabled. + * + * Generated from protobuf field bool enable_multi_language_detection = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_multi_language_detection = false; + /** + * Optional. Agent will respond in the detected language if the detected + * language code is in the supported resolved languages for this flow. This + * will be used only if multi-language training is enabled in the + * [agent][google.cloud.dialogflow.cx.v3.Agent.enable_multi_language_training] + * and multi-language detection is enabled in the + * [flow][google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings.enable_multi_language_detection]. + * The supported languages must be a subset of the languages supported by + * the agent. + * + * Generated from protobuf field repeated string supported_response_language_codes = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $supported_response_language_codes; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_multi_language_detection + * Optional. Enable multi-language detection for this flow. This can be set + * only if [agent level multi language + * setting][Agent.enable_multi_language_training] is enabled. + * @type array|\Google\Protobuf\Internal\RepeatedField $supported_response_language_codes + * Optional. Agent will respond in the detected language if the detected + * language code is in the supported resolved languages for this flow. This + * will be used only if multi-language training is enabled in the + * [agent][google.cloud.dialogflow.cx.v3.Agent.enable_multi_language_training] + * and multi-language detection is enabled in the + * [flow][google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings.enable_multi_language_detection]. + * The supported languages must be a subset of the languages supported by + * the agent. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Flow::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Enable multi-language detection for this flow. This can be set + * only if [agent level multi language + * setting][Agent.enable_multi_language_training] is enabled. + * + * Generated from protobuf field bool enable_multi_language_detection = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableMultiLanguageDetection() + { + return $this->enable_multi_language_detection; + } + + /** + * Optional. Enable multi-language detection for this flow. This can be set + * only if [agent level multi language + * setting][Agent.enable_multi_language_training] is enabled. + * + * Generated from protobuf field bool enable_multi_language_detection = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableMultiLanguageDetection($var) + { + GPBUtil::checkBool($var); + $this->enable_multi_language_detection = $var; + + return $this; + } + + /** + * Optional. Agent will respond in the detected language if the detected + * language code is in the supported resolved languages for this flow. This + * will be used only if multi-language training is enabled in the + * [agent][google.cloud.dialogflow.cx.v3.Agent.enable_multi_language_training] + * and multi-language detection is enabled in the + * [flow][google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings.enable_multi_language_detection]. + * The supported languages must be a subset of the languages supported by + * the agent. + * + * Generated from protobuf field repeated string supported_response_language_codes = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSupportedResponseLanguageCodes() + { + return $this->supported_response_language_codes; + } + + /** + * Optional. Agent will respond in the detected language if the detected + * language code is in the supported resolved languages for this flow. This + * will be used only if multi-language training is enabled in the + * [agent][google.cloud.dialogflow.cx.v3.Agent.enable_multi_language_training] + * and multi-language detection is enabled in the + * [flow][google.cloud.dialogflow.cx.v3.Flow.MultiLanguageSettings.enable_multi_language_detection]. + * The supported languages must be a subset of the languages supported by + * the agent. + * + * Generated from protobuf field repeated string supported_response_language_codes = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSupportedResponseLanguageCodes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->supported_response_language_codes = $arr; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/LanguageInfo.php b/DialogflowCx/src/V3/LanguageInfo.php new file mode 100644 index 000000000000..94a80769bbf3 --- /dev/null +++ b/DialogflowCx/src/V3/LanguageInfo.php @@ -0,0 +1,143 @@ +google.cloud.dialogflow.cx.v3.LanguageInfo + */ +class LanguageInfo extends \Google\Protobuf\Internal\Message +{ + /** + * The language code specified in the original + * [request][google.cloud.dialogflow.cx.v3.QueryInput.language_code]. + * + * Generated from protobuf field string input_language_code = 1; + */ + protected $input_language_code = ''; + /** + * The language code detected for this request based on the user + * conversation. + * + * Generated from protobuf field string resolved_language_code = 2; + */ + protected $resolved_language_code = ''; + /** + * The confidence score of the detected language between 0 and 1. + * + * Generated from protobuf field float confidence_score = 3; + */ + protected $confidence_score = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $input_language_code + * The language code specified in the original + * [request][google.cloud.dialogflow.cx.v3.QueryInput.language_code]. + * @type string $resolved_language_code + * The language code detected for this request based on the user + * conversation. + * @type float $confidence_score + * The confidence score of the detected language between 0 and 1. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Webhook::initOnce(); + parent::__construct($data); + } + + /** + * The language code specified in the original + * [request][google.cloud.dialogflow.cx.v3.QueryInput.language_code]. + * + * Generated from protobuf field string input_language_code = 1; + * @return string + */ + public function getInputLanguageCode() + { + return $this->input_language_code; + } + + /** + * The language code specified in the original + * [request][google.cloud.dialogflow.cx.v3.QueryInput.language_code]. + * + * Generated from protobuf field string input_language_code = 1; + * @param string $var + * @return $this + */ + public function setInputLanguageCode($var) + { + GPBUtil::checkString($var, True); + $this->input_language_code = $var; + + return $this; + } + + /** + * The language code detected for this request based on the user + * conversation. + * + * Generated from protobuf field string resolved_language_code = 2; + * @return string + */ + public function getResolvedLanguageCode() + { + return $this->resolved_language_code; + } + + /** + * The language code detected for this request based on the user + * conversation. + * + * Generated from protobuf field string resolved_language_code = 2; + * @param string $var + * @return $this + */ + public function setResolvedLanguageCode($var) + { + GPBUtil::checkString($var, True); + $this->resolved_language_code = $var; + + return $this; + } + + /** + * The confidence score of the detected language between 0 and 1. + * + * Generated from protobuf field float confidence_score = 3; + * @return float + */ + public function getConfidenceScore() + { + return $this->confidence_score; + } + + /** + * The confidence score of the detected language between 0 and 1. + * + * Generated from protobuf field float confidence_score = 3; + * @param float $var + * @return $this + */ + public function setConfidenceScore($var) + { + GPBUtil::checkFloat($var); + $this->confidence_score = $var; + + return $this; + } + +} + diff --git a/DialogflowCx/src/V3/PBMatch/MatchType.php b/DialogflowCx/src/V3/PBMatch/MatchType.php index a74a95feaae3..57b29485c28e 100644 --- a/DialogflowCx/src/V3/PBMatch/MatchType.php +++ b/DialogflowCx/src/V3/PBMatch/MatchType.php @@ -55,6 +55,18 @@ class MatchType * Generated from protobuf enum EVENT = 6; */ const EVENT = 6; + /** + * The query was matched to a Knowledge Connector answer. + * + * Generated from protobuf enum KNOWLEDGE_CONNECTOR = 8; + */ + const KNOWLEDGE_CONNECTOR = 8; + /** + * The query was handled by a [`Playbook`][Playbook]. + * + * Generated from protobuf enum PLAYBOOK = 9; + */ + const PLAYBOOK = 9; private static $valueToName = [ self::MATCH_TYPE_UNSPECIFIED => 'MATCH_TYPE_UNSPECIFIED', @@ -64,6 +76,8 @@ class MatchType self::NO_MATCH => 'NO_MATCH', self::NO_INPUT => 'NO_INPUT', self::EVENT => 'EVENT', + self::KNOWLEDGE_CONNECTOR => 'KNOWLEDGE_CONNECTOR', + self::PLAYBOOK => 'PLAYBOOK', ]; public static function name($value) diff --git a/DialogflowCx/src/V3/QueryParameters.php b/DialogflowCx/src/V3/QueryParameters.php index e2facc6afcc5..d861dab3cf26 100644 --- a/DialogflowCx/src/V3/QueryParameters.php +++ b/DialogflowCx/src/V3/QueryParameters.php @@ -183,6 +183,15 @@ class QueryParameters extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL]; */ protected $search_config = null; + /** + * Optional. If set to true and data stores are involved in serving the + * request then + * DetectIntentResponse.query_result.data_store_connection_signals + * will be filled with data that can help evaluations. + * + * Generated from protobuf field bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $populate_data_store_connection_signals = false; /** * Constructor. @@ -302,6 +311,11 @@ class QueryParameters extends \Google\Protobuf\Internal\Message * ``` * @type \Google\Cloud\Dialogflow\Cx\V3\SearchConfig $search_config * Optional. Search configuration for UCS search queries. + * @type bool $populate_data_store_connection_signals + * Optional. If set to true and data stores are involved in serving the + * request then + * DetectIntentResponse.query_result.data_store_connection_signals + * will be filled with data that can help evaluations. * } */ public function __construct($data = NULL) { @@ -901,5 +915,37 @@ public function setSearchConfig($var) return $this; } + /** + * Optional. If set to true and data stores are involved in serving the + * request then + * DetectIntentResponse.query_result.data_store_connection_signals + * will be filled with data that can help evaluations. + * + * Generated from protobuf field bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getPopulateDataStoreConnectionSignals() + { + return $this->populate_data_store_connection_signals; + } + + /** + * Optional. If set to true and data stores are involved in serving the + * request then + * DetectIntentResponse.query_result.data_store_connection_signals + * will be filled with data that can help evaluations. + * + * Generated from protobuf field bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setPopulateDataStoreConnectionSignals($var) + { + GPBUtil::checkBool($var); + $this->populate_data_store_connection_signals = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/QueryResult.php b/DialogflowCx/src/V3/QueryResult.php index 12cbc570aedb..8a30be3c061f 100644 --- a/DialogflowCx/src/V3/QueryResult.php +++ b/DialogflowCx/src/V3/QueryResult.php @@ -184,6 +184,15 @@ class QueryResult extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool allow_answer_feedback = 32; */ protected $allow_answer_feedback = false; + /** + * Optional. Data store connection feature output signals. + * Filled only when data stores are involved in serving the query and + * DetectIntentRequest.populate data_store_connection_quality_signals is set + * to true in the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $data_store_connection_signals = null; protected $query; /** @@ -306,6 +315,11 @@ class QueryResult extends \Google\Protobuf\Internal\Message * @type bool $allow_answer_feedback * Indicates whether the Thumbs up/Thumbs down rating controls are need to be * shown for the response in the Dialogflow Messenger widget. + * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals $data_store_connection_signals + * Optional. Data store connection feature output signals. + * Filled only when data stores are involved in serving the query and + * DetectIntentRequest.populate data_store_connection_quality_signals is set + * to true in the request. * } */ public function __construct($data = NULL) { @@ -1162,6 +1176,48 @@ public function setAllowAnswerFeedback($var) return $this; } + /** + * Optional. Data store connection feature output signals. + * Filled only when data stores are involved in serving the query and + * DetectIntentRequest.populate data_store_connection_quality_signals is set + * to true in the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals|null + */ + public function getDataStoreConnectionSignals() + { + return $this->data_store_connection_signals; + } + + public function hasDataStoreConnectionSignals() + { + return isset($this->data_store_connection_signals); + } + + public function clearDataStoreConnectionSignals() + { + unset($this->data_store_connection_signals); + } + + /** + * Optional. Data store connection feature output signals. + * Filled only when data stores are involved in serving the query and + * DetectIntentRequest.populate data_store_connection_quality_signals is set + * to true in the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals $var + * @return $this + */ + public function setDataStoreConnectionSignals($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals::class); + $this->data_store_connection_signals = $var; + + return $this; + } + /** * @return string */ diff --git a/DialogflowCx/src/V3/SecuritySettings.php b/DialogflowCx/src/V3/SecuritySettings.php index 59d7042162c8..f4707817be0e 100644 --- a/DialogflowCx/src/V3/SecuritySettings.php +++ b/DialogflowCx/src/V3/SecuritySettings.php @@ -181,6 +181,9 @@ class SecuritySettings extends \Google\Protobuf\Internal\Message * for Agent Assist traffic), higher value will be ignored and use default. * Setting a value higher than that has no effect. A missing value or * setting to 0 also means we use default TTL. + * When data retention configuration is changed, it only applies to the data + * created after the change; the TTL of existing data created before the + * change stays intact. * @type int $retention_strategy * Specifies the retention behavior defined by * [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy]. @@ -443,6 +446,9 @@ public function setDeidentifyTemplate($var) * for Agent Assist traffic), higher value will be ignored and use default. * Setting a value higher than that has no effect. A missing value or * setting to 0 also means we use default TTL. + * When data retention configuration is changed, it only applies to the data + * created after the change; the TTL of existing data created before the + * change stays intact. * * Generated from protobuf field int32 retention_window_days = 6; * @return int @@ -463,6 +469,9 @@ public function hasRetentionWindowDays() * for Agent Assist traffic), higher value will be ignored and use default. * Setting a value higher than that has no effect. A missing value or * setting to 0 also means we use default TTL. + * When data retention configuration is changed, it only applies to the data + * created after the change; the TTL of existing data created before the + * change stays intact. * * Generated from protobuf field int32 retention_window_days = 6; * @param int $var diff --git a/DialogflowCx/src/V3/SecuritySettings/AudioExportSettings.php b/DialogflowCx/src/V3/SecuritySettings/AudioExportSettings.php index 940a36162d2a..a9f833bc172e 100644 --- a/DialogflowCx/src/V3/SecuritySettings/AudioExportSettings.php +++ b/DialogflowCx/src/V3/SecuritySettings/AudioExportSettings.php @@ -33,6 +33,8 @@ class AudioExportSettings extends \Google\Protobuf\Internal\Message protected $audio_export_pattern = ''; /** * Enable audio redaction if it is true. + * Note that this only redacts end-user audio data; + * Synthesised audio from the virtual agent is not redacted. * * Generated from protobuf field bool enable_audio_redaction = 3; */ @@ -44,6 +46,13 @@ class AudioExportSettings extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings.AudioFormat audio_format = 4; */ protected $audio_format = 0; + /** + * Whether to store TTS audio. By default, TTS audio from the virtual agent + * is not exported. + * + * Generated from protobuf field bool store_tts_audio = 6; + */ + protected $store_tts_audio = false; /** * Constructor. @@ -61,9 +70,14 @@ class AudioExportSettings extends \Google\Protobuf\Internal\Message * Filename pattern for exported audio. * @type bool $enable_audio_redaction * Enable audio redaction if it is true. + * Note that this only redacts end-user audio data; + * Synthesised audio from the virtual agent is not redacted. * @type int $audio_format * File format for exported audio file. Currently only in telephony * recordings. + * @type bool $store_tts_audio + * Whether to store TTS audio. By default, TTS audio from the virtual agent + * is not exported. * } */ public function __construct($data = NULL) { @@ -133,6 +147,8 @@ public function setAudioExportPattern($var) /** * Enable audio redaction if it is true. + * Note that this only redacts end-user audio data; + * Synthesised audio from the virtual agent is not redacted. * * Generated from protobuf field bool enable_audio_redaction = 3; * @return bool @@ -144,6 +160,8 @@ public function getEnableAudioRedaction() /** * Enable audio redaction if it is true. + * Note that this only redacts end-user audio data; + * Synthesised audio from the virtual agent is not redacted. * * Generated from protobuf field bool enable_audio_redaction = 3; * @param bool $var @@ -185,6 +203,34 @@ public function setAudioFormat($var) return $this; } + /** + * Whether to store TTS audio. By default, TTS audio from the virtual agent + * is not exported. + * + * Generated from protobuf field bool store_tts_audio = 6; + * @return bool + */ + public function getStoreTtsAudio() + { + return $this->store_tts_audio; + } + + /** + * Whether to store TTS audio. By default, TTS audio from the virtual agent + * is not exported. + * + * Generated from protobuf field bool store_tts_audio = 6; + * @param bool $var + * @return $this + */ + public function setStoreTtsAudio($var) + { + GPBUtil::checkBool($var); + $this->store_tts_audio = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/TestConfig.php b/DialogflowCx/src/V3/TestConfig.php index d53400423280..4623f00ea546 100644 --- a/DialogflowCx/src/V3/TestConfig.php +++ b/DialogflowCx/src/V3/TestConfig.php @@ -26,9 +26,8 @@ class TestConfig extends \Google\Protobuf\Internal\Message * Format: `projects//locations//agents//flows/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string flow = 2 [(.google.api.resource_reference) = { */ @@ -38,9 +37,8 @@ class TestConfig extends \Google\Protobuf\Internal\Message * Format: `projects//locations//agents//flows//pages/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string page = 3 [(.google.api.resource_reference) = { */ @@ -59,17 +57,15 @@ class TestConfig extends \Google\Protobuf\Internal\Message * Format: `projects//locations//agents//flows/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * @type string $page * The [page][google.cloud.dialogflow.cx.v3.Page] to start the test case with. * Format: `projects//locations//agents//flows//pages/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * } */ public function __construct($data = NULL) { @@ -108,9 +104,8 @@ public function setTrackingParameters($var) * Format: `projects//locations//agents//flows/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string flow = 2 [(.google.api.resource_reference) = { * @return string @@ -125,9 +120,8 @@ public function getFlow() * Format: `projects//locations//agents//flows/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string flow = 2 [(.google.api.resource_reference) = { * @param string $var @@ -146,9 +140,8 @@ public function setFlow($var) * Format: `projects//locations//agents//flows//pages/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string page = 3 [(.google.api.resource_reference) = { * @return string @@ -163,9 +156,8 @@ public function getPage() * Format: `projects//locations//agents//flows//pages/`. * Only one of `flow` and `page` should be set to indicate the starting point - * of the test case. If both are set, `page` takes precedence over `flow`. If - * neither is set, the test case will start with start page on the default - * start flow. + * of the test case. If neither is set, the test case will start with start + * page on the default start flow. * * Generated from protobuf field string page = 3 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/Webhook/GenericWebService.php b/DialogflowCx/src/V3/Webhook/GenericWebService.php index db663c6a66aa..66adc39d51ab 100644 --- a/DialogflowCx/src/V3/Webhook/GenericWebService.php +++ b/DialogflowCx/src/V3/Webhook/GenericWebService.php @@ -60,6 +60,23 @@ class GenericWebService extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $allowed_ca_certs; + /** + * Optional. The OAuth configuration of the webhook. If specified, + * Dialogflow will initiate the OAuth client credential flow to exchange an + * access token from the 3rd party platform and put it in the auth header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $oauth_config = null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow + * service + * agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + * The generated token is sent in the Authorization header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.ServiceAgentAuth service_agent_auth = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $service_agent_auth = 0; /** * Optional. Type of the webhook. * @@ -119,6 +136,15 @@ class GenericWebService extends \Google\Protobuf\Internal\Message * -out example.com.crt \ * -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") * ``` + * @type \Google\Cloud\Dialogflow\Cx\V3\Webhook\GenericWebService\OAuthConfig $oauth_config + * Optional. The OAuth configuration of the webhook. If specified, + * Dialogflow will initiate the OAuth client credential flow to exchange an + * access token from the 3rd party platform and put it in the auth header. + * @type int $service_agent_auth + * Optional. Indicate the auth token type generated from the [Diglogflow + * service + * agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + * The generated token is sent in the Authorization header. * @type int $webhook_type * Optional. Type of the webhook. * @type int $http_method @@ -303,6 +329,78 @@ public function setAllowedCaCerts($var) return $this; } + /** + * Optional. The OAuth configuration of the webhook. If specified, + * Dialogflow will initiate the OAuth client credential flow to exchange an + * access token from the 3rd party platform and put it in the auth header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\Webhook\GenericWebService\OAuthConfig|null + */ + public function getOauthConfig() + { + return $this->oauth_config; + } + + public function hasOauthConfig() + { + return isset($this->oauth_config); + } + + public function clearOauthConfig() + { + unset($this->oauth_config); + } + + /** + * Optional. The OAuth configuration of the webhook. If specified, + * Dialogflow will initiate the OAuth client credential flow to exchange an + * access token from the 3rd party platform and put it in the auth header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\Webhook\GenericWebService\OAuthConfig $var + * @return $this + */ + public function setOauthConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Webhook\GenericWebService\OAuthConfig::class); + $this->oauth_config = $var; + + return $this; + } + + /** + * Optional. Indicate the auth token type generated from the [Diglogflow + * service + * agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + * The generated token is sent in the Authorization header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.ServiceAgentAuth service_agent_auth = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getServiceAgentAuth() + { + return $this->service_agent_auth; + } + + /** + * Optional. Indicate the auth token type generated from the [Diglogflow + * service + * agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + * The generated token is sent in the Authorization header. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.ServiceAgentAuth service_agent_auth = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setServiceAgentAuth($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\Webhook\GenericWebService\ServiceAgentAuth::class); + $this->service_agent_auth = $var; + + return $this; + } + /** * Optional. Type of the webhook. * diff --git a/DialogflowCx/src/V3/Webhook/GenericWebService/OAuthConfig.php b/DialogflowCx/src/V3/Webhook/GenericWebService/OAuthConfig.php new file mode 100644 index 000000000000..cbeaead928bc --- /dev/null +++ b/DialogflowCx/src/V3/Webhook/GenericWebService/OAuthConfig.php @@ -0,0 +1,175 @@ +google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.OAuthConfig + */ +class OAuthConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The client ID provided by the 3rd party platform. + * + * Generated from protobuf field string client_id = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $client_id = ''; + /** + * Required. The client secret provided by the 3rd party platform. + * + * Generated from protobuf field string client_secret = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $client_secret = ''; + /** + * Required. The token endpoint provided by the 3rd party platform to + * exchange an access token. + * + * Generated from protobuf field string token_endpoint = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $token_endpoint = ''; + /** + * Optional. The OAuth scopes to grant. + * + * Generated from protobuf field repeated string scopes = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $scopes; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $client_id + * Required. The client ID provided by the 3rd party platform. + * @type string $client_secret + * Required. The client secret provided by the 3rd party platform. + * @type string $token_endpoint + * Required. The token endpoint provided by the 3rd party platform to + * exchange an access token. + * @type array|\Google\Protobuf\Internal\RepeatedField $scopes + * Optional. The OAuth scopes to grant. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Webhook::initOnce(); + parent::__construct($data); + } + + /** + * Required. The client ID provided by the 3rd party platform. + * + * Generated from protobuf field string client_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getClientId() + { + return $this->client_id; + } + + /** + * Required. The client ID provided by the 3rd party platform. + * + * Generated from protobuf field string client_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setClientId($var) + { + GPBUtil::checkString($var, True); + $this->client_id = $var; + + return $this; + } + + /** + * Required. The client secret provided by the 3rd party platform. + * + * Generated from protobuf field string client_secret = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getClientSecret() + { + return $this->client_secret; + } + + /** + * Required. The client secret provided by the 3rd party platform. + * + * Generated from protobuf field string client_secret = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setClientSecret($var) + { + GPBUtil::checkString($var, True); + $this->client_secret = $var; + + return $this; + } + + /** + * Required. The token endpoint provided by the 3rd party platform to + * exchange an access token. + * + * Generated from protobuf field string token_endpoint = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getTokenEndpoint() + { + return $this->token_endpoint; + } + + /** + * Required. The token endpoint provided by the 3rd party platform to + * exchange an access token. + * + * Generated from protobuf field string token_endpoint = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setTokenEndpoint($var) + { + GPBUtil::checkString($var, True); + $this->token_endpoint = $var; + + return $this; + } + + /** + * Optional. The OAuth scopes to grant. + * + * Generated from protobuf field repeated string scopes = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getScopes() + { + return $this->scopes; + } + + /** + * Optional. The OAuth scopes to grant. + * + * Generated from protobuf field repeated string scopes = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setScopes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->scopes = $arr; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/Webhook/GenericWebService/ServiceAgentAuth.php b/DialogflowCx/src/V3/Webhook/GenericWebService/ServiceAgentAuth.php new file mode 100644 index 000000000000..978b70c0708e --- /dev/null +++ b/DialogflowCx/src/V3/Webhook/GenericWebService/ServiceAgentAuth.php @@ -0,0 +1,78 @@ +google.cloud.dialogflow.cx.v3.Webhook.GenericWebService.ServiceAgentAuth + */ +class ServiceAgentAuth +{ + /** + * Service agent auth type unspecified. Default to ID_TOKEN. + * + * Generated from protobuf enum SERVICE_AGENT_AUTH_UNSPECIFIED = 0; + */ + const SERVICE_AGENT_AUTH_UNSPECIFIED = 0; + /** + * No token used. + * + * Generated from protobuf enum NONE = 1; + */ + const NONE = 1; + /** + * Use [ID + * token](https://cloud.google.com/docs/authentication/token-types#id) + * generated from service agent. This can be used to access Cloud Function + * and Cloud Run after you grant Invoker role to + * `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. + * + * Generated from protobuf enum ID_TOKEN = 2; + */ + const ID_TOKEN = 2; + /** + * Use [access + * token](https://cloud.google.com/docs/authentication/token-types#access) + * generated from service agent. This can be used to access other Google + * Cloud APIs after you grant required roles to + * `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. + * + * Generated from protobuf enum ACCESS_TOKEN = 3; + */ + const ACCESS_TOKEN = 3; + + private static $valueToName = [ + self::SERVICE_AGENT_AUTH_UNSPECIFIED => 'SERVICE_AGENT_AUTH_UNSPECIFIED', + self::NONE => 'NONE', + self::ID_TOKEN => 'ID_TOKEN', + self::ACCESS_TOKEN => 'ACCESS_TOKEN', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/WebhookRequest.php b/DialogflowCx/src/V3/WebhookRequest.php index ede61efb11b1..fd03a0bfd01c 100644 --- a/DialogflowCx/src/V3/WebhookRequest.php +++ b/DialogflowCx/src/V3/WebhookRequest.php @@ -80,6 +80,12 @@ class WebhookRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9; */ protected $sentiment_analysis_result = null; + /** + * Information about the language of the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.LanguageInfo language_info = 18; + */ + protected $language_info = null; protected $query; /** @@ -132,6 +138,8 @@ class WebhookRequest extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\SentimentAnalysisResult $sentiment_analysis_result * The sentiment analysis result of the current user request. The field is * filled when sentiment analysis is configured to be enabled for the request. + * @type \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo $language_info + * Information about the language of the request. * } */ public function __construct($data = NULL) { @@ -620,6 +628,42 @@ public function setSentimentAnalysisResult($var) return $this; } + /** + * Information about the language of the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.LanguageInfo language_info = 18; + * @return \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo|null + */ + public function getLanguageInfo() + { + return $this->language_info; + } + + public function hasLanguageInfo() + { + return isset($this->language_info); + } + + public function clearLanguageInfo() + { + unset($this->language_info); + } + + /** + * Information about the language of the request. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.LanguageInfo language_info = 18; + * @param \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo $var + * @return $this + */ + public function setLanguageInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo::class); + $this->language_info = $var; + + return $this; + } + /** * @return string */ diff --git a/DialogflowCx/tests/Unit/V3/Client/AgentsClientTest.php b/DialogflowCx/tests/Unit/V3/Client/AgentsClientTest.php index 1b25561cc68a..973f35579c24 100644 --- a/DialogflowCx/tests/Unit/V3/Client/AgentsClientTest.php +++ b/DialogflowCx/tests/Unit/V3/Client/AgentsClientTest.php @@ -104,6 +104,7 @@ public function createAgentTest() $securitySettings = 'securitySettings-595091902'; $enableStackdriverLogging = true; $enableSpellCorrection = false; + $enableMultiLanguageTraining = false; $locked = true; $expectedResponse = new Agent(); $expectedResponse->setName($name); @@ -116,6 +117,7 @@ public function createAgentTest() $expectedResponse->setSecuritySettings($securitySettings); $expectedResponse->setEnableStackdriverLogging($enableStackdriverLogging); $expectedResponse->setEnableSpellCorrection($enableSpellCorrection); + $expectedResponse->setEnableMultiLanguageTraining($enableMultiLanguageTraining); $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request @@ -391,6 +393,7 @@ public function getAgentTest() $securitySettings = 'securitySettings-595091902'; $enableStackdriverLogging = true; $enableSpellCorrection = false; + $enableMultiLanguageTraining = false; $locked = true; $expectedResponse = new Agent(); $expectedResponse->setName($name2); @@ -403,6 +406,7 @@ public function getAgentTest() $expectedResponse->setSecuritySettings($securitySettings); $expectedResponse->setEnableStackdriverLogging($enableStackdriverLogging); $expectedResponse->setEnableSpellCorrection($enableSpellCorrection); + $expectedResponse->setEnableMultiLanguageTraining($enableMultiLanguageTraining); $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request @@ -805,6 +809,7 @@ public function updateAgentTest() $securitySettings = 'securitySettings-595091902'; $enableStackdriverLogging = true; $enableSpellCorrection = false; + $enableMultiLanguageTraining = false; $locked = true; $expectedResponse = new Agent(); $expectedResponse->setName($name); @@ -817,6 +822,7 @@ public function updateAgentTest() $expectedResponse->setSecuritySettings($securitySettings); $expectedResponse->setEnableStackdriverLogging($enableStackdriverLogging); $expectedResponse->setEnableSpellCorrection($enableSpellCorrection); + $expectedResponse->setEnableMultiLanguageTraining($enableMultiLanguageTraining); $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request @@ -1162,6 +1168,7 @@ public function createAgentAsyncTest() $securitySettings = 'securitySettings-595091902'; $enableStackdriverLogging = true; $enableSpellCorrection = false; + $enableMultiLanguageTraining = false; $locked = true; $expectedResponse = new Agent(); $expectedResponse->setName($name); @@ -1174,6 +1181,7 @@ public function createAgentAsyncTest() $expectedResponse->setSecuritySettings($securitySettings); $expectedResponse->setEnableStackdriverLogging($enableStackdriverLogging); $expectedResponse->setEnableSpellCorrection($enableSpellCorrection); + $expectedResponse->setEnableMultiLanguageTraining($enableMultiLanguageTraining); $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request diff --git a/DialogflowCx/tests/Unit/V3/Client/FlowsClientTest.php b/DialogflowCx/tests/Unit/V3/Client/FlowsClientTest.php index e1d37e2a1369..226165ce7af3 100644 --- a/DialogflowCx/tests/Unit/V3/Client/FlowsClientTest.php +++ b/DialogflowCx/tests/Unit/V3/Client/FlowsClientTest.php @@ -96,10 +96,12 @@ public function createFlowTest() $name = 'name3373707'; $displayName = 'displayName1615086568'; $description = 'description-1724546052'; + $locked = true; $expectedResponse = new Flow(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setDescription($description); + $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request $formattedParent = $gapicClient->agentName('[PROJECT]', '[LOCATION]', '[AGENT]'); @@ -359,10 +361,12 @@ public function getFlowTest() $name2 = 'name2-1052831874'; $displayName = 'displayName1615086568'; $description = 'description-1724546052'; + $locked = true; $expectedResponse = new Flow(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setDescription($description); + $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->flowName('[PROJECT]', '[LOCATION]', '[AGENT]', '[FLOW]'); @@ -810,10 +814,12 @@ public function updateFlowTest() $name = 'name3373707'; $displayName = 'displayName1615086568'; $description = 'description-1724546052'; + $locked = true; $expectedResponse = new Flow(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setDescription($description); + $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request $flow = new Flow(); @@ -1076,10 +1082,12 @@ public function createFlowAsyncTest() $name = 'name3373707'; $displayName = 'displayName1615086568'; $description = 'description-1724546052'; + $locked = true; $expectedResponse = new Flow(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setDescription($description); + $expectedResponse->setLocked($locked); $transport->addResponse($expectedResponse); // Mock request $formattedParent = $gapicClient->agentName('[PROJECT]', '[LOCATION]', '[AGENT]');