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

blob: 5b4695f1468785256134d961f1e960ba3ae94317 [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">
				83	<code><a href="dialogflow_v2beta1.projects.locations.operations.html">operations()</a></code>
				84	</p>
				85	<p class="firstline">Returns the operations Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
				89	<p class="firstline">Deletes the specified agent.</p>
				90	<p class="toc_element">
				91	<code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
				92	<p class="firstline">Retrieves the specified agent.</p>
				93	<p class="toc_element">
				94	<code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				95	<p class="firstline">Creates/updates the specified agent.</p>
				96	<h3>Method Details</h3>
				97	<div class="method">
				98	<code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
				99	<pre>Deletes the specified agent.
				100
				101	Args:
				102	parent: string, Required. The project that the agent to delete is associated with.
				103	Format: `projects/<Project ID>`. (required)
				104	x__xgafv: string, V1 error format.
				105	Allowed values
				106	1 - v1 error format
				107	2 - v2 error format
				108
				109	Returns:
				110	An object of the form:
				111
				112	{ # A generic empty message that you can re-use to avoid defining duplicated
				113	# empty messages in your APIs. A typical example is to use it as the request
				114	# or the response type of an API method. For instance:
				115	#
				116	# service Foo {
				117	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				118	# }
				119	#
				120	# The JSON representation for `Empty` is empty JSON object `{}`.
				121	}</pre>
				122	</div>
				123
				124	<div class="method">
				125	<code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
				126	<pre>Retrieves the specified agent.
				127
				128	Args:
				129	parent: string, Required. The project that the agent to fetch is associated with.
				130	Format: `projects/<Project ID>`. (required)
				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
				139	{ # Represents a conversational agent.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	140	"timeZone": "A String", # Required. The time zone of this agent from the
				141	# [time zone database](https://www.iana.org/time-zones), e.g.,
				142	# America/New_York, Europe/Paris.
				143	"description": "A String", # Optional. The description of this agent.
				144	# The maximum length is 500 characters. If exceeded, the request is rejected.
				145	"parent": "A String", # Required. The project of this agent.
				146	# Format: `projects/<Project ID>`.
				147	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
				148	# `default_language_code`).
				149	"A String",
				150	],
				151	"avatarUri": "A String", # Optional. The URI of the agent's avatar.
				152	# Avatars are used throughout the Dialogflow console and in the self-hosted
				153	# [Web
				154	# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
				155	# integration.
				156	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
				157	# [Language
				158	# Support](https://cloud.google.com/dialogflow/docs/reference/language)
				159	# for a list of the currently supported language codes. This field cannot be
				160	# set by the `Update` method.
				161	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				162	"displayName": "A String", # Required. The name of this agent.
				163	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				164	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				165	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
				166	# V2 API is assumed. Clients are free to query different service endpoints
				167	# for different API versions. However, bots connectors and webhook calls will
				168	# follow the specified API version.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	169	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
				170	# matched natural language inputs for your agent, you can tune the machine
				171	# learning classification threshold. If the returned score value is less than
				172	# the threshold value, then a fallback intent will be triggered or, if there
				173	# are no fallback intents defined, no intent will be triggered. The score
				174	# values range from 0.0 (completely uncertain) to 1.0 (completely certain).
				175	# If set to 0.0, the default of 0.3 is used.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	176	}</pre>
				177	</div>
				178
				179	<div class="method">
				180	<code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>
				181	<pre>Creates/updates the specified agent.
				182
				183	Args:
				184	parent: string, Required. The project of this agent.
				185	Format: `projects/<Project ID>`. (required)
				186	body: object, The request body.
				187	The object takes the form of:
				188
				189	{ # Represents a conversational agent.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	190	"timeZone": "A String", # Required. The time zone of this agent from the
				191	# [time zone database](https://www.iana.org/time-zones), e.g.,
				192	# America/New_York, Europe/Paris.
				193	"description": "A String", # Optional. The description of this agent.
				194	# The maximum length is 500 characters. If exceeded, the request is rejected.
				195	"parent": "A String", # Required. The project of this agent.
				196	# Format: `projects/<Project ID>`.
				197	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
				198	# `default_language_code`).
				199	"A String",
				200	],
				201	"avatarUri": "A String", # Optional. The URI of the agent's avatar.
				202	# Avatars are used throughout the Dialogflow console and in the self-hosted
				203	# [Web
				204	# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
				205	# integration.
				206	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
				207	# [Language
				208	# Support](https://cloud.google.com/dialogflow/docs/reference/language)
				209	# for a list of the currently supported language codes. This field cannot be
				210	# set by the `Update` method.
				211	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				212	"displayName": "A String", # Required. The name of this agent.
				213	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				214	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				215	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
				216	# V2 API is assumed. Clients are free to query different service endpoints
				217	# for different API versions. However, bots connectors and webhook calls will
				218	# follow the specified API version.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	219	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
				220	# matched natural language inputs for your agent, you can tune the machine
				221	# learning classification threshold. If the returned score value is less than
				222	# the threshold value, then a fallback intent will be triggered or, if there
				223	# are no fallback intents defined, no intent will be triggered. The score
				224	# values range from 0.0 (completely uncertain) to 1.0 (completely certain).
				225	# If set to 0.0, the default of 0.3 is used.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	}
				227
				228	updateMask: string, Optional. The mask to control which fields get updated.
				229	x__xgafv: string, V1 error format.
				230	Allowed values
				231	1 - v1 error format
				232	2 - v2 error format
				233
				234	Returns:
				235	An object of the form:
				236
				237	{ # Represents a conversational agent.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	238	"timeZone": "A String", # Required. The time zone of this agent from the
				239	# [time zone database](https://www.iana.org/time-zones), e.g.,
				240	# America/New_York, Europe/Paris.
				241	"description": "A String", # Optional. The description of this agent.
				242	# The maximum length is 500 characters. If exceeded, the request is rejected.
				243	"parent": "A String", # Required. The project of this agent.
				244	# Format: `projects/<Project ID>`.
				245	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
				246	# `default_language_code`).
				247	"A String",
				248	],
				249	"avatarUri": "A String", # Optional. The URI of the agent's avatar.
				250	# Avatars are used throughout the Dialogflow console and in the self-hosted
				251	# [Web
				252	# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
				253	# integration.
				254	"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
				255	# [Language
				256	# Support](https://cloud.google.com/dialogflow/docs/reference/language)
				257	# for a list of the currently supported language codes. This field cannot be
				258	# set by the `Update` method.
				259	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				260	"displayName": "A String", # Required. The name of this agent.
				261	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				262	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				263	"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
				264	# V2 API is assumed. Clients are free to query different service endpoints
				265	# for different API versions. However, bots connectors and webhook calls will
				266	# follow the specified API version.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	267	"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
				268	# matched natural language inputs for your agent, you can tune the machine
				269	# learning classification threshold. If the returned score value is less than
				270	# the threshold value, then a fallback intent will be triggered or, if there
				271	# are no fallback intents defined, no intent will be triggered. The score
				272	# values range from 0.0 (completely uncertain) to 1.0 (completely certain).
				273	# If set to 0.0, the default of 0.3 is used.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	274	}</pre>
				275	</div>
				276
				277	</body></html>