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)
  },
  "sttConfig": {
    object (SpeechToTextConfig)
  },
  "languageCode": string,
  "timeZone": string,
  "securitySettings": string
}
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Update time of the conversation profile.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

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

Methods

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.