Blame - docs/dyn/dialogflow_v2beta1.projects.locations.html - platform/external/python/google-api-python-client

blob: 23aef4bc164b8d87978fa0f8c9f7c0af5ade6dd4 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.locations.html">locations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v2beta1.projects.locations.agent.html">agent()</a></code>
				79	</p>
				80	<p class="firstline">Returns the agent Resource.</p>
				81
				82	<p class="toc_element">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	83	<code><a href="dialogflow_v2beta1.projects.locations.answerRecords.html">answerRecords()</a></code>
				84	</p>
				85	<p class="firstline">Returns the answerRecords Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="dialogflow_v2beta1.projects.locations.conversationProfiles.html">conversationProfiles()</a></code>
				89	</p>
				90	<p class="firstline">Returns the conversationProfiles Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="dialogflow_v2beta1.projects.locations.conversations.html">conversations()</a></code>
				94	</p>
				95	<p class="firstline">Returns the conversations Resource.</p>
				96
				97	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	98	<code><a href="dialogflow_v2beta1.projects.locations.knowledgeBases.html">knowledgeBases()</a></code>
				99	</p>
				100	<p class="firstline">Returns the knowledgeBases Resource.</p>
				101
				102	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	<code><a href="dialogflow_v2beta1.projects.locations.operations.html">operations()</a></code>
				104	</p>
				105	<p class="firstline">Returns the operations Resource.</p>
				106
				107	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<code><a href="#close">close()</a></code></p>
				109	<p class="firstline">Close httplib2 connections.</p>
				110	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	111	<code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Deletes the specified agent.</p>
				113	<p class="toc_element">
				114	<code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
				115	<p class="firstline">Retrieves the specified agent.</p>
				116	<p class="toc_element">
				117	<code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				118	<p class="firstline">Creates/updates the specified agent.</p>
				119	<h3>Method Details</h3>
				120	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	121	<code class="details" id="close">close()</code>
				122	<pre>Close httplib2 connections.</pre>
				123	</div>
				124
				125	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	<code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
				127	<pre>Deletes the specified agent.
				128
				129	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	130	parent: string, Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	131	x__xgafv: string, V1 error format.
				132	Allowed values
				133	1 - v1 error format
				134	2 - v2 error format
				135
				136	Returns:
				137	An object of the form:
				138
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	139	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	140	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	</div>
				142
				143	<div class="method">
				144	<code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
				145	<pre>Retrieves the specified agent.
				146
				147	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	parent: string, Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	149	x__xgafv: string, V1 error format.
				150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
				153
				154	Returns:
				155	An object of the form:
				156
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	{ # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	158	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
				159	"avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				160	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
				161	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
				162	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				163	"displayName": "A String", # Required. The name of this agent.
				164	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				165	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				166	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				167	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				168	"A String",
				169	],
				170	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				171	"timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				172	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	173	</div>
				174
				175	<div class="method">
				176	<code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>
				177	<pre>Creates/updates the specified agent.
				178
				179	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	parent: string, Required. The project of this agent. Format: `projects/` or `projects//locations/` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	181	body: object, The request body.
				182	The object takes the form of:
				183
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	184	{ # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	185	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
				186	"avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				187	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
				188	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
				189	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				190	"displayName": "A String", # Required. The name of this agent.
				191	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				192	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				193	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				194	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				195	"A String",
				196	],
				197	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				198	"timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				199	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	200
				201	updateMask: string, Optional. The mask to control which fields get updated.
				202	x__xgafv: string, V1 error format.
				203	Allowed values
				204	1 - v1 error format
				205	2 - v2 error format
				206
				207	Returns:
				208	An object of the form:
				209
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	{ # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	211	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
				212	"avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				213	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
				214	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
				215	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				216	"displayName": "A String", # Required. The name of this agent.
				217	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				218	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				219	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				220	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				221	"A String",
				222	],
				223	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				224	"timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				225	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	</div>
				227
				228	</body></html>