| 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.locations.html">locations</a> . <a href="dialogflow_v2beta1.projects.locations.conversations.html">conversations</a> . <a href="dialogflow_v2beta1.projects.locations.conversations.participants.html">participants</a> . <a href="dialogflow_v2beta1.projects.locations.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="#suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <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> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets suggested faq answers for a participant based on specific historical messages.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Gets smart replies for a participant based on specific historical messages.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</code> |
| 97 | <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. |
| 98 | |
| 99 | Args: |
| 100 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 101 | body: object, The request body. |
| 102 | The object takes the form of: |
| 103 | |
| 104 | { # The request message for Participants.SuggestArticles. |
| 105 | "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. |
| 106 | "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/`. |
| 107 | } |
| 108 | |
| 109 | x__xgafv: string, V1 error format. |
| 110 | Allowed values |
| 111 | 1 - v1 error format |
| 112 | 2 - v2 error format |
| 113 | |
| 114 | Returns: |
| 115 | An object of the form: |
| 116 | |
| 117 | { # The response message for Participants.SuggestArticles. |
| 118 | "articleAnswers": [ # Output only. Articles ordered by score in descending order. |
| 119 | { # Represents article answer. |
| 120 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 121 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 122 | "a_key": "A String", |
| 123 | }, |
| 124 | "snippets": [ # Output only. Article snippets. |
| 125 | "A String", |
| 126 | ], |
| 127 | "title": "A String", # The article title. |
| 128 | "uri": "A String", # The article URI. |
| 129 | }, |
| 130 | ], |
| 131 | "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. |
| 132 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 133 | }</pre> |
| 134 | </div> |
| 135 | |
| 136 | <div class="method"> |
| 137 | <code class="details" id="suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</code> |
| 138 | <pre>Gets suggested faq answers for a participant based on specific historical messages. |
| 139 | |
| 140 | Args: |
| 141 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 142 | body: object, The request body. |
| 143 | The object takes the form of: |
| 144 | |
| 145 | { # The request message for Participants.SuggestFaqAnswers. |
| 146 | "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. |
| 147 | "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/`. |
| 148 | } |
| 149 | |
| 150 | x__xgafv: string, V1 error format. |
| 151 | Allowed values |
| 152 | 1 - v1 error format |
| 153 | 2 - v2 error format |
| 154 | |
| 155 | Returns: |
| 156 | An object of the form: |
| 157 | |
| 158 | { # The request message for Participants.SuggestFaqAnswers. |
| 159 | "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. |
| 160 | "faqAnswers": [ # Output only. Answers extracted from FAQ documents. |
| 161 | { # Represents answer from "frequently asked questions". |
| 162 | "answer": "A String", # The piece of text from the `source` knowledge base document. |
| 163 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 164 | "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). |
| 165 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 166 | "a_key": "A String", |
| 167 | }, |
| 168 | "question": "A String", # The corresponding FAQ question. |
| 169 | "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. |
| 170 | }, |
| 171 | ], |
| 172 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 173 | }</pre> |
| 174 | </div> |
| 175 | |
| 176 | <div class="method"> |
| 177 | <code class="details" id="suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</code> |
| 178 | <pre>Gets smart replies for a participant based on specific historical messages. |
| 179 | |
| 180 | Args: |
| 181 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 182 | body: object, The request body. |
| 183 | The object takes the form of: |
| 184 | |
| 185 | { # The request message for Participants.SuggestSmartReplies. |
| 186 | "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. |
| 187 | "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. |
| 188 | "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. |
| 189 | "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| 190 | }, |
| 191 | "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/`. |
| 192 | } |
| 193 | |
| 194 | x__xgafv: string, V1 error format. |
| 195 | Allowed values |
| 196 | 1 - v1 error format |
| 197 | 2 - v2 error format |
| 198 | |
| 199 | Returns: |
| 200 | An object of the form: |
| 201 | |
| 202 | { # The response message for Participants.SuggestSmartReplies. |
| 203 | "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. |
| 204 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 205 | "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. |
| 206 | { # Represents a smart reply answer. |
| 207 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 208 | "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). |
| 209 | "reply": "A String", # The content of the reply. |
| 210 | }, |
| 211 | ], |
| 212 | }</pre> |
| 213 | </div> |
| 214 | |
| 215 | </body></html> |