blob: 146aafdcca4cf1f228b058595436d068ac813de9 [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_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>
<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="#suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#suggestKnowledgeAssist">suggestKnowledgeAssist(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></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="suggestArticles">suggestArticles(parent, body=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;assistQueryParams&quot;: {
&quot;documentsMetadataFilters&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
},
&quot;contextSize&quot;: 42,
&quot;latestMessage&quot;: &quot;A String&quot;,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;articleAnswers&quot;: [
{
&quot;answerRecord&quot;: &quot;A String&quot;,
&quot;confidence&quot;: 3.14,
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;snippets&quot;: [
&quot;A String&quot;,
],
&quot;title&quot;: &quot;A String&quot;,
&quot;uri&quot;: &quot;A String&quot;,
},
],
&quot;contextSize&quot;: 42,
&quot;latestMessage&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="suggestFaqAnswers">suggestFaqAnswers(parent, body=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;assistQueryParams&quot;: {
&quot;documentsMetadataFilters&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
},
&quot;contextSize&quot;: 42,
&quot;latestMessage&quot;: &quot;A String&quot;,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;contextSize&quot;: 42,
&quot;faqAnswers&quot;: [
{
&quot;answer&quot;: &quot;A String&quot;,
&quot;answerRecord&quot;: &quot;A String&quot;,
&quot;confidence&quot;: 3.14,
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;question&quot;: &quot;A String&quot;,
&quot;source&quot;: &quot;A String&quot;,
},
],
&quot;latestMessage&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="suggestKnowledgeAssist">suggestKnowledgeAssist(parent, body=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;contextSize&quot;: 42,
&quot;latestMessage&quot;: &quot;A String&quot;,
&quot;previousSuggestedQuery&quot;: &quot;A String&quot;,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;additionalSuggestedQueryResults&quot;: [
{
&quot;answerRecord&quot;: &quot;A String&quot;,
&quot;suggestedQuery&quot;: {
&quot;queryText&quot;: &quot;A String&quot;,
&quot;searchContexts&quot;: [
{
&quot;key&quot;: &quot;A String&quot;,
&quot;value&quot;: &quot;A String&quot;,
},
],
},
},
],
&quot;contextSize&quot;: 42,
&quot;knowledgeAssistAnswer&quot;: {
&quot;answerRecord&quot;: &quot;A String&quot;,
&quot;knowledgeAssistDebugInfo&quot;: {
&quot;cesDebugInfo&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;datastoreResponseReason&quot;: &quot;A String&quot;,
&quot;ingestedContextReferenceDebugInfo&quot;: {
&quot;contextReferenceRetrieved&quot;: True or False,
&quot;ingestedParametersDebugInfo&quot;: [
{
&quot;ingestionStatus&quot;: &quot;A String&quot;,
&quot;parameter&quot;: &quot;A String&quot;,
},
],
&quot;projectNotAllowlisted&quot;: True or False,
},
&quot;knowledgeAssistBehavior&quot;: {
&quot;answerGenerationRewriterOn&quot;: True or False,
&quot;appendedSearchContextCount&quot;: 42,
&quot;conversationTranscriptHasMixedLanguages&quot;: True or False,
&quot;disableSyncDelivery&quot;: True or False,
&quot;endUserMetadataIncluded&quot;: True or False,
&quot;invalidItemsQuerySuggestionSkipped&quot;: True or False,
&quot;multipleQueriesGenerated&quot;: True or False,
&quot;previousQueriesIncluded&quot;: True or False,
&quot;primaryQueryRedactedAndReplaced&quot;: True or False,
&quot;queryContainedSearchContext&quot;: True or False,
&quot;queryGenerationAgentLanguageMismatch&quot;: True or False,
&quot;queryGenerationEndUserLanguageMismatch&quot;: True or False,
&quot;returnQueryOnly&quot;: True or False,
&quot;thirdPartyConnectorAllowed&quot;: True or False,
&quot;useCustomSafetyFilterLevel&quot;: True or False,
&quot;usePubsubDelivery&quot;: True or False,
&quot;useTranslatedMessage&quot;: True or False,
},
&quot;queryCategorizationFailureReason&quot;: &quot;A String&quot;,
&quot;queryGenerationDebugInfo&quot;: {
&quot;candidatesTokenCount&quot;: 42,
&quot;promptTokenCount&quot;: 42,
&quot;similarityToLastQuery&quot;: 3.14,
&quot;similarityToLastQueryThreshold&quot;: 3.14,
&quot;thinkingBudgetTokens&quot;: 42,
&quot;thinkingLevel&quot;: &quot;A String&quot;,
&quot;totalTokenCount&quot;: 42,
},
&quot;queryGenerationFailureReason&quot;: &quot;A String&quot;,
&quot;serviceLatency&quot;: {
&quot;internalServiceLatencies&quot;: [
{
&quot;completeTime&quot;: &quot;A String&quot;,
&quot;latencyMs&quot;: 3.14,
&quot;startTime&quot;: &quot;A String&quot;,
&quot;step&quot;: &quot;A String&quot;,
},
],
},
},
&quot;suggestedQuery&quot;: {
&quot;queryText&quot;: &quot;A String&quot;,
&quot;searchContexts&quot;: [
{
&quot;key&quot;: &quot;A String&quot;,
&quot;value&quot;: &quot;A String&quot;,
},
],
},
&quot;suggestedQueryAnswer&quot;: {
&quot;answerText&quot;: &quot;A String&quot;,
&quot;eventSource&quot;: {
&quot;event&quot;: &quot;A String&quot;,
&quot;snippets&quot;: {
&quot;snippets&quot;: [
{
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;text&quot;: &quot;A String&quot;,
&quot;title&quot;: &quot;A String&quot;,
&quot;uri&quot;: &quot;A String&quot;,
},
],
},
},
&quot;faqSource&quot;: {
&quot;question&quot;: &quot;A String&quot;,
},
&quot;generativeSource&quot;: {
&quot;snippets&quot;: [
{
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;text&quot;: &quot;A String&quot;,
&quot;title&quot;: &quot;A String&quot;,
&quot;uri&quot;: &quot;A String&quot;,
},
],
},
&quot;playbookSource&quot;: {
&quot;snippets&quot;: [
{
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;text&quot;: &quot;A String&quot;,
&quot;title&quot;: &quot;A String&quot;,
&quot;uri&quot;: &quot;A String&quot;,
},
],
},
},
},
&quot;latestMessage&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="suggestSmartReplies">suggestSmartReplies(parent, body=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;contextSize&quot;: 42,
&quot;currentTextInput&quot;: {
&quot;languageCode&quot;: &quot;A String&quot;,
&quot;text&quot;: &quot;A String&quot;,
},
&quot;latestMessage&quot;: &quot;A String&quot;,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;contextSize&quot;: 42,
&quot;latestMessage&quot;: &quot;A String&quot;,
&quot;smartReplyAnswers&quot;: [
{
&quot;answerRecord&quot;: &quot;A String&quot;,
&quot;confidence&quot;: 3.14,
&quot;reply&quot;: &quot;A String&quot;,
},
],
}</pre>
</div>
</body></html>