@googleapis/discoveryengine 26.1.0 → 27.0.0
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/CHANGELOG.md +12 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +1055 -8
- package/build/v1.js +326 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +3547 -113
- package/build/v1alpha.js +1040 -66
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +514 -7
- package/build/v1beta.js +128 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +2294 -373
- package/v1alpha.ts +24898 -18973
- package/v1beta.ts +857 -7
package/build/v1alpha.d.ts
CHANGED
|
@@ -67,6 +67,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
67
67
|
*/
|
|
68
68
|
export class Discoveryengine {
|
|
69
69
|
context: APIRequestContext;
|
|
70
|
+
billingAccounts: Resource$Billingaccounts;
|
|
70
71
|
media: Resource$Media;
|
|
71
72
|
projects: Resource$Projects;
|
|
72
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
@@ -909,6 +910,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
909
910
|
*/
|
|
910
911
|
enrollState?: string | null;
|
|
911
912
|
}
|
|
913
|
+
/**
|
|
914
|
+
* Stored definition of an agent that uses A2A.
|
|
915
|
+
*/
|
|
916
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition {
|
|
917
|
+
/**
|
|
918
|
+
* Optional. The agent card is a JSON string.
|
|
919
|
+
*/
|
|
920
|
+
jsonAgentCard?: string | null;
|
|
921
|
+
}
|
|
912
922
|
/**
|
|
913
923
|
* Access Control Configuration.
|
|
914
924
|
*/
|
|
@@ -967,6 +977,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
967
977
|
*/
|
|
968
978
|
useStaticSecrets?: boolean | null;
|
|
969
979
|
}
|
|
980
|
+
/**
|
|
981
|
+
* Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).
|
|
982
|
+
*/
|
|
983
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition {
|
|
984
|
+
/**
|
|
985
|
+
* Optional. The reasoning engine that the agent is connected to.
|
|
986
|
+
*/
|
|
987
|
+
provisionedReasoningEngine?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.
|
|
991
|
+
*/
|
|
992
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine {
|
|
993
|
+
/**
|
|
994
|
+
* Required. The reasoning engine that the agent is connected to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`
|
|
995
|
+
*/
|
|
996
|
+
reasoningEngine?: string | null;
|
|
997
|
+
}
|
|
970
998
|
/**
|
|
971
999
|
* Request message for CompletionService.AdvancedCompleteQuery method. .
|
|
972
1000
|
*/
|
|
@@ -1004,7 +1032,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1004
1032
|
*/
|
|
1005
1033
|
userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo;
|
|
1006
1034
|
/**
|
|
1007
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
|
|
1035
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
|
|
1008
1036
|
*/
|
|
1009
1037
|
userPseudoId?: string | null;
|
|
1010
1038
|
}
|
|
@@ -1185,6 +1213,118 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1185
1213
|
*/
|
|
1186
1214
|
disableInitialIndex?: boolean | null;
|
|
1187
1215
|
}
|
|
1216
|
+
/**
|
|
1217
|
+
* Performs a predefined, specific task.
|
|
1218
|
+
*/
|
|
1219
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgent {
|
|
1220
|
+
/**
|
|
1221
|
+
* Optional. The behavior of the agent is defined as an A2A agent.
|
|
1222
|
+
*/
|
|
1223
|
+
a2aAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition;
|
|
1224
|
+
/**
|
|
1225
|
+
* Optional. The behavior of the agent is defined as an ADK agent.
|
|
1226
|
+
*/
|
|
1227
|
+
adkAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition;
|
|
1228
|
+
/**
|
|
1229
|
+
* Optional. The authorizations that are required by the agent.
|
|
1230
|
+
*/
|
|
1231
|
+
authorizationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationConfig;
|
|
1232
|
+
/**
|
|
1233
|
+
* Output only. Timestamp when this Agent was created.
|
|
1234
|
+
*/
|
|
1235
|
+
createTime?: string | null;
|
|
1236
|
+
/**
|
|
1237
|
+
* Optional. The custom placeholder text that appears in the text box before the user enters any text.
|
|
1238
|
+
*/
|
|
1239
|
+
customPlaceholderText?: string | null;
|
|
1240
|
+
/**
|
|
1241
|
+
* Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
|
|
1242
|
+
*/
|
|
1243
|
+
deploymentFailureReason?: string | null;
|
|
1244
|
+
/**
|
|
1245
|
+
* Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
|
|
1246
|
+
*/
|
|
1247
|
+
description?: string | null;
|
|
1248
|
+
/**
|
|
1249
|
+
* Optional. The behavior of the agent is defined as a Dialogflow agent.
|
|
1250
|
+
*/
|
|
1251
|
+
dialogflowAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition;
|
|
1252
|
+
/**
|
|
1253
|
+
* Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
|
|
1254
|
+
*/
|
|
1255
|
+
displayName?: string | null;
|
|
1256
|
+
/**
|
|
1257
|
+
* Optional. The icon that represents the agent on the UI.
|
|
1258
|
+
*/
|
|
1259
|
+
icon?: Schema$GoogleCloudDiscoveryengineV1alphaAgentImage;
|
|
1260
|
+
/**
|
|
1261
|
+
* Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
|
|
1262
|
+
*/
|
|
1263
|
+
languageCode?: string | null;
|
|
1264
|
+
/**
|
|
1265
|
+
* Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
1266
|
+
*/
|
|
1267
|
+
name?: string | null;
|
|
1268
|
+
/**
|
|
1269
|
+
* Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
|
|
1270
|
+
*/
|
|
1271
|
+
rejectionReason?: string | null;
|
|
1272
|
+
/**
|
|
1273
|
+
* Optional. The starter prompt suggestions to show the user on the landing page of the agent.
|
|
1274
|
+
*/
|
|
1275
|
+
starterPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt[];
|
|
1276
|
+
/**
|
|
1277
|
+
* Output only. The lifecycle state of the agent.
|
|
1278
|
+
*/
|
|
1279
|
+
state?: string | null;
|
|
1280
|
+
/**
|
|
1281
|
+
* Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
|
|
1282
|
+
*/
|
|
1283
|
+
suspensionReason?: string | null;
|
|
1284
|
+
/**
|
|
1285
|
+
* Output only. Timestamp when this Agent was most recently updated.
|
|
1286
|
+
*/
|
|
1287
|
+
updateTime?: string | null;
|
|
1288
|
+
}
|
|
1289
|
+
/**
|
|
1290
|
+
* Describes a file used internally by an agent as a context on each invocation.
|
|
1291
|
+
*/
|
|
1292
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentFile {
|
|
1293
|
+
/**
|
|
1294
|
+
* Required. The name of the file.
|
|
1295
|
+
*/
|
|
1296
|
+
fileName?: string | null;
|
|
1297
|
+
/**
|
|
1298
|
+
* Immutable. The content type of the file.
|
|
1299
|
+
*/
|
|
1300
|
+
mimeType?: string | null;
|
|
1301
|
+
/**
|
|
1302
|
+
* Identifier. The resource name of the file. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}/files/{file\}`
|
|
1303
|
+
*/
|
|
1304
|
+
name?: string | null;
|
|
1305
|
+
}
|
|
1306
|
+
/**
|
|
1307
|
+
* Represents an image.
|
|
1308
|
+
*/
|
|
1309
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentImage {
|
|
1310
|
+
/**
|
|
1311
|
+
* Base64-encoded image file contents.
|
|
1312
|
+
*/
|
|
1313
|
+
content?: string | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* Image URI.
|
|
1316
|
+
*/
|
|
1317
|
+
uri?: string | null;
|
|
1318
|
+
}
|
|
1319
|
+
/**
|
|
1320
|
+
* The starter prompt suggestion to show the user on the landing page of the agent.
|
|
1321
|
+
*/
|
|
1322
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt {
|
|
1323
|
+
/**
|
|
1324
|
+
* Required. The text of the starter prompt.
|
|
1325
|
+
*/
|
|
1326
|
+
text?: string | null;
|
|
1327
|
+
}
|
|
1188
1328
|
/**
|
|
1189
1329
|
* The connector level alert config.
|
|
1190
1330
|
*/
|
|
@@ -2585,6 +2725,61 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2585
2725
|
*/
|
|
2586
2726
|
timeZone?: string | null;
|
|
2587
2727
|
}
|
|
2728
|
+
/**
|
|
2729
|
+
* Discovery Engine Authorization resource.
|
|
2730
|
+
*/
|
|
2731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorization {
|
|
2732
|
+
/**
|
|
2733
|
+
* Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
2734
|
+
*/
|
|
2735
|
+
displayName?: string | null;
|
|
2736
|
+
/**
|
|
2737
|
+
* Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
2738
|
+
*/
|
|
2739
|
+
name?: string | null;
|
|
2740
|
+
/**
|
|
2741
|
+
* Server-side OAuth2 configuration.
|
|
2742
|
+
*/
|
|
2743
|
+
serverSideOauth2?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2;
|
|
2744
|
+
}
|
|
2745
|
+
/**
|
|
2746
|
+
* Describes the authorizations required.
|
|
2747
|
+
*/
|
|
2748
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationConfig {
|
|
2749
|
+
/**
|
|
2750
|
+
* Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
|
|
2751
|
+
*/
|
|
2752
|
+
agentAuthorization?: string | null;
|
|
2753
|
+
/**
|
|
2754
|
+
* Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
|
|
2755
|
+
*/
|
|
2756
|
+
toolAuthorizations?: string[] | null;
|
|
2757
|
+
}
|
|
2758
|
+
/**
|
|
2759
|
+
* OAuth2 configuration.
|
|
2760
|
+
*/
|
|
2761
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2 {
|
|
2762
|
+
/**
|
|
2763
|
+
* Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
|
|
2764
|
+
*/
|
|
2765
|
+
authorizationUri?: string | null;
|
|
2766
|
+
/**
|
|
2767
|
+
* Required. The OAuth2 client ID.
|
|
2768
|
+
*/
|
|
2769
|
+
clientId?: string | null;
|
|
2770
|
+
/**
|
|
2771
|
+
* Required. The OAuth2 client secret. Encrypted at rest.
|
|
2772
|
+
*/
|
|
2773
|
+
clientSecret?: string | null;
|
|
2774
|
+
/**
|
|
2775
|
+
* Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
|
|
2776
|
+
*/
|
|
2777
|
+
scopes?: string[] | null;
|
|
2778
|
+
/**
|
|
2779
|
+
* Required. The HTTP endpoint that exchanges a client authorization for an access token.
|
|
2780
|
+
*/
|
|
2781
|
+
tokenUri?: string | null;
|
|
2782
|
+
}
|
|
2588
2783
|
/**
|
|
2589
2784
|
* The configuration for the BAP connector.
|
|
2590
2785
|
*/
|
|
@@ -2857,6 +3052,65 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2857
3052
|
*/
|
|
2858
3053
|
tableId?: string | null;
|
|
2859
3054
|
}
|
|
3055
|
+
/**
|
|
3056
|
+
* Information about license configs at billing account level.
|
|
3057
|
+
*/
|
|
3058
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig {
|
|
3059
|
+
/**
|
|
3060
|
+
* Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
|
|
3061
|
+
*/
|
|
3062
|
+
autoRenew?: boolean | null;
|
|
3063
|
+
/**
|
|
3064
|
+
* Optional. The planed subscription end date.
|
|
3065
|
+
*/
|
|
3066
|
+
endDate?: Schema$GoogleTypeDate;
|
|
3067
|
+
/**
|
|
3068
|
+
* Whether the license config is for Gemini bundle.
|
|
3069
|
+
*/
|
|
3070
|
+
geminiBundle?: boolean | null;
|
|
3071
|
+
/**
|
|
3072
|
+
* A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`. The value is the count of licenses allocated to it.
|
|
3073
|
+
*/
|
|
3074
|
+
licenseConfigDistributions?: {
|
|
3075
|
+
[key: string]: string;
|
|
3076
|
+
} | null;
|
|
3077
|
+
/**
|
|
3078
|
+
* Required. The number of licenses purchased under this billing account license config.
|
|
3079
|
+
*/
|
|
3080
|
+
licenseCount?: string | null;
|
|
3081
|
+
/**
|
|
3082
|
+
* Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config\}`.
|
|
3083
|
+
*/
|
|
3084
|
+
name?: string | null;
|
|
3085
|
+
/**
|
|
3086
|
+
* The procurement entitlement id of the subscription.
|
|
3087
|
+
*/
|
|
3088
|
+
procurementEntitlementId?: string | null;
|
|
3089
|
+
/**
|
|
3090
|
+
* Required. The subscription start date.
|
|
3091
|
+
*/
|
|
3092
|
+
startDate?: Schema$GoogleTypeDate;
|
|
3093
|
+
/**
|
|
3094
|
+
* Output only. The state of the BillingAccountLicenseConfig.
|
|
3095
|
+
*/
|
|
3096
|
+
state?: string | null;
|
|
3097
|
+
/**
|
|
3098
|
+
* The subscription display name.
|
|
3099
|
+
*/
|
|
3100
|
+
subscriptionDisplayName?: string | null;
|
|
3101
|
+
/**
|
|
3102
|
+
* Output only. The corresponding SubV3 subscription name.
|
|
3103
|
+
*/
|
|
3104
|
+
subscriptionName?: string | null;
|
|
3105
|
+
/**
|
|
3106
|
+
* Required. The subscription term.
|
|
3107
|
+
*/
|
|
3108
|
+
subscriptionTerm?: string | null;
|
|
3109
|
+
/**
|
|
3110
|
+
* Required. The subscription tier.
|
|
3111
|
+
*/
|
|
3112
|
+
subscriptionTier?: string | null;
|
|
3113
|
+
}
|
|
2860
3114
|
/**
|
|
2861
3115
|
* A data branch that stores Documents.
|
|
2862
3116
|
*/
|
|
@@ -2893,6 +3147,76 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2893
3147
|
[key: string]: string;
|
|
2894
3148
|
} | null;
|
|
2895
3149
|
}
|
|
3150
|
+
/**
|
|
3151
|
+
* Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
|
|
3152
|
+
*/
|
|
3153
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery {
|
|
3154
|
+
/**
|
|
3155
|
+
* Required. The default (non-localized) values for the text attributes.
|
|
3156
|
+
*/
|
|
3157
|
+
defaultTexts?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts;
|
|
3158
|
+
/**
|
|
3159
|
+
* The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
3160
|
+
*/
|
|
3161
|
+
displayName?: string | null;
|
|
3162
|
+
/**
|
|
3163
|
+
* Whether this canned query is enabled.
|
|
3164
|
+
*/
|
|
3165
|
+
enabled?: boolean | null;
|
|
3166
|
+
/**
|
|
3167
|
+
* Output only. Whether this is a Google-defined, read-only canned query.
|
|
3168
|
+
*/
|
|
3169
|
+
googleDefined?: boolean | null;
|
|
3170
|
+
/**
|
|
3171
|
+
* Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
|
|
3172
|
+
*/
|
|
3173
|
+
localizedTexts?: {
|
|
3174
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts;
|
|
3175
|
+
} | null;
|
|
3176
|
+
/**
|
|
3177
|
+
* Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3178
|
+
*/
|
|
3179
|
+
name?: string | null;
|
|
3180
|
+
/**
|
|
3181
|
+
* Optional. The capabilities the Assistant needs to have to use this canned query.
|
|
3182
|
+
*/
|
|
3183
|
+
requiredCapabilities?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability[];
|
|
3184
|
+
}
|
|
3185
|
+
/**
|
|
3186
|
+
* Capability of an assistant needed to use this canned query.
|
|
3187
|
+
*/
|
|
3188
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability {
|
|
3189
|
+
/**
|
|
3190
|
+
* The name of the action that the Assistant needs to have set up to use this canned query.
|
|
3191
|
+
*/
|
|
3192
|
+
actionName?: string | null;
|
|
3193
|
+
}
|
|
3194
|
+
/**
|
|
3195
|
+
* The text pieces for the canned query, which can be localized.
|
|
3196
|
+
*/
|
|
3197
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts {
|
|
3198
|
+
/**
|
|
3199
|
+
* Optional. The prefix that `suggested_prompts` should start with.
|
|
3200
|
+
*/
|
|
3201
|
+
prefix?: string | null;
|
|
3202
|
+
/**
|
|
3203
|
+
* Required. The prompts the canned query will offer to the user.
|
|
3204
|
+
*/
|
|
3205
|
+
suggestedPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt[];
|
|
3206
|
+
/**
|
|
3207
|
+
* Required. The title that is for the end user.
|
|
3208
|
+
*/
|
|
3209
|
+
title?: string | null;
|
|
3210
|
+
}
|
|
3211
|
+
/**
|
|
3212
|
+
* A suggested prompt for the canned query.
|
|
3213
|
+
*/
|
|
3214
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt {
|
|
3215
|
+
/**
|
|
3216
|
+
* Required. The text of the suggested prompt.
|
|
3217
|
+
*/
|
|
3218
|
+
promptText?: string | null;
|
|
3219
|
+
}
|
|
2896
3220
|
/**
|
|
2897
3221
|
* Request message for GroundedGenerationService.CheckGrounding method.
|
|
2898
3222
|
*/
|
|
@@ -4317,6 +4641,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4317
4641
|
* Optional. Configuration for configurable billing approach. See
|
|
4318
4642
|
*/
|
|
4319
4643
|
configurableBillingApproach?: string | null;
|
|
4644
|
+
/**
|
|
4645
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
4646
|
+
*/
|
|
4647
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
4320
4648
|
/**
|
|
4321
4649
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
4322
4650
|
*/
|
|
@@ -4449,6 +4777,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4449
4777
|
*/
|
|
4450
4778
|
userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
4451
4779
|
}
|
|
4780
|
+
/**
|
|
4781
|
+
* Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4782
|
+
*/
|
|
4783
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata {
|
|
4784
|
+
/**
|
|
4785
|
+
* Operation create time.
|
|
4786
|
+
*/
|
|
4787
|
+
createTime?: string | null;
|
|
4788
|
+
/**
|
|
4789
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4790
|
+
*/
|
|
4791
|
+
updateTime?: string | null;
|
|
4792
|
+
}
|
|
4452
4793
|
/**
|
|
4453
4794
|
* Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4454
4795
|
*/
|
|
@@ -4562,6 +4903,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4562
4903
|
*/
|
|
4563
4904
|
updateTime?: string | null;
|
|
4564
4905
|
}
|
|
4906
|
+
/**
|
|
4907
|
+
* Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.
|
|
4908
|
+
*/
|
|
4909
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata {
|
|
4910
|
+
/**
|
|
4911
|
+
* The number of end users under the user store that failed to be deleted.
|
|
4912
|
+
*/
|
|
4913
|
+
failureCount?: string | null;
|
|
4914
|
+
/**
|
|
4915
|
+
* The number of end users under the user store that were successfully deleted.
|
|
4916
|
+
*/
|
|
4917
|
+
successCount?: string | null;
|
|
4918
|
+
}
|
|
4565
4919
|
/**
|
|
4566
4920
|
* Defines target endpoints used to connect to third-party sources.
|
|
4567
4921
|
*/
|
|
@@ -4598,6 +4952,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4598
4952
|
*/
|
|
4599
4953
|
port?: number | null;
|
|
4600
4954
|
}
|
|
4955
|
+
/**
|
|
4956
|
+
* Stored definition of an agent that uses a Dialogflow agent.
|
|
4957
|
+
*/
|
|
4958
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition {
|
|
4959
|
+
/**
|
|
4960
|
+
* Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`
|
|
4961
|
+
*/
|
|
4962
|
+
dialogflowAgent?: string | null;
|
|
4963
|
+
}
|
|
4601
4964
|
/**
|
|
4602
4965
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4603
4966
|
*/
|
|
@@ -4621,6 +4984,36 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4621
4984
|
*/
|
|
4622
4985
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {
|
|
4623
4986
|
}
|
|
4987
|
+
/**
|
|
4988
|
+
* Request message for LicenseConfigService.DistributeLicenseConfig method.
|
|
4989
|
+
*/
|
|
4990
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest {
|
|
4991
|
+
/**
|
|
4992
|
+
* Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
|
|
4993
|
+
*/
|
|
4994
|
+
licenseConfigId?: string | null;
|
|
4995
|
+
/**
|
|
4996
|
+
* Required. The number of licenses to distribute.
|
|
4997
|
+
*/
|
|
4998
|
+
licenseCount?: string | null;
|
|
4999
|
+
/**
|
|
5000
|
+
* Required. The target GCP project region to distribute the license config to.
|
|
5001
|
+
*/
|
|
5002
|
+
location?: string | null;
|
|
5003
|
+
/**
|
|
5004
|
+
* Required. The target GCP project number to distribute the license config to.
|
|
5005
|
+
*/
|
|
5006
|
+
projectNumber?: string | null;
|
|
5007
|
+
}
|
|
5008
|
+
/**
|
|
5009
|
+
* Response message for LicenseConfigService.DistributeLicenseConfig method.
|
|
5010
|
+
*/
|
|
5011
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse {
|
|
5012
|
+
/**
|
|
5013
|
+
* The updated or created LicenseConfig.
|
|
5014
|
+
*/
|
|
5015
|
+
licenseConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig;
|
|
5016
|
+
}
|
|
4624
5017
|
/**
|
|
4625
5018
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
4626
5019
|
*/
|
|
@@ -5818,6 +6211,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5818
6211
|
*/
|
|
5819
6212
|
width?: number | null;
|
|
5820
6213
|
}
|
|
6214
|
+
/**
|
|
6215
|
+
* Request for the AgentService.ImportAgentFile method.
|
|
6216
|
+
*/
|
|
6217
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest {
|
|
6218
|
+
/**
|
|
6219
|
+
* Required. The name of the file.
|
|
6220
|
+
*/
|
|
6221
|
+
fileName?: string | null;
|
|
6222
|
+
/**
|
|
6223
|
+
* Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type.
|
|
6224
|
+
*/
|
|
6225
|
+
mimeType?: string | null;
|
|
6226
|
+
}
|
|
6227
|
+
/**
|
|
6228
|
+
* Response for the AgentService.ImportAgentFile method.
|
|
6229
|
+
*/
|
|
6230
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse {
|
|
6231
|
+
/**
|
|
6232
|
+
* The imported AgentFile.
|
|
6233
|
+
*/
|
|
6234
|
+
agentFile?: Schema$GoogleCloudDiscoveryengineV1alphaAgentFile;
|
|
6235
|
+
}
|
|
5821
6236
|
/**
|
|
5822
6237
|
* Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
5823
6238
|
*/
|
|
@@ -6313,6 +6728,45 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6313
6728
|
*/
|
|
6314
6729
|
subscriptionTier?: string | null;
|
|
6315
6730
|
}
|
|
6731
|
+
/**
|
|
6732
|
+
* Response message for the AgentService.ListAgents method.
|
|
6733
|
+
*/
|
|
6734
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse {
|
|
6735
|
+
/**
|
|
6736
|
+
* The agents visible to the caller under the parent Assistant.
|
|
6737
|
+
*/
|
|
6738
|
+
agents?: Schema$GoogleCloudDiscoveryengineV1alphaAgent[];
|
|
6739
|
+
/**
|
|
6740
|
+
* A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
6741
|
+
*/
|
|
6742
|
+
nextPageToken?: string | null;
|
|
6743
|
+
}
|
|
6744
|
+
/**
|
|
6745
|
+
* Response message for the AuthorizationService.ListAuthorizations method.
|
|
6746
|
+
*/
|
|
6747
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse {
|
|
6748
|
+
/**
|
|
6749
|
+
* All the customer's Authorizations.
|
|
6750
|
+
*/
|
|
6751
|
+
authorizations?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization[];
|
|
6752
|
+
/**
|
|
6753
|
+
* A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
6754
|
+
*/
|
|
6755
|
+
nextPageToken?: string | null;
|
|
6756
|
+
}
|
|
6757
|
+
/**
|
|
6758
|
+
* Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.
|
|
6759
|
+
*/
|
|
6760
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse {
|
|
6761
|
+
/**
|
|
6762
|
+
* All BillingAccountLicenseConfigs for the given billing account.
|
|
6763
|
+
*/
|
|
6764
|
+
billingAccountLicenseConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig[];
|
|
6765
|
+
/**
|
|
6766
|
+
* A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
6767
|
+
*/
|
|
6768
|
+
nextPageToken?: string | null;
|
|
6769
|
+
}
|
|
6316
6770
|
/**
|
|
6317
6771
|
* Response for BranchService.ListBranches method.
|
|
6318
6772
|
*/
|
|
@@ -6322,6 +6776,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6322
6776
|
*/
|
|
6323
6777
|
branches?: Schema$GoogleCloudDiscoveryengineV1alphaBranch[];
|
|
6324
6778
|
}
|
|
6779
|
+
/**
|
|
6780
|
+
* Response message for the CannedQueryService.ListCannedQueries method.
|
|
6781
|
+
*/
|
|
6782
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse {
|
|
6783
|
+
/**
|
|
6784
|
+
* The list of CannedQuerys matching the request.
|
|
6785
|
+
*/
|
|
6786
|
+
cannedQueries?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery[];
|
|
6787
|
+
/**
|
|
6788
|
+
* A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
6789
|
+
*/
|
|
6790
|
+
nextPageToken?: string | null;
|
|
6791
|
+
}
|
|
6325
6792
|
/**
|
|
6326
6793
|
* Response message for ChunkService.ListChunks method.
|
|
6327
6794
|
*/
|
|
@@ -6801,6 +7268,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6801
7268
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
6802
7269
|
*/
|
|
6803
7270
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
|
|
7271
|
+
/**
|
|
7272
|
+
* Output only. The current status of the project's configurable billing.
|
|
7273
|
+
*/
|
|
7274
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
|
|
6804
7275
|
/**
|
|
6805
7276
|
* Output only. The timestamp when this project is created.
|
|
6806
7277
|
*/
|
|
@@ -6824,6 +7295,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6824
7295
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
6825
7296
|
} | null;
|
|
6826
7297
|
}
|
|
7298
|
+
/**
|
|
7299
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
7300
|
+
*/
|
|
7301
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
|
|
7302
|
+
/**
|
|
7303
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
7304
|
+
*/
|
|
7305
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
7306
|
+
/**
|
|
7307
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
7308
|
+
*/
|
|
7309
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
7310
|
+
/**
|
|
7311
|
+
* Optional. The start time of the currently active billing subscription.
|
|
7312
|
+
*/
|
|
7313
|
+
startTime?: string | null;
|
|
7314
|
+
}
|
|
6827
7315
|
/**
|
|
6828
7316
|
* Customer provided configurations.
|
|
6829
7317
|
*/
|
|
@@ -6841,6 +7329,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6841
7329
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
6842
7330
|
*/
|
|
6843
7331
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
7332
|
+
/**
|
|
7333
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
7334
|
+
*/
|
|
7335
|
+
optOutNotebookSharing?: boolean | null;
|
|
6844
7336
|
}
|
|
6845
7337
|
/**
|
|
6846
7338
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -7672,6 +8164,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7672
8164
|
*/
|
|
7673
8165
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
|
|
7674
8166
|
}
|
|
8167
|
+
/**
|
|
8168
|
+
* Request message for LicenseConfigService.RetractLicenseConfig method.
|
|
8169
|
+
*/
|
|
8170
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest {
|
|
8171
|
+
/**
|
|
8172
|
+
* Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
|
|
8173
|
+
*/
|
|
8174
|
+
fullRetract?: boolean | null;
|
|
8175
|
+
/**
|
|
8176
|
+
* Required. Full resource name of LicenseConfig. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config_id\}`.
|
|
8177
|
+
*/
|
|
8178
|
+
licenseConfig?: string | null;
|
|
8179
|
+
/**
|
|
8180
|
+
* Optional. The number of licenses to retract. Only used when full_retract is false.
|
|
8181
|
+
*/
|
|
8182
|
+
licenseCount?: string | null;
|
|
8183
|
+
}
|
|
8184
|
+
/**
|
|
8185
|
+
* Response message for LicenseConfigService.RetractLicenseConfig method.
|
|
8186
|
+
*/
|
|
8187
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse {
|
|
8188
|
+
/**
|
|
8189
|
+
* The updated LicenseConfig.
|
|
8190
|
+
*/
|
|
8191
|
+
licenseConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig;
|
|
8192
|
+
}
|
|
7675
8193
|
/**
|
|
7676
8194
|
* Safety rating corresponding to the generated content.
|
|
7677
8195
|
*/
|
|
@@ -7995,7 +8513,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7995
8513
|
[key: string]: string;
|
|
7996
8514
|
} | null;
|
|
7997
8515
|
/**
|
|
7998
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8516
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
7999
8517
|
*/
|
|
8000
8518
|
userPseudoId?: string | null;
|
|
8001
8519
|
}
|
|
@@ -9804,6 +10322,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9804
10322
|
*/
|
|
9805
10323
|
updateTime?: string | null;
|
|
9806
10324
|
}
|
|
10325
|
+
/**
|
|
10326
|
+
* Request message for the AgentService.UploadAgentFile method.
|
|
10327
|
+
*/
|
|
10328
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest {
|
|
10329
|
+
/**
|
|
10330
|
+
* Information about the file being uploaded.
|
|
10331
|
+
*/
|
|
10332
|
+
blob?: Schema$GdataMedia;
|
|
10333
|
+
/**
|
|
10334
|
+
* Media upload request metadata.
|
|
10335
|
+
*/
|
|
10336
|
+
mediaRequestInfo?: Schema$ApiservingMediaRequestInfo;
|
|
10337
|
+
}
|
|
10338
|
+
/**
|
|
10339
|
+
* Response message for the AgentService.UploadAgentFile method.
|
|
10340
|
+
*/
|
|
10341
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse {
|
|
10342
|
+
/**
|
|
10343
|
+
* The uploaded AgentFile.
|
|
10344
|
+
*/
|
|
10345
|
+
agentFile?: Schema$GoogleCloudDiscoveryengineV1alphaAgentFile;
|
|
10346
|
+
/**
|
|
10347
|
+
* Media upload response metadata.
|
|
10348
|
+
*/
|
|
10349
|
+
mediaResponseInfo?: Schema$ApiservingMediaResponseInfo;
|
|
10350
|
+
}
|
|
9807
10351
|
/**
|
|
9808
10352
|
* Request for the AssistantService.UploadSessionFile method.
|
|
9809
10353
|
*/
|
|
@@ -9975,6 +10519,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9975
10519
|
*/
|
|
9976
10520
|
userProfile?: string | null;
|
|
9977
10521
|
}
|
|
10522
|
+
/**
|
|
10523
|
+
* Configures metadata that is used for End User entities.
|
|
10524
|
+
*/
|
|
10525
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserStore {
|
|
10526
|
+
/**
|
|
10527
|
+
* Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
|
|
10528
|
+
*/
|
|
10529
|
+
defaultLicenseConfig?: string | null;
|
|
10530
|
+
/**
|
|
10531
|
+
* The display name of the User Store.
|
|
10532
|
+
*/
|
|
10533
|
+
displayName?: string | null;
|
|
10534
|
+
/**
|
|
10535
|
+
* Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
|
|
10536
|
+
*/
|
|
10537
|
+
enableExpiredLicenseAutoUpdate?: boolean | null;
|
|
10538
|
+
/**
|
|
10539
|
+
* Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
|
|
10540
|
+
*/
|
|
10541
|
+
enableLicenseAutoRegister?: boolean | null;
|
|
10542
|
+
/**
|
|
10543
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
10544
|
+
*/
|
|
10545
|
+
name?: string | null;
|
|
10546
|
+
}
|
|
9978
10547
|
/**
|
|
9979
10548
|
* Standard characteristics of a video media view.
|
|
9980
10549
|
*/
|
|
@@ -10108,12 +10677,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10108
10677
|
* Whether to enable standalone web app.
|
|
10109
10678
|
*/
|
|
10110
10679
|
enableWebApp?: boolean | null;
|
|
10111
|
-
/**
|
|
10112
|
-
* Allows to toggle unstable/experimental features in the widget (or web app)
|
|
10113
|
-
*/
|
|
10114
|
-
experimentalFeatures?: {
|
|
10115
|
-
[key: string]: string;
|
|
10116
|
-
} | null;
|
|
10117
10680
|
/**
|
|
10118
10681
|
* The configuration and appearance of facets in the end user view.
|
|
10119
10682
|
*/
|
|
@@ -10124,6 +10687,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10124
10687
|
fieldsUiComponentsMap?: {
|
|
10125
10688
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
10126
10689
|
} | null;
|
|
10690
|
+
/**
|
|
10691
|
+
* Output only. Whether the subscription is gemini bundle or not.
|
|
10692
|
+
*/
|
|
10693
|
+
geminiBundle?: boolean | null;
|
|
10127
10694
|
/**
|
|
10128
10695
|
* Optional. Describes the homepage settings of the widget.
|
|
10129
10696
|
*/
|
|
@@ -10327,7 +10894,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10327
10894
|
*/
|
|
10328
10895
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting {
|
|
10329
10896
|
/**
|
|
10330
|
-
* Optional. The shortcuts to display on the homepage.
|
|
10897
|
+
* Optional. The shortcuts to display on the homepage.
|
|
10331
10898
|
*/
|
|
10332
10899
|
shortcuts?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut[];
|
|
10333
10900
|
}
|
|
@@ -10445,6 +11012,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10445
11012
|
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
10446
11013
|
*/
|
|
10447
11014
|
resultDescriptionType?: string | null;
|
|
11015
|
+
/**
|
|
11016
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
|
|
11017
|
+
*/
|
|
11018
|
+
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec;
|
|
10448
11019
|
}
|
|
10449
11020
|
/**
|
|
10450
11021
|
* Describes configuration for generative answer.
|
|
@@ -10491,6 +11062,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10491
11062
|
*/
|
|
10492
11063
|
resultCount?: number | null;
|
|
10493
11064
|
}
|
|
11065
|
+
/**
|
|
11066
|
+
* SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.
|
|
11067
|
+
*/
|
|
11068
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec {
|
|
11069
|
+
/**
|
|
11070
|
+
* Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
|
|
11071
|
+
*/
|
|
11072
|
+
generativeAnswerAddOnDisabled?: boolean | null;
|
|
11073
|
+
/**
|
|
11074
|
+
* Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
|
|
11075
|
+
*/
|
|
11076
|
+
kpiPersonalizationAddOnDisabled?: boolean | null;
|
|
11077
|
+
/**
|
|
11078
|
+
* Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
|
|
11079
|
+
*/
|
|
11080
|
+
semanticAddOnDisabled?: boolean | null;
|
|
11081
|
+
}
|
|
10494
11082
|
/**
|
|
10495
11083
|
* Config to store data store type configuration for workspace data
|
|
10496
11084
|
*/
|
|
@@ -11171,6 +11759,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11171
11759
|
* Optional. Configuration for configurable billing approach. See
|
|
11172
11760
|
*/
|
|
11173
11761
|
configurableBillingApproach?: string | null;
|
|
11762
|
+
/**
|
|
11763
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
11764
|
+
*/
|
|
11765
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
11174
11766
|
/**
|
|
11175
11767
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
11176
11768
|
*/
|
|
@@ -12180,6 +12772,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12180
12772
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
12181
12773
|
*/
|
|
12182
12774
|
export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
|
|
12775
|
+
/**
|
|
12776
|
+
* Output only. The current status of the project's configurable billing.
|
|
12777
|
+
*/
|
|
12778
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
|
|
12183
12779
|
/**
|
|
12184
12780
|
* Output only. The timestamp when this project is created.
|
|
12185
12781
|
*/
|
|
@@ -12203,6 +12799,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12203
12799
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
12204
12800
|
} | null;
|
|
12205
12801
|
}
|
|
12802
|
+
/**
|
|
12803
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
12804
|
+
*/
|
|
12805
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
|
|
12806
|
+
/**
|
|
12807
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
12808
|
+
*/
|
|
12809
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
12810
|
+
/**
|
|
12811
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
12812
|
+
*/
|
|
12813
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
12814
|
+
/**
|
|
12815
|
+
* Optional. The start time of the currently active billing subscription.
|
|
12816
|
+
*/
|
|
12817
|
+
startTime?: string | null;
|
|
12818
|
+
}
|
|
12206
12819
|
/**
|
|
12207
12820
|
* Customer provided configurations.
|
|
12208
12821
|
*/
|
|
@@ -12220,6 +12833,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12220
12833
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
12221
12834
|
*/
|
|
12222
12835
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
12836
|
+
/**
|
|
12837
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
12838
|
+
*/
|
|
12839
|
+
optOutNotebookSharing?: boolean | null;
|
|
12223
12840
|
}
|
|
12224
12841
|
/**
|
|
12225
12842
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -12597,7 +13214,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12597
13214
|
[key: string]: string;
|
|
12598
13215
|
} | null;
|
|
12599
13216
|
/**
|
|
12600
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
13217
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
12601
13218
|
*/
|
|
12602
13219
|
userPseudoId?: string | null;
|
|
12603
13220
|
}
|
|
@@ -13290,6 +13907,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13290
13907
|
*/
|
|
13291
13908
|
userProfile?: string | null;
|
|
13292
13909
|
}
|
|
13910
|
+
/**
|
|
13911
|
+
* Configures metadata that is used for End User entities.
|
|
13912
|
+
*/
|
|
13913
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
|
|
13914
|
+
/**
|
|
13915
|
+
* Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
|
|
13916
|
+
*/
|
|
13917
|
+
defaultLicenseConfig?: string | null;
|
|
13918
|
+
/**
|
|
13919
|
+
* The display name of the User Store.
|
|
13920
|
+
*/
|
|
13921
|
+
displayName?: string | null;
|
|
13922
|
+
/**
|
|
13923
|
+
* Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
|
|
13924
|
+
*/
|
|
13925
|
+
enableExpiredLicenseAutoUpdate?: boolean | null;
|
|
13926
|
+
/**
|
|
13927
|
+
* Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
|
|
13928
|
+
*/
|
|
13929
|
+
enableLicenseAutoRegister?: boolean | null;
|
|
13930
|
+
/**
|
|
13931
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
13932
|
+
*/
|
|
13933
|
+
name?: string | null;
|
|
13934
|
+
}
|
|
13293
13935
|
/**
|
|
13294
13936
|
* Config to store data store type configuration for workspace data
|
|
13295
13937
|
*/
|
|
@@ -13925,6 +14567,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13925
14567
|
* Optional. Configuration for configurable billing approach. See
|
|
13926
14568
|
*/
|
|
13927
14569
|
configurableBillingApproach?: string | null;
|
|
14570
|
+
/**
|
|
14571
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
14572
|
+
*/
|
|
14573
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
13928
14574
|
/**
|
|
13929
14575
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
13930
14576
|
*/
|
|
@@ -14798,6 +15444,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14798
15444
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
14799
15445
|
*/
|
|
14800
15446
|
export interface Schema$GoogleCloudDiscoveryengineV1Project {
|
|
15447
|
+
/**
|
|
15448
|
+
* Output only. The current status of the project's configurable billing.
|
|
15449
|
+
*/
|
|
15450
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
|
|
14801
15451
|
/**
|
|
14802
15452
|
* Output only. The timestamp when this project is created.
|
|
14803
15453
|
*/
|
|
@@ -14821,6 +15471,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14821
15471
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
14822
15472
|
} | null;
|
|
14823
15473
|
}
|
|
15474
|
+
/**
|
|
15475
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
15476
|
+
*/
|
|
15477
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
|
|
15478
|
+
/**
|
|
15479
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
15480
|
+
*/
|
|
15481
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
15482
|
+
/**
|
|
15483
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
15484
|
+
*/
|
|
15485
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
15486
|
+
/**
|
|
15487
|
+
* Optional. The start time of the currently active billing subscription.
|
|
15488
|
+
*/
|
|
15489
|
+
startTime?: string | null;
|
|
15490
|
+
}
|
|
14824
15491
|
/**
|
|
14825
15492
|
* Customer provided configurations.
|
|
14826
15493
|
*/
|
|
@@ -14838,6 +15505,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14838
15505
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
14839
15506
|
*/
|
|
14840
15507
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
15508
|
+
/**
|
|
15509
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
15510
|
+
*/
|
|
15511
|
+
optOutNotebookSharing?: boolean | null;
|
|
14841
15512
|
}
|
|
14842
15513
|
/**
|
|
14843
15514
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -15518,6 +16189,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15518
16189
|
*/
|
|
15519
16190
|
userProfile?: string | null;
|
|
15520
16191
|
}
|
|
16192
|
+
/**
|
|
16193
|
+
* Configures metadata that is used for End User entities.
|
|
16194
|
+
*/
|
|
16195
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
|
|
16196
|
+
/**
|
|
16197
|
+
* Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
|
|
16198
|
+
*/
|
|
16199
|
+
defaultLicenseConfig?: string | null;
|
|
16200
|
+
/**
|
|
16201
|
+
* The display name of the User Store.
|
|
16202
|
+
*/
|
|
16203
|
+
displayName?: string | null;
|
|
16204
|
+
/**
|
|
16205
|
+
* Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
|
|
16206
|
+
*/
|
|
16207
|
+
enableExpiredLicenseAutoUpdate?: boolean | null;
|
|
16208
|
+
/**
|
|
16209
|
+
* Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
|
|
16210
|
+
*/
|
|
16211
|
+
enableLicenseAutoRegister?: boolean | null;
|
|
16212
|
+
/**
|
|
16213
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
16214
|
+
*/
|
|
16215
|
+
name?: string | null;
|
|
16216
|
+
}
|
|
15521
16217
|
/**
|
|
15522
16218
|
* Config to store data store type configuration for workspace data
|
|
15523
16219
|
*/
|
|
@@ -16401,11 +17097,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16401
17097
|
*/
|
|
16402
17098
|
version?: string | null;
|
|
16403
17099
|
}
|
|
16404
|
-
export class Resource$
|
|
17100
|
+
export class Resource$Billingaccounts {
|
|
17101
|
+
context: APIRequestContext;
|
|
17102
|
+
billingAccountLicenseConfigs: Resource$Billingaccounts$Billingaccountlicenseconfigs;
|
|
17103
|
+
constructor(context: APIRequestContext);
|
|
17104
|
+
}
|
|
17105
|
+
export class Resource$Billingaccounts$Billingaccountlicenseconfigs {
|
|
16405
17106
|
context: APIRequestContext;
|
|
16406
17107
|
constructor(context: APIRequestContext);
|
|
16407
17108
|
/**
|
|
16408
|
-
*
|
|
17109
|
+
* Distributes a LicenseConfig from billing account level to project level.
|
|
16409
17110
|
* @example
|
|
16410
17111
|
* ```js
|
|
16411
17112
|
* // Before running the sample:
|
|
@@ -16428,7 +17129,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16428
17129
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
16429
17130
|
* scopes: [
|
|
16430
17131
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
16431
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
16432
17132
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
16433
17133
|
* ],
|
|
16434
17134
|
* });
|
|
@@ -16438,48 +17138,30 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16438
17138
|
* google.options({auth: authClient});
|
|
16439
17139
|
*
|
|
16440
17140
|
* // Do the magic
|
|
16441
|
-
* const res =
|
|
16442
|
-
*
|
|
16443
|
-
*
|
|
16444
|
-
*
|
|
16445
|
-
*
|
|
16446
|
-
*
|
|
16447
|
-
*
|
|
16448
|
-
*
|
|
17141
|
+
* const res =
|
|
17142
|
+
* await discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig(
|
|
17143
|
+
* {
|
|
17144
|
+
* // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17145
|
+
* billingAccountLicenseConfig:
|
|
17146
|
+
* 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig',
|
|
17147
|
+
*
|
|
17148
|
+
* // Request body metadata
|
|
17149
|
+
* requestBody: {
|
|
17150
|
+
* // request body parameters
|
|
17151
|
+
* // {
|
|
17152
|
+
* // "licenseConfigId": "my_licenseConfigId",
|
|
17153
|
+
* // "licenseCount": "my_licenseCount",
|
|
17154
|
+
* // "location": "my_location",
|
|
17155
|
+
* // "projectNumber": "my_projectNumber"
|
|
17156
|
+
* // }
|
|
17157
|
+
* },
|
|
17158
|
+
* },
|
|
17159
|
+
* );
|
|
16449
17160
|
* console.log(res.data);
|
|
16450
17161
|
*
|
|
16451
17162
|
* // Example response
|
|
16452
17163
|
* // {
|
|
16453
|
-
* // "
|
|
16454
|
-
* // "bigstoreObjectRef": "my_bigstoreObjectRef",
|
|
16455
|
-
* // "blobRef": "my_blobRef",
|
|
16456
|
-
* // "blobstore2Info": {},
|
|
16457
|
-
* // "compositeMedia": [],
|
|
16458
|
-
* // "contentType": "my_contentType",
|
|
16459
|
-
* // "contentTypeInfo": {},
|
|
16460
|
-
* // "cosmoBinaryReference": "my_cosmoBinaryReference",
|
|
16461
|
-
* // "crc32cHash": 0,
|
|
16462
|
-
* // "diffChecksumsResponse": {},
|
|
16463
|
-
* // "diffDownloadResponse": {},
|
|
16464
|
-
* // "diffUploadRequest": {},
|
|
16465
|
-
* // "diffUploadResponse": {},
|
|
16466
|
-
* // "diffVersionResponse": {},
|
|
16467
|
-
* // "downloadParameters": {},
|
|
16468
|
-
* // "filename": "my_filename",
|
|
16469
|
-
* // "hash": "my_hash",
|
|
16470
|
-
* // "hashVerified": false,
|
|
16471
|
-
* // "inline": "my_inline",
|
|
16472
|
-
* // "isPotentialRetry": false,
|
|
16473
|
-
* // "length": "my_length",
|
|
16474
|
-
* // "md5Hash": "my_md5Hash",
|
|
16475
|
-
* // "mediaId": "my_mediaId",
|
|
16476
|
-
* // "objectId": {},
|
|
16477
|
-
* // "path": "my_path",
|
|
16478
|
-
* // "referenceType": "my_referenceType",
|
|
16479
|
-
* // "sha1Hash": "my_sha1Hash",
|
|
16480
|
-
* // "sha256Hash": "my_sha256Hash",
|
|
16481
|
-
* // "timestamp": "my_timestamp",
|
|
16482
|
-
* // "token": "my_token"
|
|
17164
|
+
* // "licenseConfig": {}
|
|
16483
17165
|
* // }
|
|
16484
17166
|
* }
|
|
16485
17167
|
*
|
|
@@ -16495,34 +17177,498 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16495
17177
|
* @param callback - Optional callback that handles the response.
|
|
16496
17178
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
16497
17179
|
*/
|
|
16498
|
-
|
|
16499
|
-
|
|
16500
|
-
|
|
16501
|
-
|
|
16502
|
-
|
|
16503
|
-
|
|
16504
|
-
}
|
|
16505
|
-
export interface Params$Resource$Media$Download extends StandardParameters {
|
|
16506
|
-
/**
|
|
16507
|
-
* Required. The ID of the file to be downloaded.
|
|
16508
|
-
*/
|
|
16509
|
-
fileId?: string;
|
|
16510
|
-
/**
|
|
16511
|
-
* Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
16512
|
-
*/
|
|
16513
|
-
name?: string;
|
|
16514
|
-
/**
|
|
16515
|
-
* Optional. The ID of the view to be downloaded.
|
|
16516
|
-
*/
|
|
16517
|
-
viewId?: string;
|
|
16518
|
-
}
|
|
16519
|
-
export class Resource$Projects {
|
|
16520
|
-
context: APIRequestContext;
|
|
16521
|
-
locations: Resource$Projects$Locations;
|
|
16522
|
-
operations: Resource$Projects$Operations;
|
|
16523
|
-
constructor(context: APIRequestContext);
|
|
17180
|
+
distributeLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17181
|
+
distributeLicenseConfig(params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse>>;
|
|
17182
|
+
distributeLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17183
|
+
distributeLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse>): void;
|
|
17184
|
+
distributeLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse>): void;
|
|
17185
|
+
distributeLicenseConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse>): void;
|
|
16524
17186
|
/**
|
|
16525
|
-
* Gets a
|
|
17187
|
+
* Gets a BillingAccountLicenseConfig.
|
|
17188
|
+
* @example
|
|
17189
|
+
* ```js
|
|
17190
|
+
* // Before running the sample:
|
|
17191
|
+
* // - Enable the API at:
|
|
17192
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17193
|
+
* // - Login into gcloud by running:
|
|
17194
|
+
* // ```sh
|
|
17195
|
+
* // $ gcloud auth application-default login
|
|
17196
|
+
* // ```
|
|
17197
|
+
* // - Install the npm module by running:
|
|
17198
|
+
* // ```sh
|
|
17199
|
+
* // $ npm install googleapis
|
|
17200
|
+
* // ```
|
|
17201
|
+
*
|
|
17202
|
+
* const {google} = require('googleapis');
|
|
17203
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
17204
|
+
*
|
|
17205
|
+
* async function main() {
|
|
17206
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17207
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17208
|
+
* scopes: [
|
|
17209
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17210
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17211
|
+
* ],
|
|
17212
|
+
* });
|
|
17213
|
+
*
|
|
17214
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17215
|
+
* const authClient = await auth.getClient();
|
|
17216
|
+
* google.options({auth: authClient});
|
|
17217
|
+
*
|
|
17218
|
+
* // Do the magic
|
|
17219
|
+
* const res =
|
|
17220
|
+
* await discoveryengine.billingAccounts.billingAccountLicenseConfigs.get({
|
|
17221
|
+
* // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17222
|
+
* name: 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig',
|
|
17223
|
+
* });
|
|
17224
|
+
* console.log(res.data);
|
|
17225
|
+
*
|
|
17226
|
+
* // Example response
|
|
17227
|
+
* // {
|
|
17228
|
+
* // "autoRenew": false,
|
|
17229
|
+
* // "endDate": {},
|
|
17230
|
+
* // "geminiBundle": false,
|
|
17231
|
+
* // "licenseConfigDistributions": {},
|
|
17232
|
+
* // "licenseCount": "my_licenseCount",
|
|
17233
|
+
* // "name": "my_name",
|
|
17234
|
+
* // "procurementEntitlementId": "my_procurementEntitlementId",
|
|
17235
|
+
* // "startDate": {},
|
|
17236
|
+
* // "state": "my_state",
|
|
17237
|
+
* // "subscriptionDisplayName": "my_subscriptionDisplayName",
|
|
17238
|
+
* // "subscriptionName": "my_subscriptionName",
|
|
17239
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
17240
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
17241
|
+
* // }
|
|
17242
|
+
* }
|
|
17243
|
+
*
|
|
17244
|
+
* main().catch(e => {
|
|
17245
|
+
* console.error(e);
|
|
17246
|
+
* throw e;
|
|
17247
|
+
* });
|
|
17248
|
+
*
|
|
17249
|
+
* ```
|
|
17250
|
+
*
|
|
17251
|
+
* @param params - Parameters for request
|
|
17252
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17253
|
+
* @param callback - Optional callback that handles the response.
|
|
17254
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17255
|
+
*/
|
|
17256
|
+
get(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17257
|
+
get(params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig>>;
|
|
17258
|
+
get(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17259
|
+
get(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig>): void;
|
|
17260
|
+
get(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig>): void;
|
|
17261
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig>): void;
|
|
17262
|
+
/**
|
|
17263
|
+
* Lists all BillingAccountLicenseConfigs for a given billing account.
|
|
17264
|
+
* @example
|
|
17265
|
+
* ```js
|
|
17266
|
+
* // Before running the sample:
|
|
17267
|
+
* // - Enable the API at:
|
|
17268
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17269
|
+
* // - Login into gcloud by running:
|
|
17270
|
+
* // ```sh
|
|
17271
|
+
* // $ gcloud auth application-default login
|
|
17272
|
+
* // ```
|
|
17273
|
+
* // - Install the npm module by running:
|
|
17274
|
+
* // ```sh
|
|
17275
|
+
* // $ npm install googleapis
|
|
17276
|
+
* // ```
|
|
17277
|
+
*
|
|
17278
|
+
* const {google} = require('googleapis');
|
|
17279
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
17280
|
+
*
|
|
17281
|
+
* async function main() {
|
|
17282
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17283
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17284
|
+
* scopes: [
|
|
17285
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17286
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17287
|
+
* ],
|
|
17288
|
+
* });
|
|
17289
|
+
*
|
|
17290
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17291
|
+
* const authClient = await auth.getClient();
|
|
17292
|
+
* google.options({auth: authClient});
|
|
17293
|
+
*
|
|
17294
|
+
* // Do the magic
|
|
17295
|
+
* const res =
|
|
17296
|
+
* await discoveryengine.billingAccounts.billingAccountLicenseConfigs.list({
|
|
17297
|
+
* // Optional. Not supported.
|
|
17298
|
+
* pageSize: 'placeholder-value',
|
|
17299
|
+
* // Optional. Not supported.
|
|
17300
|
+
* pageToken: 'placeholder-value',
|
|
17301
|
+
* // Required. Format: `billingAccounts/{billing_account\}`.
|
|
17302
|
+
* parent: 'billingAccounts/my-billingAccount',
|
|
17303
|
+
* });
|
|
17304
|
+
* console.log(res.data);
|
|
17305
|
+
*
|
|
17306
|
+
* // Example response
|
|
17307
|
+
* // {
|
|
17308
|
+
* // "billingAccountLicenseConfigs": [],
|
|
17309
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
17310
|
+
* // }
|
|
17311
|
+
* }
|
|
17312
|
+
*
|
|
17313
|
+
* main().catch(e => {
|
|
17314
|
+
* console.error(e);
|
|
17315
|
+
* throw e;
|
|
17316
|
+
* });
|
|
17317
|
+
*
|
|
17318
|
+
* ```
|
|
17319
|
+
*
|
|
17320
|
+
* @param params - Parameters for request
|
|
17321
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17322
|
+
* @param callback - Optional callback that handles the response.
|
|
17323
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17324
|
+
*/
|
|
17325
|
+
list(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17326
|
+
list(params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse>>;
|
|
17327
|
+
list(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17328
|
+
list(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse>): void;
|
|
17329
|
+
list(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse>): void;
|
|
17330
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse>): void;
|
|
17331
|
+
/**
|
|
17332
|
+
* This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
|
|
17333
|
+
* @example
|
|
17334
|
+
* ```js
|
|
17335
|
+
* // Before running the sample:
|
|
17336
|
+
* // - Enable the API at:
|
|
17337
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17338
|
+
* // - Login into gcloud by running:
|
|
17339
|
+
* // ```sh
|
|
17340
|
+
* // $ gcloud auth application-default login
|
|
17341
|
+
* // ```
|
|
17342
|
+
* // - Install the npm module by running:
|
|
17343
|
+
* // ```sh
|
|
17344
|
+
* // $ npm install googleapis
|
|
17345
|
+
* // ```
|
|
17346
|
+
*
|
|
17347
|
+
* const {google} = require('googleapis');
|
|
17348
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
17349
|
+
*
|
|
17350
|
+
* async function main() {
|
|
17351
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17352
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17353
|
+
* scopes: [
|
|
17354
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17355
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17356
|
+
* ],
|
|
17357
|
+
* });
|
|
17358
|
+
*
|
|
17359
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17360
|
+
* const authClient = await auth.getClient();
|
|
17361
|
+
* google.options({auth: authClient});
|
|
17362
|
+
*
|
|
17363
|
+
* // Do the magic
|
|
17364
|
+
* const res =
|
|
17365
|
+
* await discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig(
|
|
17366
|
+
* {
|
|
17367
|
+
* // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17368
|
+
* billingAccountLicenseConfig:
|
|
17369
|
+
* 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig',
|
|
17370
|
+
*
|
|
17371
|
+
* // Request body metadata
|
|
17372
|
+
* requestBody: {
|
|
17373
|
+
* // request body parameters
|
|
17374
|
+
* // {
|
|
17375
|
+
* // "fullRetract": false,
|
|
17376
|
+
* // "licenseConfig": "my_licenseConfig",
|
|
17377
|
+
* // "licenseCount": "my_licenseCount"
|
|
17378
|
+
* // }
|
|
17379
|
+
* },
|
|
17380
|
+
* },
|
|
17381
|
+
* );
|
|
17382
|
+
* console.log(res.data);
|
|
17383
|
+
*
|
|
17384
|
+
* // Example response
|
|
17385
|
+
* // {
|
|
17386
|
+
* // "licenseConfig": {}
|
|
17387
|
+
* // }
|
|
17388
|
+
* }
|
|
17389
|
+
*
|
|
17390
|
+
* main().catch(e => {
|
|
17391
|
+
* console.error(e);
|
|
17392
|
+
* throw e;
|
|
17393
|
+
* });
|
|
17394
|
+
*
|
|
17395
|
+
* ```
|
|
17396
|
+
*
|
|
17397
|
+
* @param params - Parameters for request
|
|
17398
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17399
|
+
* @param callback - Optional callback that handles the response.
|
|
17400
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17401
|
+
*/
|
|
17402
|
+
retractLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17403
|
+
retractLicenseConfig(params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse>>;
|
|
17404
|
+
retractLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17405
|
+
retractLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse>): void;
|
|
17406
|
+
retractLicenseConfig(params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse>): void;
|
|
17407
|
+
retractLicenseConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse>): void;
|
|
17408
|
+
}
|
|
17409
|
+
export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig extends StandardParameters {
|
|
17410
|
+
/**
|
|
17411
|
+
* Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17412
|
+
*/
|
|
17413
|
+
billingAccountLicenseConfig?: string;
|
|
17414
|
+
/**
|
|
17415
|
+
* Request body metadata
|
|
17416
|
+
*/
|
|
17417
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest;
|
|
17418
|
+
}
|
|
17419
|
+
export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get extends StandardParameters {
|
|
17420
|
+
/**
|
|
17421
|
+
* Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17422
|
+
*/
|
|
17423
|
+
name?: string;
|
|
17424
|
+
}
|
|
17425
|
+
export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List extends StandardParameters {
|
|
17426
|
+
/**
|
|
17427
|
+
* Optional. Not supported.
|
|
17428
|
+
*/
|
|
17429
|
+
pageSize?: number;
|
|
17430
|
+
/**
|
|
17431
|
+
* Optional. Not supported.
|
|
17432
|
+
*/
|
|
17433
|
+
pageToken?: string;
|
|
17434
|
+
/**
|
|
17435
|
+
* Required. Format: `billingAccounts/{billing_account\}`.
|
|
17436
|
+
*/
|
|
17437
|
+
parent?: string;
|
|
17438
|
+
}
|
|
17439
|
+
export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig extends StandardParameters {
|
|
17440
|
+
/**
|
|
17441
|
+
* Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`.
|
|
17442
|
+
*/
|
|
17443
|
+
billingAccountLicenseConfig?: string;
|
|
17444
|
+
/**
|
|
17445
|
+
* Request body metadata
|
|
17446
|
+
*/
|
|
17447
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest;
|
|
17448
|
+
}
|
|
17449
|
+
export class Resource$Media {
|
|
17450
|
+
context: APIRequestContext;
|
|
17451
|
+
constructor(context: APIRequestContext);
|
|
17452
|
+
/**
|
|
17453
|
+
* Downloads a file from the session.
|
|
17454
|
+
* @example
|
|
17455
|
+
* ```js
|
|
17456
|
+
* // Before running the sample:
|
|
17457
|
+
* // - Enable the API at:
|
|
17458
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17459
|
+
* // - Login into gcloud by running:
|
|
17460
|
+
* // ```sh
|
|
17461
|
+
* // $ gcloud auth application-default login
|
|
17462
|
+
* // ```
|
|
17463
|
+
* // - Install the npm module by running:
|
|
17464
|
+
* // ```sh
|
|
17465
|
+
* // $ npm install googleapis
|
|
17466
|
+
* // ```
|
|
17467
|
+
*
|
|
17468
|
+
* const {google} = require('googleapis');
|
|
17469
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
17470
|
+
*
|
|
17471
|
+
* async function main() {
|
|
17472
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17473
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17474
|
+
* scopes: [
|
|
17475
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17476
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
17477
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17478
|
+
* ],
|
|
17479
|
+
* });
|
|
17480
|
+
*
|
|
17481
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17482
|
+
* const authClient = await auth.getClient();
|
|
17483
|
+
* google.options({auth: authClient});
|
|
17484
|
+
*
|
|
17485
|
+
* // Do the magic
|
|
17486
|
+
* const res = await discoveryengine.media.download({
|
|
17487
|
+
* // Required. The ID of the file to be downloaded.
|
|
17488
|
+
* fileId: 'placeholder-value',
|
|
17489
|
+
* // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
17490
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
17491
|
+
* // Optional. The ID of the view to be downloaded.
|
|
17492
|
+
* viewId: 'placeholder-value',
|
|
17493
|
+
* });
|
|
17494
|
+
* console.log(res.data);
|
|
17495
|
+
*
|
|
17496
|
+
* // Example response
|
|
17497
|
+
* // {
|
|
17498
|
+
* // "algorithm": "my_algorithm",
|
|
17499
|
+
* // "bigstoreObjectRef": "my_bigstoreObjectRef",
|
|
17500
|
+
* // "blobRef": "my_blobRef",
|
|
17501
|
+
* // "blobstore2Info": {},
|
|
17502
|
+
* // "compositeMedia": [],
|
|
17503
|
+
* // "contentType": "my_contentType",
|
|
17504
|
+
* // "contentTypeInfo": {},
|
|
17505
|
+
* // "cosmoBinaryReference": "my_cosmoBinaryReference",
|
|
17506
|
+
* // "crc32cHash": 0,
|
|
17507
|
+
* // "diffChecksumsResponse": {},
|
|
17508
|
+
* // "diffDownloadResponse": {},
|
|
17509
|
+
* // "diffUploadRequest": {},
|
|
17510
|
+
* // "diffUploadResponse": {},
|
|
17511
|
+
* // "diffVersionResponse": {},
|
|
17512
|
+
* // "downloadParameters": {},
|
|
17513
|
+
* // "filename": "my_filename",
|
|
17514
|
+
* // "hash": "my_hash",
|
|
17515
|
+
* // "hashVerified": false,
|
|
17516
|
+
* // "inline": "my_inline",
|
|
17517
|
+
* // "isPotentialRetry": false,
|
|
17518
|
+
* // "length": "my_length",
|
|
17519
|
+
* // "md5Hash": "my_md5Hash",
|
|
17520
|
+
* // "mediaId": "my_mediaId",
|
|
17521
|
+
* // "objectId": {},
|
|
17522
|
+
* // "path": "my_path",
|
|
17523
|
+
* // "referenceType": "my_referenceType",
|
|
17524
|
+
* // "sha1Hash": "my_sha1Hash",
|
|
17525
|
+
* // "sha256Hash": "my_sha256Hash",
|
|
17526
|
+
* // "timestamp": "my_timestamp",
|
|
17527
|
+
* // "token": "my_token"
|
|
17528
|
+
* // }
|
|
17529
|
+
* }
|
|
17530
|
+
*
|
|
17531
|
+
* main().catch(e => {
|
|
17532
|
+
* console.error(e);
|
|
17533
|
+
* throw e;
|
|
17534
|
+
* });
|
|
17535
|
+
*
|
|
17536
|
+
* ```
|
|
17537
|
+
*
|
|
17538
|
+
* @param params - Parameters for request
|
|
17539
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17540
|
+
* @param callback - Optional callback that handles the response.
|
|
17541
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17542
|
+
*/
|
|
17543
|
+
download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17544
|
+
download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GdataMedia>>;
|
|
17545
|
+
download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17546
|
+
download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
17547
|
+
download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
17548
|
+
download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
17549
|
+
/**
|
|
17550
|
+
* Uploads a file for the assistant to use as a source of information within the session.
|
|
17551
|
+
* @example
|
|
17552
|
+
* ```js
|
|
17553
|
+
* // Before running the sample:
|
|
17554
|
+
* // - Enable the API at:
|
|
17555
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17556
|
+
* // - Login into gcloud by running:
|
|
17557
|
+
* // ```sh
|
|
17558
|
+
* // $ gcloud auth application-default login
|
|
17559
|
+
* // ```
|
|
17560
|
+
* // - Install the npm module by running:
|
|
17561
|
+
* // ```sh
|
|
17562
|
+
* // $ npm install googleapis
|
|
17563
|
+
* // ```
|
|
17564
|
+
*
|
|
17565
|
+
* const {google} = require('googleapis');
|
|
17566
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
17567
|
+
*
|
|
17568
|
+
* async function main() {
|
|
17569
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17570
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17571
|
+
* scopes: [
|
|
17572
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17573
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
17574
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17575
|
+
* ],
|
|
17576
|
+
* });
|
|
17577
|
+
*
|
|
17578
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17579
|
+
* const authClient = await auth.getClient();
|
|
17580
|
+
* google.options({auth: authClient});
|
|
17581
|
+
*
|
|
17582
|
+
* // Do the magic
|
|
17583
|
+
* const res = await discoveryengine.media.upload({
|
|
17584
|
+
* // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
17585
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
17586
|
+
*
|
|
17587
|
+
* // Request body metadata
|
|
17588
|
+
* requestBody: {
|
|
17589
|
+
* // request body parameters
|
|
17590
|
+
* // {
|
|
17591
|
+
* // "blob": {},
|
|
17592
|
+
* // "mediaRequestInfo": {}
|
|
17593
|
+
* // }
|
|
17594
|
+
* },
|
|
17595
|
+
* media: {
|
|
17596
|
+
* mimeType: 'placeholder-value',
|
|
17597
|
+
* body: 'placeholder-value',
|
|
17598
|
+
* },
|
|
17599
|
+
* });
|
|
17600
|
+
* console.log(res.data);
|
|
17601
|
+
*
|
|
17602
|
+
* // Example response
|
|
17603
|
+
* // {
|
|
17604
|
+
* // "fileId": "my_fileId",
|
|
17605
|
+
* // "mediaResponseInfo": {}
|
|
17606
|
+
* // }
|
|
17607
|
+
* }
|
|
17608
|
+
*
|
|
17609
|
+
* main().catch(e => {
|
|
17610
|
+
* console.error(e);
|
|
17611
|
+
* throw e;
|
|
17612
|
+
* });
|
|
17613
|
+
*
|
|
17614
|
+
* ```
|
|
17615
|
+
*
|
|
17616
|
+
* @param params - Parameters for request
|
|
17617
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17618
|
+
* @param callback - Optional callback that handles the response.
|
|
17619
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17620
|
+
*/
|
|
17621
|
+
upload(params: Params$Resource$Media$Upload, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17622
|
+
upload(params?: Params$Resource$Media$Upload, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse>>;
|
|
17623
|
+
upload(params: Params$Resource$Media$Upload, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
17624
|
+
upload(params: Params$Resource$Media$Upload, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse>): void;
|
|
17625
|
+
upload(params: Params$Resource$Media$Upload, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse>): void;
|
|
17626
|
+
upload(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse>): void;
|
|
17627
|
+
}
|
|
17628
|
+
export interface Params$Resource$Media$Download extends StandardParameters {
|
|
17629
|
+
/**
|
|
17630
|
+
* Required. The ID of the file to be downloaded.
|
|
17631
|
+
*/
|
|
17632
|
+
fileId?: string;
|
|
17633
|
+
/**
|
|
17634
|
+
* Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
17635
|
+
*/
|
|
17636
|
+
name?: string;
|
|
17637
|
+
/**
|
|
17638
|
+
* Optional. The ID of the view to be downloaded.
|
|
17639
|
+
*/
|
|
17640
|
+
viewId?: string;
|
|
17641
|
+
}
|
|
17642
|
+
export interface Params$Resource$Media$Upload extends StandardParameters {
|
|
17643
|
+
/**
|
|
17644
|
+
* Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
17645
|
+
*/
|
|
17646
|
+
name?: string;
|
|
17647
|
+
/**
|
|
17648
|
+
* Request body metadata
|
|
17649
|
+
*/
|
|
17650
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest;
|
|
17651
|
+
/**
|
|
17652
|
+
* Media metadata
|
|
17653
|
+
*/
|
|
17654
|
+
media?: {
|
|
17655
|
+
/**
|
|
17656
|
+
* Media mime-type
|
|
17657
|
+
*/
|
|
17658
|
+
mimeType?: string;
|
|
17659
|
+
/**
|
|
17660
|
+
* Media body contents
|
|
17661
|
+
*/
|
|
17662
|
+
body?: any;
|
|
17663
|
+
};
|
|
17664
|
+
}
|
|
17665
|
+
export class Resource$Projects {
|
|
17666
|
+
context: APIRequestContext;
|
|
17667
|
+
locations: Resource$Projects$Locations;
|
|
17668
|
+
operations: Resource$Projects$Operations;
|
|
17669
|
+
constructor(context: APIRequestContext);
|
|
17670
|
+
/**
|
|
17671
|
+
* Gets a Project. Returns NOT_FOUND when the project is not yet created.
|
|
16526
17672
|
* @example
|
|
16527
17673
|
* ```js
|
|
16528
17674
|
* // Before running the sample:
|
|
@@ -16562,6 +17708,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16562
17708
|
*
|
|
16563
17709
|
* // Example response
|
|
16564
17710
|
* // {
|
|
17711
|
+
* // "configurableBillingStatus": {},
|
|
16565
17712
|
* // "createTime": "my_createTime",
|
|
16566
17713
|
* // "customerProvidedConfig": {},
|
|
16567
17714
|
* // "name": "my_name",
|
|
@@ -16631,6 +17778,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16631
17778
|
* requestBody: {
|
|
16632
17779
|
* // request body parameters
|
|
16633
17780
|
* // {
|
|
17781
|
+
* // "configurableBillingStatus": {},
|
|
16634
17782
|
* // "createTime": "my_createTime",
|
|
16635
17783
|
* // "customerProvidedConfig": {},
|
|
16636
17784
|
* // "name": "my_name",
|
|
@@ -16643,6 +17791,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16643
17791
|
*
|
|
16644
17792
|
* // Example response
|
|
16645
17793
|
* // {
|
|
17794
|
+
* // "configurableBillingStatus": {},
|
|
16646
17795
|
* // "createTime": "my_createTime",
|
|
16647
17796
|
* // "customerProvidedConfig": {},
|
|
16648
17797
|
* // "name": "my_name",
|
|
@@ -16797,6 +17946,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16797
17946
|
*
|
|
16798
17947
|
* // Example response
|
|
16799
17948
|
* // {
|
|
17949
|
+
* // "configurableBillingStatus": {},
|
|
16800
17950
|
* // "createTime": "my_createTime",
|
|
16801
17951
|
* // "customerProvidedConfig": {},
|
|
16802
17952
|
* // "name": "my_name",
|
|
@@ -16866,6 +18016,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16866
18016
|
}
|
|
16867
18017
|
export class Resource$Projects$Locations {
|
|
16868
18018
|
context: APIRequestContext;
|
|
18019
|
+
authorizations: Resource$Projects$Locations$Authorizations;
|
|
16869
18020
|
cmekConfigs: Resource$Projects$Locations$Cmekconfigs;
|
|
16870
18021
|
collections: Resource$Projects$Locations$Collections;
|
|
16871
18022
|
dataStores: Resource$Projects$Locations$Datastores;
|
|
@@ -17892,6 +19043,412 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
17892
19043
|
*/
|
|
17893
19044
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
17894
19045
|
}
|
|
19046
|
+
export class Resource$Projects$Locations$Authorizations {
|
|
19047
|
+
context: APIRequestContext;
|
|
19048
|
+
constructor(context: APIRequestContext);
|
|
19049
|
+
/**
|
|
19050
|
+
* Creates an Authorization.
|
|
19051
|
+
* @example
|
|
19052
|
+
* ```js
|
|
19053
|
+
* // Before running the sample:
|
|
19054
|
+
* // - Enable the API at:
|
|
19055
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
19056
|
+
* // - Login into gcloud by running:
|
|
19057
|
+
* // ```sh
|
|
19058
|
+
* // $ gcloud auth application-default login
|
|
19059
|
+
* // ```
|
|
19060
|
+
* // - Install the npm module by running:
|
|
19061
|
+
* // ```sh
|
|
19062
|
+
* // $ npm install googleapis
|
|
19063
|
+
* // ```
|
|
19064
|
+
*
|
|
19065
|
+
* const {google} = require('googleapis');
|
|
19066
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
19067
|
+
*
|
|
19068
|
+
* async function main() {
|
|
19069
|
+
* const auth = new google.auth.GoogleAuth({
|
|
19070
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
19071
|
+
* scopes: [
|
|
19072
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
19073
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19074
|
+
* ],
|
|
19075
|
+
* });
|
|
19076
|
+
*
|
|
19077
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19078
|
+
* const authClient = await auth.getClient();
|
|
19079
|
+
* google.options({auth: authClient});
|
|
19080
|
+
*
|
|
19081
|
+
* // Do the magic
|
|
19082
|
+
* const res = await discoveryengine.projects.locations.authorizations.create({
|
|
19083
|
+
* // Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
19084
|
+
* authorizationId: 'placeholder-value',
|
|
19085
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}`
|
|
19086
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
19087
|
+
*
|
|
19088
|
+
* // Request body metadata
|
|
19089
|
+
* requestBody: {
|
|
19090
|
+
* // request body parameters
|
|
19091
|
+
* // {
|
|
19092
|
+
* // "displayName": "my_displayName",
|
|
19093
|
+
* // "name": "my_name",
|
|
19094
|
+
* // "serverSideOauth2": {}
|
|
19095
|
+
* // }
|
|
19096
|
+
* },
|
|
19097
|
+
* });
|
|
19098
|
+
* console.log(res.data);
|
|
19099
|
+
*
|
|
19100
|
+
* // Example response
|
|
19101
|
+
* // {
|
|
19102
|
+
* // "displayName": "my_displayName",
|
|
19103
|
+
* // "name": "my_name",
|
|
19104
|
+
* // "serverSideOauth2": {}
|
|
19105
|
+
* // }
|
|
19106
|
+
* }
|
|
19107
|
+
*
|
|
19108
|
+
* main().catch(e => {
|
|
19109
|
+
* console.error(e);
|
|
19110
|
+
* throw e;
|
|
19111
|
+
* });
|
|
19112
|
+
*
|
|
19113
|
+
* ```
|
|
19114
|
+
*
|
|
19115
|
+
* @param params - Parameters for request
|
|
19116
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19117
|
+
* @param callback - Optional callback that handles the response.
|
|
19118
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19119
|
+
*/
|
|
19120
|
+
create(params: Params$Resource$Projects$Locations$Authorizations$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19121
|
+
create(params?: Params$Resource$Projects$Locations$Authorizations$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>>;
|
|
19122
|
+
create(params: Params$Resource$Projects$Locations$Authorizations$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19123
|
+
create(params: Params$Resource$Projects$Locations$Authorizations$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19124
|
+
create(params: Params$Resource$Projects$Locations$Authorizations$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19125
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19126
|
+
/**
|
|
19127
|
+
* Deletes an Authorization.
|
|
19128
|
+
* @example
|
|
19129
|
+
* ```js
|
|
19130
|
+
* // Before running the sample:
|
|
19131
|
+
* // - Enable the API at:
|
|
19132
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
19133
|
+
* // - Login into gcloud by running:
|
|
19134
|
+
* // ```sh
|
|
19135
|
+
* // $ gcloud auth application-default login
|
|
19136
|
+
* // ```
|
|
19137
|
+
* // - Install the npm module by running:
|
|
19138
|
+
* // ```sh
|
|
19139
|
+
* // $ npm install googleapis
|
|
19140
|
+
* // ```
|
|
19141
|
+
*
|
|
19142
|
+
* const {google} = require('googleapis');
|
|
19143
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
19144
|
+
*
|
|
19145
|
+
* async function main() {
|
|
19146
|
+
* const auth = new google.auth.GoogleAuth({
|
|
19147
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
19148
|
+
* scopes: [
|
|
19149
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
19150
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19151
|
+
* ],
|
|
19152
|
+
* });
|
|
19153
|
+
*
|
|
19154
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19155
|
+
* const authClient = await auth.getClient();
|
|
19156
|
+
* google.options({auth: authClient});
|
|
19157
|
+
*
|
|
19158
|
+
* // Do the magic
|
|
19159
|
+
* const res = await discoveryengine.projects.locations.authorizations.delete({
|
|
19160
|
+
* // Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned.
|
|
19161
|
+
* name: 'projects/my-project/locations/my-location/authorizations/my-authorization',
|
|
19162
|
+
* });
|
|
19163
|
+
* console.log(res.data);
|
|
19164
|
+
*
|
|
19165
|
+
* // Example response
|
|
19166
|
+
* // {}
|
|
19167
|
+
* }
|
|
19168
|
+
*
|
|
19169
|
+
* main().catch(e => {
|
|
19170
|
+
* console.error(e);
|
|
19171
|
+
* throw e;
|
|
19172
|
+
* });
|
|
19173
|
+
*
|
|
19174
|
+
* ```
|
|
19175
|
+
*
|
|
19176
|
+
* @param params - Parameters for request
|
|
19177
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19178
|
+
* @param callback - Optional callback that handles the response.
|
|
19179
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19180
|
+
*/
|
|
19181
|
+
delete(params: Params$Resource$Projects$Locations$Authorizations$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19182
|
+
delete(params?: Params$Resource$Projects$Locations$Authorizations$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
19183
|
+
delete(params: Params$Resource$Projects$Locations$Authorizations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19184
|
+
delete(params: Params$Resource$Projects$Locations$Authorizations$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
19185
|
+
delete(params: Params$Resource$Projects$Locations$Authorizations$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
19186
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
19187
|
+
/**
|
|
19188
|
+
* Gets an Authorization.
|
|
19189
|
+
* @example
|
|
19190
|
+
* ```js
|
|
19191
|
+
* // Before running the sample:
|
|
19192
|
+
* // - Enable the API at:
|
|
19193
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
19194
|
+
* // - Login into gcloud by running:
|
|
19195
|
+
* // ```sh
|
|
19196
|
+
* // $ gcloud auth application-default login
|
|
19197
|
+
* // ```
|
|
19198
|
+
* // - Install the npm module by running:
|
|
19199
|
+
* // ```sh
|
|
19200
|
+
* // $ npm install googleapis
|
|
19201
|
+
* // ```
|
|
19202
|
+
*
|
|
19203
|
+
* const {google} = require('googleapis');
|
|
19204
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
19205
|
+
*
|
|
19206
|
+
* async function main() {
|
|
19207
|
+
* const auth = new google.auth.GoogleAuth({
|
|
19208
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
19209
|
+
* scopes: [
|
|
19210
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
19211
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19212
|
+
* ],
|
|
19213
|
+
* });
|
|
19214
|
+
*
|
|
19215
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19216
|
+
* const authClient = await auth.getClient();
|
|
19217
|
+
* google.options({auth: authClient});
|
|
19218
|
+
*
|
|
19219
|
+
* // Do the magic
|
|
19220
|
+
* const res = await discoveryengine.projects.locations.authorizations.get({
|
|
19221
|
+
* // Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}`
|
|
19222
|
+
* name: 'projects/my-project/locations/my-location/authorizations/my-authorization',
|
|
19223
|
+
* });
|
|
19224
|
+
* console.log(res.data);
|
|
19225
|
+
*
|
|
19226
|
+
* // Example response
|
|
19227
|
+
* // {
|
|
19228
|
+
* // "displayName": "my_displayName",
|
|
19229
|
+
* // "name": "my_name",
|
|
19230
|
+
* // "serverSideOauth2": {}
|
|
19231
|
+
* // }
|
|
19232
|
+
* }
|
|
19233
|
+
*
|
|
19234
|
+
* main().catch(e => {
|
|
19235
|
+
* console.error(e);
|
|
19236
|
+
* throw e;
|
|
19237
|
+
* });
|
|
19238
|
+
*
|
|
19239
|
+
* ```
|
|
19240
|
+
*
|
|
19241
|
+
* @param params - Parameters for request
|
|
19242
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19243
|
+
* @param callback - Optional callback that handles the response.
|
|
19244
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19245
|
+
*/
|
|
19246
|
+
get(params: Params$Resource$Projects$Locations$Authorizations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19247
|
+
get(params?: Params$Resource$Projects$Locations$Authorizations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>>;
|
|
19248
|
+
get(params: Params$Resource$Projects$Locations$Authorizations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19249
|
+
get(params: Params$Resource$Projects$Locations$Authorizations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19250
|
+
get(params: Params$Resource$Projects$Locations$Authorizations$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19251
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19252
|
+
/**
|
|
19253
|
+
* Lists all Authorizations under an Engine.
|
|
19254
|
+
* @example
|
|
19255
|
+
* ```js
|
|
19256
|
+
* // Before running the sample:
|
|
19257
|
+
* // - Enable the API at:
|
|
19258
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
19259
|
+
* // - Login into gcloud by running:
|
|
19260
|
+
* // ```sh
|
|
19261
|
+
* // $ gcloud auth application-default login
|
|
19262
|
+
* // ```
|
|
19263
|
+
* // - Install the npm module by running:
|
|
19264
|
+
* // ```sh
|
|
19265
|
+
* // $ npm install googleapis
|
|
19266
|
+
* // ```
|
|
19267
|
+
*
|
|
19268
|
+
* const {google} = require('googleapis');
|
|
19269
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
19270
|
+
*
|
|
19271
|
+
* async function main() {
|
|
19272
|
+
* const auth = new google.auth.GoogleAuth({
|
|
19273
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
19274
|
+
* scopes: [
|
|
19275
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
19276
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19277
|
+
* ],
|
|
19278
|
+
* });
|
|
19279
|
+
*
|
|
19280
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19281
|
+
* const authClient = await auth.getClient();
|
|
19282
|
+
* google.options({auth: authClient});
|
|
19283
|
+
*
|
|
19284
|
+
* // Do the magic
|
|
19285
|
+
* const res = await discoveryengine.projects.locations.authorizations.list({
|
|
19286
|
+
* // Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
19287
|
+
* pageSize: 'placeholder-value',
|
|
19288
|
+
* // A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.
|
|
19289
|
+
* pageToken: 'placeholder-value',
|
|
19290
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}`
|
|
19291
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
19292
|
+
* });
|
|
19293
|
+
* console.log(res.data);
|
|
19294
|
+
*
|
|
19295
|
+
* // Example response
|
|
19296
|
+
* // {
|
|
19297
|
+
* // "authorizations": [],
|
|
19298
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
19299
|
+
* // }
|
|
19300
|
+
* }
|
|
19301
|
+
*
|
|
19302
|
+
* main().catch(e => {
|
|
19303
|
+
* console.error(e);
|
|
19304
|
+
* throw e;
|
|
19305
|
+
* });
|
|
19306
|
+
*
|
|
19307
|
+
* ```
|
|
19308
|
+
*
|
|
19309
|
+
* @param params - Parameters for request
|
|
19310
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19311
|
+
* @param callback - Optional callback that handles the response.
|
|
19312
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19313
|
+
*/
|
|
19314
|
+
list(params: Params$Resource$Projects$Locations$Authorizations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19315
|
+
list(params?: Params$Resource$Projects$Locations$Authorizations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse>>;
|
|
19316
|
+
list(params: Params$Resource$Projects$Locations$Authorizations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19317
|
+
list(params: Params$Resource$Projects$Locations$Authorizations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse>): void;
|
|
19318
|
+
list(params: Params$Resource$Projects$Locations$Authorizations$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse>): void;
|
|
19319
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse>): void;
|
|
19320
|
+
/**
|
|
19321
|
+
* Updates an Authorization
|
|
19322
|
+
* @example
|
|
19323
|
+
* ```js
|
|
19324
|
+
* // Before running the sample:
|
|
19325
|
+
* // - Enable the API at:
|
|
19326
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
19327
|
+
* // - Login into gcloud by running:
|
|
19328
|
+
* // ```sh
|
|
19329
|
+
* // $ gcloud auth application-default login
|
|
19330
|
+
* // ```
|
|
19331
|
+
* // - Install the npm module by running:
|
|
19332
|
+
* // ```sh
|
|
19333
|
+
* // $ npm install googleapis
|
|
19334
|
+
* // ```
|
|
19335
|
+
*
|
|
19336
|
+
* const {google} = require('googleapis');
|
|
19337
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
19338
|
+
*
|
|
19339
|
+
* async function main() {
|
|
19340
|
+
* const auth = new google.auth.GoogleAuth({
|
|
19341
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
19342
|
+
* scopes: [
|
|
19343
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
19344
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19345
|
+
* ],
|
|
19346
|
+
* });
|
|
19347
|
+
*
|
|
19348
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19349
|
+
* const authClient = await auth.getClient();
|
|
19350
|
+
* google.options({auth: authClient});
|
|
19351
|
+
*
|
|
19352
|
+
* // Do the magic
|
|
19353
|
+
* const res = await discoveryengine.projects.locations.authorizations.patch({
|
|
19354
|
+
* // Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
19355
|
+
* name: 'projects/my-project/locations/my-location/authorizations/my-authorization',
|
|
19356
|
+
* // The list of fields to update.
|
|
19357
|
+
* updateMask: 'placeholder-value',
|
|
19358
|
+
*
|
|
19359
|
+
* // Request body metadata
|
|
19360
|
+
* requestBody: {
|
|
19361
|
+
* // request body parameters
|
|
19362
|
+
* // {
|
|
19363
|
+
* // "displayName": "my_displayName",
|
|
19364
|
+
* // "name": "my_name",
|
|
19365
|
+
* // "serverSideOauth2": {}
|
|
19366
|
+
* // }
|
|
19367
|
+
* },
|
|
19368
|
+
* });
|
|
19369
|
+
* console.log(res.data);
|
|
19370
|
+
*
|
|
19371
|
+
* // Example response
|
|
19372
|
+
* // {
|
|
19373
|
+
* // "displayName": "my_displayName",
|
|
19374
|
+
* // "name": "my_name",
|
|
19375
|
+
* // "serverSideOauth2": {}
|
|
19376
|
+
* // }
|
|
19377
|
+
* }
|
|
19378
|
+
*
|
|
19379
|
+
* main().catch(e => {
|
|
19380
|
+
* console.error(e);
|
|
19381
|
+
* throw e;
|
|
19382
|
+
* });
|
|
19383
|
+
*
|
|
19384
|
+
* ```
|
|
19385
|
+
*
|
|
19386
|
+
* @param params - Parameters for request
|
|
19387
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19388
|
+
* @param callback - Optional callback that handles the response.
|
|
19389
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19390
|
+
*/
|
|
19391
|
+
patch(params: Params$Resource$Projects$Locations$Authorizations$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19392
|
+
patch(params?: Params$Resource$Projects$Locations$Authorizations$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>>;
|
|
19393
|
+
patch(params: Params$Resource$Projects$Locations$Authorizations$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19394
|
+
patch(params: Params$Resource$Projects$Locations$Authorizations$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19395
|
+
patch(params: Params$Resource$Projects$Locations$Authorizations$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19396
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAuthorization>): void;
|
|
19397
|
+
}
|
|
19398
|
+
export interface Params$Resource$Projects$Locations$Authorizations$Create extends StandardParameters {
|
|
19399
|
+
/**
|
|
19400
|
+
* Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
19401
|
+
*/
|
|
19402
|
+
authorizationId?: string;
|
|
19403
|
+
/**
|
|
19404
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}`
|
|
19405
|
+
*/
|
|
19406
|
+
parent?: string;
|
|
19407
|
+
/**
|
|
19408
|
+
* Request body metadata
|
|
19409
|
+
*/
|
|
19410
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization;
|
|
19411
|
+
}
|
|
19412
|
+
export interface Params$Resource$Projects$Locations$Authorizations$Delete extends StandardParameters {
|
|
19413
|
+
/**
|
|
19414
|
+
* Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned.
|
|
19415
|
+
*/
|
|
19416
|
+
name?: string;
|
|
19417
|
+
}
|
|
19418
|
+
export interface Params$Resource$Projects$Locations$Authorizations$Get extends StandardParameters {
|
|
19419
|
+
/**
|
|
19420
|
+
* Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}`
|
|
19421
|
+
*/
|
|
19422
|
+
name?: string;
|
|
19423
|
+
}
|
|
19424
|
+
export interface Params$Resource$Projects$Locations$Authorizations$List extends StandardParameters {
|
|
19425
|
+
/**
|
|
19426
|
+
* Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
19427
|
+
*/
|
|
19428
|
+
pageSize?: number;
|
|
19429
|
+
/**
|
|
19430
|
+
* A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.
|
|
19431
|
+
*/
|
|
19432
|
+
pageToken?: string;
|
|
19433
|
+
/**
|
|
19434
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}`
|
|
19435
|
+
*/
|
|
19436
|
+
parent?: string;
|
|
19437
|
+
}
|
|
19438
|
+
export interface Params$Resource$Projects$Locations$Authorizations$Patch extends StandardParameters {
|
|
19439
|
+
/**
|
|
19440
|
+
* Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
19441
|
+
*/
|
|
19442
|
+
name?: string;
|
|
19443
|
+
/**
|
|
19444
|
+
* The list of fields to update.
|
|
19445
|
+
*/
|
|
19446
|
+
updateMask?: string;
|
|
19447
|
+
/**
|
|
19448
|
+
* Request body metadata
|
|
19449
|
+
*/
|
|
19450
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization;
|
|
19451
|
+
}
|
|
17895
19452
|
export class Resource$Projects$Locations$Cmekconfigs {
|
|
17896
19453
|
context: APIRequestContext;
|
|
17897
19454
|
constructor(context: APIRequestContext);
|
|
@@ -19493,7 +21050,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19493
21050
|
* query: 'placeholder-value',
|
|
19494
21051
|
* // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
19495
21052
|
* queryModel: 'placeholder-value',
|
|
19496
|
-
* // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
21053
|
+
* // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
19497
21054
|
* userPseudoId: 'placeholder-value',
|
|
19498
21055
|
* },
|
|
19499
21056
|
* );
|
|
@@ -19582,6 +21139,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19582
21139
|
* // "billingEstimation": {},
|
|
19583
21140
|
* // "cmekConfig": {},
|
|
19584
21141
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21142
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
19585
21143
|
* // "contentConfig": "my_contentConfig",
|
|
19586
21144
|
* // "createTime": "my_createTime",
|
|
19587
21145
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -19748,6 +21306,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19748
21306
|
* // "billingEstimation": {},
|
|
19749
21307
|
* // "cmekConfig": {},
|
|
19750
21308
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21309
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
19751
21310
|
* // "contentConfig": "my_contentConfig",
|
|
19752
21311
|
* // "createTime": "my_createTime",
|
|
19753
21312
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -20043,6 +21602,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20043
21602
|
* // "billingEstimation": {},
|
|
20044
21603
|
* // "cmekConfig": {},
|
|
20045
21604
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21605
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
20046
21606
|
* // "contentConfig": "my_contentConfig",
|
|
20047
21607
|
* // "createTime": "my_createTime",
|
|
20048
21608
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -20073,6 +21633,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20073
21633
|
* // "billingEstimation": {},
|
|
20074
21634
|
* // "cmekConfig": {},
|
|
20075
21635
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21636
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
20076
21637
|
* // "contentConfig": "my_contentConfig",
|
|
20077
21638
|
* // "createTime": "my_createTime",
|
|
20078
21639
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -20295,7 +21856,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20295
21856
|
*/
|
|
20296
21857
|
queryModel?: string;
|
|
20297
21858
|
/**
|
|
20298
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
21859
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
20299
21860
|
*/
|
|
20300
21861
|
userPseudoId?: string;
|
|
20301
21862
|
}
|
|
@@ -28068,9 +29629,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
28068
29629
|
* // "enableSnippetResultSummary": false,
|
|
28069
29630
|
* // "enableSummarization": false,
|
|
28070
29631
|
* // "enableWebApp": false,
|
|
28071
|
-
* // "experimentalFeatures": {},
|
|
28072
29632
|
* // "facetField": [],
|
|
28073
29633
|
* // "fieldsUiComponentsMap": {},
|
|
29634
|
+
* // "geminiBundle": false,
|
|
28074
29635
|
* // "homepageSetting": {},
|
|
28075
29636
|
* // "industryVertical": "my_industryVertical",
|
|
28076
29637
|
* // "llmEnabled": false,
|
|
@@ -28102,6 +29663,153 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
28102
29663
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
28103
29664
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
28104
29665
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
29666
|
+
/**
|
|
29667
|
+
* Update a WidgetConfig.
|
|
29668
|
+
* @example
|
|
29669
|
+
* ```js
|
|
29670
|
+
* // Before running the sample:
|
|
29671
|
+
* // - Enable the API at:
|
|
29672
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
29673
|
+
* // - Login into gcloud by running:
|
|
29674
|
+
* // ```sh
|
|
29675
|
+
* // $ gcloud auth application-default login
|
|
29676
|
+
* // ```
|
|
29677
|
+
* // - Install the npm module by running:
|
|
29678
|
+
* // ```sh
|
|
29679
|
+
* // $ npm install googleapis
|
|
29680
|
+
* // ```
|
|
29681
|
+
*
|
|
29682
|
+
* const {google} = require('googleapis');
|
|
29683
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
29684
|
+
*
|
|
29685
|
+
* async function main() {
|
|
29686
|
+
* const auth = new google.auth.GoogleAuth({
|
|
29687
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
29688
|
+
* scopes: [
|
|
29689
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
29690
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
29691
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
29692
|
+
* ],
|
|
29693
|
+
* });
|
|
29694
|
+
*
|
|
29695
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
29696
|
+
* const authClient = await auth.getClient();
|
|
29697
|
+
* google.options({auth: authClient});
|
|
29698
|
+
*
|
|
29699
|
+
* // Do the magic
|
|
29700
|
+
* const res =
|
|
29701
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch(
|
|
29702
|
+
* {
|
|
29703
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
29704
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
29705
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
29706
|
+
* updateMask: 'placeholder-value',
|
|
29707
|
+
*
|
|
29708
|
+
* // Request body metadata
|
|
29709
|
+
* requestBody: {
|
|
29710
|
+
* // request body parameters
|
|
29711
|
+
* // {
|
|
29712
|
+
* // "accessSettings": {},
|
|
29713
|
+
* // "allowPublicAccess": false,
|
|
29714
|
+
* // "allowlistedDomains": [],
|
|
29715
|
+
* // "assistantSettings": {},
|
|
29716
|
+
* // "collectionComponents": [],
|
|
29717
|
+
* // "configId": "my_configId",
|
|
29718
|
+
* // "contentSearchSpec": {},
|
|
29719
|
+
* // "createTime": "my_createTime",
|
|
29720
|
+
* // "customerProvidedConfig": {},
|
|
29721
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
29722
|
+
* // "dataStoreUiConfigs": [],
|
|
29723
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
29724
|
+
* // "displayName": "my_displayName",
|
|
29725
|
+
* // "enableAutocomplete": false,
|
|
29726
|
+
* // "enableConversationalSearch": false,
|
|
29727
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
29728
|
+
* // "enableQualityFeedback": false,
|
|
29729
|
+
* // "enableResultScore": false,
|
|
29730
|
+
* // "enableSafeSearch": false,
|
|
29731
|
+
* // "enableSearchAsYouType": false,
|
|
29732
|
+
* // "enableSnippetResultSummary": false,
|
|
29733
|
+
* // "enableSummarization": false,
|
|
29734
|
+
* // "enableWebApp": false,
|
|
29735
|
+
* // "facetField": [],
|
|
29736
|
+
* // "fieldsUiComponentsMap": {},
|
|
29737
|
+
* // "geminiBundle": false,
|
|
29738
|
+
* // "homepageSetting": {},
|
|
29739
|
+
* // "industryVertical": "my_industryVertical",
|
|
29740
|
+
* // "llmEnabled": false,
|
|
29741
|
+
* // "minimumDataTermAccepted": false,
|
|
29742
|
+
* // "name": "my_name",
|
|
29743
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
29744
|
+
* // "solutionType": "my_solutionType",
|
|
29745
|
+
* // "uiBranding": {},
|
|
29746
|
+
* // "uiSettings": {},
|
|
29747
|
+
* // "updateTime": "my_updateTime"
|
|
29748
|
+
* // }
|
|
29749
|
+
* },
|
|
29750
|
+
* },
|
|
29751
|
+
* );
|
|
29752
|
+
* console.log(res.data);
|
|
29753
|
+
*
|
|
29754
|
+
* // Example response
|
|
29755
|
+
* // {
|
|
29756
|
+
* // "accessSettings": {},
|
|
29757
|
+
* // "allowPublicAccess": false,
|
|
29758
|
+
* // "allowlistedDomains": [],
|
|
29759
|
+
* // "assistantSettings": {},
|
|
29760
|
+
* // "collectionComponents": [],
|
|
29761
|
+
* // "configId": "my_configId",
|
|
29762
|
+
* // "contentSearchSpec": {},
|
|
29763
|
+
* // "createTime": "my_createTime",
|
|
29764
|
+
* // "customerProvidedConfig": {},
|
|
29765
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
29766
|
+
* // "dataStoreUiConfigs": [],
|
|
29767
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
29768
|
+
* // "displayName": "my_displayName",
|
|
29769
|
+
* // "enableAutocomplete": false,
|
|
29770
|
+
* // "enableConversationalSearch": false,
|
|
29771
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
29772
|
+
* // "enableQualityFeedback": false,
|
|
29773
|
+
* // "enableResultScore": false,
|
|
29774
|
+
* // "enableSafeSearch": false,
|
|
29775
|
+
* // "enableSearchAsYouType": false,
|
|
29776
|
+
* // "enableSnippetResultSummary": false,
|
|
29777
|
+
* // "enableSummarization": false,
|
|
29778
|
+
* // "enableWebApp": false,
|
|
29779
|
+
* // "facetField": [],
|
|
29780
|
+
* // "fieldsUiComponentsMap": {},
|
|
29781
|
+
* // "geminiBundle": false,
|
|
29782
|
+
* // "homepageSetting": {},
|
|
29783
|
+
* // "industryVertical": "my_industryVertical",
|
|
29784
|
+
* // "llmEnabled": false,
|
|
29785
|
+
* // "minimumDataTermAccepted": false,
|
|
29786
|
+
* // "name": "my_name",
|
|
29787
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
29788
|
+
* // "solutionType": "my_solutionType",
|
|
29789
|
+
* // "uiBranding": {},
|
|
29790
|
+
* // "uiSettings": {},
|
|
29791
|
+
* // "updateTime": "my_updateTime"
|
|
29792
|
+
* // }
|
|
29793
|
+
* }
|
|
29794
|
+
*
|
|
29795
|
+
* main().catch(e => {
|
|
29796
|
+
* console.error(e);
|
|
29797
|
+
* throw e;
|
|
29798
|
+
* });
|
|
29799
|
+
*
|
|
29800
|
+
* ```
|
|
29801
|
+
*
|
|
29802
|
+
* @param params - Parameters for request
|
|
29803
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
29804
|
+
* @param callback - Optional callback that handles the response.
|
|
29805
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
29806
|
+
*/
|
|
29807
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
29808
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>>;
|
|
29809
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
29810
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
29811
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
29812
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
28105
29813
|
}
|
|
28106
29814
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
28107
29815
|
/**
|
|
@@ -28117,6 +29825,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
28117
29825
|
*/
|
|
28118
29826
|
name?: string;
|
|
28119
29827
|
}
|
|
29828
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
29829
|
+
/**
|
|
29830
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
29831
|
+
*/
|
|
29832
|
+
name?: string;
|
|
29833
|
+
/**
|
|
29834
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
29835
|
+
*/
|
|
29836
|
+
updateMask?: string;
|
|
29837
|
+
/**
|
|
29838
|
+
* Request body metadata
|
|
29839
|
+
*/
|
|
29840
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
29841
|
+
}
|
|
28120
29842
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
28121
29843
|
context: APIRequestContext;
|
|
28122
29844
|
analytics: Resource$Projects$Locations$Collections$Engines$Analytics;
|
|
@@ -29059,6 +30781,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29059
30781
|
}
|
|
29060
30782
|
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
29061
30783
|
context: APIRequestContext;
|
|
30784
|
+
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
30785
|
+
cannedQueries: Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries;
|
|
29062
30786
|
constructor(context: APIRequestContext);
|
|
29063
30787
|
/**
|
|
29064
30788
|
* Gets an Assistant.
|
|
@@ -29251,20 +30975,1038 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29251
30975
|
*
|
|
29252
30976
|
* // Do the magic
|
|
29253
30977
|
* const res =
|
|
29254
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.streamAssist(
|
|
30978
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.streamAssist(
|
|
30979
|
+
* {
|
|
30980
|
+
* // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
30981
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
30982
|
+
*
|
|
30983
|
+
* // Request body metadata
|
|
30984
|
+
* requestBody: {
|
|
30985
|
+
* // request body parameters
|
|
30986
|
+
* // {
|
|
30987
|
+
* // "generationSpec": {},
|
|
30988
|
+
* // "query": {},
|
|
30989
|
+
* // "session": "my_session",
|
|
30990
|
+
* // "toolsSpec": {},
|
|
30991
|
+
* // "userMetadata": {}
|
|
30992
|
+
* // }
|
|
30993
|
+
* },
|
|
30994
|
+
* },
|
|
30995
|
+
* );
|
|
30996
|
+
* console.log(res.data);
|
|
30997
|
+
*
|
|
30998
|
+
* // Example response
|
|
30999
|
+
* // {
|
|
31000
|
+
* // "answer": {},
|
|
31001
|
+
* // "assistToken": "my_assistToken",
|
|
31002
|
+
* // "sessionInfo": {}
|
|
31003
|
+
* // }
|
|
31004
|
+
* }
|
|
31005
|
+
*
|
|
31006
|
+
* main().catch(e => {
|
|
31007
|
+
* console.error(e);
|
|
31008
|
+
* throw e;
|
|
31009
|
+
* });
|
|
31010
|
+
*
|
|
31011
|
+
* ```
|
|
31012
|
+
*
|
|
31013
|
+
* @param params - Parameters for request
|
|
31014
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31015
|
+
* @param callback - Optional callback that handles the response.
|
|
31016
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31017
|
+
*/
|
|
31018
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31019
|
+
streamAssist(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponse>>;
|
|
31020
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31021
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponse>): void;
|
|
31022
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponse>): void;
|
|
31023
|
+
streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponse>): void;
|
|
31024
|
+
}
|
|
31025
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
31026
|
+
/**
|
|
31027
|
+
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31028
|
+
*/
|
|
31029
|
+
name?: string;
|
|
31030
|
+
}
|
|
31031
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
31032
|
+
/**
|
|
31033
|
+
* Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
31034
|
+
*/
|
|
31035
|
+
name?: string;
|
|
31036
|
+
/**
|
|
31037
|
+
* The list of fields to update.
|
|
31038
|
+
*/
|
|
31039
|
+
updateMask?: string;
|
|
31040
|
+
/**
|
|
31041
|
+
* Request body metadata
|
|
31042
|
+
*/
|
|
31043
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAssistant;
|
|
31044
|
+
}
|
|
31045
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist extends StandardParameters {
|
|
31046
|
+
/**
|
|
31047
|
+
* Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31048
|
+
*/
|
|
31049
|
+
name?: string;
|
|
31050
|
+
/**
|
|
31051
|
+
* Request body metadata
|
|
31052
|
+
*/
|
|
31053
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistRequest;
|
|
31054
|
+
}
|
|
31055
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents {
|
|
31056
|
+
context: APIRequestContext;
|
|
31057
|
+
files: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files;
|
|
31058
|
+
constructor(context: APIRequestContext);
|
|
31059
|
+
/**
|
|
31060
|
+
* Creates an Agent.
|
|
31061
|
+
* @example
|
|
31062
|
+
* ```js
|
|
31063
|
+
* // Before running the sample:
|
|
31064
|
+
* // - Enable the API at:
|
|
31065
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31066
|
+
* // - Login into gcloud by running:
|
|
31067
|
+
* // ```sh
|
|
31068
|
+
* // $ gcloud auth application-default login
|
|
31069
|
+
* // ```
|
|
31070
|
+
* // - Install the npm module by running:
|
|
31071
|
+
* // ```sh
|
|
31072
|
+
* // $ npm install googleapis
|
|
31073
|
+
* // ```
|
|
31074
|
+
*
|
|
31075
|
+
* const {google} = require('googleapis');
|
|
31076
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31077
|
+
*
|
|
31078
|
+
* async function main() {
|
|
31079
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31080
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31081
|
+
* scopes: [
|
|
31082
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31083
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31084
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31085
|
+
* ],
|
|
31086
|
+
* });
|
|
31087
|
+
*
|
|
31088
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31089
|
+
* const authClient = await auth.getClient();
|
|
31090
|
+
* google.options({auth: authClient});
|
|
31091
|
+
*
|
|
31092
|
+
* // Do the magic
|
|
31093
|
+
* const res =
|
|
31094
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.create(
|
|
31095
|
+
* {
|
|
31096
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31097
|
+
* parent:
|
|
31098
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
31099
|
+
*
|
|
31100
|
+
* // Request body metadata
|
|
31101
|
+
* requestBody: {
|
|
31102
|
+
* // request body parameters
|
|
31103
|
+
* // {
|
|
31104
|
+
* // "a2aAgentDefinition": {},
|
|
31105
|
+
* // "adkAgentDefinition": {},
|
|
31106
|
+
* // "authorizationConfig": {},
|
|
31107
|
+
* // "createTime": "my_createTime",
|
|
31108
|
+
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
31109
|
+
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
31110
|
+
* // "description": "my_description",
|
|
31111
|
+
* // "dialogflowAgentDefinition": {},
|
|
31112
|
+
* // "displayName": "my_displayName",
|
|
31113
|
+
* // "icon": {},
|
|
31114
|
+
* // "languageCode": "my_languageCode",
|
|
31115
|
+
* // "name": "my_name",
|
|
31116
|
+
* // "rejectionReason": "my_rejectionReason",
|
|
31117
|
+
* // "starterPrompts": [],
|
|
31118
|
+
* // "state": "my_state",
|
|
31119
|
+
* // "suspensionReason": "my_suspensionReason",
|
|
31120
|
+
* // "updateTime": "my_updateTime"
|
|
31121
|
+
* // }
|
|
31122
|
+
* },
|
|
31123
|
+
* },
|
|
31124
|
+
* );
|
|
31125
|
+
* console.log(res.data);
|
|
31126
|
+
*
|
|
31127
|
+
* // Example response
|
|
31128
|
+
* // {
|
|
31129
|
+
* // "a2aAgentDefinition": {},
|
|
31130
|
+
* // "adkAgentDefinition": {},
|
|
31131
|
+
* // "authorizationConfig": {},
|
|
31132
|
+
* // "createTime": "my_createTime",
|
|
31133
|
+
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
31134
|
+
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
31135
|
+
* // "description": "my_description",
|
|
31136
|
+
* // "dialogflowAgentDefinition": {},
|
|
31137
|
+
* // "displayName": "my_displayName",
|
|
31138
|
+
* // "icon": {},
|
|
31139
|
+
* // "languageCode": "my_languageCode",
|
|
31140
|
+
* // "name": "my_name",
|
|
31141
|
+
* // "rejectionReason": "my_rejectionReason",
|
|
31142
|
+
* // "starterPrompts": [],
|
|
31143
|
+
* // "state": "my_state",
|
|
31144
|
+
* // "suspensionReason": "my_suspensionReason",
|
|
31145
|
+
* // "updateTime": "my_updateTime"
|
|
31146
|
+
* // }
|
|
31147
|
+
* }
|
|
31148
|
+
*
|
|
31149
|
+
* main().catch(e => {
|
|
31150
|
+
* console.error(e);
|
|
31151
|
+
* throw e;
|
|
31152
|
+
* });
|
|
31153
|
+
*
|
|
31154
|
+
* ```
|
|
31155
|
+
*
|
|
31156
|
+
* @param params - Parameters for request
|
|
31157
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31158
|
+
* @param callback - Optional callback that handles the response.
|
|
31159
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31160
|
+
*/
|
|
31161
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31162
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
|
|
31163
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31164
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31165
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31166
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31167
|
+
/**
|
|
31168
|
+
* Deletes an Agent.
|
|
31169
|
+
* @example
|
|
31170
|
+
* ```js
|
|
31171
|
+
* // Before running the sample:
|
|
31172
|
+
* // - Enable the API at:
|
|
31173
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31174
|
+
* // - Login into gcloud by running:
|
|
31175
|
+
* // ```sh
|
|
31176
|
+
* // $ gcloud auth application-default login
|
|
31177
|
+
* // ```
|
|
31178
|
+
* // - Install the npm module by running:
|
|
31179
|
+
* // ```sh
|
|
31180
|
+
* // $ npm install googleapis
|
|
31181
|
+
* // ```
|
|
31182
|
+
*
|
|
31183
|
+
* const {google} = require('googleapis');
|
|
31184
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31185
|
+
*
|
|
31186
|
+
* async function main() {
|
|
31187
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31188
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31189
|
+
* scopes: [
|
|
31190
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31191
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31192
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31193
|
+
* ],
|
|
31194
|
+
* });
|
|
31195
|
+
*
|
|
31196
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31197
|
+
* const authClient = await auth.getClient();
|
|
31198
|
+
* google.options({auth: authClient});
|
|
31199
|
+
*
|
|
31200
|
+
* // Do the magic
|
|
31201
|
+
* const res =
|
|
31202
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.delete(
|
|
31203
|
+
* {
|
|
31204
|
+
* // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.
|
|
31205
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
31206
|
+
* },
|
|
31207
|
+
* );
|
|
31208
|
+
* console.log(res.data);
|
|
31209
|
+
*
|
|
31210
|
+
* // Example response
|
|
31211
|
+
* // {
|
|
31212
|
+
* // "done": false,
|
|
31213
|
+
* // "error": {},
|
|
31214
|
+
* // "metadata": {},
|
|
31215
|
+
* // "name": "my_name",
|
|
31216
|
+
* // "response": {}
|
|
31217
|
+
* // }
|
|
31218
|
+
* }
|
|
31219
|
+
*
|
|
31220
|
+
* main().catch(e => {
|
|
31221
|
+
* console.error(e);
|
|
31222
|
+
* throw e;
|
|
31223
|
+
* });
|
|
31224
|
+
*
|
|
31225
|
+
* ```
|
|
31226
|
+
*
|
|
31227
|
+
* @param params - Parameters for request
|
|
31228
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31229
|
+
* @param callback - Optional callback that handles the response.
|
|
31230
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31231
|
+
*/
|
|
31232
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31233
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
31234
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31235
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
31236
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
31237
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
31238
|
+
/**
|
|
31239
|
+
* Gets an Agent.
|
|
31240
|
+
* @example
|
|
31241
|
+
* ```js
|
|
31242
|
+
* // Before running the sample:
|
|
31243
|
+
* // - Enable the API at:
|
|
31244
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31245
|
+
* // - Login into gcloud by running:
|
|
31246
|
+
* // ```sh
|
|
31247
|
+
* // $ gcloud auth application-default login
|
|
31248
|
+
* // ```
|
|
31249
|
+
* // - Install the npm module by running:
|
|
31250
|
+
* // ```sh
|
|
31251
|
+
* // $ npm install googleapis
|
|
31252
|
+
* // ```
|
|
31253
|
+
*
|
|
31254
|
+
* const {google} = require('googleapis');
|
|
31255
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31256
|
+
*
|
|
31257
|
+
* async function main() {
|
|
31258
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31259
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31260
|
+
* scopes: [
|
|
31261
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31262
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31263
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31264
|
+
* ],
|
|
31265
|
+
* });
|
|
31266
|
+
*
|
|
31267
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31268
|
+
* const authClient = await auth.getClient();
|
|
31269
|
+
* google.options({auth: authClient});
|
|
31270
|
+
*
|
|
31271
|
+
* // Do the magic
|
|
31272
|
+
* const res =
|
|
31273
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.get(
|
|
31274
|
+
* {
|
|
31275
|
+
* // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31276
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
31277
|
+
* },
|
|
31278
|
+
* );
|
|
31279
|
+
* console.log(res.data);
|
|
31280
|
+
*
|
|
31281
|
+
* // Example response
|
|
31282
|
+
* // {
|
|
31283
|
+
* // "a2aAgentDefinition": {},
|
|
31284
|
+
* // "adkAgentDefinition": {},
|
|
31285
|
+
* // "authorizationConfig": {},
|
|
31286
|
+
* // "createTime": "my_createTime",
|
|
31287
|
+
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
31288
|
+
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
31289
|
+
* // "description": "my_description",
|
|
31290
|
+
* // "dialogflowAgentDefinition": {},
|
|
31291
|
+
* // "displayName": "my_displayName",
|
|
31292
|
+
* // "icon": {},
|
|
31293
|
+
* // "languageCode": "my_languageCode",
|
|
31294
|
+
* // "name": "my_name",
|
|
31295
|
+
* // "rejectionReason": "my_rejectionReason",
|
|
31296
|
+
* // "starterPrompts": [],
|
|
31297
|
+
* // "state": "my_state",
|
|
31298
|
+
* // "suspensionReason": "my_suspensionReason",
|
|
31299
|
+
* // "updateTime": "my_updateTime"
|
|
31300
|
+
* // }
|
|
31301
|
+
* }
|
|
31302
|
+
*
|
|
31303
|
+
* main().catch(e => {
|
|
31304
|
+
* console.error(e);
|
|
31305
|
+
* throw e;
|
|
31306
|
+
* });
|
|
31307
|
+
*
|
|
31308
|
+
* ```
|
|
31309
|
+
*
|
|
31310
|
+
* @param params - Parameters for request
|
|
31311
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31312
|
+
* @param callback - Optional callback that handles the response.
|
|
31313
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31314
|
+
*/
|
|
31315
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31316
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
|
|
31317
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31318
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31319
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31320
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31321
|
+
/**
|
|
31322
|
+
* Lists all Agents under an Assistant which were created by the caller.
|
|
31323
|
+
* @example
|
|
31324
|
+
* ```js
|
|
31325
|
+
* // Before running the sample:
|
|
31326
|
+
* // - Enable the API at:
|
|
31327
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31328
|
+
* // - Login into gcloud by running:
|
|
31329
|
+
* // ```sh
|
|
31330
|
+
* // $ gcloud auth application-default login
|
|
31331
|
+
* // ```
|
|
31332
|
+
* // - Install the npm module by running:
|
|
31333
|
+
* // ```sh
|
|
31334
|
+
* // $ npm install googleapis
|
|
31335
|
+
* // ```
|
|
31336
|
+
*
|
|
31337
|
+
* const {google} = require('googleapis');
|
|
31338
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31339
|
+
*
|
|
31340
|
+
* async function main() {
|
|
31341
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31342
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31343
|
+
* scopes: [
|
|
31344
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31345
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31346
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31347
|
+
* ],
|
|
31348
|
+
* });
|
|
31349
|
+
*
|
|
31350
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31351
|
+
* const authClient = await auth.getClient();
|
|
31352
|
+
* google.options({auth: authClient});
|
|
31353
|
+
*
|
|
31354
|
+
* // Do the magic
|
|
31355
|
+
* const res =
|
|
31356
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.list(
|
|
31357
|
+
* {
|
|
31358
|
+
* // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
|
|
31359
|
+
* orderBy: 'placeholder-value',
|
|
31360
|
+
* // Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
31361
|
+
* pageSize: 'placeholder-value',
|
|
31362
|
+
* // Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
|
|
31363
|
+
* pageToken: 'placeholder-value',
|
|
31364
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31365
|
+
* parent:
|
|
31366
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
31367
|
+
* },
|
|
31368
|
+
* );
|
|
31369
|
+
* console.log(res.data);
|
|
31370
|
+
*
|
|
31371
|
+
* // Example response
|
|
31372
|
+
* // {
|
|
31373
|
+
* // "agents": [],
|
|
31374
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
31375
|
+
* // }
|
|
31376
|
+
* }
|
|
31377
|
+
*
|
|
31378
|
+
* main().catch(e => {
|
|
31379
|
+
* console.error(e);
|
|
31380
|
+
* throw e;
|
|
31381
|
+
* });
|
|
31382
|
+
*
|
|
31383
|
+
* ```
|
|
31384
|
+
*
|
|
31385
|
+
* @param params - Parameters for request
|
|
31386
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31387
|
+
* @param callback - Optional callback that handles the response.
|
|
31388
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31389
|
+
*/
|
|
31390
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31391
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse>>;
|
|
31392
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31393
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse>): void;
|
|
31394
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse>): void;
|
|
31395
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse>): void;
|
|
31396
|
+
/**
|
|
31397
|
+
* Updates an Agent
|
|
31398
|
+
* @example
|
|
31399
|
+
* ```js
|
|
31400
|
+
* // Before running the sample:
|
|
31401
|
+
* // - Enable the API at:
|
|
31402
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31403
|
+
* // - Login into gcloud by running:
|
|
31404
|
+
* // ```sh
|
|
31405
|
+
* // $ gcloud auth application-default login
|
|
31406
|
+
* // ```
|
|
31407
|
+
* // - Install the npm module by running:
|
|
31408
|
+
* // ```sh
|
|
31409
|
+
* // $ npm install googleapis
|
|
31410
|
+
* // ```
|
|
31411
|
+
*
|
|
31412
|
+
* const {google} = require('googleapis');
|
|
31413
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31414
|
+
*
|
|
31415
|
+
* async function main() {
|
|
31416
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31417
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31418
|
+
* scopes: [
|
|
31419
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31420
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31421
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31422
|
+
* ],
|
|
31423
|
+
* });
|
|
31424
|
+
*
|
|
31425
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31426
|
+
* const authClient = await auth.getClient();
|
|
31427
|
+
* google.options({auth: authClient});
|
|
31428
|
+
*
|
|
31429
|
+
* // Do the magic
|
|
31430
|
+
* const res =
|
|
31431
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.patch(
|
|
31432
|
+
* {
|
|
31433
|
+
* // Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31434
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
31435
|
+
* // Optional. The list of fields to update.
|
|
31436
|
+
* updateMask: 'placeholder-value',
|
|
31437
|
+
*
|
|
31438
|
+
* // Request body metadata
|
|
31439
|
+
* requestBody: {
|
|
31440
|
+
* // request body parameters
|
|
31441
|
+
* // {
|
|
31442
|
+
* // "a2aAgentDefinition": {},
|
|
31443
|
+
* // "adkAgentDefinition": {},
|
|
31444
|
+
* // "authorizationConfig": {},
|
|
31445
|
+
* // "createTime": "my_createTime",
|
|
31446
|
+
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
31447
|
+
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
31448
|
+
* // "description": "my_description",
|
|
31449
|
+
* // "dialogflowAgentDefinition": {},
|
|
31450
|
+
* // "displayName": "my_displayName",
|
|
31451
|
+
* // "icon": {},
|
|
31452
|
+
* // "languageCode": "my_languageCode",
|
|
31453
|
+
* // "name": "my_name",
|
|
31454
|
+
* // "rejectionReason": "my_rejectionReason",
|
|
31455
|
+
* // "starterPrompts": [],
|
|
31456
|
+
* // "state": "my_state",
|
|
31457
|
+
* // "suspensionReason": "my_suspensionReason",
|
|
31458
|
+
* // "updateTime": "my_updateTime"
|
|
31459
|
+
* // }
|
|
31460
|
+
* },
|
|
31461
|
+
* },
|
|
31462
|
+
* );
|
|
31463
|
+
* console.log(res.data);
|
|
31464
|
+
*
|
|
31465
|
+
* // Example response
|
|
31466
|
+
* // {
|
|
31467
|
+
* // "a2aAgentDefinition": {},
|
|
31468
|
+
* // "adkAgentDefinition": {},
|
|
31469
|
+
* // "authorizationConfig": {},
|
|
31470
|
+
* // "createTime": "my_createTime",
|
|
31471
|
+
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
31472
|
+
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
31473
|
+
* // "description": "my_description",
|
|
31474
|
+
* // "dialogflowAgentDefinition": {},
|
|
31475
|
+
* // "displayName": "my_displayName",
|
|
31476
|
+
* // "icon": {},
|
|
31477
|
+
* // "languageCode": "my_languageCode",
|
|
31478
|
+
* // "name": "my_name",
|
|
31479
|
+
* // "rejectionReason": "my_rejectionReason",
|
|
31480
|
+
* // "starterPrompts": [],
|
|
31481
|
+
* // "state": "my_state",
|
|
31482
|
+
* // "suspensionReason": "my_suspensionReason",
|
|
31483
|
+
* // "updateTime": "my_updateTime"
|
|
31484
|
+
* // }
|
|
31485
|
+
* }
|
|
31486
|
+
*
|
|
31487
|
+
* main().catch(e => {
|
|
31488
|
+
* console.error(e);
|
|
31489
|
+
* throw e;
|
|
31490
|
+
* });
|
|
31491
|
+
*
|
|
31492
|
+
* ```
|
|
31493
|
+
*
|
|
31494
|
+
* @param params - Parameters for request
|
|
31495
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31496
|
+
* @param callback - Optional callback that handles the response.
|
|
31497
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31498
|
+
*/
|
|
31499
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31500
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
|
|
31501
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31502
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31503
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31504
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
|
|
31505
|
+
}
|
|
31506
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create extends StandardParameters {
|
|
31507
|
+
/**
|
|
31508
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31509
|
+
*/
|
|
31510
|
+
parent?: string;
|
|
31511
|
+
/**
|
|
31512
|
+
* Request body metadata
|
|
31513
|
+
*/
|
|
31514
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAgent;
|
|
31515
|
+
}
|
|
31516
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete extends StandardParameters {
|
|
31517
|
+
/**
|
|
31518
|
+
* Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.
|
|
31519
|
+
*/
|
|
31520
|
+
name?: string;
|
|
31521
|
+
}
|
|
31522
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get extends StandardParameters {
|
|
31523
|
+
/**
|
|
31524
|
+
* Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31525
|
+
*/
|
|
31526
|
+
name?: string;
|
|
31527
|
+
}
|
|
31528
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List extends StandardParameters {
|
|
31529
|
+
/**
|
|
31530
|
+
* Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
|
|
31531
|
+
*/
|
|
31532
|
+
orderBy?: string;
|
|
31533
|
+
/**
|
|
31534
|
+
* Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
31535
|
+
*/
|
|
31536
|
+
pageSize?: number;
|
|
31537
|
+
/**
|
|
31538
|
+
* Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
|
|
31539
|
+
*/
|
|
31540
|
+
pageToken?: string;
|
|
31541
|
+
/**
|
|
31542
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31543
|
+
*/
|
|
31544
|
+
parent?: string;
|
|
31545
|
+
}
|
|
31546
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch extends StandardParameters {
|
|
31547
|
+
/**
|
|
31548
|
+
* Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31549
|
+
*/
|
|
31550
|
+
name?: string;
|
|
31551
|
+
/**
|
|
31552
|
+
* Optional. The list of fields to update.
|
|
31553
|
+
*/
|
|
31554
|
+
updateMask?: string;
|
|
31555
|
+
/**
|
|
31556
|
+
* Request body metadata
|
|
31557
|
+
*/
|
|
31558
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAgent;
|
|
31559
|
+
}
|
|
31560
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files {
|
|
31561
|
+
context: APIRequestContext;
|
|
31562
|
+
constructor(context: APIRequestContext);
|
|
31563
|
+
/**
|
|
31564
|
+
* Imports a file to an Agent. Currently only No-Code agents are supported.
|
|
31565
|
+
* @example
|
|
31566
|
+
* ```js
|
|
31567
|
+
* // Before running the sample:
|
|
31568
|
+
* // - Enable the API at:
|
|
31569
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31570
|
+
* // - Login into gcloud by running:
|
|
31571
|
+
* // ```sh
|
|
31572
|
+
* // $ gcloud auth application-default login
|
|
31573
|
+
* // ```
|
|
31574
|
+
* // - Install the npm module by running:
|
|
31575
|
+
* // ```sh
|
|
31576
|
+
* // $ npm install googleapis
|
|
31577
|
+
* // ```
|
|
31578
|
+
*
|
|
31579
|
+
* const {google} = require('googleapis');
|
|
31580
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31581
|
+
*
|
|
31582
|
+
* async function main() {
|
|
31583
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31584
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31585
|
+
* scopes: [
|
|
31586
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31587
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31588
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31589
|
+
* ],
|
|
31590
|
+
* });
|
|
31591
|
+
*
|
|
31592
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31593
|
+
* const authClient = await auth.getClient();
|
|
31594
|
+
* google.options({auth: authClient});
|
|
31595
|
+
*
|
|
31596
|
+
* // Do the magic
|
|
31597
|
+
* const res =
|
|
31598
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.files.import(
|
|
31599
|
+
* {
|
|
31600
|
+
* // Required. The resource name of the Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31601
|
+
* parent:
|
|
31602
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
31603
|
+
*
|
|
31604
|
+
* // Request body metadata
|
|
31605
|
+
* requestBody: {
|
|
31606
|
+
* // request body parameters
|
|
31607
|
+
* // {
|
|
31608
|
+
* // "fileName": "my_fileName",
|
|
31609
|
+
* // "mimeType": "my_mimeType"
|
|
31610
|
+
* // }
|
|
31611
|
+
* },
|
|
31612
|
+
* },
|
|
31613
|
+
* );
|
|
31614
|
+
* console.log(res.data);
|
|
31615
|
+
*
|
|
31616
|
+
* // Example response
|
|
31617
|
+
* // {
|
|
31618
|
+
* // "agentFile": {}
|
|
31619
|
+
* // }
|
|
31620
|
+
* }
|
|
31621
|
+
*
|
|
31622
|
+
* main().catch(e => {
|
|
31623
|
+
* console.error(e);
|
|
31624
|
+
* throw e;
|
|
31625
|
+
* });
|
|
31626
|
+
*
|
|
31627
|
+
* ```
|
|
31628
|
+
*
|
|
31629
|
+
* @param params - Parameters for request
|
|
31630
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31631
|
+
* @param callback - Optional callback that handles the response.
|
|
31632
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31633
|
+
*/
|
|
31634
|
+
import(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31635
|
+
import(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse>>;
|
|
31636
|
+
import(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31637
|
+
import(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse>): void;
|
|
31638
|
+
import(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse>): void;
|
|
31639
|
+
import(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse>): void;
|
|
31640
|
+
}
|
|
31641
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import extends StandardParameters {
|
|
31642
|
+
/**
|
|
31643
|
+
* Required. The resource name of the Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31644
|
+
*/
|
|
31645
|
+
parent?: string;
|
|
31646
|
+
/**
|
|
31647
|
+
* Request body metadata
|
|
31648
|
+
*/
|
|
31649
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest;
|
|
31650
|
+
}
|
|
31651
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries {
|
|
31652
|
+
context: APIRequestContext;
|
|
31653
|
+
constructor(context: APIRequestContext);
|
|
31654
|
+
/**
|
|
31655
|
+
* Creates a CannedQuery.
|
|
31656
|
+
* @example
|
|
31657
|
+
* ```js
|
|
31658
|
+
* // Before running the sample:
|
|
31659
|
+
* // - Enable the API at:
|
|
31660
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31661
|
+
* // - Login into gcloud by running:
|
|
31662
|
+
* // ```sh
|
|
31663
|
+
* // $ gcloud auth application-default login
|
|
31664
|
+
* // ```
|
|
31665
|
+
* // - Install the npm module by running:
|
|
31666
|
+
* // ```sh
|
|
31667
|
+
* // $ npm install googleapis
|
|
31668
|
+
* // ```
|
|
31669
|
+
*
|
|
31670
|
+
* const {google} = require('googleapis');
|
|
31671
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31672
|
+
*
|
|
31673
|
+
* async function main() {
|
|
31674
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31675
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31676
|
+
* scopes: [
|
|
31677
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31678
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31679
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31680
|
+
* ],
|
|
31681
|
+
* });
|
|
31682
|
+
*
|
|
31683
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31684
|
+
* const authClient = await auth.getClient();
|
|
31685
|
+
* google.options({auth: authClient});
|
|
31686
|
+
*
|
|
31687
|
+
* // Do the magic
|
|
31688
|
+
* const res =
|
|
31689
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create(
|
|
31690
|
+
* {
|
|
31691
|
+
* // Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
31692
|
+
* cannedQueryId: 'placeholder-value',
|
|
31693
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31694
|
+
* parent:
|
|
31695
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
31696
|
+
*
|
|
31697
|
+
* // Request body metadata
|
|
31698
|
+
* requestBody: {
|
|
31699
|
+
* // request body parameters
|
|
31700
|
+
* // {
|
|
31701
|
+
* // "defaultTexts": {},
|
|
31702
|
+
* // "displayName": "my_displayName",
|
|
31703
|
+
* // "enabled": false,
|
|
31704
|
+
* // "googleDefined": false,
|
|
31705
|
+
* // "localizedTexts": {},
|
|
31706
|
+
* // "name": "my_name",
|
|
31707
|
+
* // "requiredCapabilities": []
|
|
31708
|
+
* // }
|
|
31709
|
+
* },
|
|
31710
|
+
* },
|
|
31711
|
+
* );
|
|
31712
|
+
* console.log(res.data);
|
|
31713
|
+
*
|
|
31714
|
+
* // Example response
|
|
31715
|
+
* // {
|
|
31716
|
+
* // "defaultTexts": {},
|
|
31717
|
+
* // "displayName": "my_displayName",
|
|
31718
|
+
* // "enabled": false,
|
|
31719
|
+
* // "googleDefined": false,
|
|
31720
|
+
* // "localizedTexts": {},
|
|
31721
|
+
* // "name": "my_name",
|
|
31722
|
+
* // "requiredCapabilities": []
|
|
31723
|
+
* // }
|
|
31724
|
+
* }
|
|
31725
|
+
*
|
|
31726
|
+
* main().catch(e => {
|
|
31727
|
+
* console.error(e);
|
|
31728
|
+
* throw e;
|
|
31729
|
+
* });
|
|
31730
|
+
*
|
|
31731
|
+
* ```
|
|
31732
|
+
*
|
|
31733
|
+
* @param params - Parameters for request
|
|
31734
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31735
|
+
* @param callback - Optional callback that handles the response.
|
|
31736
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31737
|
+
*/
|
|
31738
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31739
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>>;
|
|
31740
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31741
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31742
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31743
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31744
|
+
/**
|
|
31745
|
+
* Deletes a CannedQuery.
|
|
31746
|
+
* @example
|
|
31747
|
+
* ```js
|
|
31748
|
+
* // Before running the sample:
|
|
31749
|
+
* // - Enable the API at:
|
|
31750
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31751
|
+
* // - Login into gcloud by running:
|
|
31752
|
+
* // ```sh
|
|
31753
|
+
* // $ gcloud auth application-default login
|
|
31754
|
+
* // ```
|
|
31755
|
+
* // - Install the npm module by running:
|
|
31756
|
+
* // ```sh
|
|
31757
|
+
* // $ npm install googleapis
|
|
31758
|
+
* // ```
|
|
31759
|
+
*
|
|
31760
|
+
* const {google} = require('googleapis');
|
|
31761
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31762
|
+
*
|
|
31763
|
+
* async function main() {
|
|
31764
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31765
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31766
|
+
* scopes: [
|
|
31767
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31768
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31769
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31770
|
+
* ],
|
|
31771
|
+
* });
|
|
31772
|
+
*
|
|
31773
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31774
|
+
* const authClient = await auth.getClient();
|
|
31775
|
+
* google.options({auth: authClient});
|
|
31776
|
+
*
|
|
31777
|
+
* // Do the magic
|
|
31778
|
+
* const res =
|
|
31779
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete(
|
|
31780
|
+
* {
|
|
31781
|
+
* // Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.
|
|
31782
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie',
|
|
31783
|
+
* },
|
|
31784
|
+
* );
|
|
31785
|
+
* console.log(res.data);
|
|
31786
|
+
*
|
|
31787
|
+
* // Example response
|
|
31788
|
+
* // {}
|
|
31789
|
+
* }
|
|
31790
|
+
*
|
|
31791
|
+
* main().catch(e => {
|
|
31792
|
+
* console.error(e);
|
|
31793
|
+
* throw e;
|
|
31794
|
+
* });
|
|
31795
|
+
*
|
|
31796
|
+
* ```
|
|
31797
|
+
*
|
|
31798
|
+
* @param params - Parameters for request
|
|
31799
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31800
|
+
* @param callback - Optional callback that handles the response.
|
|
31801
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31802
|
+
*/
|
|
31803
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31804
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
31805
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31806
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
31807
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
31808
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
31809
|
+
/**
|
|
31810
|
+
* Gets a CannedQuery.
|
|
31811
|
+
* @example
|
|
31812
|
+
* ```js
|
|
31813
|
+
* // Before running the sample:
|
|
31814
|
+
* // - Enable the API at:
|
|
31815
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31816
|
+
* // - Login into gcloud by running:
|
|
31817
|
+
* // ```sh
|
|
31818
|
+
* // $ gcloud auth application-default login
|
|
31819
|
+
* // ```
|
|
31820
|
+
* // - Install the npm module by running:
|
|
31821
|
+
* // ```sh
|
|
31822
|
+
* // $ npm install googleapis
|
|
31823
|
+
* // ```
|
|
31824
|
+
*
|
|
31825
|
+
* const {google} = require('googleapis');
|
|
31826
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31827
|
+
*
|
|
31828
|
+
* async function main() {
|
|
31829
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31830
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31831
|
+
* scopes: [
|
|
31832
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31833
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31834
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31835
|
+
* ],
|
|
31836
|
+
* });
|
|
31837
|
+
*
|
|
31838
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31839
|
+
* const authClient = await auth.getClient();
|
|
31840
|
+
* google.options({auth: authClient});
|
|
31841
|
+
*
|
|
31842
|
+
* // Do the magic
|
|
31843
|
+
* const res =
|
|
31844
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get(
|
|
31845
|
+
* {
|
|
31846
|
+
* // Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}`
|
|
31847
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie',
|
|
31848
|
+
* },
|
|
31849
|
+
* );
|
|
31850
|
+
* console.log(res.data);
|
|
31851
|
+
*
|
|
31852
|
+
* // Example response
|
|
31853
|
+
* // {
|
|
31854
|
+
* // "defaultTexts": {},
|
|
31855
|
+
* // "displayName": "my_displayName",
|
|
31856
|
+
* // "enabled": false,
|
|
31857
|
+
* // "googleDefined": false,
|
|
31858
|
+
* // "localizedTexts": {},
|
|
31859
|
+
* // "name": "my_name",
|
|
31860
|
+
* // "requiredCapabilities": []
|
|
31861
|
+
* // }
|
|
31862
|
+
* }
|
|
31863
|
+
*
|
|
31864
|
+
* main().catch(e => {
|
|
31865
|
+
* console.error(e);
|
|
31866
|
+
* throw e;
|
|
31867
|
+
* });
|
|
31868
|
+
*
|
|
31869
|
+
* ```
|
|
31870
|
+
*
|
|
31871
|
+
* @param params - Parameters for request
|
|
31872
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31873
|
+
* @param callback - Optional callback that handles the response.
|
|
31874
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31875
|
+
*/
|
|
31876
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31877
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>>;
|
|
31878
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31879
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31880
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31881
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
31882
|
+
/**
|
|
31883
|
+
* Lists all CannedQuerys under an Assistant.
|
|
31884
|
+
* @example
|
|
31885
|
+
* ```js
|
|
31886
|
+
* // Before running the sample:
|
|
31887
|
+
* // - Enable the API at:
|
|
31888
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31889
|
+
* // - Login into gcloud by running:
|
|
31890
|
+
* // ```sh
|
|
31891
|
+
* // $ gcloud auth application-default login
|
|
31892
|
+
* // ```
|
|
31893
|
+
* // - Install the npm module by running:
|
|
31894
|
+
* // ```sh
|
|
31895
|
+
* // $ npm install googleapis
|
|
31896
|
+
* // ```
|
|
31897
|
+
*
|
|
31898
|
+
* const {google} = require('googleapis');
|
|
31899
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31900
|
+
*
|
|
31901
|
+
* async function main() {
|
|
31902
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31903
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31904
|
+
* scopes: [
|
|
31905
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31906
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31907
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31908
|
+
* ],
|
|
31909
|
+
* });
|
|
31910
|
+
*
|
|
31911
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31912
|
+
* const authClient = await auth.getClient();
|
|
31913
|
+
* google.options({auth: authClient});
|
|
31914
|
+
*
|
|
31915
|
+
* // Do the magic
|
|
31916
|
+
* const res =
|
|
31917
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list(
|
|
31918
|
+
* {
|
|
31919
|
+
* // Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`
|
|
31920
|
+
* filter: 'placeholder-value',
|
|
31921
|
+
* // Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
31922
|
+
* pageSize: 'placeholder-value',
|
|
31923
|
+
* // A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.
|
|
31924
|
+
* pageToken: 'placeholder-value',
|
|
31925
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
31926
|
+
* parent:
|
|
31927
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
31928
|
+
* },
|
|
31929
|
+
* );
|
|
31930
|
+
* console.log(res.data);
|
|
31931
|
+
*
|
|
31932
|
+
* // Example response
|
|
31933
|
+
* // {
|
|
31934
|
+
* // "cannedQueries": [],
|
|
31935
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
31936
|
+
* // }
|
|
31937
|
+
* }
|
|
31938
|
+
*
|
|
31939
|
+
* main().catch(e => {
|
|
31940
|
+
* console.error(e);
|
|
31941
|
+
* throw e;
|
|
31942
|
+
* });
|
|
31943
|
+
*
|
|
31944
|
+
* ```
|
|
31945
|
+
*
|
|
31946
|
+
* @param params - Parameters for request
|
|
31947
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31948
|
+
* @param callback - Optional callback that handles the response.
|
|
31949
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31950
|
+
*/
|
|
31951
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31952
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse>>;
|
|
31953
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31954
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse>): void;
|
|
31955
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse>): void;
|
|
31956
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse>): void;
|
|
31957
|
+
/**
|
|
31958
|
+
* Updates a CannedQuery.
|
|
31959
|
+
* @example
|
|
31960
|
+
* ```js
|
|
31961
|
+
* // Before running the sample:
|
|
31962
|
+
* // - Enable the API at:
|
|
31963
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31964
|
+
* // - Login into gcloud by running:
|
|
31965
|
+
* // ```sh
|
|
31966
|
+
* // $ gcloud auth application-default login
|
|
31967
|
+
* // ```
|
|
31968
|
+
* // - Install the npm module by running:
|
|
31969
|
+
* // ```sh
|
|
31970
|
+
* // $ npm install googleapis
|
|
31971
|
+
* // ```
|
|
31972
|
+
*
|
|
31973
|
+
* const {google} = require('googleapis');
|
|
31974
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31975
|
+
*
|
|
31976
|
+
* async function main() {
|
|
31977
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31978
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31979
|
+
* scopes: [
|
|
31980
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31981
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31982
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31983
|
+
* ],
|
|
31984
|
+
* });
|
|
31985
|
+
*
|
|
31986
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31987
|
+
* const authClient = await auth.getClient();
|
|
31988
|
+
* google.options({auth: authClient});
|
|
31989
|
+
*
|
|
31990
|
+
* // Do the magic
|
|
31991
|
+
* const res =
|
|
31992
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch(
|
|
29255
31993
|
* {
|
|
29256
|
-
* //
|
|
29257
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
31994
|
+
* // Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
31995
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie',
|
|
31996
|
+
* // The list of fields to update.
|
|
31997
|
+
* updateMask: 'placeholder-value',
|
|
29258
31998
|
*
|
|
29259
31999
|
* // Request body metadata
|
|
29260
32000
|
* requestBody: {
|
|
29261
32001
|
* // request body parameters
|
|
29262
32002
|
* // {
|
|
29263
|
-
* // "
|
|
29264
|
-
* // "
|
|
29265
|
-
* // "
|
|
29266
|
-
* // "
|
|
29267
|
-
* // "
|
|
32003
|
+
* // "defaultTexts": {},
|
|
32004
|
+
* // "displayName": "my_displayName",
|
|
32005
|
+
* // "enabled": false,
|
|
32006
|
+
* // "googleDefined": false,
|
|
32007
|
+
* // "localizedTexts": {},
|
|
32008
|
+
* // "name": "my_name",
|
|
32009
|
+
* // "requiredCapabilities": []
|
|
29268
32010
|
* // }
|
|
29269
32011
|
* },
|
|
29270
32012
|
* },
|
|
@@ -29273,9 +32015,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29273
32015
|
*
|
|
29274
32016
|
* // Example response
|
|
29275
32017
|
* // {
|
|
29276
|
-
* // "
|
|
29277
|
-
* // "
|
|
29278
|
-
* // "
|
|
32018
|
+
* // "defaultTexts": {},
|
|
32019
|
+
* // "displayName": "my_displayName",
|
|
32020
|
+
* // "enabled": false,
|
|
32021
|
+
* // "googleDefined": false,
|
|
32022
|
+
* // "localizedTexts": {},
|
|
32023
|
+
* // "name": "my_name",
|
|
32024
|
+
* // "requiredCapabilities": []
|
|
29279
32025
|
* // }
|
|
29280
32026
|
* }
|
|
29281
32027
|
*
|
|
@@ -29291,42 +32037,70 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29291
32037
|
* @param callback - Optional callback that handles the response.
|
|
29292
32038
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
29293
32039
|
*/
|
|
29294
|
-
|
|
29295
|
-
|
|
29296
|
-
|
|
29297
|
-
|
|
29298
|
-
|
|
29299
|
-
|
|
32040
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
32041
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>>;
|
|
32042
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
32043
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
32044
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
32045
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery>): void;
|
|
29300
32046
|
}
|
|
29301
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$
|
|
32047
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create extends StandardParameters {
|
|
29302
32048
|
/**
|
|
29303
|
-
* Required.
|
|
32049
|
+
* Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
32050
|
+
*/
|
|
32051
|
+
cannedQueryId?: string;
|
|
32052
|
+
/**
|
|
32053
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
32054
|
+
*/
|
|
32055
|
+
parent?: string;
|
|
32056
|
+
/**
|
|
32057
|
+
* Request body metadata
|
|
32058
|
+
*/
|
|
32059
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
|
|
32060
|
+
}
|
|
32061
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete extends StandardParameters {
|
|
32062
|
+
/**
|
|
32063
|
+
* Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.
|
|
29304
32064
|
*/
|
|
29305
32065
|
name?: string;
|
|
29306
32066
|
}
|
|
29307
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$
|
|
32067
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get extends StandardParameters {
|
|
29308
32068
|
/**
|
|
29309
|
-
*
|
|
32069
|
+
* Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}`
|
|
29310
32070
|
*/
|
|
29311
32071
|
name?: string;
|
|
32072
|
+
}
|
|
32073
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List extends StandardParameters {
|
|
29312
32074
|
/**
|
|
29313
|
-
* The
|
|
32075
|
+
* Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`
|
|
29314
32076
|
*/
|
|
29315
|
-
|
|
32077
|
+
filter?: string;
|
|
29316
32078
|
/**
|
|
29317
|
-
*
|
|
32079
|
+
* Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
29318
32080
|
*/
|
|
29319
|
-
|
|
32081
|
+
pageSize?: number;
|
|
32082
|
+
/**
|
|
32083
|
+
* A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.
|
|
32084
|
+
*/
|
|
32085
|
+
pageToken?: string;
|
|
32086
|
+
/**
|
|
32087
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
32088
|
+
*/
|
|
32089
|
+
parent?: string;
|
|
29320
32090
|
}
|
|
29321
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$
|
|
32091
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch extends StandardParameters {
|
|
29322
32092
|
/**
|
|
29323
|
-
*
|
|
32093
|
+
* Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
29324
32094
|
*/
|
|
29325
32095
|
name?: string;
|
|
32096
|
+
/**
|
|
32097
|
+
* The list of fields to update.
|
|
32098
|
+
*/
|
|
32099
|
+
updateMask?: string;
|
|
29326
32100
|
/**
|
|
29327
32101
|
* Request body metadata
|
|
29328
32102
|
*/
|
|
29329
|
-
requestBody?: Schema$
|
|
32103
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
|
|
29330
32104
|
}
|
|
29331
32105
|
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
29332
32106
|
context: APIRequestContext;
|
|
@@ -32325,9 +35099,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32325
35099
|
* // "enableSnippetResultSummary": false,
|
|
32326
35100
|
* // "enableSummarization": false,
|
|
32327
35101
|
* // "enableWebApp": false,
|
|
32328
|
-
* // "experimentalFeatures": {},
|
|
32329
35102
|
* // "facetField": [],
|
|
32330
35103
|
* // "fieldsUiComponentsMap": {},
|
|
35104
|
+
* // "geminiBundle": false,
|
|
32331
35105
|
* // "homepageSetting": {},
|
|
32332
35106
|
* // "industryVertical": "my_industryVertical",
|
|
32333
35107
|
* // "llmEnabled": false,
|
|
@@ -32359,6 +35133,153 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32359
35133
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
32360
35134
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
32361
35135
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
35136
|
+
/**
|
|
35137
|
+
* Update a WidgetConfig.
|
|
35138
|
+
* @example
|
|
35139
|
+
* ```js
|
|
35140
|
+
* // Before running the sample:
|
|
35141
|
+
* // - Enable the API at:
|
|
35142
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35143
|
+
* // - Login into gcloud by running:
|
|
35144
|
+
* // ```sh
|
|
35145
|
+
* // $ gcloud auth application-default login
|
|
35146
|
+
* // ```
|
|
35147
|
+
* // - Install the npm module by running:
|
|
35148
|
+
* // ```sh
|
|
35149
|
+
* // $ npm install googleapis
|
|
35150
|
+
* // ```
|
|
35151
|
+
*
|
|
35152
|
+
* const {google} = require('googleapis');
|
|
35153
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
35154
|
+
*
|
|
35155
|
+
* async function main() {
|
|
35156
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35157
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35158
|
+
* scopes: [
|
|
35159
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
35160
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
35161
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
35162
|
+
* ],
|
|
35163
|
+
* });
|
|
35164
|
+
*
|
|
35165
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35166
|
+
* const authClient = await auth.getClient();
|
|
35167
|
+
* google.options({auth: authClient});
|
|
35168
|
+
*
|
|
35169
|
+
* // Do the magic
|
|
35170
|
+
* const res =
|
|
35171
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch(
|
|
35172
|
+
* {
|
|
35173
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
35174
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
35175
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
35176
|
+
* updateMask: 'placeholder-value',
|
|
35177
|
+
*
|
|
35178
|
+
* // Request body metadata
|
|
35179
|
+
* requestBody: {
|
|
35180
|
+
* // request body parameters
|
|
35181
|
+
* // {
|
|
35182
|
+
* // "accessSettings": {},
|
|
35183
|
+
* // "allowPublicAccess": false,
|
|
35184
|
+
* // "allowlistedDomains": [],
|
|
35185
|
+
* // "assistantSettings": {},
|
|
35186
|
+
* // "collectionComponents": [],
|
|
35187
|
+
* // "configId": "my_configId",
|
|
35188
|
+
* // "contentSearchSpec": {},
|
|
35189
|
+
* // "createTime": "my_createTime",
|
|
35190
|
+
* // "customerProvidedConfig": {},
|
|
35191
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
35192
|
+
* // "dataStoreUiConfigs": [],
|
|
35193
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
35194
|
+
* // "displayName": "my_displayName",
|
|
35195
|
+
* // "enableAutocomplete": false,
|
|
35196
|
+
* // "enableConversationalSearch": false,
|
|
35197
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
35198
|
+
* // "enableQualityFeedback": false,
|
|
35199
|
+
* // "enableResultScore": false,
|
|
35200
|
+
* // "enableSafeSearch": false,
|
|
35201
|
+
* // "enableSearchAsYouType": false,
|
|
35202
|
+
* // "enableSnippetResultSummary": false,
|
|
35203
|
+
* // "enableSummarization": false,
|
|
35204
|
+
* // "enableWebApp": false,
|
|
35205
|
+
* // "facetField": [],
|
|
35206
|
+
* // "fieldsUiComponentsMap": {},
|
|
35207
|
+
* // "geminiBundle": false,
|
|
35208
|
+
* // "homepageSetting": {},
|
|
35209
|
+
* // "industryVertical": "my_industryVertical",
|
|
35210
|
+
* // "llmEnabled": false,
|
|
35211
|
+
* // "minimumDataTermAccepted": false,
|
|
35212
|
+
* // "name": "my_name",
|
|
35213
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
35214
|
+
* // "solutionType": "my_solutionType",
|
|
35215
|
+
* // "uiBranding": {},
|
|
35216
|
+
* // "uiSettings": {},
|
|
35217
|
+
* // "updateTime": "my_updateTime"
|
|
35218
|
+
* // }
|
|
35219
|
+
* },
|
|
35220
|
+
* },
|
|
35221
|
+
* );
|
|
35222
|
+
* console.log(res.data);
|
|
35223
|
+
*
|
|
35224
|
+
* // Example response
|
|
35225
|
+
* // {
|
|
35226
|
+
* // "accessSettings": {},
|
|
35227
|
+
* // "allowPublicAccess": false,
|
|
35228
|
+
* // "allowlistedDomains": [],
|
|
35229
|
+
* // "assistantSettings": {},
|
|
35230
|
+
* // "collectionComponents": [],
|
|
35231
|
+
* // "configId": "my_configId",
|
|
35232
|
+
* // "contentSearchSpec": {},
|
|
35233
|
+
* // "createTime": "my_createTime",
|
|
35234
|
+
* // "customerProvidedConfig": {},
|
|
35235
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
35236
|
+
* // "dataStoreUiConfigs": [],
|
|
35237
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
35238
|
+
* // "displayName": "my_displayName",
|
|
35239
|
+
* // "enableAutocomplete": false,
|
|
35240
|
+
* // "enableConversationalSearch": false,
|
|
35241
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
35242
|
+
* // "enableQualityFeedback": false,
|
|
35243
|
+
* // "enableResultScore": false,
|
|
35244
|
+
* // "enableSafeSearch": false,
|
|
35245
|
+
* // "enableSearchAsYouType": false,
|
|
35246
|
+
* // "enableSnippetResultSummary": false,
|
|
35247
|
+
* // "enableSummarization": false,
|
|
35248
|
+
* // "enableWebApp": false,
|
|
35249
|
+
* // "facetField": [],
|
|
35250
|
+
* // "fieldsUiComponentsMap": {},
|
|
35251
|
+
* // "geminiBundle": false,
|
|
35252
|
+
* // "homepageSetting": {},
|
|
35253
|
+
* // "industryVertical": "my_industryVertical",
|
|
35254
|
+
* // "llmEnabled": false,
|
|
35255
|
+
* // "minimumDataTermAccepted": false,
|
|
35256
|
+
* // "name": "my_name",
|
|
35257
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
35258
|
+
* // "solutionType": "my_solutionType",
|
|
35259
|
+
* // "uiBranding": {},
|
|
35260
|
+
* // "uiSettings": {},
|
|
35261
|
+
* // "updateTime": "my_updateTime"
|
|
35262
|
+
* // }
|
|
35263
|
+
* }
|
|
35264
|
+
*
|
|
35265
|
+
* main().catch(e => {
|
|
35266
|
+
* console.error(e);
|
|
35267
|
+
* throw e;
|
|
35268
|
+
* });
|
|
35269
|
+
*
|
|
35270
|
+
* ```
|
|
35271
|
+
*
|
|
35272
|
+
* @param params - Parameters for request
|
|
35273
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
35274
|
+
* @param callback - Optional callback that handles the response.
|
|
35275
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
35276
|
+
*/
|
|
35277
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
35278
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>>;
|
|
35279
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
35280
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
35281
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
35282
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
32362
35283
|
}
|
|
32363
35284
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get extends StandardParameters {
|
|
32364
35285
|
/**
|
|
@@ -32374,6 +35295,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32374
35295
|
*/
|
|
32375
35296
|
name?: string;
|
|
32376
35297
|
}
|
|
35298
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch extends StandardParameters {
|
|
35299
|
+
/**
|
|
35300
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
35301
|
+
*/
|
|
35302
|
+
name?: string;
|
|
35303
|
+
/**
|
|
35304
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
35305
|
+
*/
|
|
35306
|
+
updateMask?: string;
|
|
35307
|
+
/**
|
|
35308
|
+
* Request body metadata
|
|
35309
|
+
*/
|
|
35310
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
35311
|
+
}
|
|
32377
35312
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
32378
35313
|
context: APIRequestContext;
|
|
32379
35314
|
constructor(context: APIRequestContext);
|
|
@@ -32610,7 +35545,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32610
35545
|
* query: 'placeholder-value',
|
|
32611
35546
|
* // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
32612
35547
|
* queryModel: 'placeholder-value',
|
|
32613
|
-
* // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
35548
|
+
* // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
32614
35549
|
* userPseudoId: 'placeholder-value',
|
|
32615
35550
|
* },
|
|
32616
35551
|
* );
|
|
@@ -32697,6 +35632,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32697
35632
|
* // "billingEstimation": {},
|
|
32698
35633
|
* // "cmekConfig": {},
|
|
32699
35634
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
35635
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
32700
35636
|
* // "contentConfig": "my_contentConfig",
|
|
32701
35637
|
* // "createTime": "my_createTime",
|
|
32702
35638
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -32861,6 +35797,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32861
35797
|
* // "billingEstimation": {},
|
|
32862
35798
|
* // "cmekConfig": {},
|
|
32863
35799
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
35800
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
32864
35801
|
* // "contentConfig": "my_contentConfig",
|
|
32865
35802
|
* // "createTime": "my_createTime",
|
|
32866
35803
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -33151,6 +36088,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33151
36088
|
* // "billingEstimation": {},
|
|
33152
36089
|
* // "cmekConfig": {},
|
|
33153
36090
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
36091
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
33154
36092
|
* // "contentConfig": "my_contentConfig",
|
|
33155
36093
|
* // "createTime": "my_createTime",
|
|
33156
36094
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -33181,6 +36119,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33181
36119
|
* // "billingEstimation": {},
|
|
33182
36120
|
* // "cmekConfig": {},
|
|
33183
36121
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
36122
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
33184
36123
|
* // "contentConfig": "my_contentConfig",
|
|
33185
36124
|
* // "createTime": "my_createTime",
|
|
33186
36125
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -33321,7 +36260,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33321
36260
|
*/
|
|
33322
36261
|
queryModel?: string;
|
|
33323
36262
|
/**
|
|
33324
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
36263
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
33325
36264
|
*/
|
|
33326
36265
|
userPseudoId?: string;
|
|
33327
36266
|
}
|
|
@@ -40051,9 +42990,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40051
42990
|
* // "enableSnippetResultSummary": false,
|
|
40052
42991
|
* // "enableSummarization": false,
|
|
40053
42992
|
* // "enableWebApp": false,
|
|
40054
|
-
* // "experimentalFeatures": {},
|
|
40055
42993
|
* // "facetField": [],
|
|
40056
42994
|
* // "fieldsUiComponentsMap": {},
|
|
42995
|
+
* // "geminiBundle": false,
|
|
40057
42996
|
* // "homepageSetting": {},
|
|
40058
42997
|
* // "industryVertical": "my_industryVertical",
|
|
40059
42998
|
* // "llmEnabled": false,
|
|
@@ -40085,6 +43024,151 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40085
43024
|
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
40086
43025
|
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
40087
43026
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
43027
|
+
/**
|
|
43028
|
+
* Update a WidgetConfig.
|
|
43029
|
+
* @example
|
|
43030
|
+
* ```js
|
|
43031
|
+
* // Before running the sample:
|
|
43032
|
+
* // - Enable the API at:
|
|
43033
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
43034
|
+
* // - Login into gcloud by running:
|
|
43035
|
+
* // ```sh
|
|
43036
|
+
* // $ gcloud auth application-default login
|
|
43037
|
+
* // ```
|
|
43038
|
+
* // - Install the npm module by running:
|
|
43039
|
+
* // ```sh
|
|
43040
|
+
* // $ npm install googleapis
|
|
43041
|
+
* // ```
|
|
43042
|
+
*
|
|
43043
|
+
* const {google} = require('googleapis');
|
|
43044
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
43045
|
+
*
|
|
43046
|
+
* async function main() {
|
|
43047
|
+
* const auth = new google.auth.GoogleAuth({
|
|
43048
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
43049
|
+
* scopes: [
|
|
43050
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
43051
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
43052
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
43053
|
+
* ],
|
|
43054
|
+
* });
|
|
43055
|
+
*
|
|
43056
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
43057
|
+
* const authClient = await auth.getClient();
|
|
43058
|
+
* google.options({auth: authClient});
|
|
43059
|
+
*
|
|
43060
|
+
* // Do the magic
|
|
43061
|
+
* const res =
|
|
43062
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({
|
|
43063
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
43064
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
43065
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
43066
|
+
* updateMask: 'placeholder-value',
|
|
43067
|
+
*
|
|
43068
|
+
* // Request body metadata
|
|
43069
|
+
* requestBody: {
|
|
43070
|
+
* // request body parameters
|
|
43071
|
+
* // {
|
|
43072
|
+
* // "accessSettings": {},
|
|
43073
|
+
* // "allowPublicAccess": false,
|
|
43074
|
+
* // "allowlistedDomains": [],
|
|
43075
|
+
* // "assistantSettings": {},
|
|
43076
|
+
* // "collectionComponents": [],
|
|
43077
|
+
* // "configId": "my_configId",
|
|
43078
|
+
* // "contentSearchSpec": {},
|
|
43079
|
+
* // "createTime": "my_createTime",
|
|
43080
|
+
* // "customerProvidedConfig": {},
|
|
43081
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
43082
|
+
* // "dataStoreUiConfigs": [],
|
|
43083
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
43084
|
+
* // "displayName": "my_displayName",
|
|
43085
|
+
* // "enableAutocomplete": false,
|
|
43086
|
+
* // "enableConversationalSearch": false,
|
|
43087
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
43088
|
+
* // "enableQualityFeedback": false,
|
|
43089
|
+
* // "enableResultScore": false,
|
|
43090
|
+
* // "enableSafeSearch": false,
|
|
43091
|
+
* // "enableSearchAsYouType": false,
|
|
43092
|
+
* // "enableSnippetResultSummary": false,
|
|
43093
|
+
* // "enableSummarization": false,
|
|
43094
|
+
* // "enableWebApp": false,
|
|
43095
|
+
* // "facetField": [],
|
|
43096
|
+
* // "fieldsUiComponentsMap": {},
|
|
43097
|
+
* // "geminiBundle": false,
|
|
43098
|
+
* // "homepageSetting": {},
|
|
43099
|
+
* // "industryVertical": "my_industryVertical",
|
|
43100
|
+
* // "llmEnabled": false,
|
|
43101
|
+
* // "minimumDataTermAccepted": false,
|
|
43102
|
+
* // "name": "my_name",
|
|
43103
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
43104
|
+
* // "solutionType": "my_solutionType",
|
|
43105
|
+
* // "uiBranding": {},
|
|
43106
|
+
* // "uiSettings": {},
|
|
43107
|
+
* // "updateTime": "my_updateTime"
|
|
43108
|
+
* // }
|
|
43109
|
+
* },
|
|
43110
|
+
* });
|
|
43111
|
+
* console.log(res.data);
|
|
43112
|
+
*
|
|
43113
|
+
* // Example response
|
|
43114
|
+
* // {
|
|
43115
|
+
* // "accessSettings": {},
|
|
43116
|
+
* // "allowPublicAccess": false,
|
|
43117
|
+
* // "allowlistedDomains": [],
|
|
43118
|
+
* // "assistantSettings": {},
|
|
43119
|
+
* // "collectionComponents": [],
|
|
43120
|
+
* // "configId": "my_configId",
|
|
43121
|
+
* // "contentSearchSpec": {},
|
|
43122
|
+
* // "createTime": "my_createTime",
|
|
43123
|
+
* // "customerProvidedConfig": {},
|
|
43124
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
43125
|
+
* // "dataStoreUiConfigs": [],
|
|
43126
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
43127
|
+
* // "displayName": "my_displayName",
|
|
43128
|
+
* // "enableAutocomplete": false,
|
|
43129
|
+
* // "enableConversationalSearch": false,
|
|
43130
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
43131
|
+
* // "enableQualityFeedback": false,
|
|
43132
|
+
* // "enableResultScore": false,
|
|
43133
|
+
* // "enableSafeSearch": false,
|
|
43134
|
+
* // "enableSearchAsYouType": false,
|
|
43135
|
+
* // "enableSnippetResultSummary": false,
|
|
43136
|
+
* // "enableSummarization": false,
|
|
43137
|
+
* // "enableWebApp": false,
|
|
43138
|
+
* // "facetField": [],
|
|
43139
|
+
* // "fieldsUiComponentsMap": {},
|
|
43140
|
+
* // "geminiBundle": false,
|
|
43141
|
+
* // "homepageSetting": {},
|
|
43142
|
+
* // "industryVertical": "my_industryVertical",
|
|
43143
|
+
* // "llmEnabled": false,
|
|
43144
|
+
* // "minimumDataTermAccepted": false,
|
|
43145
|
+
* // "name": "my_name",
|
|
43146
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
43147
|
+
* // "solutionType": "my_solutionType",
|
|
43148
|
+
* // "uiBranding": {},
|
|
43149
|
+
* // "uiSettings": {},
|
|
43150
|
+
* // "updateTime": "my_updateTime"
|
|
43151
|
+
* // }
|
|
43152
|
+
* }
|
|
43153
|
+
*
|
|
43154
|
+
* main().catch(e => {
|
|
43155
|
+
* console.error(e);
|
|
43156
|
+
* throw e;
|
|
43157
|
+
* });
|
|
43158
|
+
*
|
|
43159
|
+
* ```
|
|
43160
|
+
*
|
|
43161
|
+
* @param params - Parameters for request
|
|
43162
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
43163
|
+
* @param callback - Optional callback that handles the response.
|
|
43164
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
43165
|
+
*/
|
|
43166
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
43167
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>>;
|
|
43168
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
43169
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
43170
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
43171
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig>): void;
|
|
40088
43172
|
}
|
|
40089
43173
|
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
40090
43174
|
/**
|
|
@@ -40100,6 +43184,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40100
43184
|
*/
|
|
40101
43185
|
name?: string;
|
|
40102
43186
|
}
|
|
43187
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
43188
|
+
/**
|
|
43189
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
43190
|
+
*/
|
|
43191
|
+
name?: string;
|
|
43192
|
+
/**
|
|
43193
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
43194
|
+
*/
|
|
43195
|
+
updateMask?: string;
|
|
43196
|
+
/**
|
|
43197
|
+
* Request body metadata
|
|
43198
|
+
*/
|
|
43199
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
43200
|
+
}
|
|
40103
43201
|
export class Resource$Projects$Locations$Evaluations {
|
|
40104
43202
|
context: APIRequestContext;
|
|
40105
43203
|
operations: Resource$Projects$Locations$Evaluations$Operations;
|
|
@@ -44428,6 +47526,302 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
44428
47526
|
batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
44429
47527
|
batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
44430
47528
|
batchUpdateUserLicenses(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
47529
|
+
/**
|
|
47530
|
+
* Creates a new User Store.
|
|
47531
|
+
* @example
|
|
47532
|
+
* ```js
|
|
47533
|
+
* // Before running the sample:
|
|
47534
|
+
* // - Enable the API at:
|
|
47535
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
47536
|
+
* // - Login into gcloud by running:
|
|
47537
|
+
* // ```sh
|
|
47538
|
+
* // $ gcloud auth application-default login
|
|
47539
|
+
* // ```
|
|
47540
|
+
* // - Install the npm module by running:
|
|
47541
|
+
* // ```sh
|
|
47542
|
+
* // $ npm install googleapis
|
|
47543
|
+
* // ```
|
|
47544
|
+
*
|
|
47545
|
+
* const {google} = require('googleapis');
|
|
47546
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
47547
|
+
*
|
|
47548
|
+
* async function main() {
|
|
47549
|
+
* const auth = new google.auth.GoogleAuth({
|
|
47550
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
47551
|
+
* scopes: [
|
|
47552
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
47553
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
47554
|
+
* ],
|
|
47555
|
+
* });
|
|
47556
|
+
*
|
|
47557
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
47558
|
+
* const authClient = await auth.getClient();
|
|
47559
|
+
* google.options({auth: authClient});
|
|
47560
|
+
*
|
|
47561
|
+
* // Do the magic
|
|
47562
|
+
* const res = await discoveryengine.projects.locations.userStores.create({
|
|
47563
|
+
* // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
47564
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
47565
|
+
* // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
47566
|
+
* userStoreId: 'placeholder-value',
|
|
47567
|
+
*
|
|
47568
|
+
* // Request body metadata
|
|
47569
|
+
* requestBody: {
|
|
47570
|
+
* // request body parameters
|
|
47571
|
+
* // {
|
|
47572
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
47573
|
+
* // "displayName": "my_displayName",
|
|
47574
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
47575
|
+
* // "enableLicenseAutoRegister": false,
|
|
47576
|
+
* // "name": "my_name"
|
|
47577
|
+
* // }
|
|
47578
|
+
* },
|
|
47579
|
+
* });
|
|
47580
|
+
* console.log(res.data);
|
|
47581
|
+
*
|
|
47582
|
+
* // Example response
|
|
47583
|
+
* // {
|
|
47584
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
47585
|
+
* // "displayName": "my_displayName",
|
|
47586
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
47587
|
+
* // "enableLicenseAutoRegister": false,
|
|
47588
|
+
* // "name": "my_name"
|
|
47589
|
+
* // }
|
|
47590
|
+
* }
|
|
47591
|
+
*
|
|
47592
|
+
* main().catch(e => {
|
|
47593
|
+
* console.error(e);
|
|
47594
|
+
* throw e;
|
|
47595
|
+
* });
|
|
47596
|
+
*
|
|
47597
|
+
* ```
|
|
47598
|
+
*
|
|
47599
|
+
* @param params - Parameters for request
|
|
47600
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
47601
|
+
* @param callback - Optional callback that handles the response.
|
|
47602
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
47603
|
+
*/
|
|
47604
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
47605
|
+
create(params?: Params$Resource$Projects$Locations$Userstores$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>>;
|
|
47606
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
47607
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47608
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47609
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47610
|
+
/**
|
|
47611
|
+
* Deletes the User Store.
|
|
47612
|
+
* @example
|
|
47613
|
+
* ```js
|
|
47614
|
+
* // Before running the sample:
|
|
47615
|
+
* // - Enable the API at:
|
|
47616
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
47617
|
+
* // - Login into gcloud by running:
|
|
47618
|
+
* // ```sh
|
|
47619
|
+
* // $ gcloud auth application-default login
|
|
47620
|
+
* // ```
|
|
47621
|
+
* // - Install the npm module by running:
|
|
47622
|
+
* // ```sh
|
|
47623
|
+
* // $ npm install googleapis
|
|
47624
|
+
* // ```
|
|
47625
|
+
*
|
|
47626
|
+
* const {google} = require('googleapis');
|
|
47627
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
47628
|
+
*
|
|
47629
|
+
* async function main() {
|
|
47630
|
+
* const auth = new google.auth.GoogleAuth({
|
|
47631
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
47632
|
+
* scopes: [
|
|
47633
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
47634
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
47635
|
+
* ],
|
|
47636
|
+
* });
|
|
47637
|
+
*
|
|
47638
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
47639
|
+
* const authClient = await auth.getClient();
|
|
47640
|
+
* google.options({auth: authClient});
|
|
47641
|
+
*
|
|
47642
|
+
* // Do the magic
|
|
47643
|
+
* const res = await discoveryengine.projects.locations.userStores.delete({
|
|
47644
|
+
* // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
47645
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
47646
|
+
* });
|
|
47647
|
+
* console.log(res.data);
|
|
47648
|
+
*
|
|
47649
|
+
* // Example response
|
|
47650
|
+
* // {
|
|
47651
|
+
* // "done": false,
|
|
47652
|
+
* // "error": {},
|
|
47653
|
+
* // "metadata": {},
|
|
47654
|
+
* // "name": "my_name",
|
|
47655
|
+
* // "response": {}
|
|
47656
|
+
* // }
|
|
47657
|
+
* }
|
|
47658
|
+
*
|
|
47659
|
+
* main().catch(e => {
|
|
47660
|
+
* console.error(e);
|
|
47661
|
+
* throw e;
|
|
47662
|
+
* });
|
|
47663
|
+
*
|
|
47664
|
+
* ```
|
|
47665
|
+
*
|
|
47666
|
+
* @param params - Parameters for request
|
|
47667
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
47668
|
+
* @param callback - Optional callback that handles the response.
|
|
47669
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
47670
|
+
*/
|
|
47671
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
47672
|
+
delete(params?: Params$Resource$Projects$Locations$Userstores$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
47673
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
47674
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
47675
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
47676
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
47677
|
+
/**
|
|
47678
|
+
* Gets the User Store.
|
|
47679
|
+
* @example
|
|
47680
|
+
* ```js
|
|
47681
|
+
* // Before running the sample:
|
|
47682
|
+
* // - Enable the API at:
|
|
47683
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
47684
|
+
* // - Login into gcloud by running:
|
|
47685
|
+
* // ```sh
|
|
47686
|
+
* // $ gcloud auth application-default login
|
|
47687
|
+
* // ```
|
|
47688
|
+
* // - Install the npm module by running:
|
|
47689
|
+
* // ```sh
|
|
47690
|
+
* // $ npm install googleapis
|
|
47691
|
+
* // ```
|
|
47692
|
+
*
|
|
47693
|
+
* const {google} = require('googleapis');
|
|
47694
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
47695
|
+
*
|
|
47696
|
+
* async function main() {
|
|
47697
|
+
* const auth = new google.auth.GoogleAuth({
|
|
47698
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
47699
|
+
* scopes: [
|
|
47700
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
47701
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
47702
|
+
* ],
|
|
47703
|
+
* });
|
|
47704
|
+
*
|
|
47705
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
47706
|
+
* const authClient = await auth.getClient();
|
|
47707
|
+
* google.options({auth: authClient});
|
|
47708
|
+
*
|
|
47709
|
+
* // Do the magic
|
|
47710
|
+
* const res = await discoveryengine.projects.locations.userStores.get({
|
|
47711
|
+
* // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
47712
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
47713
|
+
* });
|
|
47714
|
+
* console.log(res.data);
|
|
47715
|
+
*
|
|
47716
|
+
* // Example response
|
|
47717
|
+
* // {
|
|
47718
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
47719
|
+
* // "displayName": "my_displayName",
|
|
47720
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
47721
|
+
* // "enableLicenseAutoRegister": false,
|
|
47722
|
+
* // "name": "my_name"
|
|
47723
|
+
* // }
|
|
47724
|
+
* }
|
|
47725
|
+
*
|
|
47726
|
+
* main().catch(e => {
|
|
47727
|
+
* console.error(e);
|
|
47728
|
+
* throw e;
|
|
47729
|
+
* });
|
|
47730
|
+
*
|
|
47731
|
+
* ```
|
|
47732
|
+
*
|
|
47733
|
+
* @param params - Parameters for request
|
|
47734
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
47735
|
+
* @param callback - Optional callback that handles the response.
|
|
47736
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
47737
|
+
*/
|
|
47738
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
47739
|
+
get(params?: Params$Resource$Projects$Locations$Userstores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>>;
|
|
47740
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
47741
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47742
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47743
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47744
|
+
/**
|
|
47745
|
+
* Updates the User Store.
|
|
47746
|
+
* @example
|
|
47747
|
+
* ```js
|
|
47748
|
+
* // Before running the sample:
|
|
47749
|
+
* // - Enable the API at:
|
|
47750
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
47751
|
+
* // - Login into gcloud by running:
|
|
47752
|
+
* // ```sh
|
|
47753
|
+
* // $ gcloud auth application-default login
|
|
47754
|
+
* // ```
|
|
47755
|
+
* // - Install the npm module by running:
|
|
47756
|
+
* // ```sh
|
|
47757
|
+
* // $ npm install googleapis
|
|
47758
|
+
* // ```
|
|
47759
|
+
*
|
|
47760
|
+
* const {google} = require('googleapis');
|
|
47761
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
47762
|
+
*
|
|
47763
|
+
* async function main() {
|
|
47764
|
+
* const auth = new google.auth.GoogleAuth({
|
|
47765
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
47766
|
+
* scopes: [
|
|
47767
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
47768
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
47769
|
+
* ],
|
|
47770
|
+
* });
|
|
47771
|
+
*
|
|
47772
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
47773
|
+
* const authClient = await auth.getClient();
|
|
47774
|
+
* google.options({auth: authClient});
|
|
47775
|
+
*
|
|
47776
|
+
* // Do the magic
|
|
47777
|
+
* const res = await discoveryengine.projects.locations.userStores.patch({
|
|
47778
|
+
* // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
47779
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
47780
|
+
* // Optional. The list of fields to update.
|
|
47781
|
+
* updateMask: 'placeholder-value',
|
|
47782
|
+
*
|
|
47783
|
+
* // Request body metadata
|
|
47784
|
+
* requestBody: {
|
|
47785
|
+
* // request body parameters
|
|
47786
|
+
* // {
|
|
47787
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
47788
|
+
* // "displayName": "my_displayName",
|
|
47789
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
47790
|
+
* // "enableLicenseAutoRegister": false,
|
|
47791
|
+
* // "name": "my_name"
|
|
47792
|
+
* // }
|
|
47793
|
+
* },
|
|
47794
|
+
* });
|
|
47795
|
+
* console.log(res.data);
|
|
47796
|
+
*
|
|
47797
|
+
* // Example response
|
|
47798
|
+
* // {
|
|
47799
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
47800
|
+
* // "displayName": "my_displayName",
|
|
47801
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
47802
|
+
* // "enableLicenseAutoRegister": false,
|
|
47803
|
+
* // "name": "my_name"
|
|
47804
|
+
* // }
|
|
47805
|
+
* }
|
|
47806
|
+
*
|
|
47807
|
+
* main().catch(e => {
|
|
47808
|
+
* console.error(e);
|
|
47809
|
+
* throw e;
|
|
47810
|
+
* });
|
|
47811
|
+
*
|
|
47812
|
+
* ```
|
|
47813
|
+
*
|
|
47814
|
+
* @param params - Parameters for request
|
|
47815
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
47816
|
+
* @param callback - Optional callback that handles the response.
|
|
47817
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
47818
|
+
*/
|
|
47819
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
47820
|
+
patch(params?: Params$Resource$Projects$Locations$Userstores$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>>;
|
|
47821
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
47822
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47823
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
47824
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserStore>): void;
|
|
44431
47825
|
}
|
|
44432
47826
|
export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses extends StandardParameters {
|
|
44433
47827
|
/**
|
|
@@ -44439,6 +47833,46 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
44439
47833
|
*/
|
|
44440
47834
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest;
|
|
44441
47835
|
}
|
|
47836
|
+
export interface Params$Resource$Projects$Locations$Userstores$Create extends StandardParameters {
|
|
47837
|
+
/**
|
|
47838
|
+
* Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
47839
|
+
*/
|
|
47840
|
+
parent?: string;
|
|
47841
|
+
/**
|
|
47842
|
+
* Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
47843
|
+
*/
|
|
47844
|
+
userStoreId?: string;
|
|
47845
|
+
/**
|
|
47846
|
+
* Request body metadata
|
|
47847
|
+
*/
|
|
47848
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserStore;
|
|
47849
|
+
}
|
|
47850
|
+
export interface Params$Resource$Projects$Locations$Userstores$Delete extends StandardParameters {
|
|
47851
|
+
/**
|
|
47852
|
+
* Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
47853
|
+
*/
|
|
47854
|
+
name?: string;
|
|
47855
|
+
}
|
|
47856
|
+
export interface Params$Resource$Projects$Locations$Userstores$Get extends StandardParameters {
|
|
47857
|
+
/**
|
|
47858
|
+
* Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
47859
|
+
*/
|
|
47860
|
+
name?: string;
|
|
47861
|
+
}
|
|
47862
|
+
export interface Params$Resource$Projects$Locations$Userstores$Patch extends StandardParameters {
|
|
47863
|
+
/**
|
|
47864
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
47865
|
+
*/
|
|
47866
|
+
name?: string;
|
|
47867
|
+
/**
|
|
47868
|
+
* Optional. The list of fields to update.
|
|
47869
|
+
*/
|
|
47870
|
+
updateMask?: string;
|
|
47871
|
+
/**
|
|
47872
|
+
* Request body metadata
|
|
47873
|
+
*/
|
|
47874
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserStore;
|
|
47875
|
+
}
|
|
44442
47876
|
export class Resource$Projects$Locations$Userstores$Operations {
|
|
44443
47877
|
context: APIRequestContext;
|
|
44444
47878
|
constructor(context: APIRequestContext);
|