This product is not supported for your selected
Datadog site. (
).
gcp_dialogflow_conversation_profile
ancestors
Type: UNORDERED_LIST_STRING
automated_agent_config
Type: STRUCT
Provider name: automatedAgentConfig
Description: Configuration for an automated agent to use with this profile.
agent
Type: STRING
Provider name: agent
Description: Required. ID of the Dialogflow agent environment to use. This project needs to either be the same project as the conversation or you need to grant service-@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project. - For ES agents, use format: projects//locations//agent/environments/. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details. - For CX agents, use format projects//locations//agents//environments/. If environment is not specified, the default draft environment is used.
session_ttl
Type: STRING
Provider name: sessionTtl
Description: Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Create time of the conversation profile.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Required. Human readable name for this profile. Max length 1024 bytes.
human_agent_assistant_config
Type: STRUCT
Provider name: humanAgentAssistantConfig
Description: Configuration for agent assistance to use with this profile.
end_user_suggestion_config
Type: STRUCT
Provider name: endUserSuggestionConfig
Description: Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access.
disable_high_latency_features_sync_delivery
Type: BOOLEAN
Provider name: disableHighLatencyFeaturesSyncDelivery
Description: Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST
enable_async_tool_call
Type: BOOLEAN
Provider name: enableAsyncToolCall
Description: Optional. If true, enable asynchronous execution of tools.
feature_configs
Type: UNORDERED_LIST_STRUCT
Provider name: featureConfigs
Description: Configuration of different suggestion features. One feature can have only one config.
conversation_model_config
Type: STRUCT
Provider name: conversationModelConfig
Description: Configs of custom conversation model.
baseline_model_version
Type: STRING
Provider name: baselineModelVersion
Description: Version of current baseline model. It will be ignored if model is set. Valid versions are: - Article Suggestion baseline model: - 0.9 - 1.0 (default) - Summarization baseline model: - 1.0
model
Type: STRING
Provider name: model
Description: Conversation model resource name. Format: projects//conversationModels/.
conversation_process_config
Type: STRUCT
Provider name: conversationProcessConfig
Description: Configs for processing conversation.
recent_sentences_count
Type: INT32
Provider name: recentSentencesCount
Description: Number of recent non-small-talk sentences to use as context for article and FAQ suggestion
disable_agent_query_logging
Type: BOOLEAN
Provider name: disableAgentQueryLogging
Description: Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH.
enable_conversation_augmented_query
Type: BOOLEAN
Provider name: enableConversationAugmentedQuery
Description: Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.
enable_event_based_suggestion
Type: BOOLEAN
Provider name: enableEventBasedSuggestion
Description: Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.
enable_query_suggestion_only
Type: BOOLEAN
Provider name: enableQuerySuggestionOnly
Description: Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST
enable_query_suggestion_when_no_answer
Type: BOOLEAN
Provider name: enableQuerySuggestionWhenNoAnswer
Description: Optional. Enable query suggestion even if we can’t find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST
enable_response_debug_info
Type: BOOLEAN
Provider name: enableResponseDebugInfo
Description: Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST
query_config
Type: STRUCT
Provider name: queryConfig
Description: Configs of query.
confidence_threshold
Type: FLOAT
Provider name: confidenceThreshold
Description: Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
context_filter_settings
Type: STRUCT
Provider name: contextFilterSettings
Description: Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped.
drop_handoff_messages
Type: BOOLEAN
Provider name: dropHandoffMessages
Description: If set to true, the last message from virtual agent (hand off message) and the message before it (trigger message of hand off) are dropped.
drop_ivr_messages
Type: BOOLEAN
Provider name: dropIvrMessages
Description: If set to true, all messages from ivr stage are dropped.
drop_virtual_agent_messages
Type: BOOLEAN
Provider name: dropVirtualAgentMessages
Description: If set to true, all messages from virtual agent are dropped.
context_size
Type: INT32
Provider name: contextSize
Description: Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.
dialogflow_query_source
Type: STRUCT
Provider name: dialogflowQuerySource
Description: Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
agent
Type: STRING
Provider name: agent
Description: Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: projects//locations//agent. When multiple agents are allowed in the same Dialogflow project.
human_agent_side_config
Type: STRUCT
Provider name: humanAgentSideConfig
Description: Optional. The Dialogflow assist configuration for human agent.
agent
Type: STRING
Provider name: agent
Description: Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: projects//locations//agent.
document_query_source
Type: STRUCT
Provider name: documentQuerySource
Description: Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE.
documents
Type: UNORDERED_LIST_STRING
Provider name: documents
Description: Required. Knowledge documents to query from. Format: projects//locations//knowledgeBases//documents/. Currently, at most 5 documents are supported.
knowledge_base_query_source
Type: STRUCT
Provider name: knowledgeBaseQuerySource
Description: Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ.
knowledge_bases
Type: UNORDERED_LIST_STRING
Provider name: knowledgeBases
Description: Required. Knowledge bases to query. Format: projects//locations//knowledgeBases/. Currently, at most 5 knowledge bases are supported.
max_results
Type: INT32
Provider name: maxResults
Description: Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.
sections
Type: STRUCT
Provider name: sections
Description: Optional. The customized sections chosen to return when requesting a summary of a conversation.
section_types
Type: UNORDERED_LIST_STRING
Provider name: sectionTypes
Description: The selected sections chosen to return when requesting a summary of a conversation. A duplicate selected section will be treated as a single selected section. If section types are not provided, the default will be {SITUATION, ACTION, RESULT}.
rai_settings
Type: STRUCT
Provider name: raiSettings
Description: Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST
rai_category_configs
Type: UNORDERED_LIST_STRUCT
Provider name: raiCategoryConfigs
Description: Configuration for a set of RAI categories.
category
Type: STRING
Provider name: category
Description: Optional. The RAI category.
Possible values:
RAI_CATEGORY_UNSPECIFIED - Default value.
DANGEROUS_CONTENT - Dangerous content.
SEXUALLY_EXPLICIT - Sexually explicit content.
HARASSMENT - Harassment content.
HATE_SPEECH - Hate speech content.
sensitivity_level
Type: STRING
Provider name: sensitivityLevel
Description: Optional. The sensitivity level for this category.
Possible values:
SENSITIVITY_LEVEL_UNSPECIFIED - Default value. If unspecified, the default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME
BLOCK_MOST - Block most potentially sensitive responses.
BLOCK_SOME - Block some potentially sensitive responses.
BLOCK_FEW - Block a few potentially sensitive responses.
BLOCK_NONE - No filtering for this category.
suggestion_feature
Type: STRUCT
Provider name: suggestionFeature
Description: The suggestion feature.
type
Type: STRING
Provider name: type
Description: Type of Human Agent Assistant API feature to request.
Possible values:
TYPE_UNSPECIFIED - Unspecified feature type.
ARTICLE_SUGGESTION - Run article suggestion model for chat.
FAQ - Run FAQ model for chat.
SMART_REPLY - Run smart reply model for chat.
CONVERSATION_SUMMARIZATION - Run conversation summarization model for chat.
KNOWLEDGE_SEARCH - Run knowledge search with text input from agent or text generated query.
KNOWLEDGE_ASSIST - Run knowledge assist with automatic query generation.
suggestion_trigger_settings
Type: STRUCT
Provider name: suggestionTriggerSettings
Description: Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
no_smalltalk
Type: BOOLEAN
Provider name: noSmalltalk
Description: Do not trigger if last utterance is small talk.
only_end_user
Type: BOOLEAN
Provider name: onlyEndUser
Description: Only trigger suggestion if participant role of last utterance is END_USER.
generators
Type: UNORDERED_LIST_STRING
Provider name: generators
Description: Optional. List of various generator resource names used in the conversation profile.
group_suggestion_responses
Type: BOOLEAN
Provider name: groupSuggestionResponses
Description: If group_suggestion_responses is false, and there are multiple feature_configs in event based suggestion or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or StreamingAnalyzeContentResponse. If group_suggestion_responses set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.
skip_empty_event_based_suggestion
Type: BOOLEAN
Provider name: skipEmptyEventBasedSuggestion
Description: Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.
use_unredacted_conversation_data
Type: BOOLEAN
Provider name: useUnredactedConversationData
Description: Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)
human_agent_suggestion_config
Type: STRUCT
Provider name: humanAgentSuggestionConfig
Description: Configuration for agent assistance of human agent participant.
disable_high_latency_features_sync_delivery
Type: BOOLEAN
Provider name: disableHighLatencyFeaturesSyncDelivery
Description: Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST
enable_async_tool_call
Type: BOOLEAN
Provider name: enableAsyncToolCall
Description: Optional. If true, enable asynchronous execution of tools.
feature_configs
Type: UNORDERED_LIST_STRUCT
Provider name: featureConfigs
Description: Configuration of different suggestion features. One feature can have only one config.
conversation_model_config
Type: STRUCT
Provider name: conversationModelConfig
Description: Configs of custom conversation model.
baseline_model_version
Type: STRING
Provider name: baselineModelVersion
Description: Version of current baseline model. It will be ignored if model is set. Valid versions are: - Article Suggestion baseline model: - 0.9 - 1.0 (default) - Summarization baseline model: - 1.0
model
Type: STRING
Provider name: model
Description: Conversation model resource name. Format: projects//conversationModels/.
conversation_process_config
Type: STRUCT
Provider name: conversationProcessConfig
Description: Configs for processing conversation.
recent_sentences_count
Type: INT32
Provider name: recentSentencesCount
Description: Number of recent non-small-talk sentences to use as context for article and FAQ suggestion
disable_agent_query_logging
Type: BOOLEAN
Provider name: disableAgentQueryLogging
Description: Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH.
enable_conversation_augmented_query
Type: BOOLEAN
Provider name: enableConversationAugmentedQuery
Description: Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.
enable_event_based_suggestion
Type: BOOLEAN
Provider name: enableEventBasedSuggestion
Description: Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.
enable_query_suggestion_only
Type: BOOLEAN
Provider name: enableQuerySuggestionOnly
Description: Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST
enable_query_suggestion_when_no_answer
Type: BOOLEAN
Provider name: enableQuerySuggestionWhenNoAnswer
Description: Optional. Enable query suggestion even if we can’t find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST
enable_response_debug_info
Type: BOOLEAN
Provider name: enableResponseDebugInfo
Description: Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST
query_config
Type: STRUCT
Provider name: queryConfig
Description: Configs of query.
confidence_threshold
Type: FLOAT
Provider name: confidenceThreshold
Description: Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
context_filter_settings
Type: STRUCT
Provider name: contextFilterSettings
Description: Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped.
drop_handoff_messages
Type: BOOLEAN
Provider name: dropHandoffMessages
Description: If set to true, the last message from virtual agent (hand off message) and the message before it (trigger message of hand off) are dropped.
drop_ivr_messages
Type: BOOLEAN
Provider name: dropIvrMessages
Description: If set to true, all messages from ivr stage are dropped.
drop_virtual_agent_messages
Type: BOOLEAN
Provider name: dropVirtualAgentMessages
Description: If set to true, all messages from virtual agent are dropped.
context_size
Type: INT32
Provider name: contextSize
Description: Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.
dialogflow_query_source
Type: STRUCT
Provider name: dialogflowQuerySource
Description: Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
agent
Type: STRING
Provider name: agent
Description: Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: projects//locations//agent. When multiple agents are allowed in the same Dialogflow project.
human_agent_side_config
Type: STRUCT
Provider name: humanAgentSideConfig
Description: Optional. The Dialogflow assist configuration for human agent.
agent
Type: STRING
Provider name: agent
Description: Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: projects//locations//agent.
document_query_source
Type: STRUCT
Provider name: documentQuerySource
Description: Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE.
documents
Type: UNORDERED_LIST_STRING
Provider name: documents
Description: Required. Knowledge documents to query from. Format: projects//locations//knowledgeBases//documents/. Currently, at most 5 documents are supported.
knowledge_base_query_source
Type: STRUCT
Provider name: knowledgeBaseQuerySource
Description: Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ.
knowledge_bases
Type: UNORDERED_LIST_STRING
Provider name: knowledgeBases
Description: Required. Knowledge bases to query. Format: projects//locations//knowledgeBases/. Currently, at most 5 knowledge bases are supported.
max_results
Type: INT32
Provider name: maxResults
Description: Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.
sections
Type: STRUCT
Provider name: sections
Description: Optional. The customized sections chosen to return when requesting a summary of a conversation.
section_types
Type: UNORDERED_LIST_STRING
Provider name: sectionTypes
Description: The selected sections chosen to return when requesting a summary of a conversation. A duplicate selected section will be treated as a single selected section. If section types are not provided, the default will be {SITUATION, ACTION, RESULT}.
rai_settings
Type: STRUCT
Provider name: raiSettings
Description: Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST
rai_category_configs
Type: UNORDERED_LIST_STRUCT
Provider name: raiCategoryConfigs
Description: Configuration for a set of RAI categories.
category
Type: STRING
Provider name: category
Description: Optional. The RAI category.
Possible values:
RAI_CATEGORY_UNSPECIFIED - Default value.
DANGEROUS_CONTENT - Dangerous content.
SEXUALLY_EXPLICIT - Sexually explicit content.
HARASSMENT - Harassment content.
HATE_SPEECH - Hate speech content.
sensitivity_level
Type: STRING
Provider name: sensitivityLevel
Description: Optional. The sensitivity level for this category.
Possible values:
SENSITIVITY_LEVEL_UNSPECIFIED - Default value. If unspecified, the default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME
BLOCK_MOST - Block most potentially sensitive responses.
BLOCK_SOME - Block some potentially sensitive responses.
BLOCK_FEW - Block a few potentially sensitive responses.
BLOCK_NONE - No filtering for this category.
suggestion_feature
Type: STRUCT
Provider name: suggestionFeature
Description: The suggestion feature.
type
Type: STRING
Provider name: type
Description: Type of Human Agent Assistant API feature to request.
Possible values:
TYPE_UNSPECIFIED - Unspecified feature type.
ARTICLE_SUGGESTION - Run article suggestion model for chat.
FAQ - Run FAQ model for chat.
SMART_REPLY - Run smart reply model for chat.
CONVERSATION_SUMMARIZATION - Run conversation summarization model for chat.
KNOWLEDGE_SEARCH - Run knowledge search with text input from agent or text generated query.
KNOWLEDGE_ASSIST - Run knowledge assist with automatic query generation.
suggestion_trigger_settings
Type: STRUCT
Provider name: suggestionTriggerSettings
Description: Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
no_smalltalk
Type: BOOLEAN
Provider name: noSmalltalk
Description: Do not trigger if last utterance is small talk.
only_end_user
Type: BOOLEAN
Provider name: onlyEndUser
Description: Only trigger suggestion if participant role of last utterance is END_USER.
generators
Type: UNORDERED_LIST_STRING
Provider name: generators
Description: Optional. List of various generator resource names used in the conversation profile.
group_suggestion_responses
Type: BOOLEAN
Provider name: groupSuggestionResponses
Description: If group_suggestion_responses is false, and there are multiple feature_configs in event based suggestion or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or StreamingAnalyzeContentResponse. If group_suggestion_responses set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.
skip_empty_event_based_suggestion
Type: BOOLEAN
Provider name: skipEmptyEventBasedSuggestion
Description: Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.
use_unredacted_conversation_data
Type: BOOLEAN
Provider name: useUnredactedConversationData
Description: Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)
message_analysis_config
Type: STRUCT
Provider name: messageAnalysisConfig
Description: Configuration for message analysis.
enable_entity_extraction
Type: BOOLEAN
Provider name: enableEntityExtraction
Description: Enable entity extraction in conversation messages on agent assist stage. If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access.
enable_sentiment_analysis
Type: BOOLEAN
Provider name: enableSentimentAnalysis
Description: Enable sentiment analysis in conversation messages on agent assist stage. If unspecified, defaults to false. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user’s attitude as positive, negative, or neutral: https://cloud.google.com/natural-language/docs/basics#sentiment_analysis For Participants.StreamingAnalyzeContent method, result will be in StreamingAnalyzeContentResponse.message.SentimentAnalysisResult. For Participants.AnalyzeContent method, result will be in AnalyzeContentResponse.message.SentimentAnalysisResult For Conversations.ListMessages method, result will be in ListMessagesResponse.messages.SentimentAnalysisResult If Pub/Sub notification is configured, result will be in ConversationEvent.new_message_payload.SentimentAnalysisResult.
notification_config
Type: STRUCT
Provider name: notificationConfig
Description: Pub/Sub topic on which to publish new agent assistant events.
message_format
Type: STRING
Provider name: messageFormat
Description: Format of message.
Possible values:
MESSAGE_FORMAT_UNSPECIFIED - If it is unspecified, PROTO will be used.
PROTO - Pub/Sub message will be serialized proto.
JSON - Pub/Sub message will be json.
topic
Type: STRING
Provider name: topic
Description: Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant service-@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow Service Agent role in the topic project. For chat integration to receive notification, make sure API caller has been granted the Dialogflow Service Agent role for the topic. Format: projects//locations//topics/.
human_agent_handoff_config
Type: STRUCT
Provider name: humanAgentHandoffConfig
Description: Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access.
live_person_config
Type: STRUCT
Provider name: livePersonConfig
Description: Uses LivePerson.
account_number
Type: STRING
Provider name: accountNumber
Description: Required. Account number of the LivePerson account to connect. This is the account number you input at the login page.
salesforce_live_agent_config
Type: STRUCT
Provider name: salesforceLiveAgentConfig
Description: Uses Salesforce Live Agent.
button_id
Type: STRING
Provider name: buttonId
Description: Required. Live Agent chat button ID.
deployment_id
Type: STRING
Provider name: deploymentId
Description: Required. Live Agent deployment ID.
endpoint_domain
Type: STRING
Provider name: endpointDomain
Description: Required. Domain of the Live Agent endpoint for this agent. You can find the endpoint URL in the Live Agent settings page. For example if URL has the form https://d.la4-c2-phx.salesforceliveagent.com/…, you should fill in d.la4-c2-phx.salesforceliveagent.com.
organization_id
Type: STRING
Provider name: organizationId
Description: Required. The organization ID of the Salesforce account.
labels
Type: UNORDERED_LIST_STRING
language_code
Type: STRING
Provider name: languageCode
Description: 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”.
logging_config
Type: STRUCT
Provider name: loggingConfig
Description: Configuration for logging conversation lifecycle events.
enable_stackdriver_logging
Type: BOOLEAN
Provider name: enableStackdriverLogging
Description: Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos.
name
Type: STRING
Provider name: name
Description: The unique identifier of this conversation profile. Format: projects//locations//conversationProfiles/.
new_message_event_notification_config
Type: STRUCT
Provider name: newMessageEventNotificationConfig
Description: Configuration for publishing new message events. Event will be sent in format of ConversationEvent
message_format
Type: STRING
Provider name: messageFormat
Description: Format of message.
Possible values:
MESSAGE_FORMAT_UNSPECIFIED - If it is unspecified, PROTO will be used.
PROTO - Pub/Sub message will be serialized proto.
JSON - Pub/Sub message will be json.
topic
Type: STRING
Provider name: topic
Description: Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant service-@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow Service Agent role in the topic project. For chat integration to receive notification, make sure API caller has been granted the Dialogflow Service Agent role for the topic. Format: projects//locations//topics/.
new_recognition_result_notification_config
Type: STRUCT
Provider name: newRecognitionResultNotificationConfig
Description: 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” - “participant_role” - “message_id”
message_format
Type: STRING
Provider name: messageFormat
Description: Format of message.
Possible values:
MESSAGE_FORMAT_UNSPECIFIED - If it is unspecified, PROTO will be used.
PROTO - Pub/Sub message will be serialized proto.
JSON - Pub/Sub message will be json.
topic
Type: STRING
Provider name: topic
Description: Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant service-@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow Service Agent role in the topic project. For chat integration to receive notification, make sure API caller has been granted the Dialogflow Service Agent role for the topic. Format: projects//locations//topics/.
notification_config
Type: STRUCT
Provider name: notificationConfig
Description: Configuration for publishing conversation lifecycle events.
message_format
Type: STRING
Provider name: messageFormat
Description: Format of message.
Possible values:
MESSAGE_FORMAT_UNSPECIFIED - If it is unspecified, PROTO will be used.
PROTO - Pub/Sub message will be serialized proto.
JSON - Pub/Sub message will be json.
topic
Type: STRING
Provider name: topic
Description: Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant service-@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow Service Agent role in the topic project. For chat integration to receive notification, make sure API caller has been granted the Dialogflow Service Agent role for the topic. Format: projects//locations//topics/.
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
region_id
Type: STRING
resource_name
Type: STRING
security_settings
Type: STRING
Provider name: securitySettings
Description: Name of the CX SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
stt_config
Type: STRUCT
Provider name: sttConfig
Description: Settings for speech transcription.
audio_encoding
Type: STRING
Provider name: audioEncoding
Description: Audio encoding of the audio content to process.
Possible values:
AUDIO_ENCODING_UNSPECIFIED - Not specified.
AUDIO_ENCODING_LINEAR_16 - Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC - FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.
AUDIO_ENCODING_MULAW - 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR - Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.
AUDIO_ENCODING_AMR_WB - Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.
AUDIO_ENCODING_OGG_OPUS - Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE - Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000.
AUDIO_ENCODING_ALAW - 8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law.
enable_word_info
Type: BOOLEAN
Provider name: enableWordInfo
Description: If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn’t return any word-level information.
language_code
Type: STRING
Provider name: languageCode
Description: The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not specified, the default language configured at ConversationProfile is used.
model
Type: STRING
Provider name: model
Description: Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use Agent Speech settings for model selection.
phrase_sets
Type: UNORDERED_LIST_STRING
Provider name: phraseSets
Description: List of names of Cloud Speech phrase sets that are used for transcription. For phrase set limitations, please refer to Cloud Speech API quotas and limits.
sample_rate_hertz
Type: INT32
Provider name: sampleRateHertz
Description: Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
speech_model_variant
Type: STRING
Provider name: speechModelVariant
Description: The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.
Possible values:
SPEECH_MODEL_VARIANT_UNSPECIFIED - No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.
USE_BEST_AVAILABLE - Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models.
USE_STANDARD - Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models.
USE_ENHANCED - Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn’t eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible.
use_timeout_based_endpointing
Type: BOOLEAN
Provider name: useTimeoutBasedEndpointing
Description: Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
Type: UNORDERED_LIST_STRING
time_zone
Type: STRING
Provider name: timeZone
Description: The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.
tts_config
Type: STRUCT
Provider name: ttsConfig
Description: 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.
effects_profile_id
Type: UNORDERED_LIST_STRING
Provider name: effectsProfileId
Description: Optional. An identifier which selects ‘audio effects’ profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
pitch
Type: DOUBLE
Provider name: pitch
Description: Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
pronunciations
Type: UNORDERED_LIST_STRUCT
Provider name: pronunciations
Description: Optional. The custom pronunciations for the synthesized audio.
phonetic_encoding
Type: STRING
Provider name: phoneticEncoding
Description: The phonetic encoding of the phrase.
Possible values:
phrase
Type: STRING
Provider name: phrase
Description: The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn’t span the length of the sentence.
pronunciation
Type: STRING
Provider name: pronunciation
Description: The pronunciation of the phrase. This must be in the phonetic encoding specified above.
speaking_rate
Type: DOUBLE
Provider name: speakingRate
Description: Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
voice
Type: STRUCT
Provider name: voice
Description: Optional. The desired voice of the synthesized audio.
name
Type: STRING
Provider name: name
Description: Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
ssml_gender
Type: STRING
Provider name: ssmlGender
Description: Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
Possible values:
SSML_VOICE_GENDER_UNSPECIFIED - An unspecified gender, which means that the client doesn’t care which gender the selected voice will have.
SSML_VOICE_GENDER_MALE - A male voice.
SSML_VOICE_GENDER_FEMALE - A female voice.
SSML_VOICE_GENDER_NEUTRAL - A gender-neutral voice.
volume_gain_db
Type: DOUBLE
Provider name: volumeGainDb
Description: Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there’s usually no effective increase in loudness for any value greater than that.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Update time of the conversation profile.
zone_id
Type: STRING
