| 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.conversations.html">conversations</a> . <a href="dialogflow_v2.projects.conversations.participants.html">participants</a> . <a href="dialogflow_v2.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="#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. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 102 | "assistQueryParams": { # Represents the parameters of human assist query. # Parameters for a human assist query. |
| 103 | "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" } ``` |
| 104 | "a_key": "A String", |
| 105 | }, |
| 106 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 107 | "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. |
| 108 | "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/`. |
| 109 | } |
| 110 | |
| 111 | x__xgafv: string, V1 error format. |
| 112 | Allowed values |
| 113 | 1 - v1 error format |
| 114 | 2 - v2 error format |
| 115 | |
| 116 | Returns: |
| 117 | An object of the form: |
| 118 | |
| 119 | { # The response message for Participants.SuggestArticles. |
| 120 | "articleAnswers": [ # Articles ordered by score in descending order. |
| 121 | { # Represents article answer. |
| 122 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 123 | "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). |
| 124 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 125 | "a_key": "A String", |
| 126 | }, |
| 127 | "snippets": [ # Article snippets. |
| 128 | "A String", |
| 129 | ], |
| 130 | "title": "A String", # The article title. |
| 131 | "uri": "A String", # The article URI. |
| 132 | }, |
| 133 | ], |
| 134 | "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. |
| 135 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 136 | }</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</code> |
| 141 | <pre>Gets suggested faq answers for a participant based on specific historical messages. |
| 142 | |
| 143 | Args: |
| 144 | parent: string, Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`. (required) |
| 145 | body: object, The request body. |
| 146 | The object takes the form of: |
| 147 | |
| 148 | { # The request message for Participants.SuggestFaqAnswers. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 149 | "assistQueryParams": { # Represents the parameters of human assist query. # Parameters for a human assist query. |
| 150 | "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" } ``` |
| 151 | "a_key": "A String", |
| 152 | }, |
| 153 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 154 | "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. |
| 155 | "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/`. |
| 156 | } |
| 157 | |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
| 166 | { # The request message for Participants.SuggestFaqAnswers. |
| 167 | "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. |
| 168 | "faqAnswers": [ # Answers extracted from FAQ documents. |
| 169 | { # Represents answer from "frequently asked questions". |
| 170 | "answer": "A String", # The piece of text from the `source` knowledge base document. |
| 171 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 172 | "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). |
| 173 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 174 | "a_key": "A String", |
| 175 | }, |
| 176 | "question": "A String", # The corresponding FAQ question. |
| 177 | "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. |
| 178 | }, |
| 179 | ], |
| 180 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 181 | }</pre> |
| 182 | </div> |
| 183 | |
| 184 | </body></html> |