REST Resource: projects.locations.conversationProfiles

Resource: ConversationProfile

Defines the services to connect to incoming Dialogflow conversations.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "automatedAgentConfig": {
    object (AutomatedAgentConfig)
  },
  "humanAgentAssistantConfig": {
    object (HumanAgentAssistantConfig)
  },
  "humanAgentHandoffConfig": {
    object (HumanAgentHandoffConfig)
  },
  "notificationConfig": {
    object (NotificationConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "newMessageEventNotificationConfig": {
    object (NotificationConfig)
  },
  "newRecognitionResultNotificationConfig": {
    object (NotificationConfig)
  },
  "sttConfig": {
    object (SpeechToTextConfig)
  },
  "languageCode": string,
  "timeZone": string,
  "securitySettings": string,
  "ttsConfig": {
    object (SynthesizeSpeechConfig)
  }
}
Fields
name

string

The unique identifier of this conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.
displayName

string

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

string (Timestamp format)

Output only. Create time of the conversation profile.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time of the conversation profile.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
automatedAgentConfig

object (AutomatedAgentConfig)

Configuration for an automated agent to use with this profile.
humanAgentAssistantConfig

object (HumanAgentAssistantConfig)

Configuration for agent assistance to use with this profile.
humanAgentHandoffConfig

object (HumanAgentHandoffConfig)

Configuration for connecting to a live agent.

Currently, this feature is not general available, please contact Google to get access.
notificationConfig

object (NotificationConfig)

Configuration for publishing conversation lifecycle events.
loggingConfig

object (LoggingConfig)

Configuration for logging conversation lifecycle events.
newMessageEventNotificationConfig

object (NotificationConfig)

Configuration for publishing new message events. Event will be sent in format of ConversationEvent
newRecognitionResultNotificationConfig

object (NotificationConfig)

Optional. Configuration for publishing transcription intermediate results. Event will be sent in format of ConversationEvent. If configured, the following information will be populated as ConversationEvent Pub/Sub message attributes: - "participant_id" - "participantRole" - "message_id"
sttConfig

object (SpeechToTextConfig)

Settings for speech transcription.
languageCode

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

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

string

Name of the CX SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.
ttsConfig

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

Methods

clearSuggestionFeatureConfig

 Clears a suggestion feature from a conversation profile for the given participant role.

create

 Creates a conversation profile in the specified project.

delete

 Deletes the specified conversation profile.

get

 Retrieves the specified conversation profile.

list

 Returns the list of all conversation profiles in the specified project.

patch

 Updates the specified conversation profile.

setSuggestionFeatureConfig

 Adds or updates a suggestion feature in a conversation profile.