blob: 1e01a3575cf26716cf6c128cb3f76edf7ba528eb [file] [log] [blame] [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.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2.projects.knowledgeBases.documents.html">documents</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#reload">reload(name, 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="create">create(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;contentUri&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;enableAutoReload&quot;: True or False,
&quot;knowledgeTypes&quot;: [
&quot;A String&quot;,
],
&quot;latestReloadStatus&quot;: {
&quot;status&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;time&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;mimeType&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;rawContent&quot;: &quot;A String&quot;,
&quot;state&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;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;exportFullContent&quot;: True or False,
&quot;gcsDestination&quot;: {
&quot;uri&quot;: &quot;A String&quot;,
},
&quot;smartMessagingPartialUpdate&quot;: True or False,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;contentUri&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;enableAutoReload&quot;: True or False,
&quot;knowledgeTypes&quot;: [
&quot;A String&quot;,
],
&quot;latestReloadStatus&quot;: {
&quot;status&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;time&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;mimeType&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;rawContent&quot;: &quot;A String&quot;,
&quot;state&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="import_">import_(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;documentTemplate&quot;: {
&quot;knowledgeTypes&quot;: [
&quot;A String&quot;,
],
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;mimeType&quot;: &quot;A String&quot;,
},
&quot;gcsSource&quot;: {
&quot;uris&quot;: [
&quot;A String&quot;,
],
},
&quot;importGcsCustomMetadata&quot;: True or False,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
filter: string, A parameter
pageSize: integer, A parameter
pageToken: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;documents&quot;: [
{
&quot;contentUri&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;enableAutoReload&quot;: True or False,
&quot;knowledgeTypes&quot;: [
&quot;A String&quot;,
],
&quot;latestReloadStatus&quot;: {
&quot;status&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;time&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;mimeType&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;rawContent&quot;: &quot;A String&quot;,
&quot;state&quot;: &quot;A String&quot;,
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;contentUri&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;enableAutoReload&quot;: True or False,
&quot;knowledgeTypes&quot;: [
&quot;A String&quot;,
],
&quot;latestReloadStatus&quot;: {
&quot;status&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;time&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;mimeType&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;rawContent&quot;: &quot;A String&quot;,
&quot;state&quot;: &quot;A String&quot;,
}
updateMask: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;contentUri&quot;: &quot;A String&quot;,
&quot;importGcsCustomMetadata&quot;: True or False,
&quot;smartMessagingPartialUpdate&quot;: True or False,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;done&quot;: True or False,
&quot;error&quot;: {
&quot;code&quot;: 42,
&quot;details&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;,
},
&quot;metadata&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;response&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>