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

blob: 6c03301d050610c0e8f84abea428f214ed9e8570 [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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<code><a href="#close">close()</a></code></p>
				89	<p class="firstline">Close httplib2 connections.</p>
				90	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	<code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
				92	<p class="firstline">Deletes the specified agent.</p>
				93	<p class="toc_element">
				94	<code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
				95	<p class="firstline">Retrieves the specified agent.</p>
				96	<p class="toc_element">
				97	<code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				98	<p class="firstline">Creates/updates the specified agent.</p>
				99	<h3>Method Details</h3>
				100	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	101	<code class="details" id="close">close()</code>
				102	<pre>Close httplib2 connections.</pre>
				103	</div>
				104
				105	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	<code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
				107	<pre>Deletes the specified agent.
				108
				109	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	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]	111	x__xgafv: string, V1 error format.
				112	Allowed values
				113	1 - v1 error format
				114	2 - v2 error format
				115
				116	Returns:
				117	An object of the form:
				118
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	{ # 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]	120	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	121	</div>
				122
				123	<div class="method">
				124	<code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
				125	<pre>Retrieves the specified agent.
				126
				127	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	128	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]	129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
				133
				134	Returns:
				135	An object of the form:
				136
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	{ # 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]	138	"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.
				139	"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.
				140	"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.
				141	"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.
				142	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				143	"displayName": "A String", # Required. The name of this agent.
				144	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				145	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				146	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				147	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				148	"A String",
				149	],
				150	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				151	"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.
				152	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	153	</div>
				154
				155	<div class="method">
				156	<code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>
				157	<pre>Creates/updates the specified agent.
				158
				159	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	160	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]	161	body: object, The request body.
				162	The object takes the form of:
				163
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	164	{ # 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]	165	"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.
				166	"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.
				167	"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.
				168	"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.
				169	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				170	"displayName": "A String", # Required. The name of this agent.
				171	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				172	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				173	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				174	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				175	"A String",
				176	],
				177	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				178	"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.
				179	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	180
				181	updateMask: string, Optional. The mask to control which fields get updated.
				182	x__xgafv: string, V1 error format.
				183	Allowed values
				184	1 - v1 error format
				185	2 - v2 error format
				186
				187	Returns:
				188	An object of the form:
				189
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	{ # 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]	191	"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.
				192	"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.
				193	"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.
				194	"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.
				195	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				196	"displayName": "A String", # Required. The name of this agent.
				197	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
				198	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				199	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
				200	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				201	"A String",
				202	],
				203	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
				204	"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.
				205	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	</div>
				207
				208	</body></html>