| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.conversationProfiles.html">conversationProfiles</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes the specified conversation profile.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves the specified conversation profile.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Returns the list of all conversation profiles in the specified project.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| 105 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 106 | <pre>Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The project to create a conversation profile for. Format: `projects//locations/`. (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 114 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 115 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 116 | }, |
| 117 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 118 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 119 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 120 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 121 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 122 | { # Config for suggestion features. |
| 123 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 124 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 125 | }, |
| 126 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 127 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 128 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 129 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 130 | "dropHandoffMessages": True or False, # 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. |
| 131 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 132 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 133 | }, |
| 134 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 135 | "agent": "A String", # 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. |
| 136 | }, |
| 137 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 138 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 139 | "A String", |
| 140 | ], |
| 141 | }, |
| 142 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 143 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 144 | "A String", |
| 145 | ], |
| 146 | }, |
| 147 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 148 | }, |
| 149 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 150 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 151 | }, |
| 152 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 153 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 154 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 155 | }, |
| 156 | }, |
| 157 | ], |
| 158 | "groupSuggestionResponses": True or False, # 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. |
| 159 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 160 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 161 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 162 | { # Config for suggestion features. |
| 163 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 164 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 165 | }, |
| 166 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 167 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 168 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 169 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 170 | "dropHandoffMessages": True or False, # 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. |
| 171 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 172 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 173 | }, |
| 174 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 175 | "agent": "A String", # 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. |
| 176 | }, |
| 177 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 178 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 179 | "A String", |
| 180 | ], |
| 181 | }, |
| 182 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 183 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 184 | "A String", |
| 185 | ], |
| 186 | }, |
| 187 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 188 | }, |
| 189 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 190 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 191 | }, |
| 192 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 193 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 194 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 195 | }, |
| 196 | }, |
| 197 | ], |
| 198 | "groupSuggestionResponses": True or False, # 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. |
| 199 | }, |
| 200 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 201 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 202 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 203 | }, |
| 204 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 205 | "messageFormat": "A String", # Format of message. |
| 206 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 207 | }, |
| 208 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 209 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 210 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 211 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 212 | }, |
| 213 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 214 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 215 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 216 | "endpointDomain": "A String", # 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. |
| 217 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 218 | }, |
| 219 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 220 | "languageCode": "A 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. |
| 221 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 222 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 223 | }, |
| 224 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 225 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 226 | "messageFormat": "A String", # Format of message. |
| 227 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 228 | }, |
| 229 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 230 | "messageFormat": "A String", # Format of message. |
| 231 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 232 | }, |
| 233 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 234 | "speechModelVariant": "A String", # Optional. 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. |
| 235 | }, |
| 236 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 237 | } |
| 238 | |
| 239 | x__xgafv: string, V1 error format. |
| 240 | Allowed values |
| 241 | 1 - v1 error format |
| 242 | 2 - v2 error format |
| 243 | |
| 244 | Returns: |
| 245 | An object of the form: |
| 246 | |
| 247 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 248 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 249 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 250 | }, |
| 251 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 252 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 253 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 254 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 255 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 256 | { # Config for suggestion features. |
| 257 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 258 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 259 | }, |
| 260 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 261 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 262 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 263 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 264 | "dropHandoffMessages": True or False, # 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. |
| 265 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 266 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 267 | }, |
| 268 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 269 | "agent": "A String", # 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. |
| 270 | }, |
| 271 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 272 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 273 | "A String", |
| 274 | ], |
| 275 | }, |
| 276 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 277 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 278 | "A String", |
| 279 | ], |
| 280 | }, |
| 281 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 282 | }, |
| 283 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 284 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 285 | }, |
| 286 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 287 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 288 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 289 | }, |
| 290 | }, |
| 291 | ], |
| 292 | "groupSuggestionResponses": True or False, # 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. |
| 293 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 294 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 295 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 296 | { # Config for suggestion features. |
| 297 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 298 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 299 | }, |
| 300 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 301 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 302 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 303 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 304 | "dropHandoffMessages": True or False, # 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. |
| 305 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 306 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 307 | }, |
| 308 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 309 | "agent": "A String", # 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. |
| 310 | }, |
| 311 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 312 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 313 | "A String", |
| 314 | ], |
| 315 | }, |
| 316 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 317 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 318 | "A String", |
| 319 | ], |
| 320 | }, |
| 321 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 322 | }, |
| 323 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 324 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 325 | }, |
| 326 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 327 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 328 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 329 | }, |
| 330 | }, |
| 331 | ], |
| 332 | "groupSuggestionResponses": True or False, # 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. |
| 333 | }, |
| 334 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 335 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 336 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 337 | }, |
| 338 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 339 | "messageFormat": "A String", # Format of message. |
| 340 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 341 | }, |
| 342 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 343 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 344 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 345 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 346 | }, |
| 347 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 348 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 349 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 350 | "endpointDomain": "A String", # 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. |
| 351 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 352 | }, |
| 353 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 354 | "languageCode": "A 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. |
| 355 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 356 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 357 | }, |
| 358 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 359 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 360 | "messageFormat": "A String", # Format of message. |
| 361 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 362 | }, |
| 363 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 364 | "messageFormat": "A String", # Format of message. |
| 365 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 366 | }, |
| 367 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 368 | "speechModelVariant": "A String", # Optional. 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. |
| 369 | }, |
| 370 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 371 | }</pre> |
| 372 | </div> |
| 373 | |
| 374 | <div class="method"> |
| 375 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 376 | <pre>Deletes the specified conversation profile. |
| 377 | |
| 378 | Args: |
| 379 | name: string, Required. The name of the conversation profile to delete. Format: `projects//locations//conversationProfiles/`. (required) |
| 380 | x__xgafv: string, V1 error format. |
| 381 | Allowed values |
| 382 | 1 - v1 error format |
| 383 | 2 - v2 error format |
| 384 | |
| 385 | Returns: |
| 386 | An object of the form: |
| 387 | |
| 388 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 389 | }</pre> |
| 390 | </div> |
| 391 | |
| 392 | <div class="method"> |
| 393 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 394 | <pre>Retrieves the specified conversation profile. |
| 395 | |
| 396 | Args: |
| 397 | name: string, Required. The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`. (required) |
| 398 | x__xgafv: string, V1 error format. |
| 399 | Allowed values |
| 400 | 1 - v1 error format |
| 401 | 2 - v2 error format |
| 402 | |
| 403 | Returns: |
| 404 | An object of the form: |
| 405 | |
| 406 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 407 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 408 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 409 | }, |
| 410 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 411 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 412 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 413 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 414 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 415 | { # Config for suggestion features. |
| 416 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 417 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 418 | }, |
| 419 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 420 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 421 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 422 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 423 | "dropHandoffMessages": True or False, # 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. |
| 424 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 425 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 426 | }, |
| 427 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 428 | "agent": "A String", # 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. |
| 429 | }, |
| 430 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 431 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 432 | "A String", |
| 433 | ], |
| 434 | }, |
| 435 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 436 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 437 | "A String", |
| 438 | ], |
| 439 | }, |
| 440 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 441 | }, |
| 442 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 443 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 444 | }, |
| 445 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 446 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 447 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 448 | }, |
| 449 | }, |
| 450 | ], |
| 451 | "groupSuggestionResponses": True or False, # 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. |
| 452 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 453 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 454 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 455 | { # Config for suggestion features. |
| 456 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 457 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 458 | }, |
| 459 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 460 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 461 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 462 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 463 | "dropHandoffMessages": True or False, # 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. |
| 464 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 465 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 466 | }, |
| 467 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 468 | "agent": "A String", # 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. |
| 469 | }, |
| 470 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 471 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 472 | "A String", |
| 473 | ], |
| 474 | }, |
| 475 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 476 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 477 | "A String", |
| 478 | ], |
| 479 | }, |
| 480 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 481 | }, |
| 482 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 483 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 484 | }, |
| 485 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 486 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 487 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 488 | }, |
| 489 | }, |
| 490 | ], |
| 491 | "groupSuggestionResponses": True or False, # 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. |
| 492 | }, |
| 493 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 494 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 495 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 496 | }, |
| 497 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 498 | "messageFormat": "A String", # Format of message. |
| 499 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 500 | }, |
| 501 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 502 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 503 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 504 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 505 | }, |
| 506 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 507 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 508 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 509 | "endpointDomain": "A String", # 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. |
| 510 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 511 | }, |
| 512 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 513 | "languageCode": "A 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. |
| 514 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 515 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 516 | }, |
| 517 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 518 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 519 | "messageFormat": "A String", # Format of message. |
| 520 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 521 | }, |
| 522 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 523 | "messageFormat": "A String", # Format of message. |
| 524 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 525 | }, |
| 526 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 527 | "speechModelVariant": "A String", # Optional. 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. |
| 528 | }, |
| 529 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 530 | }</pre> |
| 531 | </div> |
| 532 | |
| 533 | <div class="method"> |
| 534 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 535 | <pre>Returns the list of all conversation profiles in the specified project. |
| 536 | |
| 537 | Args: |
| 538 | parent: string, Required. The project to list all conversation profiles from. Format: `projects//locations/`. (required) |
| 539 | pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. |
| 540 | pageToken: string, The next_page_token value returned from a previous list request. |
| 541 | x__xgafv: string, V1 error format. |
| 542 | Allowed values |
| 543 | 1 - v1 error format |
| 544 | 2 - v2 error format |
| 545 | |
| 546 | Returns: |
| 547 | An object of the form: |
| 548 | |
| 549 | { # The response message for ConversationProfiles.ListConversationProfiles. |
| 550 | "conversationProfiles": [ # The list of project conversation profiles. There is a maximum number of items returned based on the page_size field in the request. |
| 551 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 552 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 553 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 554 | }, |
| 555 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 556 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 557 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 558 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 559 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 560 | { # Config for suggestion features. |
| 561 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 562 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 563 | }, |
| 564 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 565 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 566 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 567 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 568 | "dropHandoffMessages": True or False, # 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. |
| 569 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 570 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 571 | }, |
| 572 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 573 | "agent": "A String", # 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. |
| 574 | }, |
| 575 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 576 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 577 | "A String", |
| 578 | ], |
| 579 | }, |
| 580 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 581 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 582 | "A String", |
| 583 | ], |
| 584 | }, |
| 585 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 586 | }, |
| 587 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 588 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 589 | }, |
| 590 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 591 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 592 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 593 | }, |
| 594 | }, |
| 595 | ], |
| 596 | "groupSuggestionResponses": True or False, # 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. |
| 597 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 598 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 599 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 600 | { # Config for suggestion features. |
| 601 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 602 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 603 | }, |
| 604 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 605 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 606 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 607 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 608 | "dropHandoffMessages": True or False, # 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. |
| 609 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 610 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 611 | }, |
| 612 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 613 | "agent": "A String", # 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. |
| 614 | }, |
| 615 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 616 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 617 | "A String", |
| 618 | ], |
| 619 | }, |
| 620 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 621 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 622 | "A String", |
| 623 | ], |
| 624 | }, |
| 625 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 626 | }, |
| 627 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 628 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 629 | }, |
| 630 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 631 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 632 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 633 | }, |
| 634 | }, |
| 635 | ], |
| 636 | "groupSuggestionResponses": True or False, # 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. |
| 637 | }, |
| 638 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 639 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 640 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 641 | }, |
| 642 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 643 | "messageFormat": "A String", # Format of message. |
| 644 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 645 | }, |
| 646 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 647 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 648 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 649 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 650 | }, |
| 651 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 652 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 653 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 654 | "endpointDomain": "A String", # 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. |
| 655 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 656 | }, |
| 657 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 658 | "languageCode": "A 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. |
| 659 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 660 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 661 | }, |
| 662 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 663 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 664 | "messageFormat": "A String", # Format of message. |
| 665 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 666 | }, |
| 667 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 668 | "messageFormat": "A String", # Format of message. |
| 669 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 670 | }, |
| 671 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 672 | "speechModelVariant": "A String", # Optional. 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. |
| 673 | }, |
| 674 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 675 | }, |
| 676 | ], |
| 677 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| 678 | }</pre> |
| 679 | </div> |
| 680 | |
| 681 | <div class="method"> |
| 682 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 683 | <pre>Retrieves the next page of results. |
| 684 | |
| 685 | Args: |
| 686 | previous_request: The request for the previous page. (required) |
| 687 | previous_response: The response from the request for the previous page. (required) |
| 688 | |
| 689 | Returns: |
| 690 | A request object that you can call 'execute()' on to request the next |
| 691 | page. Returns None if there are no more items in the collection. |
| 692 | </pre> |
| 693 | </div> |
| 694 | |
| 695 | <div class="method"> |
| 696 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 697 | <pre>Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API. |
| 698 | |
| 699 | Args: |
| 700 | name: string, The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. (required) |
| 701 | body: object, The request body. |
| 702 | The object takes the form of: |
| 703 | |
| 704 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 705 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 706 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 707 | }, |
| 708 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 709 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 710 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 711 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 712 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 713 | { # Config for suggestion features. |
| 714 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 715 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 716 | }, |
| 717 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 718 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 719 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 720 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 721 | "dropHandoffMessages": True or False, # 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. |
| 722 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 723 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 724 | }, |
| 725 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 726 | "agent": "A String", # 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. |
| 727 | }, |
| 728 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 729 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 730 | "A String", |
| 731 | ], |
| 732 | }, |
| 733 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 734 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 735 | "A String", |
| 736 | ], |
| 737 | }, |
| 738 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 739 | }, |
| 740 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 741 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 742 | }, |
| 743 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 744 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 745 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 746 | }, |
| 747 | }, |
| 748 | ], |
| 749 | "groupSuggestionResponses": True or False, # 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. |
| 750 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 751 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 752 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 753 | { # Config for suggestion features. |
| 754 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 755 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 756 | }, |
| 757 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 758 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 759 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 760 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 761 | "dropHandoffMessages": True or False, # 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. |
| 762 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 763 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 764 | }, |
| 765 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 766 | "agent": "A String", # 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. |
| 767 | }, |
| 768 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 769 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 770 | "A String", |
| 771 | ], |
| 772 | }, |
| 773 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 774 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 775 | "A String", |
| 776 | ], |
| 777 | }, |
| 778 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 779 | }, |
| 780 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 781 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 782 | }, |
| 783 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 784 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 785 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 786 | }, |
| 787 | }, |
| 788 | ], |
| 789 | "groupSuggestionResponses": True or False, # 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. |
| 790 | }, |
| 791 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 792 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 793 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 794 | }, |
| 795 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 796 | "messageFormat": "A String", # Format of message. |
| 797 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 798 | }, |
| 799 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 800 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 801 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 802 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 803 | }, |
| 804 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 805 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 806 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 807 | "endpointDomain": "A String", # 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. |
| 808 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 809 | }, |
| 810 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 811 | "languageCode": "A 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. |
| 812 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 813 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 814 | }, |
| 815 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 816 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 817 | "messageFormat": "A String", # Format of message. |
| 818 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 819 | }, |
| 820 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 821 | "messageFormat": "A String", # Format of message. |
| 822 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 823 | }, |
| 824 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 825 | "speechModelVariant": "A String", # Optional. 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. |
| 826 | }, |
| 827 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 828 | } |
| 829 | |
| 830 | updateMask: string, Required. The mask to control which fields to update. |
| 831 | x__xgafv: string, V1 error format. |
| 832 | Allowed values |
| 833 | 1 - v1 error format |
| 834 | 2 - v2 error format |
| 835 | |
| 836 | Returns: |
| 837 | An object of the form: |
| 838 | |
| 839 | { # Defines the services to connect to incoming Dialogflow conversations. |
| 840 | "automatedAgentConfig": { # Defines the Automated Agent to connect to a conversation. # Configuration for an automated agent to use with this profile. |
| 841 | "agent": "A String", # 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](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used. |
| 842 | }, |
| 843 | "createTime": "A String", # Output only. Create time of the conversation profile. |
| 844 | "displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. |
| 845 | "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 846 | "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
| 847 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 848 | { # Config for suggestion features. |
| 849 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 850 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 851 | }, |
| 852 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 853 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 854 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 855 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 856 | "dropHandoffMessages": True or False, # 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. |
| 857 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 858 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 859 | }, |
| 860 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 861 | "agent": "A String", # 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. |
| 862 | }, |
| 863 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 864 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 865 | "A String", |
| 866 | ], |
| 867 | }, |
| 868 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 869 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 870 | "A String", |
| 871 | ], |
| 872 | }, |
| 873 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 874 | }, |
| 875 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 876 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 877 | }, |
| 878 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 879 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 880 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 881 | }, |
| 882 | }, |
| 883 | ], |
| 884 | "groupSuggestionResponses": True or False, # 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. |
| 885 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 886 | "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. |
| 887 | "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. |
| 888 | { # Config for suggestion features. |
| 889 | "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 890 | "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 891 | }, |
| 892 | "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. |
| 893 | "queryConfig": { # Config for suggestion query. # Configs of query. |
| 894 | "confidenceThreshold": 3.14, # 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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE. |
| 895 | "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
| 896 | "dropHandoffMessages": True or False, # 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. |
| 897 | "dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. |
| 898 | "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. |
| 899 | }, |
| 900 | "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. |
| 901 | "agent": "A String", # 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. |
| 902 | }, |
| 903 | "documentQuerySource": { # Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. # Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
| 904 | "documents": [ # Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported. |
| 905 | "A String", |
| 906 | ], |
| 907 | }, |
| 908 | "knowledgeBaseQuerySource": { # Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. # Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
| 909 | "knowledgeBases": [ # Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported. |
| 910 | "A String", |
| 911 | ], |
| 912 | }, |
| 913 | "maxResults": 42, # Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
| 914 | }, |
| 915 | "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. |
| 916 | "type": "A String", # Type of Human Agent Assistant API feature to request. |
| 917 | }, |
| 918 | "suggestionTriggerSettings": { # Settings of suggestion trigger. # Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
| 919 | "noSmallTalk": True or False, # Do not trigger if last utterance is small talk. |
| 920 | "onlyEndUser": True or False, # Only trigger suggestion if participant role of last utterance is END_USER. |
| 921 | }, |
| 922 | }, |
| 923 | ], |
| 924 | "groupSuggestionResponses": True or False, # 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. |
| 925 | }, |
| 926 | "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 927 | "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 928 | "enableSentimentAnalysis": True or False, # Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). 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. |
| 929 | }, |
| 930 | "notificationConfig": { # Defines notification behavior. # Pub/Sub topic on which to publish new agent assistant events. |
| 931 | "messageFormat": "A String", # Format of message. |
| 932 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 933 | }, |
| 934 | }, |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 935 | "humanAgentHandoffConfig": { # Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. # Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
| 936 | "livePersonConfig": { # Configuration specific to LivePerson (https://www.liveperson.com). # Uses LivePerson (https://www.liveperson.com). |
| 937 | "accountNumber": "A String", # Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
| 938 | }, |
| 939 | "salesforceLiveAgentConfig": { # Configuration specific to Salesforce Live Agent. # Uses Salesforce Live Agent. |
| 940 | "buttonId": "A String", # Required. Live Agent chat button ID. |
| 941 | "deploymentId": "A String", # Required. Live Agent deployment ID. |
| 942 | "endpointDomain": "A String", # 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. |
| 943 | "organizationId": "A String", # Required. The organization ID of the Salesforce account. |
| 944 | }, |
| 945 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 946 | "languageCode": "A 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. |
| 947 | "loggingConfig": { # Defines logging behavior for conversation lifecycle events. # Configuration for logging conversation lifecycle events. |
| 948 | "enableStackdriverLogging": True or False, # Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos. |
| 949 | }, |
| 950 | "name": "A String", # The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`. |
| 951 | "newMessageEventNotificationConfig": { # Defines notification behavior. # Configuration for publishing new message events. Event will be sent in format of ConversationEvent |
| 952 | "messageFormat": "A String", # Format of message. |
| 953 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 954 | }, |
| 955 | "notificationConfig": { # Defines notification behavior. # Configuration for publishing conversation lifecycle events. |
| 956 | "messageFormat": "A String", # Format of message. |
| 957 | "topic": "A String", # Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. Notification works for phone calls, if this topic either 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. Format: `projects//locations//topics/`. |
| 958 | }, |
| 959 | "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. |
| 960 | "speechModelVariant": "A String", # Optional. 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. |
| 961 | }, |
| 962 | "updateTime": "A String", # Output only. Update time of the conversation profile. |
| 963 | }</pre> |
| 964 | </div> |
| 965 | |
| 966 | </body></html> |