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

blob: c22f6663ab4d9154dfe4cc3b5cd6a2755b4a22bb [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.intents.html">intents</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#create">create(parent, body=None, languageCode=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates an intent in the specified agent.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes the specified intent.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, languageCode=None, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Retrieves the specified intent.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	90	<code><a href="#list">list(parent, pageSize=None, languageCode=None, intentView=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Returns the list of all intents in the specified agent.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	96	<code><a href="#patch">patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<p class="firstline">Updates the specified intent.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="create">create(parent, body=None, languageCode=None, x__xgafv=None)</code>
				106	<pre>Creates an intent in the specified agent.
				107
				108	Args:
				109	parent: string, Required. The agent to create an intent for. Format: `projects//locations//agents/`. (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	114	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				115	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				116	"a_key": "A String",
				117	},
				118	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	"parameters": [ # The collection of parameters associated with the intent.
				120	{ # Represents an intent parameter.
				121	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	122	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	123	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	124	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	125	},
				126	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	127	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				128	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				129	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				130	{ # Represents an example that the agent is trained on to identify the intent.
				131	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				132	"id": "A String", # Output only. The unique identifier of the training phrase.
				133	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				134	{ # Represents a part of a training phrase.
				135	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				136	"text": "A String", # Required. The text for this part.
				137	},
				138	],
				139	},
				140	],
				141	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	142	}
				143
				144	languageCode: string, The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` 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.
				145	x__xgafv: string, V1 error format.
				146	Allowed values
				147	1 - v1 error format
				148	2 - v2 error format
				149
				150	Returns:
				151	An object of the form:
				152
				153	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	154	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				155	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				156	"a_key": "A String",
				157	},
				158	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	"parameters": [ # The collection of parameters associated with the intent.
				160	{ # Represents an intent parameter.
				161	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	162	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	163	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	164	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	165	},
				166	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	167	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				168	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				169	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				170	{ # Represents an example that the agent is trained on to identify the intent.
				171	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				172	"id": "A String", # Output only. The unique identifier of the training phrase.
				173	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				174	{ # Represents a part of a training phrase.
				175	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				176	"text": "A String", # Required. The text for this part.
				177	},
				178	],
				179	},
				180	],
				181	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	182	}</pre>
				183	</div>
				184
				185	<div class="method">
				186	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				187	<pre>Deletes the specified intent.
				188
				189	Args:
				190	name: string, Required. The name of the intent to delete. Format: `projects//locations//agents//intents/`. (required)
				191	x__xgafv: string, V1 error format.
				192	Allowed values
				193	1 - v1 error format
				194	2 - v2 error format
				195
				196	Returns:
				197	An object of the form:
				198
				199	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				200	}</pre>
				201	</div>
				202
				203	<div class="method">
				204	<code class="details" id="get">get(name, languageCode=None, x__xgafv=None)</code>
				205	<pre>Retrieves the specified intent.
				206
				207	Args:
				208	name: string, Required. The name of the intent. Format: `projects//locations//agents//intents/`. (required)
				209	languageCode: string, The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` 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.
				210	x__xgafv: string, V1 error format.
				211	Allowed values
				212	1 - v1 error format
				213	2 - v2 error format
				214
				215	Returns:
				216	An object of the form:
				217
				218	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	219	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				220	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				221	"a_key": "A String",
				222	},
				223	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	224	"parameters": [ # The collection of parameters associated with the intent.
				225	{ # Represents an intent parameter.
				226	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	227	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	228	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	229	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	230	},
				231	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	232	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				233	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				234	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				235	{ # Represents an example that the agent is trained on to identify the intent.
				236	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				237	"id": "A String", # Output only. The unique identifier of the training phrase.
				238	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				239	{ # Represents a part of a training phrase.
				240	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				241	"text": "A String", # Required. The text for this part.
				242	},
				243	],
				244	},
				245	],
				246	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	247	}</pre>
				248	</div>
				249
				250	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	251	<code class="details" id="list">list(parent, pageSize=None, languageCode=None, intentView=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	252	<pre>Returns the list of all intents in the specified agent.
				253
				254	Args:
				255	parent: string, Required. The agent to list all intents for. Format: `projects//locations//agents/`. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	256	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
				257	languageCode: string, The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` 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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	258	intentView: string, The resource view to apply to the returned intent.
				259	Allowed values
				260	INTENT_VIEW_UNSPECIFIED - Not specified. Treated as INTENT_VIEW_FULL.
				261	INTENT_VIEW_PARTIAL - Training phrases field is not populated in the response.
				262	INTENT_VIEW_FULL - All fields are populated.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	263	pageToken: string, The next_page_token value returned from a previous list request.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	264	x__xgafv: string, V1 error format.
				265	Allowed values
				266	1 - v1 error format
				267	2 - v2 error format
				268
				269	Returns:
				270	An object of the form:
				271
				272	{ # The response message for Intents.ListIntents.
				273	"intents": [ # The list of intents. There will be a maximum number of items returned based on the page_size field in the request.
				274	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	275	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				276	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				277	"a_key": "A String",
				278	},
				279	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	280	"parameters": [ # The collection of parameters associated with the intent.
				281	{ # Represents an intent parameter.
				282	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	283	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	284	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	285	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	286	},
				287	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	288	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				289	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				290	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				291	{ # Represents an example that the agent is trained on to identify the intent.
				292	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				293	"id": "A String", # Output only. The unique identifier of the training phrase.
				294	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				295	{ # Represents a part of a training phrase.
				296	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				297	"text": "A String", # Required. The text for this part.
				298	},
				299	],
				300	},
				301	],
				302	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	303	},
				304	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	305	"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]	306	}</pre>
				307	</div>
				308
				309	<div class="method">
				310	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				311	<pre>Retrieves the next page of results.
				312
				313	Args:
				314	previous_request: The request for the previous page. (required)
				315	previous_response: The response from the request for the previous page. (required)
				316
				317	Returns:
				318	A request object that you can call 'execute()' on to request the next
				319	page. Returns None if there are no more items in the collection.
				320	</pre>
				321	</div>
				322
				323	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	324	<code class="details" id="patch">patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	325	<pre>Updates the specified intent.
				326
				327	Args:
				328	name: string, The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. (required)
				329	body: object, The request body.
				330	The object takes the form of:
				331
				332	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	333	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				334	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				335	"a_key": "A String",
				336	},
				337	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	338	"parameters": [ # The collection of parameters associated with the intent.
				339	{ # Represents an intent parameter.
				340	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	341	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	342	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	343	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	344	},
				345	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	346	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				347	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				348	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				349	{ # Represents an example that the agent is trained on to identify the intent.
				350	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				351	"id": "A String", # Output only. The unique identifier of the training phrase.
				352	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				353	{ # Represents a part of a training phrase.
				354	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				355	"text": "A String", # Required. The text for this part.
				356	},
				357	],
				358	},
				359	],
				360	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	361	}
				362
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	363	languageCode: string, The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` 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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	364	updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	365	x__xgafv: string, V1 error format.
				366	Allowed values
				367	1 - v1 error format
				368	2 - v2 error format
				369
				370	Returns:
				371	An object of the form:
				372
				373	{ # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	374	"isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
				375	"labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
				376	"a_key": "A String",
				377	},
				378	"description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	379	"parameters": [ # The collection of parameters associated with the intent.
				380	{ # Represents an intent parameter.
				381	"redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	382	"id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	383	"isList": True or False, # Indicates whether the parameter represents a list of values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	384	"entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	385	},
				386	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	387	"name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
				388	"displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
				389	"trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
				390	{ # Represents an example that the agent is trained on to identify the intent.
				391	"repeatCount": 42, # Indicates how many times this example was added to the intent.
				392	"id": "A String", # Output only. The unique identifier of the training phrase.
				393	"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
				394	{ # Represents a part of a training phrase.
				395	"parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
				396	"text": "A String", # Required. The text for this part.
				397	},
				398	],
				399	},
				400	],
				401	"priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	402	}</pre>
				403	</div>
				404
				405	</body></html>