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

blob: 8d7918932fc04f2b91a1eb8cd92a4af86023b7f7 [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -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_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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v3beta1.projects.locations.agents.entityTypes.html">entityTypes()</a></code>
				79	</p>
				80	<p class="firstline">Returns the entityTypes Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="dialogflow_v3beta1.projects.locations.agents.environments.html">environments()</a></code>
				84	</p>
				85	<p class="firstline">Returns the environments Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="dialogflow_v3beta1.projects.locations.agents.flows.html">flows()</a></code>
				89	</p>
				90	<p class="firstline">Returns the flows Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="dialogflow_v3beta1.projects.locations.agents.intents.html">intents()</a></code>
				94	</p>
				95	<p class="firstline">Returns the intents Resource.</p>
				96
				97	<p class="toc_element">
				98	<code><a href="dialogflow_v3beta1.projects.locations.agents.sessions.html">sessions()</a></code>
				99	</p>
				100	<p class="firstline">Returns the sessions Resource.</p>
				101
				102	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	103	<code><a href="dialogflow_v3beta1.projects.locations.agents.testCases.html">testCases()</a></code>
				104	</p>
				105	<p class="firstline">Returns the testCases Resource.</p>
				106
				107	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<code><a href="dialogflow_v3beta1.projects.locations.agents.webhooks.html">webhooks()</a></code>
				109	</p>
				110	<p class="firstline">Returns the webhooks Resource.</p>
				111
				112	<p class="toc_element">
				113	<code><a href="#close">close()</a></code></p>
				114	<p class="firstline">Close httplib2 connections.</p>
				115	<p class="toc_element">
				116	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	117	<p class="firstline">Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	<p class="toc_element">
				119	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				120	<p class="firstline">Deletes the specified agent.</p>
				121	<p class="toc_element">
				122	<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	123	<p class="firstline">Exports the specified agent to a binary file.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	<p class="toc_element">
				125	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				126	<p class="firstline">Retrieves the specified agent.</p>
				127	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	128	<code><a href="#getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</a></code></p>
				129	<p class="firstline">Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.</p>
				130	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	131	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	132	<p class="firstline">Returns the list of all agents in the specified location.</p>
				133	<p class="toc_element">
				134	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				135	<p class="firstline">Retrieves the next page of results.</p>
				136	<p class="toc_element">
				137	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	138	<p class="firstline">Updates the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	139	<p class="toc_element">
				140	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	141	<p class="firstline">Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).</p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	142	<p class="toc_element">
				143	<code><a href="#validate">validate(name, body=None, x__xgafv=None)</a></code></p>
				144	<p class="firstline">Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	<h3>Method Details</h3>
				146	<div class="method">
				147	<code class="details" id="close">close()</code>
				148	<pre>Close httplib2 connections.</pre>
				149	</div>
				150
				151	<div class="method">
				152	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	153	<pre>Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154
				155	Args:
				156	parent: string, Required. The location to create a agent for. Format: `projects//locations/`. (required)
				157	body: object, The request body.
				158	The object takes the form of:
				159
				160	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	162	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	163	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				164	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				165	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				166	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				167	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	168	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				170	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				171	},
				172	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	173	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				174	"A String",
				175	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	176	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				177	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	178
				179	x__xgafv: string, V1 error format.
				180	Allowed values
				181	1 - v1 error format
				182	2 - v2 error format
				183
				184	Returns:
				185	An object of the form:
				186
				187	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	188	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	189	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	190	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				191	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				192	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				193	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				194	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	195	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	196	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				197	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				198	},
				199	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	200	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				201	"A String",
				202	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	203	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				204	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	205	</div>
				206
				207	<div class="method">
				208	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				209	<pre>Deletes the specified agent.
				210
				211	Args:
				212	name: string, Required. The name of the agent to delete. Format: `projects//locations//agents/`. (required)
				213	x__xgafv: string, V1 error format.
				214	Allowed values
				215	1 - v1 error format
				216	2 - v2 error format
				217
				218	Returns:
				219	An object of the form:
				220
				221	{ # 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]	222	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	223	</div>
				224
				225	<div class="method">
				226	<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	227	<pre>Exports the specified agent to a binary file.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	228
				229	Args:
				230	name: string, Required. The name of the agent to export. Format: `projects//locations//agents/`. (required)
				231	body: object, The request body.
				232	The object takes the form of:
				233
				234	{ # The request message for Agents.ExportAgent.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	235	"agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	236	"environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	238
				239	x__xgafv: string, V1 error format.
				240	Allowed values
				241	1 - v1 error format
				242	2 - v2 error format
				243
				244	Returns:
				245	An object of the form:
				246
				247	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				249	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				250	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				251	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				252	{
				253	"a_key": "", # Properties of the object. Contains field @type with type URL.
				254	},
				255	],
				256	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				257	},
				258	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				259	"a_key": "", # Properties of the object. Contains field @type with type URL.
				260	},
				261	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				262	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				263	"a_key": "", # Properties of the object. Contains field @type with type URL.
				264	},
				265	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	</div>
				267
				268	<div class="method">
				269	<code class="details" id="get">get(name, x__xgafv=None)</code>
				270	<pre>Retrieves the specified agent.
				271
				272	Args:
				273	name: string, Required. The name of the agent. Format: `projects//locations//agents/`. (required)
				274	x__xgafv: string, V1 error format.
				275	Allowed values
				276	1 - v1 error format
				277	2 - v2 error format
				278
				279	Returns:
				280	An object of the form:
				281
				282	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	283	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	284	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	285	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				286	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				287	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				288	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				289	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	290	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	291	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				292	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				293	},
				294	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	295	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				296	"A String",
				297	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	298	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				299	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	300	</div>
				301
				302	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	303	<code class="details" id="getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</code>
				304	<pre>Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
				305
				306	Args:
				307	name: string, Required. The agent name. Format: `projects//locations//agents//validationResult`. (required)
				308	languageCode: string, If not specified, the agent's default language is used.
				309	x__xgafv: string, V1 error format.
				310	Allowed values
				311	1 - v1 error format
				312	2 - v2 error format
				313
				314	Returns:
				315	An object of the form:
				316
				317	{ # The response message for Agents.GetAgentValidationResult.
				318	"flowValidationResults": [ # Contains all flow validation results.
				319	{ # The response message for Flows.GetFlowValidationResult.
				320	"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
				321	"updateTime": "A String", # Last time the flow was validated.
				322	"validationMessages": [ # Contains all validation messages.
				323	{ # Agent/flow validation message.
				324	"detail": "A String", # The message detail.
				325	"resourceNames": [ # The resource names of the resources where the message is found.
				326	{ # Resource name and display name.
				327	"displayName": "A String", # Display name.
				328	"name": "A String", # Name.
				329	},
				330	],
				331	"resourceType": "A String", # The type of the resources where the message is found.
				332	"resources": [ # The names of the resources where the message is found.
				333	"A String",
				334	],
				335	"severity": "A String", # Indicates the severity of the message.
				336	},
				337	],
				338	},
				339	],
				340	"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
				341	}</pre>
				342	</div>
				343
				344	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	345	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	346	<pre>Returns the list of all agents in the specified location.
				347
				348	Args:
				349	parent: string, Required. The location to list all agents for. Format: `projects//locations/`. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	350	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	351	pageToken: string, The next_page_token value returned from a previous list request.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	352	x__xgafv: string, V1 error format.
				353	Allowed values
				354	1 - v1 error format
				355	2 - v2 error format
				356
				357	Returns:
				358	An object of the form:
				359
				360	{ # The response message for Agents.ListAgents.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	361	"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
				362	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				363	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	364	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	365	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				366	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				367	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				368	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				369	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	370	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	371	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				372	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				373	},
				374	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	375	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				376	"A String",
				377	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				379	},
				380	],
				381	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				382	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	383	</div>
				384
				385	<div class="method">
				386	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				387	<pre>Retrieves the next page of results.
				388
				389	Args:
				390	previous_request: The request for the previous page. (required)
				391	previous_response: The response from the request for the previous page. (required)
				392
				393	Returns:
				394	A request object that you can call 'execute()' on to request the next
				395	page. Returns None if there are no more items in the collection.
				396	</pre>
				397	</div>
				398
				399	<div class="method">
				400	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	401	<pre>Updates the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	402
				403	Args:
				404	name: string, The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. (required)
				405	body: object, The request body.
				406	The object takes the form of:
				407
				408	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	410	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	411	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				412	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				413	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				414	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				415	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	416	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	417	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				418	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				419	},
				420	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	421	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				422	"A String",
				423	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	424	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				425	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	426
				427	updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				428	x__xgafv: string, V1 error format.
				429	Allowed values
				430	1 - v1 error format
				431	2 - v2 error format
				432
				433	Returns:
				434	An object of the form:
				435
				436	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	437	"avatarUri": "A String", # 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.
yoshi-code-bot	b1eafb3	2021-06-15 00:26:02 -0700	[diff] [blame]	438	"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	439	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				440	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				441	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				442	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				443	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	444	"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				446	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				447	},
				448	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
yoshi-code-bot	44a6719	2021-05-02 03:48:02 -0700	[diff] [blame]	449	"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
				450	"A String",
				451	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	452	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				453	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	454	</div>
				455
				456	<div class="method">
				457	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	458	<pre>Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	459
				460	Args:
				461	name: string, Required. The name of the agent to restore into. Format: `projects//locations//agents/`. (required)
				462	body: object, The request body.
				463	The object takes the form of:
				464
				465	{ # The request message for Agents.RestoreAgent.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	466	"agentContent": "A String", # Uncompressed raw byte content for agent.
				467	"agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	468	"restoreOption": "A String", # Agent restore mode. If not specified, `KEEP` is assumed.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	469	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	470
				471	x__xgafv: string, V1 error format.
				472	Allowed values
				473	1 - v1 error format
				474	2 - v2 error format
				475
				476	Returns:
				477	An object of the form:
				478
				479	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	480	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				481	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				482	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				483	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				484	{
				485	"a_key": "", # Properties of the object. Contains field @type with type URL.
				486	},
				487	],
				488	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				489	},
				490	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				491	"a_key": "", # Properties of the object. Contains field @type with type URL.
				492	},
				493	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				494	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				495	"a_key": "", # Properties of the object. Contains field @type with type URL.
				496	},
				497	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	498	</div>
				499
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	500	<div class="method">
				501	<code class="details" id="validate">validate(name, body=None, x__xgafv=None)</code>
				502	<pre>Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
				503
				504	Args:
				505	name: string, Required. The agent to validate. Format: `projects//locations//agents/`. (required)
				506	body: object, The request body.
				507	The object takes the form of:
				508
				509	{ # The request message for Agents.ValidateAgent.
				510	"languageCode": "A String", # If not specified, the agent's default language is used.
				511	}
				512
				513	x__xgafv: string, V1 error format.
				514	Allowed values
				515	1 - v1 error format
				516	2 - v2 error format
				517
				518	Returns:
				519	An object of the form:
				520
				521	{ # The response message for Agents.GetAgentValidationResult.
				522	"flowValidationResults": [ # Contains all flow validation results.
				523	{ # The response message for Flows.GetFlowValidationResult.
				524	"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
				525	"updateTime": "A String", # Last time the flow was validated.
				526	"validationMessages": [ # Contains all validation messages.
				527	{ # Agent/flow validation message.
				528	"detail": "A String", # The message detail.
				529	"resourceNames": [ # The resource names of the resources where the message is found.
				530	{ # Resource name and display name.
				531	"displayName": "A String", # Display name.
				532	"name": "A String", # Name.
				533	},
				534	],
				535	"resourceType": "A String", # The type of the resources where the message is found.
				536	"resources": [ # The names of the resources where the message is found.
				537	"A String",
				538	],
				539	"severity": "A String", # Indicates the severity of the message.
				540	},
				541	],
				542	},
				543	],
				544	"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
				545	}</pre>
				546	</div>
				547
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	548	</body></html>