blob: 5896b3ac2162928c51ae3116b52b9ef54bde21c7 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.suggestions.html">suggestions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#suggestConversationSummary">suggestConversationSummary(conversation, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="suggestConversationSummary">suggestConversationSummary(conversation, body=None, x__xgafv=None)</code>
<pre>Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.
Args:
conversation: string, Required. The conversation to fetch suggestion for. Format: `projects//locations//conversations/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Conversations.SuggestConversationSummary.
&quot;assistQueryParams&quot;: { # Represents the parameters of human assist query. # Parameters for a human assist query.
&quot;documentsMetadataFilters&quot;: { # 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 &#x27;US&#x27; or &#x27;CA&#x27; in their market metadata values and &#x27;agent&#x27; in their user metadata values will be ``` documents_metadata_filters { key: &quot;market&quot; value: &quot;US,CA&quot; } documents_metadata_filters { key: &quot;user&quot; value: &quot;agent&quot; } ```
&quot;a_key&quot;: &quot;A String&quot;,
},
},
&quot;contextSize&quot;: 42, # Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.
&quot;latestMessage&quot;: &quot;A String&quot;, # The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: `projects//locations//conversations//messages/`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Conversations.SuggestConversationSummary.
&quot;contextSize&quot;: 42, # Number of messages prior to and including last_conversation_message used to compile the suggestion. It may be smaller than the SuggestSummaryRequest.context_size field in the request if there weren&#x27;t that many messages in the conversation.
&quot;latestMessage&quot;: &quot;A String&quot;, # The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.
&quot;summary&quot;: { # Generated summary for a conversation. # Generated summary.
&quot;answerRecord&quot;: &quot;A String&quot;, # The name of the answer record. Format: &quot;projects//answerRecords/&quot;
&quot;text&quot;: &quot;A String&quot;, # The summary content that is concatenated into one string.
&quot;textSections&quot;: { # The summary content that is divided into sections. The key is the section&#x27;s name and the value is the section&#x27;s content. There is no specific format for the key or value.
&quot;a_key&quot;: &quot;A String&quot;,
},
},
}</pre>
</div>
</body></html>