Console
    Contact Us Start free

    Google Cloud Dialogflow V2 Client - Class ConversationProfile (1.0.1)

    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: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

    ↳ 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: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID> .

    getName

    The unique identifier of this conversation profile.

    Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

    Generated from protobuf field string name = 1;

    Returns
    Type
    Description
    string

    setName

    The unique identifier of this conversation profile.

    Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

    Generated from protobuf field string name = 1;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. Human readable name for this profile. Max length 1024 bytes.

    Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

    Returns
    Type
    Description
    string

    setDisplayName

    Required. Human readable name for this profile. Max length 1024 bytes.

    Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Create time of the conversation profile.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Create time of the conversation profile.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Update time of the conversation profile.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Update time of the conversation profile.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getAutomatedAgentConfig

    Configuration for an automated agent to use with this profile.

    Generated from protobuf field .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;

    Returns
    Type
    Description
    Google\Cloud\Dialogflow\V2\AutomatedAgentConfig |null

    hasAutomatedAgentConfig

    clearAutomatedAgentConfig

    setAutomatedAgentConfig

    Configuration for an automated agent to use with this profile.

    Generated from protobuf field .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;

    Parameter
    Name
    Description
    var
    Google\Cloud\Dialogflow\V2\AutomatedAgentConfig
    Returns
    Type
    Description
    $this

    getHumanAgentAssistantConfig

    Configuration for agent assistance to use with this profile.

    Generated from protobuf field .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;

    Returns
    Type
    Description
    Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig |null

    hasHumanAgentAssistantConfig

    clearHumanAgentAssistantConfig

    setHumanAgentAssistantConfig

    Configuration for agent assistance to use with this profile.

    Generated from protobuf field .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;

    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.

    Generated from protobuf field .google.cloud.dialogflow.v2.HumanAgentHandoffConfig human_agent_handoff_config = 5;

    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.

    Generated from protobuf field .google.cloud.dialogflow.v2.HumanAgentHandoffConfig human_agent_handoff_config = 5;

    Parameter
    Name
    Description
    var
    Google\Cloud\Dialogflow\V2\HumanAgentHandoffConfig
    Returns
    Type
    Description
    $this

    getNotificationConfig

    Configuration for publishing conversation lifecycle events.

    Generated from protobuf field .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;

    Returns
    Type
    Description
    Google\Cloud\Dialogflow\V2\NotificationConfig |null

    hasNotificationConfig

    clearNotificationConfig

    setNotificationConfig

    Configuration for publishing conversation lifecycle events.

    Generated from protobuf field .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;

    Parameter
    Name
    Description
    var
    Google\Cloud\Dialogflow\V2\NotificationConfig
    Returns
    Type
    Description
    $this

    getLoggingConfig

    Configuration for logging conversation lifecycle events.

    Generated from protobuf field .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;

    Returns
    Type
    Description
    Google\Cloud\Dialogflow\V2\LoggingConfig |null

    hasLoggingConfig

    clearLoggingConfig

    setLoggingConfig

    Configuration for logging conversation lifecycle events.

    Generated from protobuf field .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;

    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

    Generated from protobuf field .google.cloud.dialogflow.v2.NotificationConfig new_message_event_notification_config = 8;

    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

    Generated from protobuf field .google.cloud.dialogflow.v2.NotificationConfig new_message_event_notification_config = 8;

    Parameter
    Name
    Description
    var
    Google\Cloud\Dialogflow\V2\NotificationConfig
    Returns
    Type
    Description
    $this

    getSttConfig

    Settings for speech transcription.

    Generated from protobuf field .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;

    Returns
    Type
    Description
    Google\Cloud\Dialogflow\V2\SpeechToTextConfig |null

    hasSttConfig

    clearSttConfig

    setSttConfig

    Settings for speech transcription.

    Generated from protobuf field .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;

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

    Generated from protobuf field string language_code = 10;

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

    Generated from protobuf field string language_code = 10;

    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.

    Generated from protobuf field string time_zone = 14;

    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.

    Generated from protobuf field string time_zone = 14;

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

    Generated from protobuf field string security_settings = 13 [(.google.api.resource_reference) = {

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

    Generated from protobuf field string security_settings = 13 [(.google.api.resource_reference) = {

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: