1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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.conversations.html">conversations</a> . <a href="dialogflow_v2beta1.projects.conversations.participants.html">participants</a> . <a href="dialogflow_v2beta1.projects.conversations.participants.suggestions.html">suggestions</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="#compile">compile(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds > [first item's create_time of previous request]` and empty page_token.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.</p> 92<p class="toc_element"> 93 <code><a href="#suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets suggested faq answers for a participant based on specific historical messages.</p> 95<p class="toc_element"> 96 <code><a href="#suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Gets smart replies for a participant based on specific historical messages.</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="compile">compile(parent, body=None, x__xgafv=None)</code> 106 <pre>Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time. 107 108Args: 109 parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # The request message for Participants.CompileSuggestion. 114 "contextSize": 42, # Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. If zero or less than zero, 20 is used. 115 "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. 116} 117 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # The response message for Participants.CompileSuggestion. 127 "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the CompileSuggestionRequest.context_size field in the request if there aren't that many messages in the conversation. 128 "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. 129 "suggestion": { # Represents a suggestion for a human agent. # The compiled suggestion. 130 "articles": [ # Output only. Articles ordered by score in descending order. 131 { # Represents suggested article. 132 "answerRecord": "A String", # Output only. The name of answer record, in the format of "projects//locations//answerRecords/" 133 "metadata": { # Output only. A map that contains metadata about the answer and the document from which it originates. 134 "a_key": "A String", 135 }, 136 "snippets": [ # Output only. Article snippets. 137 "A String", 138 ], 139 "title": "A String", # Output only. The article title. 140 "uri": "A String", # Output only. The article URI. 141 }, 142 ], 143 "createTime": "A String", # Output only. The time the suggestion was created. 144 "faqAnswers": [ # Output only. Answers extracted from FAQ documents. 145 { # Represents suggested answer from "frequently asked questions". 146 "answer": "A String", # Output only. The piece of text from the `source` knowledge base document. 147 "answerRecord": "A String", # Output only. The name of answer record, in the format of "projects//locations//answerRecords/" 148 "confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). 149 "metadata": { # Output only. A map that contains metadata about the answer and the document from which it originates. 150 "a_key": "A String", 151 }, 152 "question": "A String", # Output only. The corresponding FAQ question. 153 "source": "A String", # Output only. Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. 154 }, 155 ], 156 "latestMessage": "A String", # Output only. Latest message used as context to compile this suggestion. Format: `projects//locations//conversations//messages/`. 157 "name": "A String", # Output only. The name of this suggestion. Format: `projects//locations//conversations//participants/*/suggestions/`. 158 }, 159}</pre> 160</div> 161 162<div class="method"> 163 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 164 <pre>Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds > [first item's create_time of previous request]` and empty page_token. 165 166Args: 167 parent: string, Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`. (required) 168 filter: string, Optional. Filter on suggestions fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds > 1551790877964485` or `create_time > "2017-01-15T01:30:15.01Z"` For more information about filtering, see [API Filtering](https://aip.dev/160). 169 pageSize: integer, Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000. 170 pageToken: string, Optional. The next_page_token value returned from a previous list request. 171 x__xgafv: string, V1 error format. 172 Allowed values 173 1 - v1 error format 174 2 - v2 error format 175 176Returns: 177 An object of the form: 178 179 { # The response message for Participants.ListSuggestions. 180 "nextPageToken": "A String", # Optional. Token to retrieve the next page of results or empty if there are no more results in the list. 181 "suggestions": [ # Required. The list of suggestions. There will be a maximum number of items returned based on the page_size field in the request. `suggestions` is sorted by `create_time` in descending order. 182 { # Represents a suggestion for a human agent. 183 "articles": [ # Output only. Articles ordered by score in descending order. 184 { # Represents suggested article. 185 "answerRecord": "A String", # Output only. The name of answer record, in the format of "projects//locations//answerRecords/" 186 "metadata": { # Output only. A map that contains metadata about the answer and the document from which it originates. 187 "a_key": "A String", 188 }, 189 "snippets": [ # Output only. Article snippets. 190 "A String", 191 ], 192 "title": "A String", # Output only. The article title. 193 "uri": "A String", # Output only. The article URI. 194 }, 195 ], 196 "createTime": "A String", # Output only. The time the suggestion was created. 197 "faqAnswers": [ # Output only. Answers extracted from FAQ documents. 198 { # Represents suggested answer from "frequently asked questions". 199 "answer": "A String", # Output only. The piece of text from the `source` knowledge base document. 200 "answerRecord": "A String", # Output only. The name of answer record, in the format of "projects//locations//answerRecords/" 201 "confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). 202 "metadata": { # Output only. A map that contains metadata about the answer and the document from which it originates. 203 "a_key": "A String", 204 }, 205 "question": "A String", # Output only. The corresponding FAQ question. 206 "source": "A String", # Output only. Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. 207 }, 208 ], 209 "latestMessage": "A String", # Output only. Latest message used as context to compile this suggestion. Format: `projects//locations//conversations//messages/`. 210 "name": "A String", # Output only. The name of this suggestion. Format: `projects//locations//conversations//participants/*/suggestions/`. 211 }, 212 ], 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 218 <pre>Retrieves the next page of results. 219 220Args: 221 previous_request: The request for the previous page. (required) 222 previous_response: The response from the request for the previous page. (required) 223 224Returns: 225 A request object that you can call 'execute()' on to request the next 226 page. Returns None if there are no more items in the collection. 227 </pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</code> 232 <pre>Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time. 233 234Args: 235 parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) 236 body: object, The request body. 237 The object takes the form of: 238 239{ # The request message for Participants.SuggestArticles. 240 "assistQueryParams": { # Represents the parameters of human assist query. # Optional. Parameters for a human assist query. 241 "documentsMetadataFilters": { # Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be ``` documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } ``` 242 "a_key": "A String", 243 }, 244 }, 245 "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. By default 20 and at most 50. 246 "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. 247} 248 249 x__xgafv: string, V1 error format. 250 Allowed values 251 1 - v1 error format 252 2 - v2 error format 253 254Returns: 255 An object of the form: 256 257 { # The response message for Participants.SuggestArticles. 258 "articleAnswers": [ # Output only. Articles ordered by score in descending order. 259 { # Represents article answer. 260 "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" 261 "metadata": { # A map that contains metadata about the answer and the document from which it originates. 262 "a_key": "A String", 263 }, 264 "snippets": [ # Output only. Article snippets. 265 "A String", 266 ], 267 "title": "A String", # The article title. 268 "uri": "A String", # The article URI. 269 }, 270 ], 271 "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesResponse.context_size field in the request if there aren't that many messages in the conversation. 272 "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. 273}</pre> 274</div> 275 276<div class="method"> 277 <code class="details" id="suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</code> 278 <pre>Gets suggested faq answers for a participant based on specific historical messages. 279 280Args: 281 parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) 282 body: object, The request body. 283 The object takes the form of: 284 285{ # The request message for Participants.SuggestFaqAnswers. 286 "assistQueryParams": { # Represents the parameters of human assist query. # Optional. Parameters for a human assist query. 287 "documentsMetadataFilters": { # Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be ``` documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } ``` 288 "a_key": "A String", 289 }, 290 }, 291 "contextSize": 42, # Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50. 292 "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. 293} 294 295 x__xgafv: string, V1 error format. 296 Allowed values 297 1 - v1 error format 298 2 - v2 error format 299 300Returns: 301 An object of the form: 302 303 { # The request message for Participants.SuggestFaqAnswers. 304 "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size field in the request if there aren't that many messages in the conversation. 305 "faqAnswers": [ # Output only. Answers extracted from FAQ documents. 306 { # Represents answer from "frequently asked questions". 307 "answer": "A String", # The piece of text from the `source` knowledge base document. 308 "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" 309 "confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). 310 "metadata": { # A map that contains metadata about the answer and the document from which it originates. 311 "a_key": "A String", 312 }, 313 "question": "A String", # The corresponding FAQ question. 314 "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. 315 }, 316 ], 317 "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. 318}</pre> 319</div> 320 321<div class="method"> 322 <code class="details" id="suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</code> 323 <pre>Gets smart replies for a participant based on specific historical messages. 324 325Args: 326 parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) 327 body: object, The request body. 328 The object takes the form of: 329 330{ # The request message for Participants.SuggestSmartReplies. 331 "contextSize": 42, # Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50. 332 "currentTextInput": { # Represents the natural language text to be processed. # The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message. 333 "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. 334 "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. 335 }, 336 "latestMessage": "A String", # The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`. 337} 338 339 x__xgafv: string, V1 error format. 340 Allowed values 341 1 - v1 error format 342 2 - v2 error format 343 344Returns: 345 An object of the form: 346 347 { # The response message for Participants.SuggestSmartReplies. 348 "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. 349 "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. 350 "smartReplyAnswers": [ # Output only. Multiple reply options provided by smart reply service. The order is based on the rank of the model prediction. The maximum number of the returned replies is set in SmartReplyConfig. 351 { # Represents a smart reply answer. 352 "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" 353 "confidence": 3.14, # Smart reply confidence. The system's confidence score that this reply is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain). 354 "reply": "A String", # The content of the reply. 355 }, 356 ], 357}</pre> 358</div> 359 360</body></html>