blob: 11ca9f43dcbd0caeab82bcf38b693ecc099b2523 [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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.tools.html">tools</a> . <a href="dialogflow_v3beta1.projects.locations.agents.tools.versions.html">versions</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, force=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="#list">list(parent, 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="#restore">restore(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;createTime&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;tool&quot;: {
&quot;connectorSpec&quot;: {
&quot;actions&quot;: [
{
&quot;connectionActionId&quot;: &quot;A String&quot;,
&quot;entityOperation&quot;: {
&quot;entityId&quot;: &quot;A String&quot;,
&quot;operation&quot;: &quot;A String&quot;,
},
&quot;inputFields&quot;: [
&quot;A String&quot;,
],
&quot;outputFields&quot;: [
&quot;A String&quot;,
],
},
],
&quot;endUserAuthConfig&quot;: {
&quot;oauth2AuthCodeConfig&quot;: {
&quot;oauthToken&quot;: &quot;A String&quot;,
},
&quot;oauth2JwtBearerConfig&quot;: {
&quot;clientKey&quot;: &quot;A String&quot;,
&quot;issuer&quot;: &quot;A String&quot;,
&quot;subject&quot;: &quot;A String&quot;,
},
},
&quot;name&quot;: &quot;A String&quot;,
},
&quot;dataStoreSpec&quot;: {
&quot;dataStoreConnections&quot;: [
{
&quot;dataStore&quot;: &quot;A String&quot;,
&quot;dataStoreType&quot;: &quot;A String&quot;,
&quot;documentProcessingMode&quot;: &quot;A String&quot;,
},
],
&quot;fallbackPrompt&quot;: {
},
},
&quot;description&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;extensionSpec&quot;: {
&quot;name&quot;: &quot;A String&quot;,
},
&quot;functionSpec&quot;: {
&quot;inputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;outputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;name&quot;: &quot;A String&quot;,
&quot;openApiSpec&quot;: {
&quot;authentication&quot;: {
&quot;apiKeyConfig&quot;: {
&quot;apiKey&quot;: &quot;A String&quot;,
&quot;keyName&quot;: &quot;A String&quot;,
&quot;requestLocation&quot;: &quot;A String&quot;,
&quot;secretVersionForApiKey&quot;: &quot;A String&quot;,
},
&quot;bearerTokenConfig&quot;: {
&quot;secretVersionForToken&quot;: &quot;A String&quot;,
&quot;token&quot;: &quot;A String&quot;,
},
&quot;oauthConfig&quot;: {
&quot;clientId&quot;: &quot;A String&quot;,
&quot;clientSecret&quot;: &quot;A String&quot;,
&quot;oauthGrantType&quot;: &quot;A String&quot;,
&quot;scopes&quot;: [
&quot;A String&quot;,
],
&quot;secretVersionForClientSecret&quot;: &quot;A String&quot;,
&quot;tokenEndpoint&quot;: &quot;A String&quot;,
},
&quot;serviceAccountAuthConfig&quot;: {
&quot;serviceAccount&quot;: &quot;A String&quot;,
},
&quot;serviceAgentAuthConfig&quot;: {
&quot;serviceAgentAuth&quot;: &quot;A String&quot;,
},
},
&quot;serviceDirectoryConfig&quot;: {
&quot;service&quot;: &quot;A String&quot;,
},
&quot;textSchema&quot;: &quot;A String&quot;,
&quot;tlsConfig&quot;: {
&quot;caCerts&quot;: [
{
&quot;cert&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
},
],
},
},
&quot;toolType&quot;: &quot;A String&quot;,
},
&quot;updateTime&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;createTime&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;tool&quot;: {
&quot;connectorSpec&quot;: {
&quot;actions&quot;: [
{
&quot;connectionActionId&quot;: &quot;A String&quot;,
&quot;entityOperation&quot;: {
&quot;entityId&quot;: &quot;A String&quot;,
&quot;operation&quot;: &quot;A String&quot;,
},
&quot;inputFields&quot;: [
&quot;A String&quot;,
],
&quot;outputFields&quot;: [
&quot;A String&quot;,
],
},
],
&quot;endUserAuthConfig&quot;: {
&quot;oauth2AuthCodeConfig&quot;: {
&quot;oauthToken&quot;: &quot;A String&quot;,
},
&quot;oauth2JwtBearerConfig&quot;: {
&quot;clientKey&quot;: &quot;A String&quot;,
&quot;issuer&quot;: &quot;A String&quot;,
&quot;subject&quot;: &quot;A String&quot;,
},
},
&quot;name&quot;: &quot;A String&quot;,
},
&quot;dataStoreSpec&quot;: {
&quot;dataStoreConnections&quot;: [
{
&quot;dataStore&quot;: &quot;A String&quot;,
&quot;dataStoreType&quot;: &quot;A String&quot;,
&quot;documentProcessingMode&quot;: &quot;A String&quot;,
},
],
&quot;fallbackPrompt&quot;: {
},
},
&quot;description&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;extensionSpec&quot;: {
&quot;name&quot;: &quot;A String&quot;,
},
&quot;functionSpec&quot;: {
&quot;inputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;outputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;name&quot;: &quot;A String&quot;,
&quot;openApiSpec&quot;: {
&quot;authentication&quot;: {
&quot;apiKeyConfig&quot;: {
&quot;apiKey&quot;: &quot;A String&quot;,
&quot;keyName&quot;: &quot;A String&quot;,
&quot;requestLocation&quot;: &quot;A String&quot;,
&quot;secretVersionForApiKey&quot;: &quot;A String&quot;,
},
&quot;bearerTokenConfig&quot;: {
&quot;secretVersionForToken&quot;: &quot;A String&quot;,
&quot;token&quot;: &quot;A String&quot;,
},
&quot;oauthConfig&quot;: {
&quot;clientId&quot;: &quot;A String&quot;,
&quot;clientSecret&quot;: &quot;A String&quot;,
&quot;oauthGrantType&quot;: &quot;A String&quot;,
&quot;scopes&quot;: [
&quot;A String&quot;,
],
&quot;secretVersionForClientSecret&quot;: &quot;A String&quot;,
&quot;tokenEndpoint&quot;: &quot;A String&quot;,
},
&quot;serviceAccountAuthConfig&quot;: {
&quot;serviceAccount&quot;: &quot;A String&quot;,
},
&quot;serviceAgentAuthConfig&quot;: {
&quot;serviceAgentAuth&quot;: &quot;A String&quot;,
},
},
&quot;serviceDirectoryConfig&quot;: {
&quot;service&quot;: &quot;A String&quot;,
},
&quot;textSchema&quot;: &quot;A String&quot;,
&quot;tlsConfig&quot;: {
&quot;caCerts&quot;: [
{
&quot;cert&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
},
],
},
},
&quot;toolType&quot;: &quot;A String&quot;,
},
&quot;updateTime&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>
Args:
name: string, A parameter (required)
force: boolean, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
}</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;createTime&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;tool&quot;: {
&quot;connectorSpec&quot;: {
&quot;actions&quot;: [
{
&quot;connectionActionId&quot;: &quot;A String&quot;,
&quot;entityOperation&quot;: {
&quot;entityId&quot;: &quot;A String&quot;,
&quot;operation&quot;: &quot;A String&quot;,
},
&quot;inputFields&quot;: [
&quot;A String&quot;,
],
&quot;outputFields&quot;: [
&quot;A String&quot;,
],
},
],
&quot;endUserAuthConfig&quot;: {
&quot;oauth2AuthCodeConfig&quot;: {
&quot;oauthToken&quot;: &quot;A String&quot;,
},
&quot;oauth2JwtBearerConfig&quot;: {
&quot;clientKey&quot;: &quot;A String&quot;,
&quot;issuer&quot;: &quot;A String&quot;,
&quot;subject&quot;: &quot;A String&quot;,
},
},
&quot;name&quot;: &quot;A String&quot;,
},
&quot;dataStoreSpec&quot;: {
&quot;dataStoreConnections&quot;: [
{
&quot;dataStore&quot;: &quot;A String&quot;,
&quot;dataStoreType&quot;: &quot;A String&quot;,
&quot;documentProcessingMode&quot;: &quot;A String&quot;,
},
],
&quot;fallbackPrompt&quot;: {
},
},
&quot;description&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;extensionSpec&quot;: {
&quot;name&quot;: &quot;A String&quot;,
},
&quot;functionSpec&quot;: {
&quot;inputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;outputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;name&quot;: &quot;A String&quot;,
&quot;openApiSpec&quot;: {
&quot;authentication&quot;: {
&quot;apiKeyConfig&quot;: {
&quot;apiKey&quot;: &quot;A String&quot;,
&quot;keyName&quot;: &quot;A String&quot;,
&quot;requestLocation&quot;: &quot;A String&quot;,
&quot;secretVersionForApiKey&quot;: &quot;A String&quot;,
},
&quot;bearerTokenConfig&quot;: {
&quot;secretVersionForToken&quot;: &quot;A String&quot;,
&quot;token&quot;: &quot;A String&quot;,
},
&quot;oauthConfig&quot;: {
&quot;clientId&quot;: &quot;A String&quot;,
&quot;clientSecret&quot;: &quot;A String&quot;,
&quot;oauthGrantType&quot;: &quot;A String&quot;,
&quot;scopes&quot;: [
&quot;A String&quot;,
],
&quot;secretVersionForClientSecret&quot;: &quot;A String&quot;,
&quot;tokenEndpoint&quot;: &quot;A String&quot;,
},
&quot;serviceAccountAuthConfig&quot;: {
&quot;serviceAccount&quot;: &quot;A String&quot;,
},
&quot;serviceAgentAuthConfig&quot;: {
&quot;serviceAgentAuth&quot;: &quot;A String&quot;,
},
},
&quot;serviceDirectoryConfig&quot;: {
&quot;service&quot;: &quot;A String&quot;,
},
&quot;textSchema&quot;: &quot;A String&quot;,
&quot;tlsConfig&quot;: {
&quot;caCerts&quot;: [
{
&quot;cert&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
},
],
},
},
&quot;toolType&quot;: &quot;A String&quot;,
},
&quot;updateTime&quot;: &quot;A String&quot;,
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>
Args:
parent: string, A parameter (required)
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;nextPageToken&quot;: &quot;A String&quot;,
&quot;toolVersions&quot;: [
{
&quot;createTime&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;name&quot;: &quot;A String&quot;,
&quot;tool&quot;: {
&quot;connectorSpec&quot;: {
&quot;actions&quot;: [
{
&quot;connectionActionId&quot;: &quot;A String&quot;,
&quot;entityOperation&quot;: {
&quot;entityId&quot;: &quot;A String&quot;,
&quot;operation&quot;: &quot;A String&quot;,
},
&quot;inputFields&quot;: [
&quot;A String&quot;,
],
&quot;outputFields&quot;: [
&quot;A String&quot;,
],
},
],
&quot;endUserAuthConfig&quot;: {
&quot;oauth2AuthCodeConfig&quot;: {
&quot;oauthToken&quot;: &quot;A String&quot;,
},
&quot;oauth2JwtBearerConfig&quot;: {
&quot;clientKey&quot;: &quot;A String&quot;,
&quot;issuer&quot;: &quot;A String&quot;,
&quot;subject&quot;: &quot;A String&quot;,
},
},
&quot;name&quot;: &quot;A String&quot;,
},
&quot;dataStoreSpec&quot;: {
&quot;dataStoreConnections&quot;: [
{
&quot;dataStore&quot;: &quot;A String&quot;,
&quot;dataStoreType&quot;: &quot;A String&quot;,
&quot;documentProcessingMode&quot;: &quot;A String&quot;,
},
],
&quot;fallbackPrompt&quot;: {
},
},
&quot;description&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;extensionSpec&quot;: {
&quot;name&quot;: &quot;A String&quot;,
},
&quot;functionSpec&quot;: {
&quot;inputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;outputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;name&quot;: &quot;A String&quot;,
&quot;openApiSpec&quot;: {
&quot;authentication&quot;: {
&quot;apiKeyConfig&quot;: {
&quot;apiKey&quot;: &quot;A String&quot;,
&quot;keyName&quot;: &quot;A String&quot;,
&quot;requestLocation&quot;: &quot;A String&quot;,
&quot;secretVersionForApiKey&quot;: &quot;A String&quot;,
},
&quot;bearerTokenConfig&quot;: {
&quot;secretVersionForToken&quot;: &quot;A String&quot;,
&quot;token&quot;: &quot;A String&quot;,
},
&quot;oauthConfig&quot;: {
&quot;clientId&quot;: &quot;A String&quot;,
&quot;clientSecret&quot;: &quot;A String&quot;,
&quot;oauthGrantType&quot;: &quot;A String&quot;,
&quot;scopes&quot;: [
&quot;A String&quot;,
],
&quot;secretVersionForClientSecret&quot;: &quot;A String&quot;,
&quot;tokenEndpoint&quot;: &quot;A String&quot;,
},
&quot;serviceAccountAuthConfig&quot;: {
&quot;serviceAccount&quot;: &quot;A String&quot;,
},
&quot;serviceAgentAuthConfig&quot;: {
&quot;serviceAgentAuth&quot;: &quot;A String&quot;,
},
},
&quot;serviceDirectoryConfig&quot;: {
&quot;service&quot;: &quot;A String&quot;,
},
&quot;textSchema&quot;: &quot;A String&quot;,
&quot;tlsConfig&quot;: {
&quot;caCerts&quot;: [
{
&quot;cert&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
},
],
},
},
&quot;toolType&quot;: &quot;A String&quot;,
},
&quot;updateTime&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="restore">restore(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:
{
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;tool&quot;: {
&quot;connectorSpec&quot;: {
&quot;actions&quot;: [
{
&quot;connectionActionId&quot;: &quot;A String&quot;,
&quot;entityOperation&quot;: {
&quot;entityId&quot;: &quot;A String&quot;,
&quot;operation&quot;: &quot;A String&quot;,
},
&quot;inputFields&quot;: [
&quot;A String&quot;,
],
&quot;outputFields&quot;: [
&quot;A String&quot;,
],
},
],
&quot;endUserAuthConfig&quot;: {
&quot;oauth2AuthCodeConfig&quot;: {
&quot;oauthToken&quot;: &quot;A String&quot;,
},
&quot;oauth2JwtBearerConfig&quot;: {
&quot;clientKey&quot;: &quot;A String&quot;,
&quot;issuer&quot;: &quot;A String&quot;,
&quot;subject&quot;: &quot;A String&quot;,
},
},
&quot;name&quot;: &quot;A String&quot;,
},
&quot;dataStoreSpec&quot;: {
&quot;dataStoreConnections&quot;: [
{
&quot;dataStore&quot;: &quot;A String&quot;,
&quot;dataStoreType&quot;: &quot;A String&quot;,
&quot;documentProcessingMode&quot;: &quot;A String&quot;,
},
],
&quot;fallbackPrompt&quot;: {
},
},
&quot;description&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
&quot;extensionSpec&quot;: {
&quot;name&quot;: &quot;A String&quot;,
},
&quot;functionSpec&quot;: {
&quot;inputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;outputSchema&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;name&quot;: &quot;A String&quot;,
&quot;openApiSpec&quot;: {
&quot;authentication&quot;: {
&quot;apiKeyConfig&quot;: {
&quot;apiKey&quot;: &quot;A String&quot;,
&quot;keyName&quot;: &quot;A String&quot;,
&quot;requestLocation&quot;: &quot;A String&quot;,
&quot;secretVersionForApiKey&quot;: &quot;A String&quot;,
},
&quot;bearerTokenConfig&quot;: {
&quot;secretVersionForToken&quot;: &quot;A String&quot;,
&quot;token&quot;: &quot;A String&quot;,
},
&quot;oauthConfig&quot;: {
&quot;clientId&quot;: &quot;A String&quot;,
&quot;clientSecret&quot;: &quot;A String&quot;,
&quot;oauthGrantType&quot;: &quot;A String&quot;,
&quot;scopes&quot;: [
&quot;A String&quot;,
],
&quot;secretVersionForClientSecret&quot;: &quot;A String&quot;,
&quot;tokenEndpoint&quot;: &quot;A String&quot;,
},
&quot;serviceAccountAuthConfig&quot;: {
&quot;serviceAccount&quot;: &quot;A String&quot;,
},
&quot;serviceAgentAuthConfig&quot;: {
&quot;serviceAgentAuth&quot;: &quot;A String&quot;,
},
},
&quot;serviceDirectoryConfig&quot;: {
&quot;service&quot;: &quot;A String&quot;,
},
&quot;textSchema&quot;: &quot;A String&quot;,
&quot;tlsConfig&quot;: {
&quot;caCerts&quot;: [
{
&quot;cert&quot;: &quot;A String&quot;,
&quot;displayName&quot;: &quot;A String&quot;,
},
],
},
},
&quot;toolType&quot;: &quot;A String&quot;,
},
}</pre>
</div>
</body></html>