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

blob: 7bb04102408d1a6718fa8f471fef3cd64197e1ac [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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v2beta1.projects.agent.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_v2beta1.projects.agent.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_v2beta1.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_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases()</a></code>
				94	</p>
				95	<p class="firstline">Returns the knowledgeBases Resource.</p>
				96
				97	<p class="toc_element">
				98	<code><a href="dialogflow_v2beta1.projects.agent.sessions.html">sessions()</a></code>
				99	</p>
				100	<p class="firstline">Returns the sessions Resource.</p>
				101
				102	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code><a href="#close">close()</a></code></p>
				104	<p class="firstline">Close httplib2 connections.</p>
				105	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	106	<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]	107	<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]	108	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109	<code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
				110	<p class="firstline">Retrieves the fulfillment.</p>
				111	<p class="toc_element">
				112	<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]	113	<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]	114	<p class="toc_element">
				115	<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]	116	<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]	117	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	<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]	119	<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]	120	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	121	<code><a href="#search">search(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	<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]	123	<p class="toc_element">
				124	<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
				125	<p class="firstline">Retrieves the next page of results.</p>
				126	<p class="toc_element">
				127	<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]	128	<p class="firstline">Trains the specified agent. Operation </p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	129	<p class="toc_element">
				130	<code><a href="#updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				131	<p class="firstline">Updates the fulfillment.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132	<h3>Method Details</h3>
				133	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	134	<code class="details" id="close">close()</code>
				135	<pre>Close httplib2 connections.</pre>
				136	</div>
				137
				138	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	139	<code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	140	<pre>Exports the specified agent to a ZIP file. Operation
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	141
				142	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	143	parent: string, Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	144	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	145	The object takes the form of:
				146
				147	{ # The request message for Agents.ExportAgent.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	149	}
				150
				151	x__xgafv: string, V1 error format.
				152	Allowed values
				153	1 - v1 error format
				154	2 - v2 error format
				155
				156	Returns:
				157	An object of the form:
				158
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	160	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	161	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	162	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	163	{
				164	"a_key": "", # Properties of the object. Contains field @type with type URL.
				165	},
				166	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	167	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				168	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	169	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	170	"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.
				171	"a_key": "", # Properties of the object. Contains field @type with type URL.
				172	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	173	"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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	174	"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`.
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	177	}</pre>
				178	</div>
				179
				180	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	181	<code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
				182	<pre>Retrieves the fulfillment.
				183
				184	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	name: string, Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	186	x__xgafv: string, V1 error format.
				187	Allowed values
				188	1 - v1 error format
				189	2 - v2 error format
				190
				191	Returns:
				192	An object of the form:
				193
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	{ # 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]	195	"displayName": "A String", # The human-readable name of the fulfillment, unique within the agent.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	196	"enabled": True or False, # Whether fulfillment is enabled.
				197	"name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	198	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	199	"requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
				200	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	201	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	202	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	203	"isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	204	"username": "A String", # The user name for HTTP Basic authentication.
				205	"password": "A String", # The password for HTTP Basic authentication.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	206	},
				207	"features": [ # The field defines whether the fulfillment is enabled for certain features.
				208	{ # Whether fulfillment is enabled for the specific feature.
				209	"type": "A String", # The type of the feature that enabled for fulfillment.
				210	},
				211	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	212	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	213	</div>
				214
				215	<div class="method">
				216	<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]	217	<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]	218
				219	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	220	parent: string, Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`. (required)
				221	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]	222	x__xgafv: string, V1 error format.
				223	Allowed values
				224	1 - v1 error format
				225	2 - v2 error format
				226
				227	Returns:
				228	An object of the form:
				229
				230	{ # Represents the output of agent validation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	231	"validationErrors": [ # Contains all validation errors.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	232	{ # Represents a single validation error.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	"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]	234	"A String",
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	235	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	236	"errorMessage": "A String", # The detailed error messsage.
				237	"severity": "A String", # The severity of the error.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	238	},
				239	],
				240	}</pre>
				241	</div>
				242
				243	<div class="method">
				244	<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]	245	<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]	246
				247	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	248	parent: string, Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	249	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	250	The object takes the form of:
				251
				252	{ # The request message for Agents.ImportAgent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	253	"agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	254	"agentContent": "A String", # Zip compressed raw byte content for agent.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	255	}
				256
				257	x__xgafv: string, V1 error format.
				258	Allowed values
				259	1 - v1 error format
				260	2 - v2 error format
				261
				262	Returns:
				263	An object of the form:
				264
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	266	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	267	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	268	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	269	{
				270	"a_key": "", # Properties of the object. Contains field @type with type URL.
				271	},
				272	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	273	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				274	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	275	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	276	"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.
				277	"a_key": "", # Properties of the object. Contains field @type with type URL.
				278	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	279	"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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	280	"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`.
				281	"a_key": "", # Properties of the object. Contains field @type with type URL.
				282	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	283	}</pre>
				284	</div>
				285
				286	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	287	<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]	288	<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]	289
				290	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	291	parent: string, Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	292	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	293	The object takes the form of:
				294
				295	{ # The request message for Agents.RestoreAgent.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	296	"agentContent": "A String", # Zip compressed raw byte content for agent.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	297	"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]	298	}
				299
				300	x__xgafv: string, V1 error format.
				301	Allowed values
				302	1 - v1 error format
				303	2 - v2 error format
				304
				305	Returns:
				306	An object of the form:
				307
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	308	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	309	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	310	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	311	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	312	{
				313	"a_key": "", # Properties of the object. Contains field @type with type URL.
				314	},
				315	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	316	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				317	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	318	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	319	"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.
				320	"a_key": "", # Properties of the object. Contains field @type with type URL.
				321	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	322	"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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	323	"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`.
				324	"a_key": "", # Properties of the object. Contains field @type with type URL.
				325	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	326	}</pre>
				327	</div>
				328
				329	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	330	<code class="details" id="search">search(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	331	<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]	332
				333	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	334	parent: string, Required. The project to list agents from. Format: `projects/` or `projects//locations/`. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	335	pageToken: string, Optional. The next_page_token value returned from a previous list request.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	336	pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	337	x__xgafv: string, V1 error format.
				338	Allowed values
				339	1 - v1 error format
				340	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	341
				342	Returns:
				343	An object of the form:
				344
				345	{ # The response message for Agents.SearchAgents.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	346	"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
				347	{ # 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]	348	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	349	"displayName": "A String", # Required. The name of this agent.
				350	"description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				351	"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.
				352	"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]	353	"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
				354	"A String",
				355	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	356	"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.
				357	"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.
				358	"parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	359	"matchMode": "A String", # Optional. Determines how intents are detected from user queries.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	360	"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.
				361	"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	362	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	363	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	364	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	365	}</pre>
				366	</div>
				367
				368	<div class="method">
				369	<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
				370	<pre>Retrieves the next page of results.
				371
				372	Args:
				373	previous_request: The request for the previous page. (required)
				374	previous_response: The response from the request for the previous page. (required)
				375
				376	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	377	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]	378	page. Returns None if there are no more items in the collection.
				379	</pre>
				380	</div>
				381
				382	<div class="method">
				383	<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]	384	<pre>Trains the specified agent. Operation
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	385
				386	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	387	parent: string, Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	388	body: object, The request body.
				389	The object takes the form of:
				390
				391	{ # The request message for Agents.TrainAgent.
				392	}
				393
				394	x__xgafv: string, V1 error format.
				395	Allowed values
				396	1 - v1 error format
				397	2 - v2 error format
				398
				399	Returns:
				400	An object of the form:
				401
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	402	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	403	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	404	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	405	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	406	{
				407	"a_key": "", # Properties of the object. Contains field @type with type URL.
				408	},
				409	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	410	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				411	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	412	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	413	"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.
				414	"a_key": "", # Properties of the object. Contains field @type with type URL.
				415	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	416	"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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	417	"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`.
				418	"a_key": "", # Properties of the object. Contains field @type with type URL.
				419	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	420	}</pre>
				421	</div>
				422
				423	<div class="method">
				424	<code class="details" id="updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
				425	<pre>Updates the fulfillment.
				426
				427	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	428	name: string, Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	429	body: object, The request body.
				430	The object takes the form of:
				431
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	432	{ # 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]	433	"displayName": "A String", # The human-readable name of the fulfillment, unique within the agent.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	434	"enabled": True or False, # Whether fulfillment is enabled.
				435	"name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	436	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	437	"requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
				438	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	439	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	440	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	441	"isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	442	"username": "A String", # The user name for HTTP Basic authentication.
				443	"password": "A String", # The password for HTTP Basic authentication.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	444	},
				445	"features": [ # The field defines whether the fulfillment is enabled for certain features.
				446	{ # Whether fulfillment is enabled for the specific feature.
				447	"type": "A String", # The type of the feature that enabled for fulfillment.
				448	},
				449	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	450	}
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	451
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	452	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]	453	x__xgafv: string, V1 error format.
				454	Allowed values
				455	1 - v1 error format
				456	2 - v2 error format
				457
				458	Returns:
				459	An object of the form:
				460
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	461	{ # 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]	462	"displayName": "A String", # The human-readable name of the fulfillment, unique within the agent.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	463	"enabled": True or False, # Whether fulfillment is enabled.
				464	"name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	465	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	466	"requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
				467	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	468	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	469	"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	470	"isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	471	"username": "A String", # The user name for HTTP Basic authentication.
				472	"password": "A String", # The password for HTTP Basic authentication.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	473	},
				474	"features": [ # The field defines whether the fulfillment is enabled for certain features.
				475	{ # Whether fulfillment is enabled for the specific feature.
				476	"type": "A String", # The type of the feature that enabled for fulfillment.
				477	},
				478	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	479	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	480	</div>
				481
				482	</body></html>