@maxim_mazurok/gapi.client.ces-v1 0.0.20260204
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +4174 -0
- package/package.json +20 -0
- package/readme.md +77 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,4174 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Gemini Enterprise for Customer Experience API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
|
|
8
|
+
// IMPORTANT
|
|
9
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
|
+
// Generated from: https://ces.googleapis.com/$discovery/rest?version=v1
|
|
12
|
+
// Revision: 20260204
|
|
13
|
+
|
|
14
|
+
/// <reference types="gapi.client" />
|
|
15
|
+
|
|
16
|
+
declare namespace gapi.client {
|
|
17
|
+
/** Load Gemini Enterprise for Customer Experience API v1 */
|
|
18
|
+
function load(
|
|
19
|
+
urlOrObject: 'https://ces.googleapis.com/$discovery/rest?version=v1',
|
|
20
|
+
): Promise<void>;
|
|
21
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
22
|
+
function load(name: 'ces', version: 'v1'): Promise<void>;
|
|
23
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
24
|
+
function load(name: 'ces', version: 'v1', callback: () => any): void;
|
|
25
|
+
|
|
26
|
+
namespace ces {
|
|
27
|
+
interface Action {
|
|
28
|
+
/** ID of a Connection action for the tool to use. */
|
|
29
|
+
connectionActionId?: string;
|
|
30
|
+
/** Entity operation configuration for the tool to use. */
|
|
31
|
+
entityOperation?: ActionEntityOperation;
|
|
32
|
+
/** Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used. */
|
|
33
|
+
inputFields?: string[];
|
|
34
|
+
/** Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned. */
|
|
35
|
+
outputFields?: string[];
|
|
36
|
+
}
|
|
37
|
+
interface ActionEntityOperation {
|
|
38
|
+
/** Required. ID of the entity. */
|
|
39
|
+
entityId?: string;
|
|
40
|
+
/** Required. Operation to perform on the entity. */
|
|
41
|
+
operation?: string;
|
|
42
|
+
}
|
|
43
|
+
interface Agent {
|
|
44
|
+
/** Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
45
|
+
afterAgentCallbacks?: Callback[];
|
|
46
|
+
/** Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
47
|
+
afterModelCallbacks?: Callback[];
|
|
48
|
+
/** Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
49
|
+
afterToolCallbacks?: Callback[];
|
|
50
|
+
/** Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
51
|
+
beforeAgentCallbacks?: Callback[];
|
|
52
|
+
/** Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
53
|
+
beforeModelCallbacks?: Callback[];
|
|
54
|
+
/** Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. */
|
|
55
|
+
beforeToolCallbacks?: Callback[];
|
|
56
|
+
/** Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
57
|
+
childAgents?: string[];
|
|
58
|
+
/** Output only. Timestamp when the agent was created. */
|
|
59
|
+
createTime?: string;
|
|
60
|
+
/** Optional. Human-readable description of the agent. */
|
|
61
|
+
description?: string;
|
|
62
|
+
/** Required. Display name of the agent. */
|
|
63
|
+
displayName?: string;
|
|
64
|
+
/** Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
65
|
+
etag?: string;
|
|
66
|
+
/** Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation. */
|
|
67
|
+
generatedSummary?: string;
|
|
68
|
+
/** Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` */
|
|
69
|
+
guardrails?: string[];
|
|
70
|
+
/** Optional. Instructions for the LLM model to guide the agent's behavior. */
|
|
71
|
+
instruction?: string;
|
|
72
|
+
/** Optional. The default agent type. */
|
|
73
|
+
llmAgent?: any;
|
|
74
|
+
/** Optional. Configurations for the LLM model. */
|
|
75
|
+
modelSettings?: ModelSettings;
|
|
76
|
+
/** Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
77
|
+
name?: string;
|
|
78
|
+
/** Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
79
|
+
remoteDialogflowAgent?: AgentRemoteDialogflowAgent;
|
|
80
|
+
/** Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` */
|
|
81
|
+
tools?: string[];
|
|
82
|
+
/** Optional. List of toolsets for the agent. */
|
|
83
|
+
toolsets?: AgentAgentToolset[];
|
|
84
|
+
/** Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used. */
|
|
85
|
+
transferRules?: TransferRule[];
|
|
86
|
+
/** Output only. Timestamp when the agent was last updated. */
|
|
87
|
+
updateTime?: string;
|
|
88
|
+
}
|
|
89
|
+
interface AgentAgentToolset {
|
|
90
|
+
/** Optional. The tools IDs to filter the toolset. */
|
|
91
|
+
toolIds?: string[];
|
|
92
|
+
/** Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
93
|
+
toolset?: string;
|
|
94
|
+
}
|
|
95
|
+
interface AgentLlmAgent {}
|
|
96
|
+
interface AgentRemoteDialogflowAgent {
|
|
97
|
+
/** Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` */
|
|
98
|
+
agent?: string;
|
|
99
|
+
/** Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. */
|
|
100
|
+
environmentId?: string;
|
|
101
|
+
/** Optional. The flow ID of the flow in the Dialogflow agent. */
|
|
102
|
+
flowId?: string;
|
|
103
|
+
/** Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. */
|
|
104
|
+
inputVariableMapping?: {[P in string]: string};
|
|
105
|
+
/** Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. */
|
|
106
|
+
outputVariableMapping?: {[P in string]: string};
|
|
107
|
+
/** Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings. */
|
|
108
|
+
respectResponseInterruptionSettings?: boolean;
|
|
109
|
+
}
|
|
110
|
+
interface AgentTransfer {
|
|
111
|
+
/** Output only. Display name of the agent. */
|
|
112
|
+
displayName?: string;
|
|
113
|
+
/** Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
114
|
+
targetAgent?: string;
|
|
115
|
+
}
|
|
116
|
+
interface AmbientSoundConfig {
|
|
117
|
+
/** Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object. */
|
|
118
|
+
gcsUri?: string;
|
|
119
|
+
/** Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`. */
|
|
120
|
+
prebuiltAmbientNoise?: string;
|
|
121
|
+
/** Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" */
|
|
122
|
+
prebuiltAmbientSound?: string;
|
|
123
|
+
/** Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */
|
|
124
|
+
volumeGainDb?: number;
|
|
125
|
+
}
|
|
126
|
+
interface ApiAuthentication {
|
|
127
|
+
/** Optional. Config for API key auth. */
|
|
128
|
+
apiKeyConfig?: ApiKeyConfig;
|
|
129
|
+
/** Optional. Config for bearer token auth. */
|
|
130
|
+
bearerTokenConfig?: BearerTokenConfig;
|
|
131
|
+
/** Optional. Config for OAuth. */
|
|
132
|
+
oauthConfig?: OAuthConfig;
|
|
133
|
+
/** Optional. Config for service account authentication. */
|
|
134
|
+
serviceAccountAuthConfig?: ServiceAccountAuthConfig;
|
|
135
|
+
/** Optional. Config for ID token auth generated from CES service agent. */
|
|
136
|
+
serviceAgentIdTokenAuthConfig?: any;
|
|
137
|
+
}
|
|
138
|
+
interface ApiKeyConfig {
|
|
139
|
+
/** Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
140
|
+
apiKeySecretVersion?: string;
|
|
141
|
+
/** Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. */
|
|
142
|
+
keyName?: string;
|
|
143
|
+
/** Required. Key location in the request. */
|
|
144
|
+
requestLocation?: string;
|
|
145
|
+
}
|
|
146
|
+
interface App {
|
|
147
|
+
/** Optional. Audio processing configuration of the app. */
|
|
148
|
+
audioProcessingConfig?: AudioProcessingConfig;
|
|
149
|
+
/** Optional. The default client certificate settings for the app. */
|
|
150
|
+
clientCertificateSettings?: ClientCertificateSettings;
|
|
151
|
+
/** Output only. Timestamp when the app was created. */
|
|
152
|
+
createTime?: string;
|
|
153
|
+
/** Optional. The data store settings for the app. */
|
|
154
|
+
dataStoreSettings?: DataStoreSettings;
|
|
155
|
+
/** Optional. The default channel profile used by the app. */
|
|
156
|
+
defaultChannelProfile?: ChannelProfile;
|
|
157
|
+
/** Output only. Number of deployments in the app. */
|
|
158
|
+
deploymentCount?: number;
|
|
159
|
+
/** Optional. Human-readable description of the app. */
|
|
160
|
+
description?: string;
|
|
161
|
+
/** Required. Display name of the app. */
|
|
162
|
+
displayName?: string;
|
|
163
|
+
/** Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
164
|
+
etag?: string;
|
|
165
|
+
/** Optional. The evaluation thresholds for the app. */
|
|
166
|
+
evaluationMetricsThresholds?: EvaluationMetricsThresholds;
|
|
167
|
+
/** Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents. */
|
|
168
|
+
globalInstruction?: string;
|
|
169
|
+
/** Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` */
|
|
170
|
+
guardrails?: string[];
|
|
171
|
+
/** Optional. Language settings of the app. */
|
|
172
|
+
languageSettings?: LanguageSettings;
|
|
173
|
+
/** Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. */
|
|
174
|
+
locked?: boolean;
|
|
175
|
+
/** Optional. Logging settings of the app. */
|
|
176
|
+
loggingSettings?: LoggingSettings;
|
|
177
|
+
/** Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. */
|
|
178
|
+
metadata?: {[P in string]: string};
|
|
179
|
+
/** Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed. */
|
|
180
|
+
modelSettings?: ModelSettings;
|
|
181
|
+
/** Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
182
|
+
name?: string;
|
|
183
|
+
/** Optional. Whether the app is pinned in the app list. */
|
|
184
|
+
pinned?: boolean;
|
|
185
|
+
/** Output only. The declarations of predefined variables for the app. */
|
|
186
|
+
predefinedVariableDeclarations?: AppVariableDeclaration[];
|
|
187
|
+
/** Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
188
|
+
rootAgent?: string;
|
|
189
|
+
/** Optional. TimeZone settings of the app. */
|
|
190
|
+
timeZoneSettings?: TimeZoneSettings;
|
|
191
|
+
/** Optional. The tool execution mode for the app. If not provided, will default to PARALLEL. */
|
|
192
|
+
toolExecutionMode?: string;
|
|
193
|
+
/** Output only. Timestamp when the app was last updated. */
|
|
194
|
+
updateTime?: string;
|
|
195
|
+
/** Optional. The declarations of the variables. */
|
|
196
|
+
variableDeclarations?: AppVariableDeclaration[];
|
|
197
|
+
}
|
|
198
|
+
interface AppSnapshot {
|
|
199
|
+
/** Optional. List of agents in the app. */
|
|
200
|
+
agents?: Agent[];
|
|
201
|
+
/** Optional. The basic settings for the app. */
|
|
202
|
+
app?: App;
|
|
203
|
+
/** Optional. List of examples in the app. */
|
|
204
|
+
examples?: Example[];
|
|
205
|
+
/** Optional. List of guardrails in the app. */
|
|
206
|
+
guardrails?: Guardrail[];
|
|
207
|
+
/** Optional. List of tools in the app. */
|
|
208
|
+
tools?: Tool[];
|
|
209
|
+
/** Optional. List of toolsets in the app. */
|
|
210
|
+
toolsets?: Toolset[];
|
|
211
|
+
}
|
|
212
|
+
interface AppVariableDeclaration {
|
|
213
|
+
/** Required. The description of the variable. */
|
|
214
|
+
description?: string;
|
|
215
|
+
/** Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores. */
|
|
216
|
+
name?: string;
|
|
217
|
+
/** Required. The schema of the variable. */
|
|
218
|
+
schema?: Schema;
|
|
219
|
+
}
|
|
220
|
+
interface AppVersion {
|
|
221
|
+
/** Output only. Timestamp when the app version was created. */
|
|
222
|
+
createTime?: string;
|
|
223
|
+
/** Output only. Email of the user who created the app version. */
|
|
224
|
+
creator?: string;
|
|
225
|
+
/** Optional. The description of the app version. */
|
|
226
|
+
description?: string;
|
|
227
|
+
/** Optional. The display name of the app version. */
|
|
228
|
+
displayName?: string;
|
|
229
|
+
/** Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
230
|
+
etag?: string;
|
|
231
|
+
/** Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` */
|
|
232
|
+
name?: string;
|
|
233
|
+
/** Output only. The snapshot of the app when the version is created. */
|
|
234
|
+
snapshot?: AppSnapshot;
|
|
235
|
+
}
|
|
236
|
+
interface AudioProcessingConfig {
|
|
237
|
+
/** Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. */
|
|
238
|
+
ambientSoundConfig?: AmbientSoundConfig;
|
|
239
|
+
/** Optional. Configures the agent behavior for the user barge-in activities. */
|
|
240
|
+
bargeInConfig?: BargeInConfig;
|
|
241
|
+
/** Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. */
|
|
242
|
+
inactivityTimeout?: string;
|
|
243
|
+
/** Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. */
|
|
244
|
+
synthesizeSpeechConfigs?: {[P in string]: SynthesizeSpeechConfig};
|
|
245
|
+
}
|
|
246
|
+
interface AudioRecordingConfig {
|
|
247
|
+
/** Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
248
|
+
gcsBucket?: string;
|
|
249
|
+
/** Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. */
|
|
250
|
+
gcsPathPrefix?: string;
|
|
251
|
+
}
|
|
252
|
+
interface BargeInConfig {
|
|
253
|
+
/** Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. */
|
|
254
|
+
bargeInAwareness?: boolean;
|
|
255
|
+
/** Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. */
|
|
256
|
+
disableBargeIn?: boolean;
|
|
257
|
+
}
|
|
258
|
+
interface BatchDeleteConversationsRequest {
|
|
259
|
+
/** Required. The resource names of the conversations to delete. */
|
|
260
|
+
conversations?: string[];
|
|
261
|
+
}
|
|
262
|
+
interface BearerTokenConfig {
|
|
263
|
+
/** Required. The bearer token. Must be in the format `$context.variables.`. */
|
|
264
|
+
token?: string;
|
|
265
|
+
}
|
|
266
|
+
interface BigQueryExportSettings {
|
|
267
|
+
/** Optional. The BigQuery dataset to export the data to. */
|
|
268
|
+
dataset?: string;
|
|
269
|
+
/** Optional. Indicates whether the BigQuery export is enabled. */
|
|
270
|
+
enabled?: boolean;
|
|
271
|
+
/** Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
272
|
+
project?: string;
|
|
273
|
+
}
|
|
274
|
+
interface Blob {
|
|
275
|
+
/** Required. Raw bytes of the blob. */
|
|
276
|
+
data?: string;
|
|
277
|
+
/** Required. The IANA standard MIME type of the source data. */
|
|
278
|
+
mimeType?: string;
|
|
279
|
+
}
|
|
280
|
+
interface Callback {
|
|
281
|
+
/** Optional. Human-readable description of the callback. */
|
|
282
|
+
description?: string;
|
|
283
|
+
/** Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent. */
|
|
284
|
+
disabled?: boolean;
|
|
285
|
+
/** Required. The python code to execute for the callback. */
|
|
286
|
+
pythonCode?: string;
|
|
287
|
+
}
|
|
288
|
+
interface CancelOperationRequest {}
|
|
289
|
+
interface Changelog {
|
|
290
|
+
/** Output only. The action that was performed on the resource. */
|
|
291
|
+
action?: string;
|
|
292
|
+
/** Output only. Email address of the change author. */
|
|
293
|
+
author?: string;
|
|
294
|
+
/** Output only. The time when the change was made. */
|
|
295
|
+
createTime?: string;
|
|
296
|
+
/** Output only. The dependent resources that were changed. */
|
|
297
|
+
dependentResources?: Array<{[P in string]: any}>;
|
|
298
|
+
/** Output only. Description of the change. which typically captures the changed fields in the resource. */
|
|
299
|
+
description?: string;
|
|
300
|
+
/** Output only. Display name of the change. It typically should be the display name of the resource that was changed. */
|
|
301
|
+
displayName?: string;
|
|
302
|
+
/** Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}` */
|
|
303
|
+
name?: string;
|
|
304
|
+
/** Output only. The new resource after the change. */
|
|
305
|
+
newResource?: {[P in string]: any};
|
|
306
|
+
/** Output only. The original resource before the change. */
|
|
307
|
+
originalResource?: {[P in string]: any};
|
|
308
|
+
/** Output only. The resource that was changed. */
|
|
309
|
+
resource?: string;
|
|
310
|
+
/** Output only. The type of the resource that was changed. */
|
|
311
|
+
resourceType?: string;
|
|
312
|
+
/** Output only. The monotonically increasing sequence number of the changelog. */
|
|
313
|
+
sequenceNumber?: string;
|
|
314
|
+
}
|
|
315
|
+
interface ChannelProfile {
|
|
316
|
+
/** Optional. The type of the channel profile. */
|
|
317
|
+
channelType?: string;
|
|
318
|
+
/** Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. */
|
|
319
|
+
disableBargeInControl?: boolean;
|
|
320
|
+
/** Optional. Whether to disable DTMF (dual-tone multi-frequency). */
|
|
321
|
+
disableDtmf?: boolean;
|
|
322
|
+
/** Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". */
|
|
323
|
+
noiseSuppressionLevel?: string;
|
|
324
|
+
/** Optional. The persona property of the channel profile. */
|
|
325
|
+
personaProperty?: ChannelProfilePersonaProperty;
|
|
326
|
+
/** Optional. The unique identifier of the channel profile. */
|
|
327
|
+
profileId?: string;
|
|
328
|
+
/** Optional. The configuration for the web widget. */
|
|
329
|
+
webWidgetConfig?: ChannelProfileWebWidgetConfig;
|
|
330
|
+
}
|
|
331
|
+
interface ChannelProfilePersonaProperty {
|
|
332
|
+
/** Optional. The persona of the channel. */
|
|
333
|
+
persona?: string;
|
|
334
|
+
}
|
|
335
|
+
interface ChannelProfileWebWidgetConfig {
|
|
336
|
+
/** Optional. The modality of the web widget. */
|
|
337
|
+
modality?: string;
|
|
338
|
+
/** Optional. The security settings of the web widget. */
|
|
339
|
+
securitySettings?: ChannelProfileWebWidgetConfigSecuritySettings;
|
|
340
|
+
/** Optional. The theme of the web widget. */
|
|
341
|
+
theme?: string;
|
|
342
|
+
/** Optional. The title of the web widget. */
|
|
343
|
+
webWidgetTitle?: string;
|
|
344
|
+
}
|
|
345
|
+
interface ChannelProfileWebWidgetConfigSecuritySettings {
|
|
346
|
+
/** Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com" */
|
|
347
|
+
allowedOrigins?: string[];
|
|
348
|
+
/** Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins. */
|
|
349
|
+
enableOriginCheck?: boolean;
|
|
350
|
+
/** Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent. */
|
|
351
|
+
enablePublicAccess?: boolean;
|
|
352
|
+
/** Optional. Indicates whether reCAPTCHA verification for the web widget is enabled. */
|
|
353
|
+
enableRecaptcha?: boolean;
|
|
354
|
+
}
|
|
355
|
+
interface Chunk {
|
|
356
|
+
/** Optional. Agent transfer event. */
|
|
357
|
+
agentTransfer?: AgentTransfer;
|
|
358
|
+
/** A struct represents default variables at the start of the conversation, keyed by variable names. */
|
|
359
|
+
defaultVariables?: {[P in string]: any};
|
|
360
|
+
/** Optional. Image data. */
|
|
361
|
+
image?: Image;
|
|
362
|
+
/** Optional. Custom payload data. */
|
|
363
|
+
payload?: {[P in string]: any};
|
|
364
|
+
/** Optional. Text data. */
|
|
365
|
+
text?: string;
|
|
366
|
+
/** Optional. Tool execution request. */
|
|
367
|
+
toolCall?: ToolCall;
|
|
368
|
+
/** Optional. Tool execution response. */
|
|
369
|
+
toolResponse?: ToolResponse;
|
|
370
|
+
/** Optional. Transcript associated with the audio. */
|
|
371
|
+
transcript?: string;
|
|
372
|
+
/** A struct represents variables that were updated in the conversation, keyed by variable names. */
|
|
373
|
+
updatedVariables?: {[P in string]: any};
|
|
374
|
+
}
|
|
375
|
+
interface Citations {
|
|
376
|
+
/** List of cited pieces of information. */
|
|
377
|
+
citedChunks?: CitationsCitedChunk[];
|
|
378
|
+
}
|
|
379
|
+
interface CitationsCitedChunk {
|
|
380
|
+
/** Text used for citaiton. */
|
|
381
|
+
text?: string;
|
|
382
|
+
/** Title of the cited document. */
|
|
383
|
+
title?: string;
|
|
384
|
+
/** URI used for citation. */
|
|
385
|
+
uri?: string;
|
|
386
|
+
}
|
|
387
|
+
interface ClientCertificateSettings {
|
|
388
|
+
/** Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` */
|
|
389
|
+
passphrase?: string;
|
|
390
|
+
/** Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` */
|
|
391
|
+
privateKey?: string;
|
|
392
|
+
/** Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines. */
|
|
393
|
+
tlsCertificate?: string;
|
|
394
|
+
}
|
|
395
|
+
interface ClientFunction {
|
|
396
|
+
/** Optional. The function description. */
|
|
397
|
+
description?: string;
|
|
398
|
+
/** Required. The function name. */
|
|
399
|
+
name?: string;
|
|
400
|
+
/** Optional. The schema of the function parameters. */
|
|
401
|
+
parameters?: Schema;
|
|
402
|
+
/** Optional. The schema of the function response. */
|
|
403
|
+
response?: Schema;
|
|
404
|
+
}
|
|
405
|
+
interface CloudLoggingSettings {
|
|
406
|
+
/** Optional. Whether to enable Cloud Logging for the sessions. */
|
|
407
|
+
enableCloudLogging?: boolean;
|
|
408
|
+
}
|
|
409
|
+
interface CodeBlock {
|
|
410
|
+
/** Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. */
|
|
411
|
+
pythonCode?: string;
|
|
412
|
+
}
|
|
413
|
+
interface ConnectorTool {
|
|
414
|
+
/** Required. Action for the tool to use. */
|
|
415
|
+
action?: Action;
|
|
416
|
+
/** Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details. */
|
|
417
|
+
authConfig?: EndUserAuthConfig;
|
|
418
|
+
/** Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}` */
|
|
419
|
+
connection?: string;
|
|
420
|
+
/** Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool. */
|
|
421
|
+
description?: string;
|
|
422
|
+
/** Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool. */
|
|
423
|
+
name?: string;
|
|
424
|
+
}
|
|
425
|
+
interface ConnectorToolset {
|
|
426
|
+
/** Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override */
|
|
427
|
+
authConfig?: EndUserAuthConfig;
|
|
428
|
+
/** Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}` */
|
|
429
|
+
connection?: string;
|
|
430
|
+
/** Required. The list of connector actions/entity operations to generate tools for. */
|
|
431
|
+
connectorActions?: Action[];
|
|
432
|
+
}
|
|
433
|
+
interface Conversation {
|
|
434
|
+
/** Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` */
|
|
435
|
+
appVersion?: string;
|
|
436
|
+
/** DEPRECATED. Please use input_types instead. */
|
|
437
|
+
channelType?: string;
|
|
438
|
+
/** Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` */
|
|
439
|
+
deployment?: string;
|
|
440
|
+
/** Output only. Timestamp when the conversation was completed. */
|
|
441
|
+
endTime?: string;
|
|
442
|
+
/** Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
443
|
+
entryAgent?: string;
|
|
444
|
+
/** Output only. The input types of the conversation. */
|
|
445
|
+
inputTypes?: string[];
|
|
446
|
+
/** Output only. The language code of the conversation. */
|
|
447
|
+
languageCode?: string;
|
|
448
|
+
/** Deprecated. Use turns instead. */
|
|
449
|
+
messages?: Message[];
|
|
450
|
+
/** Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}` */
|
|
451
|
+
name?: string;
|
|
452
|
+
/** Output only. Indicate the source of the conversation. */
|
|
453
|
+
source?: string;
|
|
454
|
+
/** Output only. Timestamp when the conversation was created. */
|
|
455
|
+
startTime?: string;
|
|
456
|
+
/** Output only. The number of turns in the conversation. */
|
|
457
|
+
turnCount?: number;
|
|
458
|
+
/** Required. The turns in the conversation. */
|
|
459
|
+
turns?: ConversationTurn[];
|
|
460
|
+
}
|
|
461
|
+
interface ConversationLoggingSettings {
|
|
462
|
+
/** Optional. Whether to disable conversation logging for the sessions. */
|
|
463
|
+
disableConversationLogging?: boolean;
|
|
464
|
+
}
|
|
465
|
+
interface ConversationTurn {
|
|
466
|
+
/** Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing. */
|
|
467
|
+
messages?: Message[];
|
|
468
|
+
/** Optional. The root span of the action processing. */
|
|
469
|
+
rootSpan?: Span;
|
|
470
|
+
}
|
|
471
|
+
interface DataStore {
|
|
472
|
+
/** Output only. The connector config for the data store connection. */
|
|
473
|
+
connectorConfig?: DataStoreConnectorConfig;
|
|
474
|
+
/** Output only. Timestamp when the data store was created. */
|
|
475
|
+
createTime?: string;
|
|
476
|
+
/** Output only. The display name of the data store. */
|
|
477
|
+
displayName?: string;
|
|
478
|
+
/** Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. */
|
|
479
|
+
documentProcessingMode?: string;
|
|
480
|
+
/** Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
481
|
+
name?: string;
|
|
482
|
+
/** Output only. The type of the data store. This field is readonly and populated by the server. */
|
|
483
|
+
type?: string;
|
|
484
|
+
}
|
|
485
|
+
interface DataStoreConnectorConfig {
|
|
486
|
+
/** Resource name of the collection the data store belongs to. */
|
|
487
|
+
collection?: string;
|
|
488
|
+
/** Display name of the collection the data store belongs to. */
|
|
489
|
+
collectionDisplayName?: string;
|
|
490
|
+
/** The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`. */
|
|
491
|
+
dataSource?: string;
|
|
492
|
+
}
|
|
493
|
+
interface DataStoreSettings {
|
|
494
|
+
/** Output only. The engines for the app. */
|
|
495
|
+
engines?: DataStoreSettingsEngine[];
|
|
496
|
+
}
|
|
497
|
+
interface DataStoreSettingsEngine {
|
|
498
|
+
/** Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
499
|
+
name?: string;
|
|
500
|
+
/** Output only. The type of the engine. */
|
|
501
|
+
type?: string;
|
|
502
|
+
}
|
|
503
|
+
interface DataStoreTool {
|
|
504
|
+
/** Optional. Boost specification to boost certain documents. */
|
|
505
|
+
boostSpecs?: DataStoreToolBoostSpecs[];
|
|
506
|
+
/** Optional. Search within a single specific DataStore. */
|
|
507
|
+
dataStoreSource?: DataStoreToolDataStoreSource;
|
|
508
|
+
/** Optional. The tool description. */
|
|
509
|
+
description?: string;
|
|
510
|
+
/** Optional. Search within an Engine (potentially across multiple DataStores). */
|
|
511
|
+
engineSource?: DataStoreToolEngineSource;
|
|
512
|
+
/** Optional. The filter parameter behavior. */
|
|
513
|
+
filterParameterBehavior?: string;
|
|
514
|
+
/** Optional. The modality configs for the data store. */
|
|
515
|
+
modalityConfigs?: DataStoreToolModalityConfig[];
|
|
516
|
+
/** Required. The data store tool name. */
|
|
517
|
+
name?: string;
|
|
518
|
+
}
|
|
519
|
+
interface DataStoreToolBoostSpec {
|
|
520
|
+
/** Required. A list of boosting specifications. */
|
|
521
|
+
conditionBoostSpecs?: DataStoreToolBoostSpecConditionBoostSpec[];
|
|
522
|
+
}
|
|
523
|
+
interface DataStoreToolBoostSpecConditionBoostSpec {
|
|
524
|
+
/** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
525
|
+
boost?: number;
|
|
526
|
+
/** Optional. Complex specification for custom ranking based on customer defined attribute value. */
|
|
527
|
+
boostControlSpec?: DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec;
|
|
528
|
+
/** Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr")) */
|
|
529
|
+
condition?: string;
|
|
530
|
+
}
|
|
531
|
+
interface DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec {
|
|
532
|
+
/** Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */
|
|
533
|
+
attributeType?: string;
|
|
534
|
+
/** Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
535
|
+
controlPoints?: DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
536
|
+
/** Optional. The name of the field whose value will be used to determine the boost amount. */
|
|
537
|
+
fieldName?: string;
|
|
538
|
+
/** Optional. The interpolation type to be applied to connect the control points listed below. */
|
|
539
|
+
interpolationType?: string;
|
|
540
|
+
}
|
|
541
|
+
interface DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
542
|
+
/** Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */
|
|
543
|
+
attributeValue?: string;
|
|
544
|
+
/** Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
545
|
+
boostAmount?: number;
|
|
546
|
+
}
|
|
547
|
+
interface DataStoreToolBoostSpecs {
|
|
548
|
+
/** Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. */
|
|
549
|
+
dataStores?: string[];
|
|
550
|
+
/** Required. A list of boosting specifications. */
|
|
551
|
+
spec?: DataStoreToolBoostSpec[];
|
|
552
|
+
}
|
|
553
|
+
interface DataStoreToolDataStoreSource {
|
|
554
|
+
/** Optional. The data store. */
|
|
555
|
+
dataStore?: DataStore;
|
|
556
|
+
/** Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata */
|
|
557
|
+
filter?: string;
|
|
558
|
+
}
|
|
559
|
+
interface DataStoreToolEngineSource {
|
|
560
|
+
/** Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. */
|
|
561
|
+
dataStoreSources?: DataStoreToolDataStoreSource[];
|
|
562
|
+
/** Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
563
|
+
engine?: string;
|
|
564
|
+
/** Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata */
|
|
565
|
+
filter?: string;
|
|
566
|
+
}
|
|
567
|
+
interface DataStoreToolGroundingConfig {
|
|
568
|
+
/** Optional. Whether grounding is disabled. */
|
|
569
|
+
disabled?: boolean;
|
|
570
|
+
/** Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned. */
|
|
571
|
+
groundingLevel?: number;
|
|
572
|
+
}
|
|
573
|
+
interface DataStoreToolModalityConfig {
|
|
574
|
+
/** Optional. The grounding configuration. */
|
|
575
|
+
groundingConfig?: DataStoreToolGroundingConfig;
|
|
576
|
+
/** Required. The modality type. */
|
|
577
|
+
modalityType?: string;
|
|
578
|
+
/** Optional. The rewriter config. */
|
|
579
|
+
rewriterConfig?: DataStoreToolRewriterConfig;
|
|
580
|
+
/** Optional. The summarization config. */
|
|
581
|
+
summarizationConfig?: DataStoreToolSummarizationConfig;
|
|
582
|
+
}
|
|
583
|
+
interface DataStoreToolRewriterConfig {
|
|
584
|
+
/** Optional. Whether the rewriter is disabled. */
|
|
585
|
+
disabled?: boolean;
|
|
586
|
+
/** Required. Configurations for the LLM model. */
|
|
587
|
+
modelSettings?: ModelSettings;
|
|
588
|
+
/** Optional. The prompt definition. If not set, default prompt will be used. */
|
|
589
|
+
prompt?: string;
|
|
590
|
+
}
|
|
591
|
+
interface DataStoreToolSummarizationConfig {
|
|
592
|
+
/** Optional. Whether summarization is disabled. */
|
|
593
|
+
disabled?: boolean;
|
|
594
|
+
/** Optional. Configurations for the LLM model. */
|
|
595
|
+
modelSettings?: ModelSettings;
|
|
596
|
+
/** Optional. The prompt definition. If not set, default prompt will be used. */
|
|
597
|
+
prompt?: string;
|
|
598
|
+
}
|
|
599
|
+
interface Deployment {
|
|
600
|
+
/** Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} */
|
|
601
|
+
appVersion?: string;
|
|
602
|
+
/** Required. The channel profile used in the deployment. */
|
|
603
|
+
channelProfile?: ChannelProfile;
|
|
604
|
+
/** Output only. Timestamp when this deployment was created. */
|
|
605
|
+
createTime?: string;
|
|
606
|
+
/** Required. Display name of the deployment. */
|
|
607
|
+
displayName?: string;
|
|
608
|
+
/** Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
609
|
+
etag?: string;
|
|
610
|
+
/** Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} */
|
|
611
|
+
name?: string;
|
|
612
|
+
/** Output only. Timestamp when this deployment was last updated. */
|
|
613
|
+
updateTime?: string;
|
|
614
|
+
}
|
|
615
|
+
interface Empty {}
|
|
616
|
+
interface EndSession {
|
|
617
|
+
/** Optional. Provides additional information about the end session signal, such as the reason for ending the session. */
|
|
618
|
+
metadata?: {[P in string]: any};
|
|
619
|
+
}
|
|
620
|
+
interface EndUserAuthConfig {
|
|
621
|
+
/** Oauth 2.0 Authorization Code authentication. */
|
|
622
|
+
oauth2AuthCodeConfig?: EndUserAuthConfigOauth2AuthCodeConfig;
|
|
623
|
+
/** JWT Profile Oauth 2.0 Authorization Grant authentication. */
|
|
624
|
+
oauth2JwtBearerConfig?: EndUserAuthConfigOauth2JwtBearerConfig;
|
|
625
|
+
}
|
|
626
|
+
interface EndUserAuthConfigOauth2AuthCodeConfig {
|
|
627
|
+
/** Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`. */
|
|
628
|
+
oauthToken?: string;
|
|
629
|
+
}
|
|
630
|
+
interface EndUserAuthConfigOauth2JwtBearerConfig {
|
|
631
|
+
/** Required. Client parameter name to pass through. Must be in the format `$context.variables.`. */
|
|
632
|
+
clientKey?: string;
|
|
633
|
+
/** Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`. */
|
|
634
|
+
issuer?: string;
|
|
635
|
+
/** Required. Subject parameter name to pass through. Must be in the format `$context.variables.`. */
|
|
636
|
+
subject?: string;
|
|
637
|
+
}
|
|
638
|
+
interface EvaluationMetricsThresholds {
|
|
639
|
+
/** Optional. The golden evaluation metrics thresholds. */
|
|
640
|
+
goldenEvaluationMetricsThresholds?: EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds;
|
|
641
|
+
/** Optional. The hallucination metric behavior for golden evaluations. */
|
|
642
|
+
goldenHallucinationMetricBehavior?: string;
|
|
643
|
+
/** Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations. */
|
|
644
|
+
hallucinationMetricBehavior?: string;
|
|
645
|
+
/** Optional. The hallucination metric behavior for scenario evaluations. */
|
|
646
|
+
scenarioHallucinationMetricBehavior?: string;
|
|
647
|
+
}
|
|
648
|
+
interface EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds {
|
|
649
|
+
/** Optional. The expectation level metrics thresholds. */
|
|
650
|
+
expectationLevelMetricsThresholds?: EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds;
|
|
651
|
+
/** Optional. The turn level metrics thresholds. */
|
|
652
|
+
turnLevelMetricsThresholds?: EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds;
|
|
653
|
+
}
|
|
654
|
+
interface EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds {
|
|
655
|
+
/** Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. */
|
|
656
|
+
toolInvocationParameterCorrectnessThreshold?: number;
|
|
657
|
+
}
|
|
658
|
+
interface EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds {
|
|
659
|
+
/** Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0. */
|
|
660
|
+
overallToolInvocationCorrectnessThreshold?: number;
|
|
661
|
+
/** Optional. The semantic similarity channel to use for evaluation. */
|
|
662
|
+
semanticSimilarityChannel?: string;
|
|
663
|
+
/** Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3. */
|
|
664
|
+
semanticSimilaritySuccessThreshold?: number;
|
|
665
|
+
}
|
|
666
|
+
interface Event {
|
|
667
|
+
/** Required. The name of the event. */
|
|
668
|
+
event?: string;
|
|
669
|
+
}
|
|
670
|
+
interface Example {
|
|
671
|
+
/** Output only. Timestamp when the example was created. */
|
|
672
|
+
createTime?: string;
|
|
673
|
+
/** Optional. Human-readable description of the example. */
|
|
674
|
+
description?: string;
|
|
675
|
+
/** Required. Display name of the example. */
|
|
676
|
+
displayName?: string;
|
|
677
|
+
/** Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
678
|
+
entryAgent?: string;
|
|
679
|
+
/** Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
680
|
+
etag?: string;
|
|
681
|
+
/** Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples. */
|
|
682
|
+
invalid?: boolean;
|
|
683
|
+
/** Optional. The collection of messages that make up the conversation. */
|
|
684
|
+
messages?: Message[];
|
|
685
|
+
/** Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` */
|
|
686
|
+
name?: string;
|
|
687
|
+
/** Output only. Timestamp when the example was last updated. */
|
|
688
|
+
updateTime?: string;
|
|
689
|
+
}
|
|
690
|
+
interface ExecuteToolRequest {
|
|
691
|
+
/** Optional. The input parameters and values for the tool in JSON object format. */
|
|
692
|
+
args?: {[P in string]: any};
|
|
693
|
+
/** Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} */
|
|
694
|
+
tool?: string;
|
|
695
|
+
/** Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. */
|
|
696
|
+
toolsetTool?: ToolsetTool;
|
|
697
|
+
}
|
|
698
|
+
interface ExecuteToolResponse {
|
|
699
|
+
/** Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. */
|
|
700
|
+
response?: {[P in string]: any};
|
|
701
|
+
/** The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` */
|
|
702
|
+
tool?: string;
|
|
703
|
+
/** The toolset tool that got executed. */
|
|
704
|
+
toolsetTool?: ToolsetTool;
|
|
705
|
+
}
|
|
706
|
+
interface ExportAppRequest {
|
|
707
|
+
/** Required. The format to export the app in. */
|
|
708
|
+
exportFormat?: string;
|
|
709
|
+
/** Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object. */
|
|
710
|
+
gcsUri?: string;
|
|
711
|
+
}
|
|
712
|
+
interface ExportAppResponse {
|
|
713
|
+
/** App folder compressed as a zip file. */
|
|
714
|
+
appContent?: string;
|
|
715
|
+
/** The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported. */
|
|
716
|
+
appUri?: string;
|
|
717
|
+
}
|
|
718
|
+
interface ExpressionCondition {
|
|
719
|
+
/** Required. The string representation of cloud.api.Expression condition. */
|
|
720
|
+
expression?: string;
|
|
721
|
+
}
|
|
722
|
+
interface FileSearchTool {
|
|
723
|
+
/** Optional. The type of the corpus. Default is FULLY_MANAGED. */
|
|
724
|
+
corpusType?: string;
|
|
725
|
+
/** Optional. The tool description. */
|
|
726
|
+
description?: string;
|
|
727
|
+
/** Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} */
|
|
728
|
+
fileCorpus?: string;
|
|
729
|
+
/** Required. The tool name. */
|
|
730
|
+
name?: string;
|
|
731
|
+
}
|
|
732
|
+
interface GenerateChatTokenRequest {
|
|
733
|
+
/** Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} */
|
|
734
|
+
deployment?: string;
|
|
735
|
+
/** Optional. The reCAPTCHA token generated by the client-side chat widget. */
|
|
736
|
+
recaptchaToken?: string;
|
|
737
|
+
}
|
|
738
|
+
interface GenerateChatTokenResponse {
|
|
739
|
+
/** The session scoped token for chat widget to authenticate with Session APIs. */
|
|
740
|
+
chatToken?: string;
|
|
741
|
+
/** The time at which the chat token expires. */
|
|
742
|
+
expireTime?: string;
|
|
743
|
+
}
|
|
744
|
+
interface GoogleSearchSuggestions {
|
|
745
|
+
/** Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`. */
|
|
746
|
+
htmls?: string[];
|
|
747
|
+
/** List of queries used to perform the google search along with the search result URIs forming the search suggestions. */
|
|
748
|
+
webSearchQueries?: WebSearchQuery[];
|
|
749
|
+
}
|
|
750
|
+
interface GoogleSearchTool {
|
|
751
|
+
/** Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed. */
|
|
752
|
+
contextUrls?: string[];
|
|
753
|
+
/** Optional. Description of the tool's purpose. */
|
|
754
|
+
description?: string;
|
|
755
|
+
/** Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded. */
|
|
756
|
+
excludeDomains?: string[];
|
|
757
|
+
/** Required. The name of the tool. */
|
|
758
|
+
name?: string;
|
|
759
|
+
/** Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified. */
|
|
760
|
+
preferredDomains?: string[];
|
|
761
|
+
}
|
|
762
|
+
interface Guardrail {
|
|
763
|
+
/** Optional. Action to take when the guardrail is triggered. */
|
|
764
|
+
action?: TriggerAction;
|
|
765
|
+
/** Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution. */
|
|
766
|
+
codeCallback?: GuardrailCodeCallback;
|
|
767
|
+
/** Optional. Guardrail that bans certain content from being used in the conversation. */
|
|
768
|
+
contentFilter?: GuardrailContentFilter;
|
|
769
|
+
/** Output only. Timestamp when the guardrail was created. */
|
|
770
|
+
createTime?: string;
|
|
771
|
+
/** Optional. Description of the guardrail. */
|
|
772
|
+
description?: string;
|
|
773
|
+
/** Required. Display name of the guardrail. */
|
|
774
|
+
displayName?: string;
|
|
775
|
+
/** Optional. Whether the guardrail is enabled. */
|
|
776
|
+
enabled?: boolean;
|
|
777
|
+
/** Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
778
|
+
etag?: string;
|
|
779
|
+
/** Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. */
|
|
780
|
+
llmPolicy?: GuardrailLlmPolicy;
|
|
781
|
+
/** Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification. */
|
|
782
|
+
llmPromptSecurity?: GuardrailLlmPromptSecurity;
|
|
783
|
+
/** Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings. */
|
|
784
|
+
modelSafety?: GuardrailModelSafety;
|
|
785
|
+
/** Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` */
|
|
786
|
+
name?: string;
|
|
787
|
+
/** Output only. Timestamp when the guardrail was last updated. */
|
|
788
|
+
updateTime?: string;
|
|
789
|
+
}
|
|
790
|
+
interface GuardrailCodeCallback {
|
|
791
|
+
/** Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. */
|
|
792
|
+
afterAgentCallback?: Callback;
|
|
793
|
+
/** Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. */
|
|
794
|
+
afterModelCallback?: Callback;
|
|
795
|
+
/** Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. */
|
|
796
|
+
beforeAgentCallback?: Callback;
|
|
797
|
+
/** Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. */
|
|
798
|
+
beforeModelCallback?: Callback;
|
|
799
|
+
}
|
|
800
|
+
interface GuardrailContentFilter {
|
|
801
|
+
/** Optional. List of banned phrases. Applies to both user inputs and agent responses. */
|
|
802
|
+
bannedContents?: string[];
|
|
803
|
+
/** Optional. List of banned phrases. Applies only to agent responses. */
|
|
804
|
+
bannedContentsInAgentResponse?: string[];
|
|
805
|
+
/** Optional. List of banned phrases. Applies only to user inputs. */
|
|
806
|
+
bannedContentsInUserInput?: string[];
|
|
807
|
+
/** Optional. If true, diacritics are ignored during matching. */
|
|
808
|
+
disregardDiacritics?: boolean;
|
|
809
|
+
/** Required. Match type for the content filter. */
|
|
810
|
+
matchType?: string;
|
|
811
|
+
}
|
|
812
|
+
interface GuardrailLlmPolicy {
|
|
813
|
+
/** Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped. */
|
|
814
|
+
allowShortUtterance?: boolean;
|
|
815
|
+
/** Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail. */
|
|
816
|
+
failOpen?: boolean;
|
|
817
|
+
/** Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used. */
|
|
818
|
+
maxConversationMessages?: number;
|
|
819
|
+
/** Optional. Model settings. */
|
|
820
|
+
modelSettings?: ModelSettings;
|
|
821
|
+
/** Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. */
|
|
822
|
+
policyScope?: string;
|
|
823
|
+
/** Required. Policy prompt. */
|
|
824
|
+
prompt?: string;
|
|
825
|
+
}
|
|
826
|
+
interface GuardrailLlmPromptSecurity {
|
|
827
|
+
/** Optional. Use a user-defined LlmPolicy to configure the security guardrail. */
|
|
828
|
+
customPolicy?: GuardrailLlmPolicy;
|
|
829
|
+
/** Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response. */
|
|
830
|
+
defaultSettings?: GuardrailLlmPromptSecurityDefaultSecuritySettings;
|
|
831
|
+
/** Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration. */
|
|
832
|
+
failOpen?: boolean;
|
|
833
|
+
}
|
|
834
|
+
interface GuardrailLlmPromptSecurityDefaultSecuritySettings {
|
|
835
|
+
/** Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY. */
|
|
836
|
+
defaultPromptTemplate?: string;
|
|
837
|
+
}
|
|
838
|
+
interface GuardrailModelSafety {
|
|
839
|
+
/** Required. List of safety settings. */
|
|
840
|
+
safetySettings?: GuardrailModelSafetySafetySetting[];
|
|
841
|
+
}
|
|
842
|
+
interface GuardrailModelSafetySafetySetting {
|
|
843
|
+
/** Required. The harm category. */
|
|
844
|
+
category?: string;
|
|
845
|
+
/** Required. The harm block threshold. */
|
|
846
|
+
threshold?: string;
|
|
847
|
+
}
|
|
848
|
+
interface Image {
|
|
849
|
+
/** Required. Raw bytes of the image. */
|
|
850
|
+
data?: string;
|
|
851
|
+
/** Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp */
|
|
852
|
+
mimeType?: string;
|
|
853
|
+
}
|
|
854
|
+
interface ImportAppRequest {
|
|
855
|
+
/** Raw bytes representing the compressed zip file with the app folder structure. */
|
|
856
|
+
appContent?: string;
|
|
857
|
+
/** Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced. */
|
|
858
|
+
appId?: string;
|
|
859
|
+
/** Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error. */
|
|
860
|
+
displayName?: string;
|
|
861
|
+
/** The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`. */
|
|
862
|
+
gcsUri?: string;
|
|
863
|
+
/** Optional. Options governing the import process for the app. */
|
|
864
|
+
importOptions?: ImportAppRequestImportOptions;
|
|
865
|
+
}
|
|
866
|
+
interface ImportAppRequestImportOptions {
|
|
867
|
+
/** Optional. The strategy to use when resolving conflicts during import. */
|
|
868
|
+
conflictResolutionStrategy?: string;
|
|
869
|
+
}
|
|
870
|
+
interface ImportAppResponse {
|
|
871
|
+
/** The resource name of the app that was imported. */
|
|
872
|
+
name?: string;
|
|
873
|
+
/** Warning messages generated during the import process. If errors occur for specific resources, they will not be included in the imported app and the error will be mentioned here. */
|
|
874
|
+
warnings?: string[];
|
|
875
|
+
}
|
|
876
|
+
interface InputAudioConfig {
|
|
877
|
+
/** Required. The encoding of the input audio data. */
|
|
878
|
+
audioEncoding?: string;
|
|
879
|
+
/** Optional. Whether to enable noise suppression on the input audio. Available values are "low", "moderate", "high", "very_high". */
|
|
880
|
+
noiseSuppressionLevel?: string;
|
|
881
|
+
/** Required. The sample rate (in Hertz) of the input audio data. */
|
|
882
|
+
sampleRateHertz?: number;
|
|
883
|
+
}
|
|
884
|
+
interface LanguageSettings {
|
|
885
|
+
/** Optional. The default language code of the app. */
|
|
886
|
+
defaultLanguageCode?: string;
|
|
887
|
+
/** Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input. */
|
|
888
|
+
enableMultilingualSupport?: boolean;
|
|
889
|
+
/** Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation. */
|
|
890
|
+
fallbackAction?: string;
|
|
891
|
+
/** Optional. List of languages codes supported by the app, in addition to the `default_language_code`. */
|
|
892
|
+
supportedLanguageCodes?: string[];
|
|
893
|
+
}
|
|
894
|
+
interface ListAgentsResponse {
|
|
895
|
+
/** The list of agents. */
|
|
896
|
+
agents?: Agent[];
|
|
897
|
+
/** A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
898
|
+
nextPageToken?: string;
|
|
899
|
+
}
|
|
900
|
+
interface ListAppsResponse {
|
|
901
|
+
/** The list of apps. */
|
|
902
|
+
apps?: App[];
|
|
903
|
+
/** A token that can be sent as ListAppsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
904
|
+
nextPageToken?: string;
|
|
905
|
+
/** Unordered list. Locations that could not be reached. */
|
|
906
|
+
unreachable?: string[];
|
|
907
|
+
}
|
|
908
|
+
interface ListAppVersionsResponse {
|
|
909
|
+
/** The list of app versions. */
|
|
910
|
+
appVersions?: AppVersion[];
|
|
911
|
+
/** A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
912
|
+
nextPageToken?: string;
|
|
913
|
+
}
|
|
914
|
+
interface ListChangelogsResponse {
|
|
915
|
+
/** The list of changelogs. */
|
|
916
|
+
changelogs?: Changelog[];
|
|
917
|
+
/** A token that can be sent as ListChangelogsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
918
|
+
nextPageToken?: string;
|
|
919
|
+
}
|
|
920
|
+
interface ListConversationsResponse {
|
|
921
|
+
/** The list of conversations. */
|
|
922
|
+
conversations?: Conversation[];
|
|
923
|
+
/** A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
924
|
+
nextPageToken?: string;
|
|
925
|
+
}
|
|
926
|
+
interface ListDeploymentsResponse {
|
|
927
|
+
/** The list of deployments. */
|
|
928
|
+
deployments?: Deployment[];
|
|
929
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
930
|
+
nextPageToken?: string;
|
|
931
|
+
}
|
|
932
|
+
interface ListExamplesResponse {
|
|
933
|
+
/** The list of examples. */
|
|
934
|
+
examples?: Example[];
|
|
935
|
+
/** A token that can be sent as ListExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
936
|
+
nextPageToken?: string;
|
|
937
|
+
}
|
|
938
|
+
interface ListGuardrailsResponse {
|
|
939
|
+
/** The list of guardrails. */
|
|
940
|
+
guardrails?: Guardrail[];
|
|
941
|
+
/** A token that can be sent as ListGuardrailsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
942
|
+
nextPageToken?: string;
|
|
943
|
+
}
|
|
944
|
+
interface ListLocationsResponse {
|
|
945
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
946
|
+
locations?: Location[];
|
|
947
|
+
/** The standard List next-page token. */
|
|
948
|
+
nextPageToken?: string;
|
|
949
|
+
}
|
|
950
|
+
interface ListOperationsResponse {
|
|
951
|
+
/** The standard List next-page token. */
|
|
952
|
+
nextPageToken?: string;
|
|
953
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
954
|
+
operations?: Operation[];
|
|
955
|
+
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
|
|
956
|
+
unreachable?: string[];
|
|
957
|
+
}
|
|
958
|
+
interface ListToolsetsResponse {
|
|
959
|
+
/** A token that can be sent as ListToolsetsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
960
|
+
nextPageToken?: string;
|
|
961
|
+
/** The list of toolsets. */
|
|
962
|
+
toolsets?: Toolset[];
|
|
963
|
+
}
|
|
964
|
+
interface ListToolsResponse {
|
|
965
|
+
/** A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. */
|
|
966
|
+
nextPageToken?: string;
|
|
967
|
+
/** The list of tools. */
|
|
968
|
+
tools?: Tool[];
|
|
969
|
+
}
|
|
970
|
+
interface Location {
|
|
971
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
972
|
+
displayName?: string;
|
|
973
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
974
|
+
labels?: {[P in string]: string};
|
|
975
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
976
|
+
locationId?: string;
|
|
977
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
978
|
+
metadata?: {[P in string]: any};
|
|
979
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
980
|
+
name?: string;
|
|
981
|
+
}
|
|
982
|
+
interface LoggingSettings {
|
|
983
|
+
/** Optional. Configuration for how audio interactions should be recorded. */
|
|
984
|
+
audioRecordingConfig?: AudioRecordingConfig;
|
|
985
|
+
/** Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. */
|
|
986
|
+
bigqueryExportSettings?: BigQueryExportSettings;
|
|
987
|
+
/** Optional. Settings to describe the Cloud Logging behaviors for the app. */
|
|
988
|
+
cloudLoggingSettings?: CloudLoggingSettings;
|
|
989
|
+
/** Optional. Settings to describe the conversation logging behaviors for the app. */
|
|
990
|
+
conversationLoggingSettings?: ConversationLoggingSettings;
|
|
991
|
+
/** Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. */
|
|
992
|
+
evaluationAudioRecordingConfig?: AudioRecordingConfig;
|
|
993
|
+
/** Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app. */
|
|
994
|
+
metricAnalysisSettings?: MetricAnalysisSettings;
|
|
995
|
+
/** Optional. Configuration for how sensitive data should be redacted. */
|
|
996
|
+
redactionConfig?: RedactionConfig;
|
|
997
|
+
}
|
|
998
|
+
interface McpTool {
|
|
999
|
+
/** Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication. */
|
|
1000
|
+
apiAuthentication?: ApiAuthentication;
|
|
1001
|
+
/** Optional. The description of the MCP tool. */
|
|
1002
|
+
description?: string;
|
|
1003
|
+
/** Optional. The schema of the input arguments of the MCP tool. */
|
|
1004
|
+
inputSchema?: Schema;
|
|
1005
|
+
/** Required. The name of the MCP tool. */
|
|
1006
|
+
name?: string;
|
|
1007
|
+
/** Optional. The schema of the output arguments of the MCP tool. */
|
|
1008
|
+
outputSchema?: Schema;
|
|
1009
|
+
/** Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. */
|
|
1010
|
+
serverAddress?: string;
|
|
1011
|
+
/** Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. */
|
|
1012
|
+
serviceDirectoryConfig?: ServiceDirectoryConfig;
|
|
1013
|
+
/** Optional. The TLS configuration. Includes the custom server certificates that the client should trust. */
|
|
1014
|
+
tlsConfig?: TlsConfig;
|
|
1015
|
+
}
|
|
1016
|
+
interface McpToolset {
|
|
1017
|
+
/** Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication. */
|
|
1018
|
+
apiAuthentication?: ApiAuthentication;
|
|
1019
|
+
/** Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. */
|
|
1020
|
+
serverAddress?: string;
|
|
1021
|
+
/** Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. */
|
|
1022
|
+
serviceDirectoryConfig?: ServiceDirectoryConfig;
|
|
1023
|
+
/** Optional. The TLS configuration. Includes the custom server certificates that the client should trust. */
|
|
1024
|
+
tlsConfig?: TlsConfig;
|
|
1025
|
+
}
|
|
1026
|
+
interface Message {
|
|
1027
|
+
/** Optional. Content of the message as a series of chunks. */
|
|
1028
|
+
chunks?: Chunk[];
|
|
1029
|
+
/** Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. */
|
|
1030
|
+
eventTime?: string;
|
|
1031
|
+
/** Optional. The role within the conversation, e.g., user, agent. */
|
|
1032
|
+
role?: string;
|
|
1033
|
+
}
|
|
1034
|
+
interface MetricAnalysisSettings {
|
|
1035
|
+
/** Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected. */
|
|
1036
|
+
llmMetricsOptedOut?: boolean;
|
|
1037
|
+
}
|
|
1038
|
+
interface ModelSettings {
|
|
1039
|
+
/** Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent. */
|
|
1040
|
+
model?: string;
|
|
1041
|
+
/** Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. */
|
|
1042
|
+
temperature?: number;
|
|
1043
|
+
}
|
|
1044
|
+
interface OAuthConfig {
|
|
1045
|
+
/** Required. The client ID from the OAuth provider. */
|
|
1046
|
+
clientId?: string;
|
|
1047
|
+
/** Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
1048
|
+
clientSecretVersion?: string;
|
|
1049
|
+
/** Required. OAuth grant types. */
|
|
1050
|
+
oauthGrantType?: string;
|
|
1051
|
+
/** Optional. The OAuth scopes to grant. */
|
|
1052
|
+
scopes?: string[];
|
|
1053
|
+
/** Required. The token endpoint in the OAuth provider to exchange for an access token. */
|
|
1054
|
+
tokenEndpoint?: string;
|
|
1055
|
+
}
|
|
1056
|
+
interface Omnichannel {
|
|
1057
|
+
/** Output only. Timestamp when the omnichannel resource was created. */
|
|
1058
|
+
createTime?: string;
|
|
1059
|
+
/** Optional. Human-readable description of the omnichannel resource. */
|
|
1060
|
+
description?: string;
|
|
1061
|
+
/** Required. Display name of the omnichannel resource. */
|
|
1062
|
+
displayName?: string;
|
|
1063
|
+
/** Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. */
|
|
1064
|
+
etag?: string;
|
|
1065
|
+
/** Optional. The integration config for the omnichannel resource. */
|
|
1066
|
+
integrationConfig?: OmnichannelIntegrationConfig;
|
|
1067
|
+
/** Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project}/locations/{location}/omnichannels/{omnichannel}` */
|
|
1068
|
+
name?: string;
|
|
1069
|
+
/** Output only. Timestamp when the omnichannel resource was last updated. */
|
|
1070
|
+
updateTime?: string;
|
|
1071
|
+
}
|
|
1072
|
+
interface OmnichannelIntegrationConfig {
|
|
1073
|
+
/** Optional. Various of configuration for handling App events. */
|
|
1074
|
+
channelConfigs?: {
|
|
1075
|
+
[P in string]: OmnichannelIntegrationConfigChannelConfig;
|
|
1076
|
+
};
|
|
1077
|
+
/** Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key. */
|
|
1078
|
+
routingConfigs?: {
|
|
1079
|
+
[P in string]: OmnichannelIntegrationConfigRoutingConfig;
|
|
1080
|
+
};
|
|
1081
|
+
/** Optional. Various of subscribers configs. */
|
|
1082
|
+
subscriberConfigs?: {
|
|
1083
|
+
[P in string]: OmnichannelIntegrationConfigSubscriberConfig;
|
|
1084
|
+
};
|
|
1085
|
+
}
|
|
1086
|
+
interface OmnichannelIntegrationConfigCesAppConfig {
|
|
1087
|
+
/** The unique identifier of the CES app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
1088
|
+
app?: string;
|
|
1089
|
+
}
|
|
1090
|
+
interface OmnichannelIntegrationConfigChannelConfig {
|
|
1091
|
+
/** WhatsApp config. */
|
|
1092
|
+
whatsappConfig?: OmnichannelIntegrationConfigWhatsappConfig;
|
|
1093
|
+
}
|
|
1094
|
+
interface OmnichannelIntegrationConfigRoutingConfig {
|
|
1095
|
+
/** The key of the subscriber. */
|
|
1096
|
+
subscriberKey?: string;
|
|
1097
|
+
}
|
|
1098
|
+
interface OmnichannelIntegrationConfigSubscriberConfig {
|
|
1099
|
+
/** Ces app config. */
|
|
1100
|
+
cesAppConfig?: OmnichannelIntegrationConfigCesAppConfig;
|
|
1101
|
+
}
|
|
1102
|
+
interface OmnichannelIntegrationConfigWhatsappConfig {
|
|
1103
|
+
/** The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657 */
|
|
1104
|
+
metaBusinessPortfolioId?: string;
|
|
1105
|
+
/** The phone number used for sending/receiving messages. */
|
|
1106
|
+
phoneNumber?: string;
|
|
1107
|
+
/** The Phone Number ID associated with the WhatsApp Business Account. */
|
|
1108
|
+
phoneNumberId?: string;
|
|
1109
|
+
/** The verify token configured in the Meta App Dashboard for webhook verification. */
|
|
1110
|
+
webhookVerifyToken?: string;
|
|
1111
|
+
/** The customer's WhatsApp Business Account (WABA) ID. */
|
|
1112
|
+
whatsappBusinessAccountId?: string;
|
|
1113
|
+
/** The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens */
|
|
1114
|
+
whatsappBusinessToken?: string;
|
|
1115
|
+
}
|
|
1116
|
+
interface OmnichannelOperationMetadata {
|
|
1117
|
+
/** Output only. The time the operation was created. */
|
|
1118
|
+
createTime?: string;
|
|
1119
|
+
/** Output only. The time the operation finished running. */
|
|
1120
|
+
endTime?: string;
|
|
1121
|
+
/** Output only. Identifies whether the user has requested cancellation of the operation. */
|
|
1122
|
+
requestedCancellation?: boolean;
|
|
1123
|
+
/** Output only. Human-readable status of the operation, if any. */
|
|
1124
|
+
statusMessage?: string;
|
|
1125
|
+
}
|
|
1126
|
+
interface OpenApiTool {
|
|
1127
|
+
/** Optional. Authentication information required by the API. */
|
|
1128
|
+
apiAuthentication?: ApiAuthentication;
|
|
1129
|
+
/** Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`. */
|
|
1130
|
+
description?: string;
|
|
1131
|
+
/** Optional. If true, the agent will ignore unknown fields in the API response. */
|
|
1132
|
+
ignoreUnknownFields?: boolean;
|
|
1133
|
+
/** Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`. */
|
|
1134
|
+
name?: string;
|
|
1135
|
+
/** Required. The OpenAPI schema in JSON or YAML format. */
|
|
1136
|
+
openApiSchema?: string;
|
|
1137
|
+
/** Optional. Service Directory configuration. */
|
|
1138
|
+
serviceDirectoryConfig?: ServiceDirectoryConfig;
|
|
1139
|
+
/** Optional. The TLS configuration. Includes the custom server certificates that the client will trust. */
|
|
1140
|
+
tlsConfig?: TlsConfig;
|
|
1141
|
+
/** Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. */
|
|
1142
|
+
url?: string;
|
|
1143
|
+
}
|
|
1144
|
+
interface OpenApiToolset {
|
|
1145
|
+
/** Optional. Authentication information required by the API. */
|
|
1146
|
+
apiAuthentication?: ApiAuthentication;
|
|
1147
|
+
/** Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema. */
|
|
1148
|
+
ignoreUnknownFields?: boolean;
|
|
1149
|
+
/** Required. The OpenAPI schema of the toolset. */
|
|
1150
|
+
openApiSchema?: string;
|
|
1151
|
+
/** Optional. Service Directory configuration. */
|
|
1152
|
+
serviceDirectoryConfig?: ServiceDirectoryConfig;
|
|
1153
|
+
/** Optional. The TLS configuration. Includes the custom server certificates */
|
|
1154
|
+
tlsConfig?: TlsConfig;
|
|
1155
|
+
/** Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. */
|
|
1156
|
+
url?: string;
|
|
1157
|
+
}
|
|
1158
|
+
interface Operation {
|
|
1159
|
+
/** 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. */
|
|
1160
|
+
done?: boolean;
|
|
1161
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
1162
|
+
error?: Status;
|
|
1163
|
+
/** 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. */
|
|
1164
|
+
metadata?: {[P in string]: any};
|
|
1165
|
+
/** 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}`. */
|
|
1166
|
+
name?: string;
|
|
1167
|
+
/** The normal, successful response of the operation. 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`. */
|
|
1168
|
+
response?: {[P in string]: any};
|
|
1169
|
+
}
|
|
1170
|
+
interface OperationMetadata {
|
|
1171
|
+
/** Output only. The time the operation was created. */
|
|
1172
|
+
createTime?: string;
|
|
1173
|
+
/** Output only. The time the operation finished running. */
|
|
1174
|
+
endTime?: string;
|
|
1175
|
+
/** Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
1176
|
+
requestedCancellation?: boolean;
|
|
1177
|
+
/** Output only. Human-readable status of the operation, if any. */
|
|
1178
|
+
statusMessage?: string;
|
|
1179
|
+
}
|
|
1180
|
+
interface OutputAudioConfig {
|
|
1181
|
+
/** Required. The encoding of the output audio data. */
|
|
1182
|
+
audioEncoding?: string;
|
|
1183
|
+
/** Required. The sample rate (in Hertz) of the output audio data. */
|
|
1184
|
+
sampleRateHertz?: number;
|
|
1185
|
+
}
|
|
1186
|
+
interface PythonCodeCondition {
|
|
1187
|
+
/** Required. The python code to execute. */
|
|
1188
|
+
pythonCode?: string;
|
|
1189
|
+
}
|
|
1190
|
+
interface PythonFunction {
|
|
1191
|
+
/** Output only. The description of the Python function, parsed from the python code's docstring. */
|
|
1192
|
+
description?: string;
|
|
1193
|
+
/** Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. */
|
|
1194
|
+
name?: string;
|
|
1195
|
+
/** Optional. The Python code to execute for the tool. */
|
|
1196
|
+
pythonCode?: string;
|
|
1197
|
+
}
|
|
1198
|
+
interface RedactionConfig {
|
|
1199
|
+
/** Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}` */
|
|
1200
|
+
deidentifyTemplate?: string;
|
|
1201
|
+
/** Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. */
|
|
1202
|
+
enableRedaction?: boolean;
|
|
1203
|
+
/** Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` */
|
|
1204
|
+
inspectTemplate?: string;
|
|
1205
|
+
}
|
|
1206
|
+
interface RestoreAppVersionRequest {}
|
|
1207
|
+
interface RetrieveToolSchemaRequest {
|
|
1208
|
+
/** Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} */
|
|
1209
|
+
tool?: string;
|
|
1210
|
+
/** Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. */
|
|
1211
|
+
toolsetTool?: ToolsetTool;
|
|
1212
|
+
}
|
|
1213
|
+
interface RetrieveToolSchemaResponse {
|
|
1214
|
+
/** Required. The schema of the tool input parameters. */
|
|
1215
|
+
inputSchema?: Schema;
|
|
1216
|
+
/** Required. The schema of the tool output parameters. */
|
|
1217
|
+
outputSchema?: Schema;
|
|
1218
|
+
/** The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` */
|
|
1219
|
+
tool?: string;
|
|
1220
|
+
/** The toolset tool that the schema is for. */
|
|
1221
|
+
toolsetTool?: ToolsetTool;
|
|
1222
|
+
}
|
|
1223
|
+
interface RetrieveToolsRequest {
|
|
1224
|
+
/** Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. */
|
|
1225
|
+
toolIds?: string[];
|
|
1226
|
+
}
|
|
1227
|
+
interface RetrieveToolsResponse {
|
|
1228
|
+
/** Required. The list of tools that are included in the specified toolset. */
|
|
1229
|
+
tools?: Tool[];
|
|
1230
|
+
}
|
|
1231
|
+
interface RunSessionRequest {
|
|
1232
|
+
/** Required. The configuration for the session. */
|
|
1233
|
+
config?: SessionConfig;
|
|
1234
|
+
/** Required. Inputs for the session. */
|
|
1235
|
+
inputs?: SessionInput[];
|
|
1236
|
+
}
|
|
1237
|
+
interface RunSessionResponse {
|
|
1238
|
+
/** Outputs for the session. */
|
|
1239
|
+
outputs?: SessionOutput[];
|
|
1240
|
+
}
|
|
1241
|
+
interface Schema {
|
|
1242
|
+
/** Optional. Can either be a boolean or an object, controls the presence of additional properties. */
|
|
1243
|
+
additionalProperties?: Schema;
|
|
1244
|
+
/** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
|
|
1245
|
+
anyOf?: Schema[];
|
|
1246
|
+
/** Optional. Default value of the data. */
|
|
1247
|
+
default?: any;
|
|
1248
|
+
/** Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. */
|
|
1249
|
+
defs?: {[P in string]: Schema};
|
|
1250
|
+
/** Optional. The description of the data. */
|
|
1251
|
+
description?: string;
|
|
1252
|
+
/** Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} */
|
|
1253
|
+
enum?: string[];
|
|
1254
|
+
/** Optional. Schema of the elements of Type.ARRAY. */
|
|
1255
|
+
items?: Schema;
|
|
1256
|
+
/** Optional. Maximum value for Type.INTEGER and Type.NUMBER. */
|
|
1257
|
+
maximum?: number;
|
|
1258
|
+
/** Optional. Maximum number of the elements for Type.ARRAY. */
|
|
1259
|
+
maxItems?: string;
|
|
1260
|
+
/** Optional. Minimum value for Type.INTEGER and Type.NUMBER. */
|
|
1261
|
+
minimum?: number;
|
|
1262
|
+
/** Optional. Minimum number of the elements for Type.ARRAY. */
|
|
1263
|
+
minItems?: string;
|
|
1264
|
+
/** Optional. Indicates if the value may be null. */
|
|
1265
|
+
nullable?: boolean;
|
|
1266
|
+
/** Optional. Schemas of initial elements of Type.ARRAY. */
|
|
1267
|
+
prefixItems?: Schema[];
|
|
1268
|
+
/** Optional. Properties of Type.OBJECT. */
|
|
1269
|
+
properties?: {[P in string]: Schema};
|
|
1270
|
+
/** Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. */
|
|
1271
|
+
ref?: string;
|
|
1272
|
+
/** Optional. Required properties of Type.OBJECT. */
|
|
1273
|
+
required?: string[];
|
|
1274
|
+
/** Optional. The title of the schema. */
|
|
1275
|
+
title?: string;
|
|
1276
|
+
/** Required. The type of the data. */
|
|
1277
|
+
type?: string;
|
|
1278
|
+
/** Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. */
|
|
1279
|
+
uniqueItems?: boolean;
|
|
1280
|
+
}
|
|
1281
|
+
interface ServiceAccountAuthConfig {
|
|
1282
|
+
/** Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. */
|
|
1283
|
+
scopes?: string[];
|
|
1284
|
+
/** Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. */
|
|
1285
|
+
serviceAccount?: string;
|
|
1286
|
+
}
|
|
1287
|
+
interface ServiceAgentIdTokenAuthConfig {}
|
|
1288
|
+
interface ServiceDirectoryConfig {
|
|
1289
|
+
/** Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. */
|
|
1290
|
+
service?: string;
|
|
1291
|
+
}
|
|
1292
|
+
interface SessionConfig {
|
|
1293
|
+
/** Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` */
|
|
1294
|
+
deployment?: string;
|
|
1295
|
+
/** Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}` */
|
|
1296
|
+
entryAgent?: string;
|
|
1297
|
+
/** Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. */
|
|
1298
|
+
historicalContexts?: Message[];
|
|
1299
|
+
/** Optional. Configuration for processing the input audio. */
|
|
1300
|
+
inputAudioConfig?: InputAudioConfig;
|
|
1301
|
+
/** Optional. Configuration for generating the output audio. */
|
|
1302
|
+
outputAudioConfig?: OutputAudioConfig;
|
|
1303
|
+
/** Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent. */
|
|
1304
|
+
remoteDialogflowQueryParameters?: SessionConfigRemoteDialogflowQueryParameters;
|
|
1305
|
+
/** Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". */
|
|
1306
|
+
timeZone?: string;
|
|
1307
|
+
}
|
|
1308
|
+
interface SessionConfigRemoteDialogflowQueryParameters {
|
|
1309
|
+
/** Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). */
|
|
1310
|
+
endUserMetadata?: {[P in string]: any};
|
|
1311
|
+
/** Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). */
|
|
1312
|
+
payload?: {[P in string]: any};
|
|
1313
|
+
/** Optional. The HTTP headers to be sent as webhook_headers in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). */
|
|
1314
|
+
webhookHeaders?: {[P in string]: string};
|
|
1315
|
+
}
|
|
1316
|
+
interface SessionInput {
|
|
1317
|
+
/** Optional. Audio data from the end user. */
|
|
1318
|
+
audio?: string;
|
|
1319
|
+
/** Optional. Blob data from the end user. */
|
|
1320
|
+
blob?: Blob;
|
|
1321
|
+
/** Optional. DTMF digits from the end user. */
|
|
1322
|
+
dtmf?: string;
|
|
1323
|
+
/** Optional. Event input. */
|
|
1324
|
+
event?: Event;
|
|
1325
|
+
/** Optional. Image data from the end user. */
|
|
1326
|
+
image?: Image;
|
|
1327
|
+
/** Optional. Text data from the end user. */
|
|
1328
|
+
text?: string;
|
|
1329
|
+
/** Optional. Execution results for the tool calls from the client. */
|
|
1330
|
+
toolResponses?: ToolResponses;
|
|
1331
|
+
/** Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters. */
|
|
1332
|
+
variables?: {[P in string]: any};
|
|
1333
|
+
/** Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time. */
|
|
1334
|
+
willContinue?: boolean;
|
|
1335
|
+
}
|
|
1336
|
+
interface SessionOutput {
|
|
1337
|
+
/** Output audio from the CES agent. */
|
|
1338
|
+
audio?: string;
|
|
1339
|
+
/** Citations that provide the source information for the agent's generated text. */
|
|
1340
|
+
citations?: Citations;
|
|
1341
|
+
/** Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn. */
|
|
1342
|
+
diagnosticInfo?: SessionOutputDiagnosticInfo;
|
|
1343
|
+
/** Indicates the session has ended. */
|
|
1344
|
+
endSession?: EndSession;
|
|
1345
|
+
/** The suggestions returned from Google Search as a result of invoking the GoogleSearchTool. */
|
|
1346
|
+
googleSearchSuggestions?: GoogleSearchSuggestions;
|
|
1347
|
+
/** Custom payload with structured output from the CES agent. */
|
|
1348
|
+
payload?: {[P in string]: any};
|
|
1349
|
+
/** Output text from the CES agent. */
|
|
1350
|
+
text?: string;
|
|
1351
|
+
/** Request for the client to execute the tools. */
|
|
1352
|
+
toolCalls?: ToolCalls;
|
|
1353
|
+
/** If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn. */
|
|
1354
|
+
turnCompleted?: boolean;
|
|
1355
|
+
/** Indicates the sequential order of conversation turn to which this output belongs to, starting from 1. */
|
|
1356
|
+
turnIndex?: number;
|
|
1357
|
+
}
|
|
1358
|
+
interface SessionOutputDiagnosticInfo {
|
|
1359
|
+
/** List of the messages that happened during the processing. */
|
|
1360
|
+
messages?: Message[];
|
|
1361
|
+
/** A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations. */
|
|
1362
|
+
rootSpan?: Span;
|
|
1363
|
+
}
|
|
1364
|
+
interface Span {
|
|
1365
|
+
/** Output only. Key-value attributes associated with the span. */
|
|
1366
|
+
attributes?: {[P in string]: any};
|
|
1367
|
+
/** Output only. The child spans that are nested under this span. */
|
|
1368
|
+
childSpans?: Span[];
|
|
1369
|
+
/** Output only. The duration of the span. */
|
|
1370
|
+
duration?: string;
|
|
1371
|
+
/** Output only. The end time of the span. */
|
|
1372
|
+
endTime?: string;
|
|
1373
|
+
/** Output only. The name of the span. */
|
|
1374
|
+
name?: string;
|
|
1375
|
+
/** Output only. The start time of the span. */
|
|
1376
|
+
startTime?: string;
|
|
1377
|
+
}
|
|
1378
|
+
interface Status {
|
|
1379
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1380
|
+
code?: number;
|
|
1381
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1382
|
+
details?: Array<{[P in string]: any}>;
|
|
1383
|
+
/** 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. */
|
|
1384
|
+
message?: string;
|
|
1385
|
+
}
|
|
1386
|
+
interface SynthesizeSpeechConfig {
|
|
1387
|
+
/** Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error. */
|
|
1388
|
+
speakingRate?: number;
|
|
1389
|
+
/** Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech. */
|
|
1390
|
+
voice?: string;
|
|
1391
|
+
}
|
|
1392
|
+
interface SystemTool {
|
|
1393
|
+
/** Output only. The description of the system tool. */
|
|
1394
|
+
description?: string;
|
|
1395
|
+
/** Required. The name of the system tool. */
|
|
1396
|
+
name?: string;
|
|
1397
|
+
}
|
|
1398
|
+
interface TimeZoneSettings {
|
|
1399
|
+
/** Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris. */
|
|
1400
|
+
timeZone?: string;
|
|
1401
|
+
}
|
|
1402
|
+
interface TlsConfig {
|
|
1403
|
+
/** Required. Specifies a list of allowed custom CA certificates for HTTPS verification. */
|
|
1404
|
+
caCerts?: TlsConfigCaCert[];
|
|
1405
|
+
}
|
|
1406
|
+
interface TlsConfigCaCert {
|
|
1407
|
+
/** Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") */
|
|
1408
|
+
cert?: string;
|
|
1409
|
+
/** Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. */
|
|
1410
|
+
displayName?: string;
|
|
1411
|
+
}
|
|
1412
|
+
interface Tool {
|
|
1413
|
+
/** Optional. The client function. */
|
|
1414
|
+
clientFunction?: ClientFunction;
|
|
1415
|
+
/** Optional. The Integration Connector tool. */
|
|
1416
|
+
connectorTool?: ConnectorTool;
|
|
1417
|
+
/** Output only. Timestamp when the tool was created. */
|
|
1418
|
+
createTime?: string;
|
|
1419
|
+
/** Optional. The data store tool. */
|
|
1420
|
+
dataStoreTool?: DataStoreTool;
|
|
1421
|
+
/** Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property. */
|
|
1422
|
+
displayName?: string;
|
|
1423
|
+
/** Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
1424
|
+
etag?: string;
|
|
1425
|
+
/** Optional. The execution type of the tool. */
|
|
1426
|
+
executionType?: string;
|
|
1427
|
+
/** Optional. The file search tool. */
|
|
1428
|
+
fileSearchTool?: FileSearchTool;
|
|
1429
|
+
/** Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation. */
|
|
1430
|
+
generatedSummary?: string;
|
|
1431
|
+
/** Optional. The google search tool. */
|
|
1432
|
+
googleSearchTool?: GoogleSearchTool;
|
|
1433
|
+
/** Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset. */
|
|
1434
|
+
mcpTool?: McpTool;
|
|
1435
|
+
/** Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. */
|
|
1436
|
+
name?: string;
|
|
1437
|
+
/** Optional. The open API tool. */
|
|
1438
|
+
openApiTool?: OpenApiTool;
|
|
1439
|
+
/** Optional. The python function tool. */
|
|
1440
|
+
pythonFunction?: PythonFunction;
|
|
1441
|
+
/** Optional. The system tool. */
|
|
1442
|
+
systemTool?: SystemTool;
|
|
1443
|
+
/** Optional. Configuration for tool behavior in fake mode. */
|
|
1444
|
+
toolFakeConfig?: ToolFakeConfig;
|
|
1445
|
+
/** Output only. Timestamp when the tool was last updated. */
|
|
1446
|
+
updateTime?: string;
|
|
1447
|
+
/** Optional. The widget tool. */
|
|
1448
|
+
widgetTool?: WidgetTool;
|
|
1449
|
+
}
|
|
1450
|
+
interface ToolCall {
|
|
1451
|
+
/** Optional. The input parameters and values for the tool in JSON object format. */
|
|
1452
|
+
args?: {[P in string]: any};
|
|
1453
|
+
/** Output only. Display name of the tool. */
|
|
1454
|
+
displayName?: string;
|
|
1455
|
+
/** Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. */
|
|
1456
|
+
id?: string;
|
|
1457
|
+
/** Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` */
|
|
1458
|
+
tool?: string;
|
|
1459
|
+
/** Optional. The toolset tool to execute. */
|
|
1460
|
+
toolsetTool?: ToolsetTool;
|
|
1461
|
+
}
|
|
1462
|
+
interface ToolCalls {
|
|
1463
|
+
/** Optional. The list of tool calls to execute. */
|
|
1464
|
+
toolCalls?: ToolCall[];
|
|
1465
|
+
}
|
|
1466
|
+
interface ToolFakeConfig {
|
|
1467
|
+
/** Optional. Code block which will be executed instead of a real tool call. */
|
|
1468
|
+
codeBlock?: CodeBlock;
|
|
1469
|
+
/** Optional. Whether the tool is using fake mode. */
|
|
1470
|
+
enableFakeMode?: boolean;
|
|
1471
|
+
}
|
|
1472
|
+
interface ToolResponse {
|
|
1473
|
+
/** Output only. Display name of the tool. */
|
|
1474
|
+
displayName?: string;
|
|
1475
|
+
/** Optional. The matching ID of the tool call the response is for. */
|
|
1476
|
+
id?: string;
|
|
1477
|
+
/** Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. */
|
|
1478
|
+
response?: {[P in string]: any};
|
|
1479
|
+
/** Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` */
|
|
1480
|
+
tool?: string;
|
|
1481
|
+
/** Optional. The toolset tool that got executed. */
|
|
1482
|
+
toolsetTool?: ToolsetTool;
|
|
1483
|
+
}
|
|
1484
|
+
interface ToolResponses {
|
|
1485
|
+
/** Optional. The list of tool execution results. */
|
|
1486
|
+
toolResponses?: ToolResponse[];
|
|
1487
|
+
}
|
|
1488
|
+
interface Toolset {
|
|
1489
|
+
/** Optional. A toolset that generates tools from an Integration Connectors Connection. */
|
|
1490
|
+
connectorToolset?: ConnectorToolset;
|
|
1491
|
+
/** Output only. Timestamp when the toolset was created. */
|
|
1492
|
+
createTime?: string;
|
|
1493
|
+
/** Optional. The description of the toolset. */
|
|
1494
|
+
description?: string;
|
|
1495
|
+
/** Optional. The display name of the toolset. Must be unique within the same app. */
|
|
1496
|
+
displayName?: string;
|
|
1497
|
+
/** ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. */
|
|
1498
|
+
etag?: string;
|
|
1499
|
+
/** Optional. The execution type of the tools in the toolset. */
|
|
1500
|
+
executionType?: string;
|
|
1501
|
+
/** Optional. A toolset that contains a list of tools that are offered by the MCP server. */
|
|
1502
|
+
mcpToolset?: McpToolset;
|
|
1503
|
+
/** Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
1504
|
+
name?: string;
|
|
1505
|
+
/** Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. */
|
|
1506
|
+
openApiToolset?: OpenApiToolset;
|
|
1507
|
+
/** Optional. Configuration for tools behavior in fake mode. */
|
|
1508
|
+
toolFakeConfig?: ToolFakeConfig;
|
|
1509
|
+
/** Output only. Timestamp when the toolset was last updated. */
|
|
1510
|
+
updateTime?: string;
|
|
1511
|
+
}
|
|
1512
|
+
interface ToolsetTool {
|
|
1513
|
+
/** Optional. The tool ID to filter the tools to retrieve the schema for. */
|
|
1514
|
+
toolId?: string;
|
|
1515
|
+
/** Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
1516
|
+
toolset?: string;
|
|
1517
|
+
}
|
|
1518
|
+
interface TransferRule {
|
|
1519
|
+
/** Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
1520
|
+
childAgent?: string;
|
|
1521
|
+
/** Optional. A rule that immediately transfers to the target agent when the condition is met. */
|
|
1522
|
+
deterministicTransfer?: TransferRuleDeterministicTransfer;
|
|
1523
|
+
/** Required. The direction of the transfer. */
|
|
1524
|
+
direction?: string;
|
|
1525
|
+
/** Optional. Rule that prevents the planner from transferring to the target agent. */
|
|
1526
|
+
disablePlannerTransfer?: TransferRuleDisablePlannerTransfer;
|
|
1527
|
+
}
|
|
1528
|
+
interface TransferRuleDeterministicTransfer {
|
|
1529
|
+
/** Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs. */
|
|
1530
|
+
expressionCondition?: ExpressionCondition;
|
|
1531
|
+
/** Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs. */
|
|
1532
|
+
pythonCodeCondition?: PythonCodeCondition;
|
|
1533
|
+
}
|
|
1534
|
+
interface TransferRuleDisablePlannerTransfer {
|
|
1535
|
+
/** Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent. */
|
|
1536
|
+
expressionCondition?: ExpressionCondition;
|
|
1537
|
+
}
|
|
1538
|
+
interface TriggerAction {
|
|
1539
|
+
/** Optional. Respond with a generative answer. */
|
|
1540
|
+
generativeAnswer?: TriggerActionGenerativeAnswer;
|
|
1541
|
+
/** Optional. Immediately respond with a preconfigured response. */
|
|
1542
|
+
respondImmediately?: TriggerActionRespondImmediately;
|
|
1543
|
+
/** Optional. Transfer the conversation to a different agent. */
|
|
1544
|
+
transferAgent?: TriggerActionTransferAgent;
|
|
1545
|
+
}
|
|
1546
|
+
interface TriggerActionGenerativeAnswer {
|
|
1547
|
+
/** Required. The prompt to use for the generative answer. */
|
|
1548
|
+
prompt?: string;
|
|
1549
|
+
}
|
|
1550
|
+
interface TriggerActionRespondImmediately {
|
|
1551
|
+
/** Required. The canned responses for the agent to choose from. The response is chosen randomly. */
|
|
1552
|
+
responses?: TriggerActionResponse[];
|
|
1553
|
+
}
|
|
1554
|
+
interface TriggerActionResponse {
|
|
1555
|
+
/** Optional. Whether the response is disabled. Disabled responses are not used by the agent. */
|
|
1556
|
+
disabled?: boolean;
|
|
1557
|
+
/** Required. Text for the agent to respond with. */
|
|
1558
|
+
text?: string;
|
|
1559
|
+
}
|
|
1560
|
+
interface TriggerActionTransferAgent {
|
|
1561
|
+
/** Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
1562
|
+
agent?: string;
|
|
1563
|
+
}
|
|
1564
|
+
interface WebSearchQuery {
|
|
1565
|
+
/** The search query text. */
|
|
1566
|
+
query?: string;
|
|
1567
|
+
/** The URI to the Google Search results page for the query. */
|
|
1568
|
+
uri?: string;
|
|
1569
|
+
}
|
|
1570
|
+
interface WidgetTool {
|
|
1571
|
+
/** Optional. The description of the widget tool. */
|
|
1572
|
+
description?: string;
|
|
1573
|
+
/** Required. The display name of the widget tool. */
|
|
1574
|
+
name?: string;
|
|
1575
|
+
/** Optional. The input parameters of the widget tool. */
|
|
1576
|
+
parameters?: Schema;
|
|
1577
|
+
/** Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. */
|
|
1578
|
+
widgetType?: string;
|
|
1579
|
+
}
|
|
1580
|
+
interface AgentsResource {
|
|
1581
|
+
/** Creates a new agent in the given app. */
|
|
1582
|
+
create(request: {
|
|
1583
|
+
/** V1 error format. */
|
|
1584
|
+
'$.xgafv'?: string;
|
|
1585
|
+
/** OAuth access token. */
|
|
1586
|
+
access_token?: string;
|
|
1587
|
+
/** Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. */
|
|
1588
|
+
agentId?: string;
|
|
1589
|
+
/** Data format for response. */
|
|
1590
|
+
alt?: string;
|
|
1591
|
+
/** JSONP */
|
|
1592
|
+
callback?: string;
|
|
1593
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1594
|
+
fields?: string;
|
|
1595
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1596
|
+
key?: string;
|
|
1597
|
+
/** OAuth 2.0 token for the current user. */
|
|
1598
|
+
oauth_token?: string;
|
|
1599
|
+
/** Required. The resource name of the app to create an agent in. */
|
|
1600
|
+
parent: string;
|
|
1601
|
+
/** Returns response with indentations and line breaks. */
|
|
1602
|
+
prettyPrint?: boolean;
|
|
1603
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1604
|
+
quotaUser?: string;
|
|
1605
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1606
|
+
upload_protocol?: string;
|
|
1607
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1608
|
+
uploadType?: string;
|
|
1609
|
+
/** Request body */
|
|
1610
|
+
resource: Agent;
|
|
1611
|
+
}): Request<Agent>;
|
|
1612
|
+
create(
|
|
1613
|
+
request: {
|
|
1614
|
+
/** V1 error format. */
|
|
1615
|
+
'$.xgafv'?: string;
|
|
1616
|
+
/** OAuth access token. */
|
|
1617
|
+
access_token?: string;
|
|
1618
|
+
/** Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. */
|
|
1619
|
+
agentId?: string;
|
|
1620
|
+
/** Data format for response. */
|
|
1621
|
+
alt?: string;
|
|
1622
|
+
/** JSONP */
|
|
1623
|
+
callback?: string;
|
|
1624
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1625
|
+
fields?: string;
|
|
1626
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1627
|
+
key?: string;
|
|
1628
|
+
/** OAuth 2.0 token for the current user. */
|
|
1629
|
+
oauth_token?: string;
|
|
1630
|
+
/** Required. The resource name of the app to create an agent in. */
|
|
1631
|
+
parent: string;
|
|
1632
|
+
/** Returns response with indentations and line breaks. */
|
|
1633
|
+
prettyPrint?: boolean;
|
|
1634
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1635
|
+
quotaUser?: string;
|
|
1636
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1637
|
+
upload_protocol?: string;
|
|
1638
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1639
|
+
uploadType?: string;
|
|
1640
|
+
},
|
|
1641
|
+
body: Agent,
|
|
1642
|
+
): Request<Agent>;
|
|
1643
|
+
/** Deletes the specified agent. */
|
|
1644
|
+
delete(request?: {
|
|
1645
|
+
/** V1 error format. */
|
|
1646
|
+
'$.xgafv'?: string;
|
|
1647
|
+
/** OAuth access token. */
|
|
1648
|
+
access_token?: string;
|
|
1649
|
+
/** Data format for response. */
|
|
1650
|
+
alt?: string;
|
|
1651
|
+
/** JSONP */
|
|
1652
|
+
callback?: string;
|
|
1653
|
+
/** Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned. */
|
|
1654
|
+
etag?: string;
|
|
1655
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1656
|
+
fields?: string;
|
|
1657
|
+
/** Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples. */
|
|
1658
|
+
force?: boolean;
|
|
1659
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1660
|
+
key?: string;
|
|
1661
|
+
/** Required. The resource name of the agent to delete. */
|
|
1662
|
+
name: string;
|
|
1663
|
+
/** OAuth 2.0 token for the current user. */
|
|
1664
|
+
oauth_token?: string;
|
|
1665
|
+
/** Returns response with indentations and line breaks. */
|
|
1666
|
+
prettyPrint?: boolean;
|
|
1667
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1668
|
+
quotaUser?: string;
|
|
1669
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1670
|
+
upload_protocol?: string;
|
|
1671
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1672
|
+
uploadType?: string;
|
|
1673
|
+
}): Request<{}>;
|
|
1674
|
+
/** Gets details of the specified agent. */
|
|
1675
|
+
get(request?: {
|
|
1676
|
+
/** V1 error format. */
|
|
1677
|
+
'$.xgafv'?: string;
|
|
1678
|
+
/** OAuth access token. */
|
|
1679
|
+
access_token?: string;
|
|
1680
|
+
/** Data format for response. */
|
|
1681
|
+
alt?: string;
|
|
1682
|
+
/** JSONP */
|
|
1683
|
+
callback?: string;
|
|
1684
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1685
|
+
fields?: string;
|
|
1686
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1687
|
+
key?: string;
|
|
1688
|
+
/** Required. The resource name of the agent to retrieve. */
|
|
1689
|
+
name: string;
|
|
1690
|
+
/** OAuth 2.0 token for the current user. */
|
|
1691
|
+
oauth_token?: string;
|
|
1692
|
+
/** Returns response with indentations and line breaks. */
|
|
1693
|
+
prettyPrint?: boolean;
|
|
1694
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1695
|
+
quotaUser?: string;
|
|
1696
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1697
|
+
upload_protocol?: string;
|
|
1698
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1699
|
+
uploadType?: string;
|
|
1700
|
+
}): Request<Agent>;
|
|
1701
|
+
/** Lists agents in the given app. */
|
|
1702
|
+
list(request?: {
|
|
1703
|
+
/** V1 error format. */
|
|
1704
|
+
'$.xgafv'?: string;
|
|
1705
|
+
/** OAuth access token. */
|
|
1706
|
+
access_token?: string;
|
|
1707
|
+
/** Data format for response. */
|
|
1708
|
+
alt?: string;
|
|
1709
|
+
/** JSONP */
|
|
1710
|
+
callback?: string;
|
|
1711
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1712
|
+
fields?: string;
|
|
1713
|
+
/** Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details. */
|
|
1714
|
+
filter?: string;
|
|
1715
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1716
|
+
key?: string;
|
|
1717
|
+
/** OAuth 2.0 token for the current user. */
|
|
1718
|
+
oauth_token?: string;
|
|
1719
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
1720
|
+
orderBy?: string;
|
|
1721
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
1722
|
+
pageSize?: number;
|
|
1723
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListAgents call. */
|
|
1724
|
+
pageToken?: string;
|
|
1725
|
+
/** Required. The resource name of the app to list agents from. */
|
|
1726
|
+
parent: string;
|
|
1727
|
+
/** Returns response with indentations and line breaks. */
|
|
1728
|
+
prettyPrint?: boolean;
|
|
1729
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1730
|
+
quotaUser?: string;
|
|
1731
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1732
|
+
upload_protocol?: string;
|
|
1733
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1734
|
+
uploadType?: string;
|
|
1735
|
+
}): Request<ListAgentsResponse>;
|
|
1736
|
+
/** Updates the specified agent. */
|
|
1737
|
+
patch(request: {
|
|
1738
|
+
/** V1 error format. */
|
|
1739
|
+
'$.xgafv'?: string;
|
|
1740
|
+
/** OAuth access token. */
|
|
1741
|
+
access_token?: string;
|
|
1742
|
+
/** Data format for response. */
|
|
1743
|
+
alt?: string;
|
|
1744
|
+
/** JSONP */
|
|
1745
|
+
callback?: string;
|
|
1746
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1747
|
+
fields?: string;
|
|
1748
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1749
|
+
key?: string;
|
|
1750
|
+
/** Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
1751
|
+
name: string;
|
|
1752
|
+
/** OAuth 2.0 token for the current user. */
|
|
1753
|
+
oauth_token?: string;
|
|
1754
|
+
/** Returns response with indentations and line breaks. */
|
|
1755
|
+
prettyPrint?: boolean;
|
|
1756
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1757
|
+
quotaUser?: string;
|
|
1758
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
1759
|
+
updateMask?: string;
|
|
1760
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1761
|
+
upload_protocol?: string;
|
|
1762
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1763
|
+
uploadType?: string;
|
|
1764
|
+
/** Request body */
|
|
1765
|
+
resource: Agent;
|
|
1766
|
+
}): Request<Agent>;
|
|
1767
|
+
patch(
|
|
1768
|
+
request: {
|
|
1769
|
+
/** V1 error format. */
|
|
1770
|
+
'$.xgafv'?: string;
|
|
1771
|
+
/** OAuth access token. */
|
|
1772
|
+
access_token?: string;
|
|
1773
|
+
/** Data format for response. */
|
|
1774
|
+
alt?: string;
|
|
1775
|
+
/** JSONP */
|
|
1776
|
+
callback?: string;
|
|
1777
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1778
|
+
fields?: string;
|
|
1779
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1780
|
+
key?: string;
|
|
1781
|
+
/** Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` */
|
|
1782
|
+
name: string;
|
|
1783
|
+
/** OAuth 2.0 token for the current user. */
|
|
1784
|
+
oauth_token?: string;
|
|
1785
|
+
/** Returns response with indentations and line breaks. */
|
|
1786
|
+
prettyPrint?: boolean;
|
|
1787
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1788
|
+
quotaUser?: string;
|
|
1789
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
1790
|
+
updateMask?: string;
|
|
1791
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1792
|
+
upload_protocol?: string;
|
|
1793
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1794
|
+
uploadType?: string;
|
|
1795
|
+
},
|
|
1796
|
+
body: Agent,
|
|
1797
|
+
): Request<Agent>;
|
|
1798
|
+
}
|
|
1799
|
+
interface ChangelogsResource {
|
|
1800
|
+
/** Gets the specified changelog. */
|
|
1801
|
+
get(request?: {
|
|
1802
|
+
/** V1 error format. */
|
|
1803
|
+
'$.xgafv'?: string;
|
|
1804
|
+
/** OAuth access token. */
|
|
1805
|
+
access_token?: string;
|
|
1806
|
+
/** Data format for response. */
|
|
1807
|
+
alt?: string;
|
|
1808
|
+
/** JSONP */
|
|
1809
|
+
callback?: string;
|
|
1810
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1811
|
+
fields?: string;
|
|
1812
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1813
|
+
key?: string;
|
|
1814
|
+
/** Required. The resource name of the changelog to retrieve. */
|
|
1815
|
+
name: string;
|
|
1816
|
+
/** OAuth 2.0 token for the current user. */
|
|
1817
|
+
oauth_token?: string;
|
|
1818
|
+
/** Returns response with indentations and line breaks. */
|
|
1819
|
+
prettyPrint?: boolean;
|
|
1820
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1821
|
+
quotaUser?: string;
|
|
1822
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1823
|
+
upload_protocol?: string;
|
|
1824
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1825
|
+
uploadType?: string;
|
|
1826
|
+
}): Request<Changelog>;
|
|
1827
|
+
/** Lists the changelogs of the specified app. */
|
|
1828
|
+
list(request?: {
|
|
1829
|
+
/** V1 error format. */
|
|
1830
|
+
'$.xgafv'?: string;
|
|
1831
|
+
/** OAuth access token. */
|
|
1832
|
+
access_token?: string;
|
|
1833
|
+
/** Data format for response. */
|
|
1834
|
+
alt?: string;
|
|
1835
|
+
/** JSONP */
|
|
1836
|
+
callback?: string;
|
|
1837
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1838
|
+
fields?: string;
|
|
1839
|
+
/** Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action="Create"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool` */
|
|
1840
|
+
filter?: string;
|
|
1841
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1842
|
+
key?: string;
|
|
1843
|
+
/** OAuth 2.0 token for the current user. */
|
|
1844
|
+
oauth_token?: string;
|
|
1845
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
1846
|
+
orderBy?: string;
|
|
1847
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
1848
|
+
pageSize?: number;
|
|
1849
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call. */
|
|
1850
|
+
pageToken?: string;
|
|
1851
|
+
/** Required. The resource name of the app to list changelogs from. */
|
|
1852
|
+
parent: string;
|
|
1853
|
+
/** Returns response with indentations and line breaks. */
|
|
1854
|
+
prettyPrint?: boolean;
|
|
1855
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1856
|
+
quotaUser?: string;
|
|
1857
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1858
|
+
upload_protocol?: string;
|
|
1859
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1860
|
+
uploadType?: string;
|
|
1861
|
+
}): Request<ListChangelogsResponse>;
|
|
1862
|
+
}
|
|
1863
|
+
interface ConversationsResource {
|
|
1864
|
+
/** Batch deletes the specified conversations. */
|
|
1865
|
+
batchDelete(request: {
|
|
1866
|
+
/** V1 error format. */
|
|
1867
|
+
'$.xgafv'?: string;
|
|
1868
|
+
/** OAuth access token. */
|
|
1869
|
+
access_token?: string;
|
|
1870
|
+
/** Data format for response. */
|
|
1871
|
+
alt?: string;
|
|
1872
|
+
/** JSONP */
|
|
1873
|
+
callback?: string;
|
|
1874
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1875
|
+
fields?: string;
|
|
1876
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1877
|
+
key?: string;
|
|
1878
|
+
/** OAuth 2.0 token for the current user. */
|
|
1879
|
+
oauth_token?: string;
|
|
1880
|
+
/** Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
1881
|
+
parent: string;
|
|
1882
|
+
/** Returns response with indentations and line breaks. */
|
|
1883
|
+
prettyPrint?: boolean;
|
|
1884
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1885
|
+
quotaUser?: string;
|
|
1886
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1887
|
+
upload_protocol?: string;
|
|
1888
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1889
|
+
uploadType?: string;
|
|
1890
|
+
/** Request body */
|
|
1891
|
+
resource: BatchDeleteConversationsRequest;
|
|
1892
|
+
}): Request<Operation>;
|
|
1893
|
+
batchDelete(
|
|
1894
|
+
request: {
|
|
1895
|
+
/** V1 error format. */
|
|
1896
|
+
'$.xgafv'?: string;
|
|
1897
|
+
/** OAuth access token. */
|
|
1898
|
+
access_token?: string;
|
|
1899
|
+
/** Data format for response. */
|
|
1900
|
+
alt?: string;
|
|
1901
|
+
/** JSONP */
|
|
1902
|
+
callback?: string;
|
|
1903
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1904
|
+
fields?: string;
|
|
1905
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1906
|
+
key?: string;
|
|
1907
|
+
/** OAuth 2.0 token for the current user. */
|
|
1908
|
+
oauth_token?: string;
|
|
1909
|
+
/** Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
1910
|
+
parent: string;
|
|
1911
|
+
/** Returns response with indentations and line breaks. */
|
|
1912
|
+
prettyPrint?: boolean;
|
|
1913
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1914
|
+
quotaUser?: string;
|
|
1915
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1916
|
+
upload_protocol?: string;
|
|
1917
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1918
|
+
uploadType?: string;
|
|
1919
|
+
},
|
|
1920
|
+
body: BatchDeleteConversationsRequest,
|
|
1921
|
+
): Request<Operation>;
|
|
1922
|
+
/** Deletes the specified conversation. */
|
|
1923
|
+
delete(request?: {
|
|
1924
|
+
/** V1 error format. */
|
|
1925
|
+
'$.xgafv'?: string;
|
|
1926
|
+
/** OAuth access token. */
|
|
1927
|
+
access_token?: string;
|
|
1928
|
+
/** Data format for response. */
|
|
1929
|
+
alt?: string;
|
|
1930
|
+
/** JSONP */
|
|
1931
|
+
callback?: string;
|
|
1932
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1933
|
+
fields?: string;
|
|
1934
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1935
|
+
key?: string;
|
|
1936
|
+
/** Required. The resource name of the conversation to delete. */
|
|
1937
|
+
name: string;
|
|
1938
|
+
/** OAuth 2.0 token for the current user. */
|
|
1939
|
+
oauth_token?: string;
|
|
1940
|
+
/** Returns response with indentations and line breaks. */
|
|
1941
|
+
prettyPrint?: boolean;
|
|
1942
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1943
|
+
quotaUser?: string;
|
|
1944
|
+
/** Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. */
|
|
1945
|
+
source?: string;
|
|
1946
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1947
|
+
upload_protocol?: string;
|
|
1948
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1949
|
+
uploadType?: string;
|
|
1950
|
+
}): Request<{}>;
|
|
1951
|
+
/** Gets details of the specified conversation. */
|
|
1952
|
+
get(request?: {
|
|
1953
|
+
/** V1 error format. */
|
|
1954
|
+
'$.xgafv'?: string;
|
|
1955
|
+
/** OAuth access token. */
|
|
1956
|
+
access_token?: string;
|
|
1957
|
+
/** Data format for response. */
|
|
1958
|
+
alt?: string;
|
|
1959
|
+
/** JSONP */
|
|
1960
|
+
callback?: string;
|
|
1961
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1962
|
+
fields?: string;
|
|
1963
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1964
|
+
key?: string;
|
|
1965
|
+
/** Required. The resource name of the conversation to retrieve. */
|
|
1966
|
+
name: string;
|
|
1967
|
+
/** OAuth 2.0 token for the current user. */
|
|
1968
|
+
oauth_token?: string;
|
|
1969
|
+
/** Returns response with indentations and line breaks. */
|
|
1970
|
+
prettyPrint?: boolean;
|
|
1971
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1972
|
+
quotaUser?: string;
|
|
1973
|
+
/** Optional. Indicate the source of the conversation. If not set, all source will be searched. */
|
|
1974
|
+
source?: string;
|
|
1975
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1976
|
+
upload_protocol?: string;
|
|
1977
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1978
|
+
uploadType?: string;
|
|
1979
|
+
}): Request<Conversation>;
|
|
1980
|
+
/** Lists conversations in the given app. */
|
|
1981
|
+
list(request?: {
|
|
1982
|
+
/** V1 error format. */
|
|
1983
|
+
'$.xgafv'?: string;
|
|
1984
|
+
/** OAuth access token. */
|
|
1985
|
+
access_token?: string;
|
|
1986
|
+
/** Data format for response. */
|
|
1987
|
+
alt?: string;
|
|
1988
|
+
/** JSONP */
|
|
1989
|
+
callback?: string;
|
|
1990
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1991
|
+
fields?: string;
|
|
1992
|
+
/** Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details. */
|
|
1993
|
+
filter?: string;
|
|
1994
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1995
|
+
key?: string;
|
|
1996
|
+
/** OAuth 2.0 token for the current user. */
|
|
1997
|
+
oauth_token?: string;
|
|
1998
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
1999
|
+
pageSize?: number;
|
|
2000
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListConversations call. */
|
|
2001
|
+
pageToken?: string;
|
|
2002
|
+
/** Required. The resource name of the app to list conversations from. */
|
|
2003
|
+
parent: string;
|
|
2004
|
+
/** Returns response with indentations and line breaks. */
|
|
2005
|
+
prettyPrint?: boolean;
|
|
2006
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2007
|
+
quotaUser?: string;
|
|
2008
|
+
/** Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. */
|
|
2009
|
+
source?: string;
|
|
2010
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2011
|
+
upload_protocol?: string;
|
|
2012
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2013
|
+
uploadType?: string;
|
|
2014
|
+
}): Request<ListConversationsResponse>;
|
|
2015
|
+
}
|
|
2016
|
+
interface DeploymentsResource {
|
|
2017
|
+
/** Creates a new deployment in the given app. */
|
|
2018
|
+
create(request: {
|
|
2019
|
+
/** V1 error format. */
|
|
2020
|
+
'$.xgafv'?: string;
|
|
2021
|
+
/** OAuth access token. */
|
|
2022
|
+
access_token?: string;
|
|
2023
|
+
/** Data format for response. */
|
|
2024
|
+
alt?: string;
|
|
2025
|
+
/** JSONP */
|
|
2026
|
+
callback?: string;
|
|
2027
|
+
/** Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. */
|
|
2028
|
+
deploymentId?: string;
|
|
2029
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2030
|
+
fields?: string;
|
|
2031
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2032
|
+
key?: string;
|
|
2033
|
+
/** OAuth 2.0 token for the current user. */
|
|
2034
|
+
oauth_token?: string;
|
|
2035
|
+
/** Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
2036
|
+
parent: string;
|
|
2037
|
+
/** Returns response with indentations and line breaks. */
|
|
2038
|
+
prettyPrint?: boolean;
|
|
2039
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2040
|
+
quotaUser?: string;
|
|
2041
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2042
|
+
upload_protocol?: string;
|
|
2043
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2044
|
+
uploadType?: string;
|
|
2045
|
+
/** Request body */
|
|
2046
|
+
resource: Deployment;
|
|
2047
|
+
}): Request<Deployment>;
|
|
2048
|
+
create(
|
|
2049
|
+
request: {
|
|
2050
|
+
/** V1 error format. */
|
|
2051
|
+
'$.xgafv'?: string;
|
|
2052
|
+
/** OAuth access token. */
|
|
2053
|
+
access_token?: string;
|
|
2054
|
+
/** Data format for response. */
|
|
2055
|
+
alt?: string;
|
|
2056
|
+
/** JSONP */
|
|
2057
|
+
callback?: string;
|
|
2058
|
+
/** Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. */
|
|
2059
|
+
deploymentId?: string;
|
|
2060
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2061
|
+
fields?: string;
|
|
2062
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2063
|
+
key?: string;
|
|
2064
|
+
/** OAuth 2.0 token for the current user. */
|
|
2065
|
+
oauth_token?: string;
|
|
2066
|
+
/** Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
2067
|
+
parent: string;
|
|
2068
|
+
/** Returns response with indentations and line breaks. */
|
|
2069
|
+
prettyPrint?: boolean;
|
|
2070
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2071
|
+
quotaUser?: string;
|
|
2072
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2073
|
+
upload_protocol?: string;
|
|
2074
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2075
|
+
uploadType?: string;
|
|
2076
|
+
},
|
|
2077
|
+
body: Deployment,
|
|
2078
|
+
): Request<Deployment>;
|
|
2079
|
+
/** Deletes the specified deployment. */
|
|
2080
|
+
delete(request?: {
|
|
2081
|
+
/** V1 error format. */
|
|
2082
|
+
'$.xgafv'?: string;
|
|
2083
|
+
/** OAuth access token. */
|
|
2084
|
+
access_token?: string;
|
|
2085
|
+
/** Data format for response. */
|
|
2086
|
+
alt?: string;
|
|
2087
|
+
/** JSONP */
|
|
2088
|
+
callback?: string;
|
|
2089
|
+
/** Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned. */
|
|
2090
|
+
etag?: string;
|
|
2091
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2092
|
+
fields?: string;
|
|
2093
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2094
|
+
key?: string;
|
|
2095
|
+
/** Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` */
|
|
2096
|
+
name: string;
|
|
2097
|
+
/** OAuth 2.0 token for the current user. */
|
|
2098
|
+
oauth_token?: string;
|
|
2099
|
+
/** Returns response with indentations and line breaks. */
|
|
2100
|
+
prettyPrint?: boolean;
|
|
2101
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2102
|
+
quotaUser?: string;
|
|
2103
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2104
|
+
upload_protocol?: string;
|
|
2105
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2106
|
+
uploadType?: string;
|
|
2107
|
+
}): Request<{}>;
|
|
2108
|
+
/** Gets details of the specified deployment. */
|
|
2109
|
+
get(request?: {
|
|
2110
|
+
/** V1 error format. */
|
|
2111
|
+
'$.xgafv'?: string;
|
|
2112
|
+
/** OAuth access token. */
|
|
2113
|
+
access_token?: string;
|
|
2114
|
+
/** Data format for response. */
|
|
2115
|
+
alt?: string;
|
|
2116
|
+
/** JSONP */
|
|
2117
|
+
callback?: string;
|
|
2118
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2119
|
+
fields?: string;
|
|
2120
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2121
|
+
key?: string;
|
|
2122
|
+
/** Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` */
|
|
2123
|
+
name: string;
|
|
2124
|
+
/** OAuth 2.0 token for the current user. */
|
|
2125
|
+
oauth_token?: string;
|
|
2126
|
+
/** Returns response with indentations and line breaks. */
|
|
2127
|
+
prettyPrint?: boolean;
|
|
2128
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2129
|
+
quotaUser?: string;
|
|
2130
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2131
|
+
upload_protocol?: string;
|
|
2132
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2133
|
+
uploadType?: string;
|
|
2134
|
+
}): Request<Deployment>;
|
|
2135
|
+
/** Lists deployments in the given app. */
|
|
2136
|
+
list(request?: {
|
|
2137
|
+
/** V1 error format. */
|
|
2138
|
+
'$.xgafv'?: string;
|
|
2139
|
+
/** OAuth access token. */
|
|
2140
|
+
access_token?: string;
|
|
2141
|
+
/** Data format for response. */
|
|
2142
|
+
alt?: string;
|
|
2143
|
+
/** JSONP */
|
|
2144
|
+
callback?: string;
|
|
2145
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2146
|
+
fields?: string;
|
|
2147
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2148
|
+
key?: string;
|
|
2149
|
+
/** OAuth 2.0 token for the current user. */
|
|
2150
|
+
oauth_token?: string;
|
|
2151
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
2152
|
+
orderBy?: string;
|
|
2153
|
+
/** Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
2154
|
+
pageSize?: number;
|
|
2155
|
+
/** Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token. */
|
|
2156
|
+
pageToken?: string;
|
|
2157
|
+
/** Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
2158
|
+
parent: string;
|
|
2159
|
+
/** Returns response with indentations and line breaks. */
|
|
2160
|
+
prettyPrint?: boolean;
|
|
2161
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2162
|
+
quotaUser?: string;
|
|
2163
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2164
|
+
upload_protocol?: string;
|
|
2165
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2166
|
+
uploadType?: string;
|
|
2167
|
+
}): Request<ListDeploymentsResponse>;
|
|
2168
|
+
/** Updates the specified deployment. */
|
|
2169
|
+
patch(request: {
|
|
2170
|
+
/** V1 error format. */
|
|
2171
|
+
'$.xgafv'?: string;
|
|
2172
|
+
/** OAuth access token. */
|
|
2173
|
+
access_token?: string;
|
|
2174
|
+
/** Data format for response. */
|
|
2175
|
+
alt?: string;
|
|
2176
|
+
/** JSONP */
|
|
2177
|
+
callback?: string;
|
|
2178
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2179
|
+
fields?: string;
|
|
2180
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2181
|
+
key?: string;
|
|
2182
|
+
/** Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} */
|
|
2183
|
+
name: string;
|
|
2184
|
+
/** OAuth 2.0 token for the current user. */
|
|
2185
|
+
oauth_token?: string;
|
|
2186
|
+
/** Returns response with indentations and line breaks. */
|
|
2187
|
+
prettyPrint?: boolean;
|
|
2188
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2189
|
+
quotaUser?: string;
|
|
2190
|
+
/** Optional. The list of fields to update. */
|
|
2191
|
+
updateMask?: string;
|
|
2192
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2193
|
+
upload_protocol?: string;
|
|
2194
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2195
|
+
uploadType?: string;
|
|
2196
|
+
/** Request body */
|
|
2197
|
+
resource: Deployment;
|
|
2198
|
+
}): Request<Deployment>;
|
|
2199
|
+
patch(
|
|
2200
|
+
request: {
|
|
2201
|
+
/** V1 error format. */
|
|
2202
|
+
'$.xgafv'?: string;
|
|
2203
|
+
/** OAuth access token. */
|
|
2204
|
+
access_token?: string;
|
|
2205
|
+
/** Data format for response. */
|
|
2206
|
+
alt?: string;
|
|
2207
|
+
/** JSONP */
|
|
2208
|
+
callback?: string;
|
|
2209
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2210
|
+
fields?: string;
|
|
2211
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2212
|
+
key?: string;
|
|
2213
|
+
/** Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} */
|
|
2214
|
+
name: string;
|
|
2215
|
+
/** OAuth 2.0 token for the current user. */
|
|
2216
|
+
oauth_token?: string;
|
|
2217
|
+
/** Returns response with indentations and line breaks. */
|
|
2218
|
+
prettyPrint?: boolean;
|
|
2219
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2220
|
+
quotaUser?: string;
|
|
2221
|
+
/** Optional. The list of fields to update. */
|
|
2222
|
+
updateMask?: string;
|
|
2223
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2224
|
+
upload_protocol?: string;
|
|
2225
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2226
|
+
uploadType?: string;
|
|
2227
|
+
},
|
|
2228
|
+
body: Deployment,
|
|
2229
|
+
): Request<Deployment>;
|
|
2230
|
+
}
|
|
2231
|
+
interface ExamplesResource {
|
|
2232
|
+
/** Creates a new example in the given app. */
|
|
2233
|
+
create(request: {
|
|
2234
|
+
/** V1 error format. */
|
|
2235
|
+
'$.xgafv'?: string;
|
|
2236
|
+
/** OAuth access token. */
|
|
2237
|
+
access_token?: string;
|
|
2238
|
+
/** Data format for response. */
|
|
2239
|
+
alt?: string;
|
|
2240
|
+
/** JSONP */
|
|
2241
|
+
callback?: string;
|
|
2242
|
+
/** Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. */
|
|
2243
|
+
exampleId?: string;
|
|
2244
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2245
|
+
fields?: string;
|
|
2246
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2247
|
+
key?: string;
|
|
2248
|
+
/** OAuth 2.0 token for the current user. */
|
|
2249
|
+
oauth_token?: string;
|
|
2250
|
+
/** Required. The resource name of the app to create an example in. */
|
|
2251
|
+
parent: string;
|
|
2252
|
+
/** Returns response with indentations and line breaks. */
|
|
2253
|
+
prettyPrint?: boolean;
|
|
2254
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2255
|
+
quotaUser?: string;
|
|
2256
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2257
|
+
upload_protocol?: string;
|
|
2258
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2259
|
+
uploadType?: string;
|
|
2260
|
+
/** Request body */
|
|
2261
|
+
resource: Example;
|
|
2262
|
+
}): Request<Example>;
|
|
2263
|
+
create(
|
|
2264
|
+
request: {
|
|
2265
|
+
/** V1 error format. */
|
|
2266
|
+
'$.xgafv'?: string;
|
|
2267
|
+
/** OAuth access token. */
|
|
2268
|
+
access_token?: string;
|
|
2269
|
+
/** Data format for response. */
|
|
2270
|
+
alt?: string;
|
|
2271
|
+
/** JSONP */
|
|
2272
|
+
callback?: string;
|
|
2273
|
+
/** Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. */
|
|
2274
|
+
exampleId?: string;
|
|
2275
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2276
|
+
fields?: string;
|
|
2277
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2278
|
+
key?: string;
|
|
2279
|
+
/** OAuth 2.0 token for the current user. */
|
|
2280
|
+
oauth_token?: string;
|
|
2281
|
+
/** Required. The resource name of the app to create an example in. */
|
|
2282
|
+
parent: string;
|
|
2283
|
+
/** Returns response with indentations and line breaks. */
|
|
2284
|
+
prettyPrint?: boolean;
|
|
2285
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2286
|
+
quotaUser?: string;
|
|
2287
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2288
|
+
upload_protocol?: string;
|
|
2289
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2290
|
+
uploadType?: string;
|
|
2291
|
+
},
|
|
2292
|
+
body: Example,
|
|
2293
|
+
): Request<Example>;
|
|
2294
|
+
/** Deletes the specified example. */
|
|
2295
|
+
delete(request?: {
|
|
2296
|
+
/** V1 error format. */
|
|
2297
|
+
'$.xgafv'?: string;
|
|
2298
|
+
/** OAuth access token. */
|
|
2299
|
+
access_token?: string;
|
|
2300
|
+
/** Data format for response. */
|
|
2301
|
+
alt?: string;
|
|
2302
|
+
/** JSONP */
|
|
2303
|
+
callback?: string;
|
|
2304
|
+
/** Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned. */
|
|
2305
|
+
etag?: string;
|
|
2306
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2307
|
+
fields?: string;
|
|
2308
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2309
|
+
key?: string;
|
|
2310
|
+
/** Required. The resource name of the example to delete. */
|
|
2311
|
+
name: string;
|
|
2312
|
+
/** OAuth 2.0 token for the current user. */
|
|
2313
|
+
oauth_token?: string;
|
|
2314
|
+
/** Returns response with indentations and line breaks. */
|
|
2315
|
+
prettyPrint?: boolean;
|
|
2316
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2317
|
+
quotaUser?: string;
|
|
2318
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2319
|
+
upload_protocol?: string;
|
|
2320
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2321
|
+
uploadType?: string;
|
|
2322
|
+
}): Request<{}>;
|
|
2323
|
+
/** Gets details of the specified example. */
|
|
2324
|
+
get(request?: {
|
|
2325
|
+
/** V1 error format. */
|
|
2326
|
+
'$.xgafv'?: string;
|
|
2327
|
+
/** OAuth access token. */
|
|
2328
|
+
access_token?: string;
|
|
2329
|
+
/** Data format for response. */
|
|
2330
|
+
alt?: string;
|
|
2331
|
+
/** JSONP */
|
|
2332
|
+
callback?: string;
|
|
2333
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2334
|
+
fields?: string;
|
|
2335
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2336
|
+
key?: string;
|
|
2337
|
+
/** Required. The resource name of the example to retrieve. */
|
|
2338
|
+
name: string;
|
|
2339
|
+
/** OAuth 2.0 token for the current user. */
|
|
2340
|
+
oauth_token?: string;
|
|
2341
|
+
/** Returns response with indentations and line breaks. */
|
|
2342
|
+
prettyPrint?: boolean;
|
|
2343
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2344
|
+
quotaUser?: string;
|
|
2345
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2346
|
+
upload_protocol?: string;
|
|
2347
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2348
|
+
uploadType?: string;
|
|
2349
|
+
}): Request<Example>;
|
|
2350
|
+
/** Lists examples in the given app. */
|
|
2351
|
+
list(request?: {
|
|
2352
|
+
/** V1 error format. */
|
|
2353
|
+
'$.xgafv'?: string;
|
|
2354
|
+
/** OAuth access token. */
|
|
2355
|
+
access_token?: string;
|
|
2356
|
+
/** Data format for response. */
|
|
2357
|
+
alt?: string;
|
|
2358
|
+
/** JSONP */
|
|
2359
|
+
callback?: string;
|
|
2360
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2361
|
+
fields?: string;
|
|
2362
|
+
/** Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details. */
|
|
2363
|
+
filter?: string;
|
|
2364
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2365
|
+
key?: string;
|
|
2366
|
+
/** OAuth 2.0 token for the current user. */
|
|
2367
|
+
oauth_token?: string;
|
|
2368
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
2369
|
+
orderBy?: string;
|
|
2370
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
2371
|
+
pageSize?: number;
|
|
2372
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListExamples call. */
|
|
2373
|
+
pageToken?: string;
|
|
2374
|
+
/** Required. The resource name of the app to list examples from. */
|
|
2375
|
+
parent: string;
|
|
2376
|
+
/** Returns response with indentations and line breaks. */
|
|
2377
|
+
prettyPrint?: boolean;
|
|
2378
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2379
|
+
quotaUser?: string;
|
|
2380
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2381
|
+
upload_protocol?: string;
|
|
2382
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2383
|
+
uploadType?: string;
|
|
2384
|
+
}): Request<ListExamplesResponse>;
|
|
2385
|
+
/** Updates the specified example. */
|
|
2386
|
+
patch(request: {
|
|
2387
|
+
/** V1 error format. */
|
|
2388
|
+
'$.xgafv'?: string;
|
|
2389
|
+
/** OAuth access token. */
|
|
2390
|
+
access_token?: string;
|
|
2391
|
+
/** Data format for response. */
|
|
2392
|
+
alt?: string;
|
|
2393
|
+
/** JSONP */
|
|
2394
|
+
callback?: string;
|
|
2395
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2396
|
+
fields?: string;
|
|
2397
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2398
|
+
key?: string;
|
|
2399
|
+
/** Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` */
|
|
2400
|
+
name: string;
|
|
2401
|
+
/** OAuth 2.0 token for the current user. */
|
|
2402
|
+
oauth_token?: string;
|
|
2403
|
+
/** Returns response with indentations and line breaks. */
|
|
2404
|
+
prettyPrint?: boolean;
|
|
2405
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2406
|
+
quotaUser?: string;
|
|
2407
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2408
|
+
updateMask?: string;
|
|
2409
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2410
|
+
upload_protocol?: string;
|
|
2411
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2412
|
+
uploadType?: string;
|
|
2413
|
+
/** Request body */
|
|
2414
|
+
resource: Example;
|
|
2415
|
+
}): Request<Example>;
|
|
2416
|
+
patch(
|
|
2417
|
+
request: {
|
|
2418
|
+
/** V1 error format. */
|
|
2419
|
+
'$.xgafv'?: string;
|
|
2420
|
+
/** OAuth access token. */
|
|
2421
|
+
access_token?: string;
|
|
2422
|
+
/** Data format for response. */
|
|
2423
|
+
alt?: string;
|
|
2424
|
+
/** JSONP */
|
|
2425
|
+
callback?: string;
|
|
2426
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2427
|
+
fields?: string;
|
|
2428
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2429
|
+
key?: string;
|
|
2430
|
+
/** Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` */
|
|
2431
|
+
name: string;
|
|
2432
|
+
/** OAuth 2.0 token for the current user. */
|
|
2433
|
+
oauth_token?: string;
|
|
2434
|
+
/** Returns response with indentations and line breaks. */
|
|
2435
|
+
prettyPrint?: boolean;
|
|
2436
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2437
|
+
quotaUser?: string;
|
|
2438
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2439
|
+
updateMask?: string;
|
|
2440
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2441
|
+
upload_protocol?: string;
|
|
2442
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2443
|
+
uploadType?: string;
|
|
2444
|
+
},
|
|
2445
|
+
body: Example,
|
|
2446
|
+
): Request<Example>;
|
|
2447
|
+
}
|
|
2448
|
+
interface GuardrailsResource {
|
|
2449
|
+
/** Creates a new guardrail in the given app. */
|
|
2450
|
+
create(request: {
|
|
2451
|
+
/** V1 error format. */
|
|
2452
|
+
'$.xgafv'?: string;
|
|
2453
|
+
/** OAuth access token. */
|
|
2454
|
+
access_token?: string;
|
|
2455
|
+
/** Data format for response. */
|
|
2456
|
+
alt?: string;
|
|
2457
|
+
/** JSONP */
|
|
2458
|
+
callback?: string;
|
|
2459
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2460
|
+
fields?: string;
|
|
2461
|
+
/** Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. */
|
|
2462
|
+
guardrailId?: string;
|
|
2463
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2464
|
+
key?: string;
|
|
2465
|
+
/** OAuth 2.0 token for the current user. */
|
|
2466
|
+
oauth_token?: string;
|
|
2467
|
+
/** Required. The resource name of the app to create a guardrail in. */
|
|
2468
|
+
parent: string;
|
|
2469
|
+
/** Returns response with indentations and line breaks. */
|
|
2470
|
+
prettyPrint?: boolean;
|
|
2471
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2472
|
+
quotaUser?: string;
|
|
2473
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2474
|
+
upload_protocol?: string;
|
|
2475
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2476
|
+
uploadType?: string;
|
|
2477
|
+
/** Request body */
|
|
2478
|
+
resource: Guardrail;
|
|
2479
|
+
}): Request<Guardrail>;
|
|
2480
|
+
create(
|
|
2481
|
+
request: {
|
|
2482
|
+
/** V1 error format. */
|
|
2483
|
+
'$.xgafv'?: string;
|
|
2484
|
+
/** OAuth access token. */
|
|
2485
|
+
access_token?: string;
|
|
2486
|
+
/** Data format for response. */
|
|
2487
|
+
alt?: string;
|
|
2488
|
+
/** JSONP */
|
|
2489
|
+
callback?: string;
|
|
2490
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2491
|
+
fields?: string;
|
|
2492
|
+
/** Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. */
|
|
2493
|
+
guardrailId?: string;
|
|
2494
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2495
|
+
key?: string;
|
|
2496
|
+
/** OAuth 2.0 token for the current user. */
|
|
2497
|
+
oauth_token?: string;
|
|
2498
|
+
/** Required. The resource name of the app to create a guardrail in. */
|
|
2499
|
+
parent: string;
|
|
2500
|
+
/** Returns response with indentations and line breaks. */
|
|
2501
|
+
prettyPrint?: boolean;
|
|
2502
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2503
|
+
quotaUser?: string;
|
|
2504
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2505
|
+
upload_protocol?: string;
|
|
2506
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2507
|
+
uploadType?: string;
|
|
2508
|
+
},
|
|
2509
|
+
body: Guardrail,
|
|
2510
|
+
): Request<Guardrail>;
|
|
2511
|
+
/** Deletes the specified guardrail. */
|
|
2512
|
+
delete(request?: {
|
|
2513
|
+
/** V1 error format. */
|
|
2514
|
+
'$.xgafv'?: string;
|
|
2515
|
+
/** OAuth access token. */
|
|
2516
|
+
access_token?: string;
|
|
2517
|
+
/** Data format for response. */
|
|
2518
|
+
alt?: string;
|
|
2519
|
+
/** JSONP */
|
|
2520
|
+
callback?: string;
|
|
2521
|
+
/** Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned. */
|
|
2522
|
+
etag?: string;
|
|
2523
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2524
|
+
fields?: string;
|
|
2525
|
+
/** Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted. */
|
|
2526
|
+
force?: boolean;
|
|
2527
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2528
|
+
key?: string;
|
|
2529
|
+
/** Required. The resource name of the guardrail to delete. */
|
|
2530
|
+
name: string;
|
|
2531
|
+
/** OAuth 2.0 token for the current user. */
|
|
2532
|
+
oauth_token?: string;
|
|
2533
|
+
/** Returns response with indentations and line breaks. */
|
|
2534
|
+
prettyPrint?: boolean;
|
|
2535
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2536
|
+
quotaUser?: string;
|
|
2537
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2538
|
+
upload_protocol?: string;
|
|
2539
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2540
|
+
uploadType?: string;
|
|
2541
|
+
}): Request<{}>;
|
|
2542
|
+
/** Gets details of the specified guardrail. */
|
|
2543
|
+
get(request?: {
|
|
2544
|
+
/** V1 error format. */
|
|
2545
|
+
'$.xgafv'?: string;
|
|
2546
|
+
/** OAuth access token. */
|
|
2547
|
+
access_token?: string;
|
|
2548
|
+
/** Data format for response. */
|
|
2549
|
+
alt?: string;
|
|
2550
|
+
/** JSONP */
|
|
2551
|
+
callback?: string;
|
|
2552
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2553
|
+
fields?: string;
|
|
2554
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2555
|
+
key?: string;
|
|
2556
|
+
/** Required. The resource name of the guardrail to retrieve. */
|
|
2557
|
+
name: string;
|
|
2558
|
+
/** OAuth 2.0 token for the current user. */
|
|
2559
|
+
oauth_token?: string;
|
|
2560
|
+
/** Returns response with indentations and line breaks. */
|
|
2561
|
+
prettyPrint?: boolean;
|
|
2562
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2563
|
+
quotaUser?: string;
|
|
2564
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2565
|
+
upload_protocol?: string;
|
|
2566
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2567
|
+
uploadType?: string;
|
|
2568
|
+
}): Request<Guardrail>;
|
|
2569
|
+
/** Lists guardrails in the given app. */
|
|
2570
|
+
list(request?: {
|
|
2571
|
+
/** V1 error format. */
|
|
2572
|
+
'$.xgafv'?: string;
|
|
2573
|
+
/** OAuth access token. */
|
|
2574
|
+
access_token?: string;
|
|
2575
|
+
/** Data format for response. */
|
|
2576
|
+
alt?: string;
|
|
2577
|
+
/** JSONP */
|
|
2578
|
+
callback?: string;
|
|
2579
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2580
|
+
fields?: string;
|
|
2581
|
+
/** Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details. */
|
|
2582
|
+
filter?: string;
|
|
2583
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2584
|
+
key?: string;
|
|
2585
|
+
/** OAuth 2.0 token for the current user. */
|
|
2586
|
+
oauth_token?: string;
|
|
2587
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
2588
|
+
orderBy?: string;
|
|
2589
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
2590
|
+
pageSize?: number;
|
|
2591
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call. */
|
|
2592
|
+
pageToken?: string;
|
|
2593
|
+
/** Required. The resource name of the app to list guardrails from. */
|
|
2594
|
+
parent: string;
|
|
2595
|
+
/** Returns response with indentations and line breaks. */
|
|
2596
|
+
prettyPrint?: boolean;
|
|
2597
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2598
|
+
quotaUser?: string;
|
|
2599
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2600
|
+
upload_protocol?: string;
|
|
2601
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2602
|
+
uploadType?: string;
|
|
2603
|
+
}): Request<ListGuardrailsResponse>;
|
|
2604
|
+
/** Updates the specified guardrail. */
|
|
2605
|
+
patch(request: {
|
|
2606
|
+
/** V1 error format. */
|
|
2607
|
+
'$.xgafv'?: string;
|
|
2608
|
+
/** OAuth access token. */
|
|
2609
|
+
access_token?: string;
|
|
2610
|
+
/** Data format for response. */
|
|
2611
|
+
alt?: string;
|
|
2612
|
+
/** JSONP */
|
|
2613
|
+
callback?: string;
|
|
2614
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2615
|
+
fields?: string;
|
|
2616
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2617
|
+
key?: string;
|
|
2618
|
+
/** Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` */
|
|
2619
|
+
name: string;
|
|
2620
|
+
/** OAuth 2.0 token for the current user. */
|
|
2621
|
+
oauth_token?: string;
|
|
2622
|
+
/** Returns response with indentations and line breaks. */
|
|
2623
|
+
prettyPrint?: boolean;
|
|
2624
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2625
|
+
quotaUser?: string;
|
|
2626
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2627
|
+
updateMask?: string;
|
|
2628
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2629
|
+
upload_protocol?: string;
|
|
2630
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2631
|
+
uploadType?: string;
|
|
2632
|
+
/** Request body */
|
|
2633
|
+
resource: Guardrail;
|
|
2634
|
+
}): Request<Guardrail>;
|
|
2635
|
+
patch(
|
|
2636
|
+
request: {
|
|
2637
|
+
/** V1 error format. */
|
|
2638
|
+
'$.xgafv'?: string;
|
|
2639
|
+
/** OAuth access token. */
|
|
2640
|
+
access_token?: string;
|
|
2641
|
+
/** Data format for response. */
|
|
2642
|
+
alt?: string;
|
|
2643
|
+
/** JSONP */
|
|
2644
|
+
callback?: string;
|
|
2645
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2646
|
+
fields?: string;
|
|
2647
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2648
|
+
key?: string;
|
|
2649
|
+
/** Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` */
|
|
2650
|
+
name: string;
|
|
2651
|
+
/** OAuth 2.0 token for the current user. */
|
|
2652
|
+
oauth_token?: string;
|
|
2653
|
+
/** Returns response with indentations and line breaks. */
|
|
2654
|
+
prettyPrint?: boolean;
|
|
2655
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2656
|
+
quotaUser?: string;
|
|
2657
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2658
|
+
updateMask?: string;
|
|
2659
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2660
|
+
upload_protocol?: string;
|
|
2661
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2662
|
+
uploadType?: string;
|
|
2663
|
+
},
|
|
2664
|
+
body: Guardrail,
|
|
2665
|
+
): Request<Guardrail>;
|
|
2666
|
+
}
|
|
2667
|
+
interface SessionsResource {
|
|
2668
|
+
/** Generates a session scoped token for chat widget to authenticate with Session APIs. */
|
|
2669
|
+
generateChatToken(request: {
|
|
2670
|
+
/** V1 error format. */
|
|
2671
|
+
'$.xgafv'?: string;
|
|
2672
|
+
/** OAuth access token. */
|
|
2673
|
+
access_token?: string;
|
|
2674
|
+
/** Data format for response. */
|
|
2675
|
+
alt?: string;
|
|
2676
|
+
/** JSONP */
|
|
2677
|
+
callback?: string;
|
|
2678
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2679
|
+
fields?: string;
|
|
2680
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2681
|
+
key?: string;
|
|
2682
|
+
/** Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session} */
|
|
2683
|
+
name: string;
|
|
2684
|
+
/** OAuth 2.0 token for the current user. */
|
|
2685
|
+
oauth_token?: string;
|
|
2686
|
+
/** Returns response with indentations and line breaks. */
|
|
2687
|
+
prettyPrint?: boolean;
|
|
2688
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2689
|
+
quotaUser?: string;
|
|
2690
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2691
|
+
upload_protocol?: string;
|
|
2692
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2693
|
+
uploadType?: string;
|
|
2694
|
+
/** Request body */
|
|
2695
|
+
resource: GenerateChatTokenRequest;
|
|
2696
|
+
}): Request<GenerateChatTokenResponse>;
|
|
2697
|
+
generateChatToken(
|
|
2698
|
+
request: {
|
|
2699
|
+
/** V1 error format. */
|
|
2700
|
+
'$.xgafv'?: string;
|
|
2701
|
+
/** OAuth access token. */
|
|
2702
|
+
access_token?: string;
|
|
2703
|
+
/** Data format for response. */
|
|
2704
|
+
alt?: string;
|
|
2705
|
+
/** JSONP */
|
|
2706
|
+
callback?: string;
|
|
2707
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2708
|
+
fields?: string;
|
|
2709
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2710
|
+
key?: string;
|
|
2711
|
+
/** Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session} */
|
|
2712
|
+
name: string;
|
|
2713
|
+
/** OAuth 2.0 token for the current user. */
|
|
2714
|
+
oauth_token?: string;
|
|
2715
|
+
/** Returns response with indentations and line breaks. */
|
|
2716
|
+
prettyPrint?: boolean;
|
|
2717
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2718
|
+
quotaUser?: string;
|
|
2719
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2720
|
+
upload_protocol?: string;
|
|
2721
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2722
|
+
uploadType?: string;
|
|
2723
|
+
},
|
|
2724
|
+
body: GenerateChatTokenRequest,
|
|
2725
|
+
): Request<GenerateChatTokenResponse>;
|
|
2726
|
+
/** Initiates a single turn interaction with the CES agent within a session. */
|
|
2727
|
+
runSession(request: {
|
|
2728
|
+
/** V1 error format. */
|
|
2729
|
+
'$.xgafv'?: string;
|
|
2730
|
+
/** OAuth access token. */
|
|
2731
|
+
access_token?: string;
|
|
2732
|
+
/** Data format for response. */
|
|
2733
|
+
alt?: string;
|
|
2734
|
+
/** JSONP */
|
|
2735
|
+
callback?: string;
|
|
2736
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2737
|
+
fields?: string;
|
|
2738
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2739
|
+
key?: string;
|
|
2740
|
+
/** OAuth 2.0 token for the current user. */
|
|
2741
|
+
oauth_token?: string;
|
|
2742
|
+
/** Returns response with indentations and line breaks. */
|
|
2743
|
+
prettyPrint?: boolean;
|
|
2744
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2745
|
+
quotaUser?: string;
|
|
2746
|
+
/** Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` */
|
|
2747
|
+
session: string;
|
|
2748
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2749
|
+
upload_protocol?: string;
|
|
2750
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2751
|
+
uploadType?: string;
|
|
2752
|
+
/** Request body */
|
|
2753
|
+
resource: RunSessionRequest;
|
|
2754
|
+
}): Request<RunSessionResponse>;
|
|
2755
|
+
runSession(
|
|
2756
|
+
request: {
|
|
2757
|
+
/** V1 error format. */
|
|
2758
|
+
'$.xgafv'?: string;
|
|
2759
|
+
/** OAuth access token. */
|
|
2760
|
+
access_token?: string;
|
|
2761
|
+
/** Data format for response. */
|
|
2762
|
+
alt?: string;
|
|
2763
|
+
/** JSONP */
|
|
2764
|
+
callback?: string;
|
|
2765
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2766
|
+
fields?: string;
|
|
2767
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2768
|
+
key?: string;
|
|
2769
|
+
/** OAuth 2.0 token for the current user. */
|
|
2770
|
+
oauth_token?: string;
|
|
2771
|
+
/** Returns response with indentations and line breaks. */
|
|
2772
|
+
prettyPrint?: boolean;
|
|
2773
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2774
|
+
quotaUser?: string;
|
|
2775
|
+
/** Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` */
|
|
2776
|
+
session: string;
|
|
2777
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2778
|
+
upload_protocol?: string;
|
|
2779
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2780
|
+
uploadType?: string;
|
|
2781
|
+
},
|
|
2782
|
+
body: RunSessionRequest,
|
|
2783
|
+
): Request<RunSessionResponse>;
|
|
2784
|
+
}
|
|
2785
|
+
interface ToolsResource {
|
|
2786
|
+
/** Creates a new tool in the given app. */
|
|
2787
|
+
create(request: {
|
|
2788
|
+
/** V1 error format. */
|
|
2789
|
+
'$.xgafv'?: string;
|
|
2790
|
+
/** OAuth access token. */
|
|
2791
|
+
access_token?: string;
|
|
2792
|
+
/** Data format for response. */
|
|
2793
|
+
alt?: string;
|
|
2794
|
+
/** JSONP */
|
|
2795
|
+
callback?: string;
|
|
2796
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2797
|
+
fields?: string;
|
|
2798
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2799
|
+
key?: string;
|
|
2800
|
+
/** OAuth 2.0 token for the current user. */
|
|
2801
|
+
oauth_token?: string;
|
|
2802
|
+
/** Required. The resource name of the app to create a tool in. */
|
|
2803
|
+
parent: string;
|
|
2804
|
+
/** Returns response with indentations and line breaks. */
|
|
2805
|
+
prettyPrint?: boolean;
|
|
2806
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2807
|
+
quotaUser?: string;
|
|
2808
|
+
/** Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. */
|
|
2809
|
+
toolId?: string;
|
|
2810
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2811
|
+
upload_protocol?: string;
|
|
2812
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2813
|
+
uploadType?: string;
|
|
2814
|
+
/** Request body */
|
|
2815
|
+
resource: Tool;
|
|
2816
|
+
}): Request<Tool>;
|
|
2817
|
+
create(
|
|
2818
|
+
request: {
|
|
2819
|
+
/** V1 error format. */
|
|
2820
|
+
'$.xgafv'?: string;
|
|
2821
|
+
/** OAuth access token. */
|
|
2822
|
+
access_token?: string;
|
|
2823
|
+
/** Data format for response. */
|
|
2824
|
+
alt?: string;
|
|
2825
|
+
/** JSONP */
|
|
2826
|
+
callback?: string;
|
|
2827
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2828
|
+
fields?: string;
|
|
2829
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2830
|
+
key?: string;
|
|
2831
|
+
/** OAuth 2.0 token for the current user. */
|
|
2832
|
+
oauth_token?: string;
|
|
2833
|
+
/** Required. The resource name of the app to create a tool in. */
|
|
2834
|
+
parent: string;
|
|
2835
|
+
/** Returns response with indentations and line breaks. */
|
|
2836
|
+
prettyPrint?: boolean;
|
|
2837
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2838
|
+
quotaUser?: string;
|
|
2839
|
+
/** Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. */
|
|
2840
|
+
toolId?: string;
|
|
2841
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2842
|
+
upload_protocol?: string;
|
|
2843
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2844
|
+
uploadType?: string;
|
|
2845
|
+
},
|
|
2846
|
+
body: Tool,
|
|
2847
|
+
): Request<Tool>;
|
|
2848
|
+
/** Deletes the specified tool. */
|
|
2849
|
+
delete(request?: {
|
|
2850
|
+
/** V1 error format. */
|
|
2851
|
+
'$.xgafv'?: string;
|
|
2852
|
+
/** OAuth access token. */
|
|
2853
|
+
access_token?: string;
|
|
2854
|
+
/** Data format for response. */
|
|
2855
|
+
alt?: string;
|
|
2856
|
+
/** JSONP */
|
|
2857
|
+
callback?: string;
|
|
2858
|
+
/** Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned. */
|
|
2859
|
+
etag?: string;
|
|
2860
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2861
|
+
fields?: string;
|
|
2862
|
+
/** Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted. */
|
|
2863
|
+
force?: boolean;
|
|
2864
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2865
|
+
key?: string;
|
|
2866
|
+
/** Required. The resource name of the tool to delete. */
|
|
2867
|
+
name: string;
|
|
2868
|
+
/** OAuth 2.0 token for the current user. */
|
|
2869
|
+
oauth_token?: string;
|
|
2870
|
+
/** Returns response with indentations and line breaks. */
|
|
2871
|
+
prettyPrint?: boolean;
|
|
2872
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2873
|
+
quotaUser?: string;
|
|
2874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2875
|
+
upload_protocol?: string;
|
|
2876
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2877
|
+
uploadType?: string;
|
|
2878
|
+
}): Request<{}>;
|
|
2879
|
+
/** Gets details of the specified tool. */
|
|
2880
|
+
get(request?: {
|
|
2881
|
+
/** V1 error format. */
|
|
2882
|
+
'$.xgafv'?: string;
|
|
2883
|
+
/** OAuth access token. */
|
|
2884
|
+
access_token?: string;
|
|
2885
|
+
/** Data format for response. */
|
|
2886
|
+
alt?: string;
|
|
2887
|
+
/** JSONP */
|
|
2888
|
+
callback?: string;
|
|
2889
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2890
|
+
fields?: string;
|
|
2891
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2892
|
+
key?: string;
|
|
2893
|
+
/** Required. The resource name of the tool to retrieve. */
|
|
2894
|
+
name: string;
|
|
2895
|
+
/** OAuth 2.0 token for the current user. */
|
|
2896
|
+
oauth_token?: string;
|
|
2897
|
+
/** Returns response with indentations and line breaks. */
|
|
2898
|
+
prettyPrint?: boolean;
|
|
2899
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2900
|
+
quotaUser?: string;
|
|
2901
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2902
|
+
upload_protocol?: string;
|
|
2903
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2904
|
+
uploadType?: string;
|
|
2905
|
+
}): Request<Tool>;
|
|
2906
|
+
/** Lists tools in the given app. */
|
|
2907
|
+
list(request?: {
|
|
2908
|
+
/** V1 error format. */
|
|
2909
|
+
'$.xgafv'?: string;
|
|
2910
|
+
/** OAuth access token. */
|
|
2911
|
+
access_token?: string;
|
|
2912
|
+
/** Data format for response. */
|
|
2913
|
+
alt?: string;
|
|
2914
|
+
/** JSONP */
|
|
2915
|
+
callback?: string;
|
|
2916
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2917
|
+
fields?: string;
|
|
2918
|
+
/** Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details. */
|
|
2919
|
+
filter?: string;
|
|
2920
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2921
|
+
key?: string;
|
|
2922
|
+
/** OAuth 2.0 token for the current user. */
|
|
2923
|
+
oauth_token?: string;
|
|
2924
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
2925
|
+
orderBy?: string;
|
|
2926
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
2927
|
+
pageSize?: number;
|
|
2928
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListTools call. */
|
|
2929
|
+
pageToken?: string;
|
|
2930
|
+
/** Required. The resource name of the app to list tools from. */
|
|
2931
|
+
parent: string;
|
|
2932
|
+
/** Returns response with indentations and line breaks. */
|
|
2933
|
+
prettyPrint?: boolean;
|
|
2934
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2935
|
+
quotaUser?: string;
|
|
2936
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2937
|
+
upload_protocol?: string;
|
|
2938
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2939
|
+
uploadType?: string;
|
|
2940
|
+
}): Request<ListToolsResponse>;
|
|
2941
|
+
/** Updates the specified tool. */
|
|
2942
|
+
patch(request: {
|
|
2943
|
+
/** V1 error format. */
|
|
2944
|
+
'$.xgafv'?: string;
|
|
2945
|
+
/** OAuth access token. */
|
|
2946
|
+
access_token?: string;
|
|
2947
|
+
/** Data format for response. */
|
|
2948
|
+
alt?: string;
|
|
2949
|
+
/** JSONP */
|
|
2950
|
+
callback?: string;
|
|
2951
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2952
|
+
fields?: string;
|
|
2953
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2954
|
+
key?: string;
|
|
2955
|
+
/** Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. */
|
|
2956
|
+
name: string;
|
|
2957
|
+
/** OAuth 2.0 token for the current user. */
|
|
2958
|
+
oauth_token?: string;
|
|
2959
|
+
/** Returns response with indentations and line breaks. */
|
|
2960
|
+
prettyPrint?: boolean;
|
|
2961
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2962
|
+
quotaUser?: string;
|
|
2963
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2964
|
+
updateMask?: string;
|
|
2965
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2966
|
+
upload_protocol?: string;
|
|
2967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2968
|
+
uploadType?: string;
|
|
2969
|
+
/** Request body */
|
|
2970
|
+
resource: Tool;
|
|
2971
|
+
}): Request<Tool>;
|
|
2972
|
+
patch(
|
|
2973
|
+
request: {
|
|
2974
|
+
/** V1 error format. */
|
|
2975
|
+
'$.xgafv'?: string;
|
|
2976
|
+
/** OAuth access token. */
|
|
2977
|
+
access_token?: string;
|
|
2978
|
+
/** Data format for response. */
|
|
2979
|
+
alt?: string;
|
|
2980
|
+
/** JSONP */
|
|
2981
|
+
callback?: string;
|
|
2982
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2983
|
+
fields?: string;
|
|
2984
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2985
|
+
key?: string;
|
|
2986
|
+
/** Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. */
|
|
2987
|
+
name: string;
|
|
2988
|
+
/** OAuth 2.0 token for the current user. */
|
|
2989
|
+
oauth_token?: string;
|
|
2990
|
+
/** Returns response with indentations and line breaks. */
|
|
2991
|
+
prettyPrint?: boolean;
|
|
2992
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2993
|
+
quotaUser?: string;
|
|
2994
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
2995
|
+
updateMask?: string;
|
|
2996
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2997
|
+
upload_protocol?: string;
|
|
2998
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2999
|
+
uploadType?: string;
|
|
3000
|
+
},
|
|
3001
|
+
body: Tool,
|
|
3002
|
+
): Request<Tool>;
|
|
3003
|
+
}
|
|
3004
|
+
interface ToolsetsResource {
|
|
3005
|
+
/** Creates a new toolset in the given app. */
|
|
3006
|
+
create(request: {
|
|
3007
|
+
/** V1 error format. */
|
|
3008
|
+
'$.xgafv'?: string;
|
|
3009
|
+
/** OAuth access token. */
|
|
3010
|
+
access_token?: string;
|
|
3011
|
+
/** Data format for response. */
|
|
3012
|
+
alt?: string;
|
|
3013
|
+
/** JSONP */
|
|
3014
|
+
callback?: string;
|
|
3015
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3016
|
+
fields?: string;
|
|
3017
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3018
|
+
key?: string;
|
|
3019
|
+
/** OAuth 2.0 token for the current user. */
|
|
3020
|
+
oauth_token?: string;
|
|
3021
|
+
/** Required. The resource name of the app to create a toolset in. */
|
|
3022
|
+
parent: string;
|
|
3023
|
+
/** Returns response with indentations and line breaks. */
|
|
3024
|
+
prettyPrint?: boolean;
|
|
3025
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3026
|
+
quotaUser?: string;
|
|
3027
|
+
/** Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. */
|
|
3028
|
+
toolsetId?: string;
|
|
3029
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3030
|
+
upload_protocol?: string;
|
|
3031
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3032
|
+
uploadType?: string;
|
|
3033
|
+
/** Request body */
|
|
3034
|
+
resource: Toolset;
|
|
3035
|
+
}): Request<Toolset>;
|
|
3036
|
+
create(
|
|
3037
|
+
request: {
|
|
3038
|
+
/** V1 error format. */
|
|
3039
|
+
'$.xgafv'?: string;
|
|
3040
|
+
/** OAuth access token. */
|
|
3041
|
+
access_token?: string;
|
|
3042
|
+
/** Data format for response. */
|
|
3043
|
+
alt?: string;
|
|
3044
|
+
/** JSONP */
|
|
3045
|
+
callback?: string;
|
|
3046
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3047
|
+
fields?: string;
|
|
3048
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3049
|
+
key?: string;
|
|
3050
|
+
/** OAuth 2.0 token for the current user. */
|
|
3051
|
+
oauth_token?: string;
|
|
3052
|
+
/** Required. The resource name of the app to create a toolset in. */
|
|
3053
|
+
parent: string;
|
|
3054
|
+
/** Returns response with indentations and line breaks. */
|
|
3055
|
+
prettyPrint?: boolean;
|
|
3056
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3057
|
+
quotaUser?: string;
|
|
3058
|
+
/** Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. */
|
|
3059
|
+
toolsetId?: string;
|
|
3060
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3061
|
+
upload_protocol?: string;
|
|
3062
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3063
|
+
uploadType?: string;
|
|
3064
|
+
},
|
|
3065
|
+
body: Toolset,
|
|
3066
|
+
): Request<Toolset>;
|
|
3067
|
+
/** Deletes the specified toolset. */
|
|
3068
|
+
delete(request?: {
|
|
3069
|
+
/** V1 error format. */
|
|
3070
|
+
'$.xgafv'?: string;
|
|
3071
|
+
/** OAuth access token. */
|
|
3072
|
+
access_token?: string;
|
|
3073
|
+
/** Data format for response. */
|
|
3074
|
+
alt?: string;
|
|
3075
|
+
/** JSONP */
|
|
3076
|
+
callback?: string;
|
|
3077
|
+
/** Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned. */
|
|
3078
|
+
etag?: string;
|
|
3079
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3080
|
+
fields?: string;
|
|
3081
|
+
/** Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted. */
|
|
3082
|
+
force?: boolean;
|
|
3083
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3084
|
+
key?: string;
|
|
3085
|
+
/** Required. The resource name of the toolset to delete. */
|
|
3086
|
+
name: string;
|
|
3087
|
+
/** OAuth 2.0 token for the current user. */
|
|
3088
|
+
oauth_token?: string;
|
|
3089
|
+
/** Returns response with indentations and line breaks. */
|
|
3090
|
+
prettyPrint?: boolean;
|
|
3091
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3092
|
+
quotaUser?: string;
|
|
3093
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3094
|
+
upload_protocol?: string;
|
|
3095
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3096
|
+
uploadType?: string;
|
|
3097
|
+
}): Request<{}>;
|
|
3098
|
+
/** Gets details of the specified toolset. */
|
|
3099
|
+
get(request?: {
|
|
3100
|
+
/** V1 error format. */
|
|
3101
|
+
'$.xgafv'?: string;
|
|
3102
|
+
/** OAuth access token. */
|
|
3103
|
+
access_token?: string;
|
|
3104
|
+
/** Data format for response. */
|
|
3105
|
+
alt?: string;
|
|
3106
|
+
/** JSONP */
|
|
3107
|
+
callback?: string;
|
|
3108
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3109
|
+
fields?: string;
|
|
3110
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3111
|
+
key?: string;
|
|
3112
|
+
/** Required. The resource name of the toolset to retrieve. */
|
|
3113
|
+
name: string;
|
|
3114
|
+
/** OAuth 2.0 token for the current user. */
|
|
3115
|
+
oauth_token?: string;
|
|
3116
|
+
/** Returns response with indentations and line breaks. */
|
|
3117
|
+
prettyPrint?: boolean;
|
|
3118
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3119
|
+
quotaUser?: string;
|
|
3120
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3121
|
+
upload_protocol?: string;
|
|
3122
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3123
|
+
uploadType?: string;
|
|
3124
|
+
}): Request<Toolset>;
|
|
3125
|
+
/** Lists toolsets in the given app. */
|
|
3126
|
+
list(request?: {
|
|
3127
|
+
/** V1 error format. */
|
|
3128
|
+
'$.xgafv'?: string;
|
|
3129
|
+
/** OAuth access token. */
|
|
3130
|
+
access_token?: string;
|
|
3131
|
+
/** Data format for response. */
|
|
3132
|
+
alt?: string;
|
|
3133
|
+
/** JSONP */
|
|
3134
|
+
callback?: string;
|
|
3135
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3136
|
+
fields?: string;
|
|
3137
|
+
/** Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details. */
|
|
3138
|
+
filter?: string;
|
|
3139
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3140
|
+
key?: string;
|
|
3141
|
+
/** OAuth 2.0 token for the current user. */
|
|
3142
|
+
oauth_token?: string;
|
|
3143
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
3144
|
+
orderBy?: string;
|
|
3145
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
3146
|
+
pageSize?: number;
|
|
3147
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call. */
|
|
3148
|
+
pageToken?: string;
|
|
3149
|
+
/** Required. The resource name of the app to list toolsets from. */
|
|
3150
|
+
parent: string;
|
|
3151
|
+
/** Returns response with indentations and line breaks. */
|
|
3152
|
+
prettyPrint?: boolean;
|
|
3153
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3154
|
+
quotaUser?: string;
|
|
3155
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3156
|
+
upload_protocol?: string;
|
|
3157
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3158
|
+
uploadType?: string;
|
|
3159
|
+
}): Request<ListToolsetsResponse>;
|
|
3160
|
+
/** Updates the specified toolset. */
|
|
3161
|
+
patch(request: {
|
|
3162
|
+
/** V1 error format. */
|
|
3163
|
+
'$.xgafv'?: string;
|
|
3164
|
+
/** OAuth access token. */
|
|
3165
|
+
access_token?: string;
|
|
3166
|
+
/** Data format for response. */
|
|
3167
|
+
alt?: string;
|
|
3168
|
+
/** JSONP */
|
|
3169
|
+
callback?: string;
|
|
3170
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3171
|
+
fields?: string;
|
|
3172
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3173
|
+
key?: string;
|
|
3174
|
+
/** Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
3175
|
+
name: string;
|
|
3176
|
+
/** OAuth 2.0 token for the current user. */
|
|
3177
|
+
oauth_token?: string;
|
|
3178
|
+
/** Returns response with indentations and line breaks. */
|
|
3179
|
+
prettyPrint?: boolean;
|
|
3180
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3181
|
+
quotaUser?: string;
|
|
3182
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
3183
|
+
updateMask?: string;
|
|
3184
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3185
|
+
upload_protocol?: string;
|
|
3186
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3187
|
+
uploadType?: string;
|
|
3188
|
+
/** Request body */
|
|
3189
|
+
resource: Toolset;
|
|
3190
|
+
}): Request<Toolset>;
|
|
3191
|
+
patch(
|
|
3192
|
+
request: {
|
|
3193
|
+
/** V1 error format. */
|
|
3194
|
+
'$.xgafv'?: string;
|
|
3195
|
+
/** OAuth access token. */
|
|
3196
|
+
access_token?: string;
|
|
3197
|
+
/** Data format for response. */
|
|
3198
|
+
alt?: string;
|
|
3199
|
+
/** JSONP */
|
|
3200
|
+
callback?: string;
|
|
3201
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3202
|
+
fields?: string;
|
|
3203
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3204
|
+
key?: string;
|
|
3205
|
+
/** Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
3206
|
+
name: string;
|
|
3207
|
+
/** OAuth 2.0 token for the current user. */
|
|
3208
|
+
oauth_token?: string;
|
|
3209
|
+
/** Returns response with indentations and line breaks. */
|
|
3210
|
+
prettyPrint?: boolean;
|
|
3211
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3212
|
+
quotaUser?: string;
|
|
3213
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
3214
|
+
updateMask?: string;
|
|
3215
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3216
|
+
upload_protocol?: string;
|
|
3217
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3218
|
+
uploadType?: string;
|
|
3219
|
+
},
|
|
3220
|
+
body: Toolset,
|
|
3221
|
+
): Request<Toolset>;
|
|
3222
|
+
/** Retrieve the list of tools included in the specified toolset. */
|
|
3223
|
+
retrieveTools(request: {
|
|
3224
|
+
/** V1 error format. */
|
|
3225
|
+
'$.xgafv'?: string;
|
|
3226
|
+
/** OAuth access token. */
|
|
3227
|
+
access_token?: string;
|
|
3228
|
+
/** Data format for response. */
|
|
3229
|
+
alt?: string;
|
|
3230
|
+
/** JSONP */
|
|
3231
|
+
callback?: string;
|
|
3232
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3233
|
+
fields?: string;
|
|
3234
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3235
|
+
key?: string;
|
|
3236
|
+
/** OAuth 2.0 token for the current user. */
|
|
3237
|
+
oauth_token?: string;
|
|
3238
|
+
/** Returns response with indentations and line breaks. */
|
|
3239
|
+
prettyPrint?: boolean;
|
|
3240
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3241
|
+
quotaUser?: string;
|
|
3242
|
+
/** Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
3243
|
+
toolset: string;
|
|
3244
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3245
|
+
upload_protocol?: string;
|
|
3246
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3247
|
+
uploadType?: string;
|
|
3248
|
+
/** Request body */
|
|
3249
|
+
resource: RetrieveToolsRequest;
|
|
3250
|
+
}): Request<RetrieveToolsResponse>;
|
|
3251
|
+
retrieveTools(
|
|
3252
|
+
request: {
|
|
3253
|
+
/** V1 error format. */
|
|
3254
|
+
'$.xgafv'?: string;
|
|
3255
|
+
/** OAuth access token. */
|
|
3256
|
+
access_token?: string;
|
|
3257
|
+
/** Data format for response. */
|
|
3258
|
+
alt?: string;
|
|
3259
|
+
/** JSONP */
|
|
3260
|
+
callback?: string;
|
|
3261
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3262
|
+
fields?: string;
|
|
3263
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3264
|
+
key?: string;
|
|
3265
|
+
/** OAuth 2.0 token for the current user. */
|
|
3266
|
+
oauth_token?: string;
|
|
3267
|
+
/** Returns response with indentations and line breaks. */
|
|
3268
|
+
prettyPrint?: boolean;
|
|
3269
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3270
|
+
quotaUser?: string;
|
|
3271
|
+
/** Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */
|
|
3272
|
+
toolset: string;
|
|
3273
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3274
|
+
upload_protocol?: string;
|
|
3275
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3276
|
+
uploadType?: string;
|
|
3277
|
+
},
|
|
3278
|
+
body: RetrieveToolsRequest,
|
|
3279
|
+
): Request<RetrieveToolsResponse>;
|
|
3280
|
+
}
|
|
3281
|
+
interface VersionsResource {
|
|
3282
|
+
/** Creates a new app version in the given app. */
|
|
3283
|
+
create(request: {
|
|
3284
|
+
/** V1 error format. */
|
|
3285
|
+
'$.xgafv'?: string;
|
|
3286
|
+
/** OAuth access token. */
|
|
3287
|
+
access_token?: string;
|
|
3288
|
+
/** Data format for response. */
|
|
3289
|
+
alt?: string;
|
|
3290
|
+
/** Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. */
|
|
3291
|
+
appVersionId?: string;
|
|
3292
|
+
/** JSONP */
|
|
3293
|
+
callback?: string;
|
|
3294
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3295
|
+
fields?: string;
|
|
3296
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3297
|
+
key?: string;
|
|
3298
|
+
/** OAuth 2.0 token for the current user. */
|
|
3299
|
+
oauth_token?: string;
|
|
3300
|
+
/** Required. The resource name of the app to create an app version in. */
|
|
3301
|
+
parent: string;
|
|
3302
|
+
/** Returns response with indentations and line breaks. */
|
|
3303
|
+
prettyPrint?: boolean;
|
|
3304
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3305
|
+
quotaUser?: string;
|
|
3306
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3307
|
+
upload_protocol?: string;
|
|
3308
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3309
|
+
uploadType?: string;
|
|
3310
|
+
/** Request body */
|
|
3311
|
+
resource: AppVersion;
|
|
3312
|
+
}): Request<AppVersion>;
|
|
3313
|
+
create(
|
|
3314
|
+
request: {
|
|
3315
|
+
/** V1 error format. */
|
|
3316
|
+
'$.xgafv'?: string;
|
|
3317
|
+
/** OAuth access token. */
|
|
3318
|
+
access_token?: string;
|
|
3319
|
+
/** Data format for response. */
|
|
3320
|
+
alt?: string;
|
|
3321
|
+
/** Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. */
|
|
3322
|
+
appVersionId?: string;
|
|
3323
|
+
/** JSONP */
|
|
3324
|
+
callback?: string;
|
|
3325
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3326
|
+
fields?: string;
|
|
3327
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3328
|
+
key?: string;
|
|
3329
|
+
/** OAuth 2.0 token for the current user. */
|
|
3330
|
+
oauth_token?: string;
|
|
3331
|
+
/** Required. The resource name of the app to create an app version in. */
|
|
3332
|
+
parent: string;
|
|
3333
|
+
/** Returns response with indentations and line breaks. */
|
|
3334
|
+
prettyPrint?: boolean;
|
|
3335
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3336
|
+
quotaUser?: string;
|
|
3337
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3338
|
+
upload_protocol?: string;
|
|
3339
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3340
|
+
uploadType?: string;
|
|
3341
|
+
},
|
|
3342
|
+
body: AppVersion,
|
|
3343
|
+
): Request<AppVersion>;
|
|
3344
|
+
/** Deletes the specified app version. */
|
|
3345
|
+
delete(request?: {
|
|
3346
|
+
/** V1 error format. */
|
|
3347
|
+
'$.xgafv'?: string;
|
|
3348
|
+
/** OAuth access token. */
|
|
3349
|
+
access_token?: string;
|
|
3350
|
+
/** Data format for response. */
|
|
3351
|
+
alt?: string;
|
|
3352
|
+
/** JSONP */
|
|
3353
|
+
callback?: string;
|
|
3354
|
+
/** Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned. */
|
|
3355
|
+
etag?: string;
|
|
3356
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3357
|
+
fields?: string;
|
|
3358
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3359
|
+
key?: string;
|
|
3360
|
+
/** Required. The resource name of the app version to delete. */
|
|
3361
|
+
name: string;
|
|
3362
|
+
/** OAuth 2.0 token for the current user. */
|
|
3363
|
+
oauth_token?: string;
|
|
3364
|
+
/** Returns response with indentations and line breaks. */
|
|
3365
|
+
prettyPrint?: boolean;
|
|
3366
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3367
|
+
quotaUser?: string;
|
|
3368
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3369
|
+
upload_protocol?: string;
|
|
3370
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3371
|
+
uploadType?: string;
|
|
3372
|
+
}): Request<{}>;
|
|
3373
|
+
/** Gets details of the specified app version. */
|
|
3374
|
+
get(request?: {
|
|
3375
|
+
/** V1 error format. */
|
|
3376
|
+
'$.xgafv'?: string;
|
|
3377
|
+
/** OAuth access token. */
|
|
3378
|
+
access_token?: string;
|
|
3379
|
+
/** Data format for response. */
|
|
3380
|
+
alt?: string;
|
|
3381
|
+
/** JSONP */
|
|
3382
|
+
callback?: string;
|
|
3383
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3384
|
+
fields?: string;
|
|
3385
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3386
|
+
key?: string;
|
|
3387
|
+
/** Required. The resource name of the app version to retrieve. */
|
|
3388
|
+
name: string;
|
|
3389
|
+
/** OAuth 2.0 token for the current user. */
|
|
3390
|
+
oauth_token?: string;
|
|
3391
|
+
/** Returns response with indentations and line breaks. */
|
|
3392
|
+
prettyPrint?: boolean;
|
|
3393
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3394
|
+
quotaUser?: string;
|
|
3395
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3396
|
+
upload_protocol?: string;
|
|
3397
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3398
|
+
uploadType?: string;
|
|
3399
|
+
}): Request<AppVersion>;
|
|
3400
|
+
/** Lists all app versions in the given app. */
|
|
3401
|
+
list(request?: {
|
|
3402
|
+
/** V1 error format. */
|
|
3403
|
+
'$.xgafv'?: string;
|
|
3404
|
+
/** OAuth access token. */
|
|
3405
|
+
access_token?: string;
|
|
3406
|
+
/** Data format for response. */
|
|
3407
|
+
alt?: string;
|
|
3408
|
+
/** JSONP */
|
|
3409
|
+
callback?: string;
|
|
3410
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3411
|
+
fields?: string;
|
|
3412
|
+
/** Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details. */
|
|
3413
|
+
filter?: string;
|
|
3414
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3415
|
+
key?: string;
|
|
3416
|
+
/** OAuth 2.0 token for the current user. */
|
|
3417
|
+
oauth_token?: string;
|
|
3418
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
3419
|
+
orderBy?: string;
|
|
3420
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
3421
|
+
pageSize?: number;
|
|
3422
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call. */
|
|
3423
|
+
pageToken?: string;
|
|
3424
|
+
/** Required. The resource name of the app to list app versions from. */
|
|
3425
|
+
parent: string;
|
|
3426
|
+
/** Returns response with indentations and line breaks. */
|
|
3427
|
+
prettyPrint?: boolean;
|
|
3428
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3429
|
+
quotaUser?: string;
|
|
3430
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3431
|
+
upload_protocol?: string;
|
|
3432
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3433
|
+
uploadType?: string;
|
|
3434
|
+
}): Request<ListAppVersionsResponse>;
|
|
3435
|
+
/** Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version. */
|
|
3436
|
+
restore(request: {
|
|
3437
|
+
/** V1 error format. */
|
|
3438
|
+
'$.xgafv'?: string;
|
|
3439
|
+
/** OAuth access token. */
|
|
3440
|
+
access_token?: string;
|
|
3441
|
+
/** Data format for response. */
|
|
3442
|
+
alt?: string;
|
|
3443
|
+
/** JSONP */
|
|
3444
|
+
callback?: string;
|
|
3445
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3446
|
+
fields?: string;
|
|
3447
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3448
|
+
key?: string;
|
|
3449
|
+
/** Required. The resource name of the app version to restore. */
|
|
3450
|
+
name: string;
|
|
3451
|
+
/** OAuth 2.0 token for the current user. */
|
|
3452
|
+
oauth_token?: string;
|
|
3453
|
+
/** Returns response with indentations and line breaks. */
|
|
3454
|
+
prettyPrint?: boolean;
|
|
3455
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3456
|
+
quotaUser?: string;
|
|
3457
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3458
|
+
upload_protocol?: string;
|
|
3459
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3460
|
+
uploadType?: string;
|
|
3461
|
+
/** Request body */
|
|
3462
|
+
resource: RestoreAppVersionRequest;
|
|
3463
|
+
}): Request<Operation>;
|
|
3464
|
+
restore(
|
|
3465
|
+
request: {
|
|
3466
|
+
/** V1 error format. */
|
|
3467
|
+
'$.xgafv'?: string;
|
|
3468
|
+
/** OAuth access token. */
|
|
3469
|
+
access_token?: string;
|
|
3470
|
+
/** Data format for response. */
|
|
3471
|
+
alt?: string;
|
|
3472
|
+
/** JSONP */
|
|
3473
|
+
callback?: string;
|
|
3474
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3475
|
+
fields?: string;
|
|
3476
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3477
|
+
key?: string;
|
|
3478
|
+
/** Required. The resource name of the app version to restore. */
|
|
3479
|
+
name: string;
|
|
3480
|
+
/** OAuth 2.0 token for the current user. */
|
|
3481
|
+
oauth_token?: string;
|
|
3482
|
+
/** Returns response with indentations and line breaks. */
|
|
3483
|
+
prettyPrint?: boolean;
|
|
3484
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3485
|
+
quotaUser?: string;
|
|
3486
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3487
|
+
upload_protocol?: string;
|
|
3488
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3489
|
+
uploadType?: string;
|
|
3490
|
+
},
|
|
3491
|
+
body: RestoreAppVersionRequest,
|
|
3492
|
+
): Request<Operation>;
|
|
3493
|
+
}
|
|
3494
|
+
interface AppsResource {
|
|
3495
|
+
/** Creates a new app in the given project and location. */
|
|
3496
|
+
create(request: {
|
|
3497
|
+
/** V1 error format. */
|
|
3498
|
+
'$.xgafv'?: string;
|
|
3499
|
+
/** OAuth access token. */
|
|
3500
|
+
access_token?: string;
|
|
3501
|
+
/** Data format for response. */
|
|
3502
|
+
alt?: string;
|
|
3503
|
+
/** Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. */
|
|
3504
|
+
appId?: string;
|
|
3505
|
+
/** JSONP */
|
|
3506
|
+
callback?: string;
|
|
3507
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3508
|
+
fields?: string;
|
|
3509
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3510
|
+
key?: string;
|
|
3511
|
+
/** OAuth 2.0 token for the current user. */
|
|
3512
|
+
oauth_token?: string;
|
|
3513
|
+
/** Required. The resource name of the location to create an app in. */
|
|
3514
|
+
parent: string;
|
|
3515
|
+
/** Returns response with indentations and line breaks. */
|
|
3516
|
+
prettyPrint?: boolean;
|
|
3517
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3518
|
+
quotaUser?: string;
|
|
3519
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3520
|
+
upload_protocol?: string;
|
|
3521
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3522
|
+
uploadType?: string;
|
|
3523
|
+
/** Request body */
|
|
3524
|
+
resource: App;
|
|
3525
|
+
}): Request<Operation>;
|
|
3526
|
+
create(
|
|
3527
|
+
request: {
|
|
3528
|
+
/** V1 error format. */
|
|
3529
|
+
'$.xgafv'?: string;
|
|
3530
|
+
/** OAuth access token. */
|
|
3531
|
+
access_token?: string;
|
|
3532
|
+
/** Data format for response. */
|
|
3533
|
+
alt?: string;
|
|
3534
|
+
/** Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. */
|
|
3535
|
+
appId?: string;
|
|
3536
|
+
/** JSONP */
|
|
3537
|
+
callback?: string;
|
|
3538
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3539
|
+
fields?: string;
|
|
3540
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3541
|
+
key?: string;
|
|
3542
|
+
/** OAuth 2.0 token for the current user. */
|
|
3543
|
+
oauth_token?: string;
|
|
3544
|
+
/** Required. The resource name of the location to create an app in. */
|
|
3545
|
+
parent: string;
|
|
3546
|
+
/** Returns response with indentations and line breaks. */
|
|
3547
|
+
prettyPrint?: boolean;
|
|
3548
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3549
|
+
quotaUser?: string;
|
|
3550
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3551
|
+
upload_protocol?: string;
|
|
3552
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3553
|
+
uploadType?: string;
|
|
3554
|
+
},
|
|
3555
|
+
body: App,
|
|
3556
|
+
): Request<Operation>;
|
|
3557
|
+
/** Deletes the specified app. */
|
|
3558
|
+
delete(request?: {
|
|
3559
|
+
/** V1 error format. */
|
|
3560
|
+
'$.xgafv'?: string;
|
|
3561
|
+
/** OAuth access token. */
|
|
3562
|
+
access_token?: string;
|
|
3563
|
+
/** Data format for response. */
|
|
3564
|
+
alt?: string;
|
|
3565
|
+
/** JSONP */
|
|
3566
|
+
callback?: string;
|
|
3567
|
+
/** Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned. */
|
|
3568
|
+
etag?: string;
|
|
3569
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3570
|
+
fields?: string;
|
|
3571
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3572
|
+
key?: string;
|
|
3573
|
+
/** Required. The resource name of the app to delete. */
|
|
3574
|
+
name: string;
|
|
3575
|
+
/** OAuth 2.0 token for the current user. */
|
|
3576
|
+
oauth_token?: string;
|
|
3577
|
+
/** Returns response with indentations and line breaks. */
|
|
3578
|
+
prettyPrint?: boolean;
|
|
3579
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3580
|
+
quotaUser?: string;
|
|
3581
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3582
|
+
upload_protocol?: string;
|
|
3583
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3584
|
+
uploadType?: string;
|
|
3585
|
+
}): Request<Operation>;
|
|
3586
|
+
/** Executes the given tool with the given arguments. */
|
|
3587
|
+
executeTool(request: {
|
|
3588
|
+
/** V1 error format. */
|
|
3589
|
+
'$.xgafv'?: string;
|
|
3590
|
+
/** OAuth access token. */
|
|
3591
|
+
access_token?: string;
|
|
3592
|
+
/** Data format for response. */
|
|
3593
|
+
alt?: string;
|
|
3594
|
+
/** JSONP */
|
|
3595
|
+
callback?: string;
|
|
3596
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3597
|
+
fields?: string;
|
|
3598
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3599
|
+
key?: string;
|
|
3600
|
+
/** OAuth 2.0 token for the current user. */
|
|
3601
|
+
oauth_token?: string;
|
|
3602
|
+
/** Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3603
|
+
parent: string;
|
|
3604
|
+
/** Returns response with indentations and line breaks. */
|
|
3605
|
+
prettyPrint?: boolean;
|
|
3606
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3607
|
+
quotaUser?: string;
|
|
3608
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3609
|
+
upload_protocol?: string;
|
|
3610
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3611
|
+
uploadType?: string;
|
|
3612
|
+
/** Request body */
|
|
3613
|
+
resource: ExecuteToolRequest;
|
|
3614
|
+
}): Request<ExecuteToolResponse>;
|
|
3615
|
+
executeTool(
|
|
3616
|
+
request: {
|
|
3617
|
+
/** V1 error format. */
|
|
3618
|
+
'$.xgafv'?: string;
|
|
3619
|
+
/** OAuth access token. */
|
|
3620
|
+
access_token?: string;
|
|
3621
|
+
/** Data format for response. */
|
|
3622
|
+
alt?: string;
|
|
3623
|
+
/** JSONP */
|
|
3624
|
+
callback?: string;
|
|
3625
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3626
|
+
fields?: string;
|
|
3627
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3628
|
+
key?: string;
|
|
3629
|
+
/** OAuth 2.0 token for the current user. */
|
|
3630
|
+
oauth_token?: string;
|
|
3631
|
+
/** Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3632
|
+
parent: string;
|
|
3633
|
+
/** Returns response with indentations and line breaks. */
|
|
3634
|
+
prettyPrint?: boolean;
|
|
3635
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3636
|
+
quotaUser?: string;
|
|
3637
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3638
|
+
upload_protocol?: string;
|
|
3639
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3640
|
+
uploadType?: string;
|
|
3641
|
+
},
|
|
3642
|
+
body: ExecuteToolRequest,
|
|
3643
|
+
): Request<ExecuteToolResponse>;
|
|
3644
|
+
/** Exports the specified app. */
|
|
3645
|
+
exportApp(request: {
|
|
3646
|
+
/** V1 error format. */
|
|
3647
|
+
'$.xgafv'?: string;
|
|
3648
|
+
/** OAuth access token. */
|
|
3649
|
+
access_token?: string;
|
|
3650
|
+
/** Data format for response. */
|
|
3651
|
+
alt?: string;
|
|
3652
|
+
/** JSONP */
|
|
3653
|
+
callback?: string;
|
|
3654
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3655
|
+
fields?: string;
|
|
3656
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3657
|
+
key?: string;
|
|
3658
|
+
/** Required. The resource name of the app to export. */
|
|
3659
|
+
name: string;
|
|
3660
|
+
/** OAuth 2.0 token for the current user. */
|
|
3661
|
+
oauth_token?: string;
|
|
3662
|
+
/** Returns response with indentations and line breaks. */
|
|
3663
|
+
prettyPrint?: boolean;
|
|
3664
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3665
|
+
quotaUser?: string;
|
|
3666
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3667
|
+
upload_protocol?: string;
|
|
3668
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3669
|
+
uploadType?: string;
|
|
3670
|
+
/** Request body */
|
|
3671
|
+
resource: ExportAppRequest;
|
|
3672
|
+
}): Request<Operation>;
|
|
3673
|
+
exportApp(
|
|
3674
|
+
request: {
|
|
3675
|
+
/** V1 error format. */
|
|
3676
|
+
'$.xgafv'?: string;
|
|
3677
|
+
/** OAuth access token. */
|
|
3678
|
+
access_token?: string;
|
|
3679
|
+
/** Data format for response. */
|
|
3680
|
+
alt?: string;
|
|
3681
|
+
/** JSONP */
|
|
3682
|
+
callback?: string;
|
|
3683
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3684
|
+
fields?: string;
|
|
3685
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3686
|
+
key?: string;
|
|
3687
|
+
/** Required. The resource name of the app to export. */
|
|
3688
|
+
name: string;
|
|
3689
|
+
/** OAuth 2.0 token for the current user. */
|
|
3690
|
+
oauth_token?: string;
|
|
3691
|
+
/** Returns response with indentations and line breaks. */
|
|
3692
|
+
prettyPrint?: boolean;
|
|
3693
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3694
|
+
quotaUser?: string;
|
|
3695
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3696
|
+
upload_protocol?: string;
|
|
3697
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3698
|
+
uploadType?: string;
|
|
3699
|
+
},
|
|
3700
|
+
body: ExportAppRequest,
|
|
3701
|
+
): Request<Operation>;
|
|
3702
|
+
/** Gets details of the specified app. */
|
|
3703
|
+
get(request?: {
|
|
3704
|
+
/** V1 error format. */
|
|
3705
|
+
'$.xgafv'?: string;
|
|
3706
|
+
/** OAuth access token. */
|
|
3707
|
+
access_token?: string;
|
|
3708
|
+
/** Data format for response. */
|
|
3709
|
+
alt?: string;
|
|
3710
|
+
/** JSONP */
|
|
3711
|
+
callback?: string;
|
|
3712
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3713
|
+
fields?: string;
|
|
3714
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3715
|
+
key?: string;
|
|
3716
|
+
/** Required. The resource name of the app to retrieve. */
|
|
3717
|
+
name: string;
|
|
3718
|
+
/** OAuth 2.0 token for the current user. */
|
|
3719
|
+
oauth_token?: string;
|
|
3720
|
+
/** Returns response with indentations and line breaks. */
|
|
3721
|
+
prettyPrint?: boolean;
|
|
3722
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3723
|
+
quotaUser?: string;
|
|
3724
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3725
|
+
upload_protocol?: string;
|
|
3726
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3727
|
+
uploadType?: string;
|
|
3728
|
+
}): Request<App>;
|
|
3729
|
+
/** Imports the specified app. */
|
|
3730
|
+
importApp(request: {
|
|
3731
|
+
/** V1 error format. */
|
|
3732
|
+
'$.xgafv'?: string;
|
|
3733
|
+
/** OAuth access token. */
|
|
3734
|
+
access_token?: string;
|
|
3735
|
+
/** Data format for response. */
|
|
3736
|
+
alt?: string;
|
|
3737
|
+
/** JSONP */
|
|
3738
|
+
callback?: string;
|
|
3739
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3740
|
+
fields?: string;
|
|
3741
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3742
|
+
key?: string;
|
|
3743
|
+
/** OAuth 2.0 token for the current user. */
|
|
3744
|
+
oauth_token?: string;
|
|
3745
|
+
/** Required. The parent resource name with the location of the app to import. */
|
|
3746
|
+
parent: string;
|
|
3747
|
+
/** Returns response with indentations and line breaks. */
|
|
3748
|
+
prettyPrint?: boolean;
|
|
3749
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3750
|
+
quotaUser?: string;
|
|
3751
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3752
|
+
upload_protocol?: string;
|
|
3753
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3754
|
+
uploadType?: string;
|
|
3755
|
+
/** Request body */
|
|
3756
|
+
resource: ImportAppRequest;
|
|
3757
|
+
}): Request<Operation>;
|
|
3758
|
+
importApp(
|
|
3759
|
+
request: {
|
|
3760
|
+
/** V1 error format. */
|
|
3761
|
+
'$.xgafv'?: string;
|
|
3762
|
+
/** OAuth access token. */
|
|
3763
|
+
access_token?: string;
|
|
3764
|
+
/** Data format for response. */
|
|
3765
|
+
alt?: string;
|
|
3766
|
+
/** JSONP */
|
|
3767
|
+
callback?: string;
|
|
3768
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3769
|
+
fields?: string;
|
|
3770
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3771
|
+
key?: string;
|
|
3772
|
+
/** OAuth 2.0 token for the current user. */
|
|
3773
|
+
oauth_token?: string;
|
|
3774
|
+
/** Required. The parent resource name with the location of the app to import. */
|
|
3775
|
+
parent: string;
|
|
3776
|
+
/** Returns response with indentations and line breaks. */
|
|
3777
|
+
prettyPrint?: boolean;
|
|
3778
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3779
|
+
quotaUser?: string;
|
|
3780
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3781
|
+
upload_protocol?: string;
|
|
3782
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3783
|
+
uploadType?: string;
|
|
3784
|
+
},
|
|
3785
|
+
body: ImportAppRequest,
|
|
3786
|
+
): Request<Operation>;
|
|
3787
|
+
/** Lists apps in the given project and location. */
|
|
3788
|
+
list(request?: {
|
|
3789
|
+
/** V1 error format. */
|
|
3790
|
+
'$.xgafv'?: string;
|
|
3791
|
+
/** OAuth access token. */
|
|
3792
|
+
access_token?: string;
|
|
3793
|
+
/** Data format for response. */
|
|
3794
|
+
alt?: string;
|
|
3795
|
+
/** JSONP */
|
|
3796
|
+
callback?: string;
|
|
3797
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3798
|
+
fields?: string;
|
|
3799
|
+
/** Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details. */
|
|
3800
|
+
filter?: string;
|
|
3801
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3802
|
+
key?: string;
|
|
3803
|
+
/** OAuth 2.0 token for the current user. */
|
|
3804
|
+
oauth_token?: string;
|
|
3805
|
+
/** Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. */
|
|
3806
|
+
orderBy?: string;
|
|
3807
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
|
|
3808
|
+
pageSize?: number;
|
|
3809
|
+
/** Optional. The next_page_token value returned from a previous list AgentService.ListApps call. */
|
|
3810
|
+
pageToken?: string;
|
|
3811
|
+
/** Required. The resource name of the location to list apps from. */
|
|
3812
|
+
parent: string;
|
|
3813
|
+
/** Returns response with indentations and line breaks. */
|
|
3814
|
+
prettyPrint?: boolean;
|
|
3815
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3816
|
+
quotaUser?: string;
|
|
3817
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3818
|
+
upload_protocol?: string;
|
|
3819
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3820
|
+
uploadType?: string;
|
|
3821
|
+
}): Request<ListAppsResponse>;
|
|
3822
|
+
/** Updates the specified app. */
|
|
3823
|
+
patch(request: {
|
|
3824
|
+
/** V1 error format. */
|
|
3825
|
+
'$.xgafv'?: string;
|
|
3826
|
+
/** OAuth access token. */
|
|
3827
|
+
access_token?: string;
|
|
3828
|
+
/** Data format for response. */
|
|
3829
|
+
alt?: string;
|
|
3830
|
+
/** JSONP */
|
|
3831
|
+
callback?: string;
|
|
3832
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3833
|
+
fields?: string;
|
|
3834
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3835
|
+
key?: string;
|
|
3836
|
+
/** Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3837
|
+
name: string;
|
|
3838
|
+
/** OAuth 2.0 token for the current user. */
|
|
3839
|
+
oauth_token?: string;
|
|
3840
|
+
/** Returns response with indentations and line breaks. */
|
|
3841
|
+
prettyPrint?: boolean;
|
|
3842
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3843
|
+
quotaUser?: string;
|
|
3844
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
3845
|
+
updateMask?: string;
|
|
3846
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3847
|
+
upload_protocol?: string;
|
|
3848
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3849
|
+
uploadType?: string;
|
|
3850
|
+
/** Request body */
|
|
3851
|
+
resource: App;
|
|
3852
|
+
}): Request<App>;
|
|
3853
|
+
patch(
|
|
3854
|
+
request: {
|
|
3855
|
+
/** V1 error format. */
|
|
3856
|
+
'$.xgafv'?: string;
|
|
3857
|
+
/** OAuth access token. */
|
|
3858
|
+
access_token?: string;
|
|
3859
|
+
/** Data format for response. */
|
|
3860
|
+
alt?: string;
|
|
3861
|
+
/** JSONP */
|
|
3862
|
+
callback?: string;
|
|
3863
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3864
|
+
fields?: string;
|
|
3865
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3866
|
+
key?: string;
|
|
3867
|
+
/** Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3868
|
+
name: string;
|
|
3869
|
+
/** OAuth 2.0 token for the current user. */
|
|
3870
|
+
oauth_token?: string;
|
|
3871
|
+
/** Returns response with indentations and line breaks. */
|
|
3872
|
+
prettyPrint?: boolean;
|
|
3873
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3874
|
+
quotaUser?: string;
|
|
3875
|
+
/** Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */
|
|
3876
|
+
updateMask?: string;
|
|
3877
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3878
|
+
upload_protocol?: string;
|
|
3879
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3880
|
+
uploadType?: string;
|
|
3881
|
+
},
|
|
3882
|
+
body: App,
|
|
3883
|
+
): Request<App>;
|
|
3884
|
+
/** Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool. */
|
|
3885
|
+
retrieveToolSchema(request: {
|
|
3886
|
+
/** V1 error format. */
|
|
3887
|
+
'$.xgafv'?: string;
|
|
3888
|
+
/** OAuth access token. */
|
|
3889
|
+
access_token?: string;
|
|
3890
|
+
/** Data format for response. */
|
|
3891
|
+
alt?: string;
|
|
3892
|
+
/** JSONP */
|
|
3893
|
+
callback?: string;
|
|
3894
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3895
|
+
fields?: string;
|
|
3896
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3897
|
+
key?: string;
|
|
3898
|
+
/** OAuth 2.0 token for the current user. */
|
|
3899
|
+
oauth_token?: string;
|
|
3900
|
+
/** Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3901
|
+
parent: string;
|
|
3902
|
+
/** Returns response with indentations and line breaks. */
|
|
3903
|
+
prettyPrint?: boolean;
|
|
3904
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3905
|
+
quotaUser?: string;
|
|
3906
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3907
|
+
upload_protocol?: string;
|
|
3908
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3909
|
+
uploadType?: string;
|
|
3910
|
+
/** Request body */
|
|
3911
|
+
resource: RetrieveToolSchemaRequest;
|
|
3912
|
+
}): Request<RetrieveToolSchemaResponse>;
|
|
3913
|
+
retrieveToolSchema(
|
|
3914
|
+
request: {
|
|
3915
|
+
/** V1 error format. */
|
|
3916
|
+
'$.xgafv'?: string;
|
|
3917
|
+
/** OAuth access token. */
|
|
3918
|
+
access_token?: string;
|
|
3919
|
+
/** Data format for response. */
|
|
3920
|
+
alt?: string;
|
|
3921
|
+
/** JSONP */
|
|
3922
|
+
callback?: string;
|
|
3923
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3924
|
+
fields?: string;
|
|
3925
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3926
|
+
key?: string;
|
|
3927
|
+
/** OAuth 2.0 token for the current user. */
|
|
3928
|
+
oauth_token?: string;
|
|
3929
|
+
/** Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` */
|
|
3930
|
+
parent: string;
|
|
3931
|
+
/** Returns response with indentations and line breaks. */
|
|
3932
|
+
prettyPrint?: boolean;
|
|
3933
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3934
|
+
quotaUser?: string;
|
|
3935
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3936
|
+
upload_protocol?: string;
|
|
3937
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3938
|
+
uploadType?: string;
|
|
3939
|
+
},
|
|
3940
|
+
body: RetrieveToolSchemaRequest,
|
|
3941
|
+
): Request<RetrieveToolSchemaResponse>;
|
|
3942
|
+
agents: AgentsResource;
|
|
3943
|
+
changelogs: ChangelogsResource;
|
|
3944
|
+
conversations: ConversationsResource;
|
|
3945
|
+
deployments: DeploymentsResource;
|
|
3946
|
+
examples: ExamplesResource;
|
|
3947
|
+
guardrails: GuardrailsResource;
|
|
3948
|
+
sessions: SessionsResource;
|
|
3949
|
+
tools: ToolsResource;
|
|
3950
|
+
toolsets: ToolsetsResource;
|
|
3951
|
+
versions: VersionsResource;
|
|
3952
|
+
}
|
|
3953
|
+
interface OperationsResource {
|
|
3954
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
3955
|
+
cancel(request: {
|
|
3956
|
+
/** V1 error format. */
|
|
3957
|
+
'$.xgafv'?: string;
|
|
3958
|
+
/** OAuth access token. */
|
|
3959
|
+
access_token?: string;
|
|
3960
|
+
/** Data format for response. */
|
|
3961
|
+
alt?: string;
|
|
3962
|
+
/** JSONP */
|
|
3963
|
+
callback?: string;
|
|
3964
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3965
|
+
fields?: string;
|
|
3966
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3967
|
+
key?: string;
|
|
3968
|
+
/** The name of the operation resource to be cancelled. */
|
|
3969
|
+
name: string;
|
|
3970
|
+
/** OAuth 2.0 token for the current user. */
|
|
3971
|
+
oauth_token?: string;
|
|
3972
|
+
/** Returns response with indentations and line breaks. */
|
|
3973
|
+
prettyPrint?: boolean;
|
|
3974
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3975
|
+
quotaUser?: string;
|
|
3976
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3977
|
+
upload_protocol?: string;
|
|
3978
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3979
|
+
uploadType?: string;
|
|
3980
|
+
/** Request body */
|
|
3981
|
+
resource: CancelOperationRequest;
|
|
3982
|
+
}): Request<{}>;
|
|
3983
|
+
cancel(
|
|
3984
|
+
request: {
|
|
3985
|
+
/** V1 error format. */
|
|
3986
|
+
'$.xgafv'?: string;
|
|
3987
|
+
/** OAuth access token. */
|
|
3988
|
+
access_token?: string;
|
|
3989
|
+
/** Data format for response. */
|
|
3990
|
+
alt?: string;
|
|
3991
|
+
/** JSONP */
|
|
3992
|
+
callback?: string;
|
|
3993
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3994
|
+
fields?: string;
|
|
3995
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3996
|
+
key?: string;
|
|
3997
|
+
/** The name of the operation resource to be cancelled. */
|
|
3998
|
+
name: string;
|
|
3999
|
+
/** OAuth 2.0 token for the current user. */
|
|
4000
|
+
oauth_token?: string;
|
|
4001
|
+
/** Returns response with indentations and line breaks. */
|
|
4002
|
+
prettyPrint?: boolean;
|
|
4003
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4004
|
+
quotaUser?: string;
|
|
4005
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4006
|
+
upload_protocol?: string;
|
|
4007
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4008
|
+
uploadType?: string;
|
|
4009
|
+
},
|
|
4010
|
+
body: CancelOperationRequest,
|
|
4011
|
+
): Request<{}>;
|
|
4012
|
+
/** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
4013
|
+
delete(request?: {
|
|
4014
|
+
/** V1 error format. */
|
|
4015
|
+
'$.xgafv'?: string;
|
|
4016
|
+
/** OAuth access token. */
|
|
4017
|
+
access_token?: string;
|
|
4018
|
+
/** Data format for response. */
|
|
4019
|
+
alt?: string;
|
|
4020
|
+
/** JSONP */
|
|
4021
|
+
callback?: string;
|
|
4022
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4023
|
+
fields?: string;
|
|
4024
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4025
|
+
key?: string;
|
|
4026
|
+
/** The name of the operation resource to be deleted. */
|
|
4027
|
+
name: string;
|
|
4028
|
+
/** OAuth 2.0 token for the current user. */
|
|
4029
|
+
oauth_token?: string;
|
|
4030
|
+
/** Returns response with indentations and line breaks. */
|
|
4031
|
+
prettyPrint?: boolean;
|
|
4032
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4033
|
+
quotaUser?: string;
|
|
4034
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4035
|
+
upload_protocol?: string;
|
|
4036
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4037
|
+
uploadType?: string;
|
|
4038
|
+
}): Request<{}>;
|
|
4039
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
4040
|
+
get(request?: {
|
|
4041
|
+
/** V1 error format. */
|
|
4042
|
+
'$.xgafv'?: string;
|
|
4043
|
+
/** OAuth access token. */
|
|
4044
|
+
access_token?: string;
|
|
4045
|
+
/** Data format for response. */
|
|
4046
|
+
alt?: string;
|
|
4047
|
+
/** JSONP */
|
|
4048
|
+
callback?: string;
|
|
4049
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4050
|
+
fields?: string;
|
|
4051
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4052
|
+
key?: string;
|
|
4053
|
+
/** The name of the operation resource. */
|
|
4054
|
+
name: string;
|
|
4055
|
+
/** OAuth 2.0 token for the current user. */
|
|
4056
|
+
oauth_token?: string;
|
|
4057
|
+
/** Returns response with indentations and line breaks. */
|
|
4058
|
+
prettyPrint?: boolean;
|
|
4059
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4060
|
+
quotaUser?: string;
|
|
4061
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4062
|
+
upload_protocol?: string;
|
|
4063
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4064
|
+
uploadType?: string;
|
|
4065
|
+
}): Request<Operation>;
|
|
4066
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4067
|
+
list(request?: {
|
|
4068
|
+
/** V1 error format. */
|
|
4069
|
+
'$.xgafv'?: string;
|
|
4070
|
+
/** OAuth access token. */
|
|
4071
|
+
access_token?: string;
|
|
4072
|
+
/** Data format for response. */
|
|
4073
|
+
alt?: string;
|
|
4074
|
+
/** JSONP */
|
|
4075
|
+
callback?: string;
|
|
4076
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4077
|
+
fields?: string;
|
|
4078
|
+
/** The standard list filter. */
|
|
4079
|
+
filter?: string;
|
|
4080
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4081
|
+
key?: string;
|
|
4082
|
+
/** The name of the operation's parent resource. */
|
|
4083
|
+
name: string;
|
|
4084
|
+
/** OAuth 2.0 token for the current user. */
|
|
4085
|
+
oauth_token?: string;
|
|
4086
|
+
/** The standard list page size. */
|
|
4087
|
+
pageSize?: number;
|
|
4088
|
+
/** The standard list page token. */
|
|
4089
|
+
pageToken?: string;
|
|
4090
|
+
/** Returns response with indentations and line breaks. */
|
|
4091
|
+
prettyPrint?: boolean;
|
|
4092
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4093
|
+
quotaUser?: string;
|
|
4094
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
4095
|
+
returnPartialSuccess?: boolean;
|
|
4096
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4097
|
+
upload_protocol?: string;
|
|
4098
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4099
|
+
uploadType?: string;
|
|
4100
|
+
}): Request<ListOperationsResponse>;
|
|
4101
|
+
}
|
|
4102
|
+
interface LocationsResource {
|
|
4103
|
+
/** Gets information about a location. */
|
|
4104
|
+
get(request?: {
|
|
4105
|
+
/** V1 error format. */
|
|
4106
|
+
'$.xgafv'?: string;
|
|
4107
|
+
/** OAuth access token. */
|
|
4108
|
+
access_token?: string;
|
|
4109
|
+
/** Data format for response. */
|
|
4110
|
+
alt?: string;
|
|
4111
|
+
/** JSONP */
|
|
4112
|
+
callback?: string;
|
|
4113
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4114
|
+
fields?: string;
|
|
4115
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4116
|
+
key?: string;
|
|
4117
|
+
/** Resource name for the location. */
|
|
4118
|
+
name: string;
|
|
4119
|
+
/** OAuth 2.0 token for the current user. */
|
|
4120
|
+
oauth_token?: string;
|
|
4121
|
+
/** Returns response with indentations and line breaks. */
|
|
4122
|
+
prettyPrint?: boolean;
|
|
4123
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4124
|
+
quotaUser?: string;
|
|
4125
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4126
|
+
upload_protocol?: string;
|
|
4127
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4128
|
+
uploadType?: string;
|
|
4129
|
+
}): Request<Location>;
|
|
4130
|
+
/** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
|
|
4131
|
+
list(request?: {
|
|
4132
|
+
/** V1 error format. */
|
|
4133
|
+
'$.xgafv'?: string;
|
|
4134
|
+
/** OAuth access token. */
|
|
4135
|
+
access_token?: string;
|
|
4136
|
+
/** Data format for response. */
|
|
4137
|
+
alt?: string;
|
|
4138
|
+
/** JSONP */
|
|
4139
|
+
callback?: string;
|
|
4140
|
+
/** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
4141
|
+
extraLocationTypes?: string | string[];
|
|
4142
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4143
|
+
fields?: string;
|
|
4144
|
+
/** A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */
|
|
4145
|
+
filter?: string;
|
|
4146
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4147
|
+
key?: string;
|
|
4148
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
4149
|
+
name: string;
|
|
4150
|
+
/** OAuth 2.0 token for the current user. */
|
|
4151
|
+
oauth_token?: string;
|
|
4152
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
4153
|
+
pageSize?: number;
|
|
4154
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
4155
|
+
pageToken?: string;
|
|
4156
|
+
/** Returns response with indentations and line breaks. */
|
|
4157
|
+
prettyPrint?: boolean;
|
|
4158
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4159
|
+
quotaUser?: string;
|
|
4160
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4161
|
+
upload_protocol?: string;
|
|
4162
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4163
|
+
uploadType?: string;
|
|
4164
|
+
}): Request<ListLocationsResponse>;
|
|
4165
|
+
apps: AppsResource;
|
|
4166
|
+
operations: OperationsResource;
|
|
4167
|
+
}
|
|
4168
|
+
interface ProjectsResource {
|
|
4169
|
+
locations: LocationsResource;
|
|
4170
|
+
}
|
|
4171
|
+
|
|
4172
|
+
const projects: ProjectsResource;
|
|
4173
|
+
}
|
|
4174
|
+
}
|