| 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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.locations.html">locations</a> . <a href="dialogflow_v2.projects.locations.conversations.html">conversations</a> . <a href="dialogflow_v2.projects.locations.conversations.participants.html">participants</a> . <a href="dialogflow_v2.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.</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 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
| 93 | <code class="details" id="suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</code> |
| 94 | <pre>Gets suggested articles for a participant based on specific historical messages. |
| 95 | |
| 96 | Args: |
| 97 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 98 | body: object, The request body. |
| 99 | The object takes the form of: |
| 100 | |
| 101 | { # The request message for Participants.SuggestArticles. |
| 102 | "contextSize": 42, # 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. |
| 103 | "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/`. |
| 104 | } |
| 105 | |
| 106 | x__xgafv: string, V1 error format. |
| 107 | Allowed values |
| 108 | 1 - v1 error format |
| 109 | 2 - v2 error format |
| 110 | |
| 111 | Returns: |
| 112 | An object of the form: |
| 113 | |
| 114 | { # The response message for Participants.SuggestArticles. |
| 115 | "articleAnswers": [ # Articles ordered by score in descending order. |
| 116 | { # Represents article answer. |
| 117 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 118 | "confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 119 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 120 | "a_key": "A String", |
| 121 | }, |
| 122 | "snippets": [ # Article snippets. |
| 123 | "A String", |
| 124 | ], |
| 125 | "title": "A String", # The article title. |
| 126 | "uri": "A String", # The article URI. |
| 127 | }, |
| 128 | ], |
| 129 | "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesRequest.context_size field in the request if there aren't that many messages in the conversation. |
| 130 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 131 | }</pre> |
| 132 | </div> |
| 133 | |
| 134 | <div class="method"> |
| 135 | <code class="details" id="suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</code> |
| 136 | <pre>Gets suggested faq answers for a participant based on specific historical messages. |
| 137 | |
| 138 | Args: |
| 139 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 140 | body: object, The request body. |
| 141 | The object takes the form of: |
| 142 | |
| 143 | { # The request message for Participants.SuggestFaqAnswers. |
| 144 | "contextSize": 42, # 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. |
| 145 | "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/`. |
| 146 | } |
| 147 | |
| 148 | x__xgafv: string, V1 error format. |
| 149 | Allowed values |
| 150 | 1 - v1 error format |
| 151 | 2 - v2 error format |
| 152 | |
| 153 | Returns: |
| 154 | An object of the form: |
| 155 | |
| 156 | { # The request message for Participants.SuggestFaqAnswers. |
| 157 | "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. |
| 158 | "faqAnswers": [ # Answers extracted from FAQ documents. |
| 159 | { # Represents answer from "frequently asked questions". |
| 160 | "answer": "A String", # The piece of text from the `source` knowledge base document. |
| 161 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 162 | "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). |
| 163 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 164 | "a_key": "A String", |
| 165 | }, |
| 166 | "question": "A String", # The corresponding FAQ question. |
| 167 | "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. |
| 168 | }, |
| 169 | ], |
| 170 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 171 | }</pre> |
| 172 | </div> |
| 173 | |
| 174 | </body></html> |