Blame - docs/dyn/dialogflow_v2.projects.agent.html - platform/external/python/google-api-python-client

blob: 7474bcb3e2c64638c486d61d79d56d19be126607 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v2.projects.agent.entityTypes.html">entityTypes()</a></code>
				79	</p>
				80	<p class="firstline">Returns the entityTypes Resource.</p>
				81
				82	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	83	<code><a href="dialogflow_v2.projects.agent.environments.html">environments()</a></code>
				84	</p>
				85	<p class="firstline">Returns the environments Resource.</p>
				86
				87	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<code><a href="dialogflow_v2.projects.agent.intents.html">intents()</a></code>
				89	</p>
				90	<p class="firstline">Returns the intents Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="dialogflow_v2.projects.agent.sessions.html">sessions()</a></code>
				94	</p>
				95	<p class="firstline">Returns the sessions Resource.</p>
				96
				97	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	98	<code><a href="#close">close()</a></code></p>
				99	<p class="firstline">Close httplib2 connections.</p>
				100	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	101	<code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<p class="firstline">Exports the specified agent to a ZIP file. Operation </p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	104	<code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
				105	<p class="firstline">Retrieves the fulfillment.</p>
				106	<p class="toc_element">
				107	<code><a href="#getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<p class="firstline">Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109	<p class="toc_element">
				110	<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	111	<p class="firstline">Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	112	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	113	<code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<p class="firstline">Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	115	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	116	<code><a href="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	117	<p class="firstline">Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118	<p class="toc_element">
				119	<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
				120	<p class="firstline">Retrieves the next page of results.</p>
				121	<p class="toc_element">
				122	<code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	123	<p class="firstline">Trains the specified agent. Operation </p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	124	<p class="toc_element">
				125	<code><a href="#updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				126	<p class="firstline">Updates the fulfillment.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	<h3>Method Details</h3>
				128	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	129	<code class="details" id="close">close()</code>
				130	<pre>Close httplib2 connections.</pre>
				131	</div>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	133	<div class="method">
				134	<code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
				135	<pre>Exports the specified agent to a ZIP file. Operation
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	136
				137	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	138	parent: string, Required. The project that the agent to export is associated with. Format: `projects/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	139	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	140	The object takes the form of:
				141
				142	{ # The request message for Agents.ExportAgent.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	143	"agentUri": "A String", # Required. 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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	144	}
				145
				146	x__xgafv: string, V1 error format.
				147	Allowed values
				148	1 - v1 error format
				149	2 - v2 error format
				150
				151	Returns:
				152	An object of the form:
				153
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	155	"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.
				156	"a_key": "", # Properties of the object. Contains field @type with type URL.
				157	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	158	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	159	"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`.
				160	"a_key": "", # Properties of the object. Contains field @type with type URL.
				161	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	162	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	163	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	164	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	165	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	166	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	167	},
				168	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	169	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	170	},
				171	"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}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	}</pre>
				173	</div>
				174
				175	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	176	<code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
				177	<pre>Retrieves the fulfillment.
				178
				179	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	name: string, Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	181	x__xgafv: string, V1 error format.
				182	Allowed values
				183	1 - v1 error format
				184	2 - v2 error format
				185
				186	Returns:
				187	An object of the form:
				188
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	189	{ # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	190	"enabled": True or False, # Optional. Whether fulfillment is enabled.
				191	"genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
				192	"requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
				193	"a_key": "A String",
				194	},
				195	"password": "A String", # Optional. The password for HTTP Basic authentication.
				196	"username": "A String", # Optional. The user name for HTTP Basic authentication.
				197	"isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
				198	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
				199	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	200	"features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
				201	{ # Whether fulfillment is enabled for the specific feature.
				202	"type": "A String", # The type of the feature that enabled for fulfillment.
				203	},
				204	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	205	"name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	206	"displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	207	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	208	</div>
				209
				210	<div class="method">
				211	<code class="details" id="getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	212	<pre>Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	213
				214	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	215	parent: string, Required. The project that the agent is associated with. Format: `projects/`. (required)
				216	languageCode: string, Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	217	x__xgafv: string, V1 error format.
				218	Allowed values
				219	1 - v1 error format
				220	2 - v2 error format
				221
				222	Returns:
				223	An object of the form:
				224
				225	{ # Represents the output of agent validation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	"validationErrors": [ # Contains all validation errors.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	227	{ # Represents a single validation error.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	228	"entries": [ # The names of the entries that the error is associated with. Format: - "projects//agent", if the error is associated with the entire agent. - "projects//agent/intents/", if the error is associated with certain intents. - "projects//agent/intents//trainingPhrases/", if the error is associated with certain intent training phrases. - "projects//agent/intents//parameters/", if the error is associated with certain intent parameters. - "projects//agent/entities/", if the error is associated with certain entities.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	229	"A String",
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	230	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	231	"severity": "A String", # The severity of the error.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	232	"errorMessage": "A String", # The detailed error messsage.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	233	},
				234	],
				235	}</pre>
				236	</div>
				237
				238	<div class="method">
				239	<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	240	<pre>Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	241
				242	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	243	parent: string, Required. The project that the agent to import is associated with. Format: `projects/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	244	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	245	The object takes the form of:
				246
				247	{ # The request message for Agents.ImportAgent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	248	"agentContent": "A String", # Zip compressed raw byte content for agent.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	249	"agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	250	}
				251
				252	x__xgafv: string, V1 error format.
				253	Allowed values
				254	1 - v1 error format
				255	2 - v2 error format
				256
				257	Returns:
				258	An object of the form:
				259
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	260	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	261	"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.
				262	"a_key": "", # Properties of the object. Contains field @type with type URL.
				263	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	264	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	265	"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`.
				266	"a_key": "", # Properties of the object. Contains field @type with type URL.
				267	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	268	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	269	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	270	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	271	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	272	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	},
				274	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	275	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	276	},
				277	"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}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	278	}</pre>
				279	</div>
				280
				281	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	282	<code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	283	<pre>Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	284
				285	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	286	parent: string, Required. The project that the agent to restore is associated with. Format: `projects/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	287	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	The object takes the form of:
				289
				290	{ # The request message for Agents.RestoreAgent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	291	"agentContent": "A String", # Zip compressed raw byte content for agent.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	292	"agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	293	}
				294
				295	x__xgafv: string, V1 error format.
				296	Allowed values
				297	1 - v1 error format
				298	2 - v2 error format
				299
				300	Returns:
				301	An object of the form:
				302
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	303	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	304	"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.
				305	"a_key": "", # Properties of the object. Contains field @type with type URL.
				306	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	307	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	308	"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`.
				309	"a_key": "", # Properties of the object. Contains field @type with type URL.
				310	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	311	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	312	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	313	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	314	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	315	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	316	},
				317	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	318	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	319	},
				320	"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}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	321	}</pre>
				322	</div>
				323
				324	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	325	<code class="details" id="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	326	<pre>Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	327
				328	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	329	parent: string, Required. The project to list agents from. Format: `projects/`. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	330	pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	331	pageToken: string, The next_page_token value returned from a previous list request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	332	x__xgafv: string, V1 error format.
				333	Allowed values
				334	1 - v1 error format
				335	2 - v2 error format
				336
				337	Returns:
				338	An object of the form:
				339
				340	{ # The response message for Agents.SearchAgents.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	341	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	342	"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
				343	{ # 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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	344	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	345	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	346	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				347	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
				348	"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.
				349	"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	350	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				351	"A String",
				352	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	353	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	354	"displayName": "A String", # Required. The name of this agent.
				355	"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.
				356	"parent": "A String", # Required. The project of this agent. Format: `projects/`.
				357	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	358	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	359	],
				360	}</pre>
				361	</div>
				362
				363	<div class="method">
				364	<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
				365	<pre>Retrieves the next page of results.
				366
				367	Args:
				368	previous_request: The request for the previous page. (required)
				369	previous_response: The response from the request for the previous page. (required)
				370
				371	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	372	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	373	page. Returns None if there are no more items in the collection.
				374	</pre>
				375	</div>
				376
				377	<div class="method">
				378	<code class="details" id="train">train(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	379	<pre>Trains the specified agent. Operation
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	380
				381	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	382	parent: string, Required. The project that the agent to train is associated with. Format: `projects/`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	383	body: object, The request body.
				384	The object takes the form of:
				385
				386	{ # The request message for Agents.TrainAgent.
				387	}
				388
				389	x__xgafv: string, V1 error format.
				390	Allowed values
				391	1 - v1 error format
				392	2 - v2 error format
				393
				394	Returns:
				395	An object of the form:
				396
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	397	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	398	"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.
				399	"a_key": "", # Properties of the object. Contains field @type with type URL.
				400	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	401	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	402	"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`.
				403	"a_key": "", # Properties of the object. Contains field @type with type URL.
				404	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	405	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	406	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	407	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	408	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	409	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	410	},
				411	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	412	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	413	},
				414	"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}`.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	415	}</pre>
				416	</div>
				417
				418	<div class="method">
				419	<code class="details" id="updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
				420	<pre>Updates the fulfillment.
				421
				422	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	423	name: string, Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	424	body: object, The request body.
				425	The object takes the form of:
				426
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	427	{ # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	428	"enabled": True or False, # Optional. Whether fulfillment is enabled.
				429	"genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
				430	"requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
				431	"a_key": "A String",
				432	},
				433	"password": "A String", # Optional. The password for HTTP Basic authentication.
				434	"username": "A String", # Optional. The user name for HTTP Basic authentication.
				435	"isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
				436	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
				437	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	438	"features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
				439	{ # Whether fulfillment is enabled for the specific feature.
				440	"type": "A String", # The type of the feature that enabled for fulfillment.
				441	},
				442	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	443	"name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	444	"displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	445	}
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	446
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	447	updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	448	x__xgafv: string, V1 error format.
				449	Allowed values
				450	1 - v1 error format
				451	2 - v2 error format
				452
				453	Returns:
				454	An object of the form:
				455
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	456	{ # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	457	"enabled": True or False, # Optional. Whether fulfillment is enabled.
				458	"genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
				459	"requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
				460	"a_key": "A String",
				461	},
				462	"password": "A String", # Optional. The password for HTTP Basic authentication.
				463	"username": "A String", # Optional. The user name for HTTP Basic authentication.
				464	"isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
				465	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
				466	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	467	"features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
				468	{ # Whether fulfillment is enabled for the specific feature.
				469	"type": "A String", # The type of the feature that enabled for fulfillment.
				470	},
				471	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	472	"name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	473	"displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	474	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	475	</div>
				476
				477	</body></html>