Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationProfile.
Defines the services to connect to incoming Dialogflow conversations.
Generated from protobuf message google.cloud.dialogflow.v2.ConversationProfile
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The unique identifier of this conversation profile. Format: |
↳ display_name |
string
Required. Human readable name for this profile. Max length 1024 bytes. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time of the conversation profile. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time of the conversation profile. |
↳ automated_agent_config |
Google\Cloud\Dialogflow\V2\AutomatedAgentConfig
Configuration for an automated agent to use with this profile. |
↳ human_agent_assistant_config |
Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig
Configuration for agent assistance to use with this profile. |
↳ human_agent_handoff_config |
Google\Cloud\Dialogflow\V2\HumanAgentHandoffConfig
Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
↳ notification_config |
Google\Cloud\Dialogflow\V2\NotificationConfig
Configuration for publishing conversation lifecycle events. |
↳ logging_config |
Google\Cloud\Dialogflow\V2\LoggingConfig
Configuration for logging conversation lifecycle events. |
↳ new_message_event_notification_config |
Google\Cloud\Dialogflow\V2\NotificationConfig
Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
↳ stt_config |
Google\Cloud\Dialogflow\V2\SpeechToTextConfig
Settings for speech transcription. |
↳ language_code |
string
Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-US languages. This should be a BCP-47 language tag. Example: "en-US". |
↳ time_zone |
string
The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York. |
↳ security_settings |
string
Name of the CX SecuritySettings reference for the agent. Format: |
↳ tts_config |
Google\Cloud\Dialogflow\V2\SynthesizeSpeechConfig
Configuration for Text-to-Speech synthesization. Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here. |
getName
The unique identifier of this conversation profile.
Format: projects/<Project ID>/locations/<Location
ID>/conversationProfiles/<Conversation Profile ID>.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The unique identifier of this conversation profile.
Format: projects/<Project ID>/locations/<Location
ID>/conversationProfiles/<Conversation Profile ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. Human readable name for this profile. Max length 1024 bytes.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. Human readable name for this profile. Max length 1024 bytes.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Create time of the conversation profile.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the conversation profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Update time of the conversation profile.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time of the conversation profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutomatedAgentConfig
Configuration for an automated agent to use with this profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\AutomatedAgentConfig|null | |
hasAutomatedAgentConfig
clearAutomatedAgentConfig
setAutomatedAgentConfig
Configuration for an automated agent to use with this profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\AutomatedAgentConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHumanAgentAssistantConfig
Configuration for agent assistance to use with this profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig|null | |
hasHumanAgentAssistantConfig
clearHumanAgentAssistantConfig
setHumanAgentAssistantConfig
Configuration for agent assistance to use with this profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHumanAgentHandoffConfig
Configuration for connecting to a live agent.
Currently, this feature is not general available, please contact Google to get access.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\HumanAgentHandoffConfig|null | |
hasHumanAgentHandoffConfig
clearHumanAgentHandoffConfig
setHumanAgentHandoffConfig
Configuration for connecting to a live agent.
Currently, this feature is not general available, please contact Google to get access.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\HumanAgentHandoffConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNotificationConfig
Configuration for publishing conversation lifecycle events.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\NotificationConfig|null | |
hasNotificationConfig
clearNotificationConfig
setNotificationConfig
Configuration for publishing conversation lifecycle events.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\NotificationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLoggingConfig
Configuration for logging conversation lifecycle events.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\LoggingConfig|null | |
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Configuration for logging conversation lifecycle events.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNewMessageEventNotificationConfig
Configuration for publishing new message events. Event will be sent in format of ConversationEvent
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\NotificationConfig|null | |
hasNewMessageEventNotificationConfig
clearNewMessageEventNotificationConfig
setNewMessageEventNotificationConfig
Configuration for publishing new message events. Event will be sent in format of ConversationEvent
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\NotificationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSttConfig
Settings for speech transcription.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\SpeechToTextConfig|null | |
hasSttConfig
clearSttConfig
setSttConfig
Settings for speech transcription.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\SpeechToTextConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-US languages.
This should be a BCP-47 language tag. Example: "en-US".
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-US languages.
This should be a BCP-47 language tag. Example: "en-US".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimeZone
The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.
| Returns | |
|---|---|
| Type | Description |
string | |
setTimeZone
The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecuritySettings
Name of the CX SecuritySettings reference for the agent.
Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>.
| Returns | |
|---|---|
| Type | Description |
string | |
setSecuritySettings
Name of the CX SecuritySettings reference for the agent.
Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTtsConfig
Configuration for Text-to-Speech synthesization.
Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\SynthesizeSpeechConfig|null | |
hasTtsConfig
clearTtsConfig
setTtsConfig
Configuration for Text-to-Speech synthesization.
Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\SynthesizeSpeechConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |