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

blob: 72a0c9e3f9a9c101ab4b029093b42fb231763d82 [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>
				117	<p class="firstline">Creates an agent in the specified location.</p>
				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>
				138	<p class="firstline">Updates the specified agent.</p>
				139	<p class="toc_element">
				140	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -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.</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>
				153	<pre>Creates an agent in the specified location.
				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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	162	"defaultLanguageCode": "A String", # 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/`.
				173	"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.
				174	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	175
				176	x__xgafv: string, V1 error format.
				177	Allowed values
				178	1 - v1 error format
				179	2 - v2 error format
				180
				181	Returns:
				182	An object of the form:
				183
				184	{ # 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]	185	"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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	186	"defaultLanguageCode": "A String", # 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]	187	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				188	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				189	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				190	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				191	"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^]	192	"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]	193	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				194	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				195	},
				196	"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/`.
				197	"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.
				198	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	</div>
				200
				201	<div class="method">
				202	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				203	<pre>Deletes the specified agent.
				204
				205	Args:
				206	name: string, Required. The name of the agent to delete. Format: `projects//locations//agents/`. (required)
				207	x__xgafv: string, V1 error format.
				208	Allowed values
				209	1 - v1 error format
				210	2 - v2 error format
				211
				212	Returns:
				213	An object of the form:
				214
				215	{ # 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]	216	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	217	</div>
				218
				219	<div class="method">
				220	<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]	221	<pre>Exports the specified agent to a binary file.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	222
				223	Args:
				224	name: string, Required. The name of the agent to export. Format: `projects//locations//agents/`. (required)
				225	body: object, The request body.
				226	The object takes the form of:
				227
				228	{ # The request message for Agents.ExportAgent.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	229	"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.
				230	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	231
				232	x__xgafv: string, V1 error format.
				233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
				236
				237	Returns:
				238	An object of the form:
				239
				240	{ # 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]	241	"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.
				242	"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.
				243	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				244	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				245	{
				246	"a_key": "", # Properties of the object. Contains field @type with type URL.
				247	},
				248	],
				249	"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.
				250	},
				251	"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.
				252	"a_key": "", # Properties of the object. Contains field @type with type URL.
				253	},
				254	"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}`.
				255	"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`.
				256	"a_key": "", # Properties of the object. Contains field @type with type URL.
				257	},
				258	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	259	</div>
				260
				261	<div class="method">
				262	<code class="details" id="get">get(name, x__xgafv=None)</code>
				263	<pre>Retrieves the specified agent.
				264
				265	Args:
				266	name: string, Required. The name of the agent. Format: `projects//locations//agents/`. (required)
				267	x__xgafv: string, V1 error format.
				268	Allowed values
				269	1 - v1 error format
				270	2 - v2 error format
				271
				272	Returns:
				273	An object of the form:
				274
				275	{ # 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]	276	"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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	277	"defaultLanguageCode": "A String", # 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]	278	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				279	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				280	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				281	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				282	"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^]	283	"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]	284	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				285	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				286	},
				287	"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/`.
				288	"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.
				289	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	290	</div>
				291
				292	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	293	<code class="details" id="getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</code>
				294	<pre>Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
				295
				296	Args:
				297	name: string, Required. The agent name. Format: `projects//locations//agents//validationResult`. (required)
				298	languageCode: string, If not specified, the agent's default language is used.
				299	x__xgafv: string, V1 error format.
				300	Allowed values
				301	1 - v1 error format
				302	2 - v2 error format
				303
				304	Returns:
				305	An object of the form:
				306
				307	{ # The response message for Agents.GetAgentValidationResult.
				308	"flowValidationResults": [ # Contains all flow validation results.
				309	{ # The response message for Flows.GetFlowValidationResult.
				310	"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
				311	"updateTime": "A String", # Last time the flow was validated.
				312	"validationMessages": [ # Contains all validation messages.
				313	{ # Agent/flow validation message.
				314	"detail": "A String", # The message detail.
				315	"resourceNames": [ # The resource names of the resources where the message is found.
				316	{ # Resource name and display name.
				317	"displayName": "A String", # Display name.
				318	"name": "A String", # Name.
				319	},
				320	],
				321	"resourceType": "A String", # The type of the resources where the message is found.
				322	"resources": [ # The names of the resources where the message is found.
				323	"A String",
				324	],
				325	"severity": "A String", # Indicates the severity of the message.
				326	},
				327	],
				328	},
				329	],
				330	"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
				331	}</pre>
				332	</div>
				333
				334	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	335	<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]	336	<pre>Returns the list of all agents in the specified location.
				337
				338	Args:
				339	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]	340	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]	341	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]	342	x__xgafv: string, V1 error format.
				343	Allowed values
				344	1 - v1 error format
				345	2 - v2 error format
				346
				347	Returns:
				348	An object of the form:
				349
				350	{ # The response message for Agents.ListAgents.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	351	"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
				352	{ # 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..
				353	"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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	354	"defaultLanguageCode": "A String", # 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]	355	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				356	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				357	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				358	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				359	"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^]	360	"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]	361	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				362	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				363	},
				364	"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/`.
				365	"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.
				366	},
				367	],
				368	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				369	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	370	</div>
				371
				372	<div class="method">
				373	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				374	<pre>Retrieves the next page of results.
				375
				376	Args:
				377	previous_request: The request for the previous page. (required)
				378	previous_response: The response from the request for the previous page. (required)
				379
				380	Returns:
				381	A request object that you can call 'execute()' on to request the next
				382	page. Returns None if there are no more items in the collection.
				383	</pre>
				384	</div>
				385
				386	<div class="method">
				387	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				388	<pre>Updates the specified agent.
				389
				390	Args:
				391	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)
				392	body: object, The request body.
				393	The object takes the form of:
				394
				395	{ # 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]	396	"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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	397	"defaultLanguageCode": "A String", # 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]	398	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				399	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				400	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				401	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				402	"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^]	403	"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]	404	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				405	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				406	},
				407	"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/`.
				408	"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.
				409	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	410
				411	updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				412	x__xgafv: string, V1 error format.
				413	Allowed values
				414	1 - v1 error format
				415	2 - v2 error format
				416
				417	Returns:
				418	An object of the form:
				419
				420	{ # 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]	421	"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	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	422	"defaultLanguageCode": "A String", # 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]	423	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				424	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				425	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				426	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				427	"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^]	428	"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]	429	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				430	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				431	},
				432	"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/`.
				433	"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.
				434	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	435	</div>
				436
				437	<div class="method">
				438	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	439	<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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	440
				441	Args:
				442	name: string, Required. The name of the agent to restore into. Format: `projects//locations//agents/`. (required)
				443	body: object, The request body.
				444	The object takes the form of:
				445
				446	{ # The request message for Agents.RestoreAgent.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	447	"agentContent": "A String", # Uncompressed raw byte content for agent.
				448	"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:///`.
				449	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	450
				451	x__xgafv: string, V1 error format.
				452	Allowed values
				453	1 - v1 error format
				454	2 - v2 error format
				455
				456	Returns:
				457	An object of the form:
				458
				459	{ # 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]	460	"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.
				461	"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.
				462	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				463	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				464	{
				465	"a_key": "", # Properties of the object. Contains field @type with type URL.
				466	},
				467	],
				468	"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.
				469	},
				470	"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.
				471	"a_key": "", # Properties of the object. Contains field @type with type URL.
				472	},
				473	"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}`.
				474	"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`.
				475	"a_key": "", # Properties of the object. Contains field @type with type URL.
				476	},
				477	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	478	</div>
				479
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	480	<div class="method">
				481	<code class="details" id="validate">validate(name, body=None, x__xgafv=None)</code>
				482	<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.
				483
				484	Args:
				485	name: string, Required. The agent to validate. Format: `projects//locations//agents/`. (required)
				486	body: object, The request body.
				487	The object takes the form of:
				488
				489	{ # The request message for Agents.ValidateAgent.
				490	"languageCode": "A String", # If not specified, the agent's default language is used.
				491	}
				492
				493	x__xgafv: string, V1 error format.
				494	Allowed values
				495	1 - v1 error format
				496	2 - v2 error format
				497
				498	Returns:
				499	An object of the form:
				500
				501	{ # The response message for Agents.GetAgentValidationResult.
				502	"flowValidationResults": [ # Contains all flow validation results.
				503	{ # The response message for Flows.GetFlowValidationResult.
				504	"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
				505	"updateTime": "A String", # Last time the flow was validated.
				506	"validationMessages": [ # Contains all validation messages.
				507	{ # Agent/flow validation message.
				508	"detail": "A String", # The message detail.
				509	"resourceNames": [ # The resource names of the resources where the message is found.
				510	{ # Resource name and display name.
				511	"displayName": "A String", # Display name.
				512	"name": "A String", # Name.
				513	},
				514	],
				515	"resourceType": "A String", # The type of the resources where the message is found.
				516	"resources": [ # The names of the resources where the message is found.
				517	"A String",
				518	],
				519	"severity": "A String", # Indicates the severity of the message.
				520	},
				521	],
				522	},
				523	],
				524	"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
				525	}</pre>
				526	</div>
				527
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	528	</body></html>