1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.generators.html">generators</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a generator in the specified agent.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified generators.</p>
<p class="toc_element">
<code><a href="#get">get(name, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified generator.</p>
<p class="toc_element">
<code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all generators in the specified agent.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the specified generator.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, languageCode=None, x__xgafv=None)</code>
<pre>Creates a generator in the specified agent.
Args:
parent: string, Required. The agent to create a generator for. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
}
languageCode: string, The language to create generators for the following fields: * `Generator.prompt_text.text` If not specified, the agent's default language is used.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>Deletes the specified generators.
Args:
name: string, Required. The name of the generator to delete. Format: `projects//locations//agents//generators/`. (required)
force: boolean, This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. Generator) in fulfillments.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, languageCode=None, x__xgafv=None)</code>
<pre>Retrieves the specified generator.
Args:
name: string, Required. The name of the generator. Format: `projects//locations//agents//generators/`. (required)
languageCode: string, The language to list generators for.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of all generators in the specified agent.
Args:
parent: string, Required. The agent to list all generators for. Format: `projects//locations//agents/`. (required)
languageCode: string, The language to list generators for.
pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Generators.ListGenerators.
"generators": [ # The list of generators. There will be a maximum number of items returned based on the page_size field in the request.
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)</code>
<pre>Update the specified generator.
Args:
name: string, The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. (required)
body: object, The request body.
The object takes the form of:
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
}
languageCode: string, The language to list generators for.
updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
"llmModelSettings": { # Settings for LLM models. # The LLM model settings.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
"maxDecodeSteps": 42, # The maximum number of tokens to generate.
"temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
"topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
"topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
},
"name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
"placeholders": [ # Optional. List of custom placeholders in the prompt text.
{ # Represents a custom placeholder in the prompt text.
"id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
"name": "A String", # Custom placeholder value in the prompt text.
},
],
"promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
}</pre>
</div>
</body></html>
|
