@googleapis/discoveryengine 37.1.0 → 37.3.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 +14 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +33 -5
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +221 -6
- package/build/v1alpha.js +116 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +25 -5
- package/build/v1beta.js.map +1 -1
- package/package.json +2 -2
- package/tsconfig.build.json +10 -0
- package/v1.ts +29 -5
- package/v1alpha.ts +414 -6
- package/v1beta.ts +21 -5
package/v1alpha.ts
CHANGED
|
@@ -2403,6 +2403,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2403
2403
|
* Reasons for not answering the assist call.
|
|
2404
2404
|
*/
|
|
2405
2405
|
assistSkippedReasons?: string[] | null;
|
|
2406
|
+
/**
|
|
2407
|
+
* Output only. Maps an internal connector agent name (the machine identifier embedded in tool names, e.g. `custom_mcp__agent`) to the connector's human-readable display name. Populated at serving time for custom MCP / agent gateway connectors so user-facing surfaces (e.g. the tool-call chip) can show the connector name instead of its internal identifier. Empty when there are no such connectors.
|
|
2408
|
+
*/
|
|
2409
|
+
connectorDisplayNames?: {[key: string]: string} | null;
|
|
2406
2410
|
/**
|
|
2407
2411
|
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
2408
2412
|
*/
|
|
@@ -2902,6 +2906,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2902
2906
|
* 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.
|
|
2903
2907
|
*/
|
|
2904
2908
|
authorizationUri?: string | null;
|
|
2909
|
+
/**
|
|
2910
|
+
* Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used.
|
|
2911
|
+
*/
|
|
2912
|
+
basicAuthenticationEnabled?: boolean | null;
|
|
2905
2913
|
/**
|
|
2906
2914
|
* Required. The OAuth2 client ID.
|
|
2907
2915
|
*/
|
|
@@ -3894,7 +3902,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
3894
3902
|
*/
|
|
3895
3903
|
selectedPosition?: number | null;
|
|
3896
3904
|
/**
|
|
3897
|
-
* End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
3905
|
+
* Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
3898
3906
|
*/
|
|
3899
3907
|
selectedSuggestion?: string | null;
|
|
3900
3908
|
}
|
|
@@ -4702,7 +4710,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
4702
4710
|
*/
|
|
4703
4711
|
syncMode?: string | null;
|
|
4704
4712
|
/**
|
|
4705
|
-
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
4713
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
4706
4714
|
*/
|
|
4707
4715
|
tag?: string | null;
|
|
4708
4716
|
/**
|
|
@@ -6174,6 +6182,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
6174
6182
|
* Required. The output location of the data.
|
|
6175
6183
|
*/
|
|
6176
6184
|
outputConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOutputConfig;
|
|
6185
|
+
/**
|
|
6186
|
+
* Optional. The earliest date (inclusive), interpreted in the UTC time zone, whose metrics are included in the export. If unset, defaults to 30 days before the current UTC date. The value must be a valid calendar date that is not in the future and not older than 180 days (the source data retention window); otherwise the request fails with `INVALID_ARGUMENT`.
|
|
6187
|
+
*/
|
|
6188
|
+
startDate?: Schema$GoogleTypeDate;
|
|
6177
6189
|
}
|
|
6178
6190
|
/**
|
|
6179
6191
|
* Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.
|
|
@@ -6332,6 +6344,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
6332
6344
|
* Name of the newly generated or continued session.
|
|
6333
6345
|
*/
|
|
6334
6346
|
session?: string | null;
|
|
6347
|
+
/**
|
|
6348
|
+
* Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project\}/locations/{location\}/tasks/{task_id\}
|
|
6349
|
+
*/
|
|
6350
|
+
taskName?: string | null;
|
|
6335
6351
|
}
|
|
6336
6352
|
/**
|
|
6337
6353
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
@@ -7308,6 +7324,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
7308
7324
|
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
7309
7325
|
*/
|
|
7310
7326
|
autoRenew?: boolean | null;
|
|
7327
|
+
/**
|
|
7328
|
+
* Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
|
|
7329
|
+
*/
|
|
7330
|
+
billingAccountLicenseConfig?: string | null;
|
|
7311
7331
|
/**
|
|
7312
7332
|
* Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
|
|
7313
7333
|
*/
|
|
@@ -9382,7 +9402,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
9382
9402
|
*/
|
|
9383
9403
|
orderBy?: string | null;
|
|
9384
9404
|
/**
|
|
9385
|
-
* The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
9405
|
+
* Optional. The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
9386
9406
|
*/
|
|
9387
9407
|
searchQuery?: string | null;
|
|
9388
9408
|
}
|
|
@@ -11629,7 +11649,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11629
11649
|
*/
|
|
11630
11650
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserEvent {
|
|
11631
11651
|
/**
|
|
11632
|
-
* Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
11652
|
+
* Optional. Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
11633
11653
|
*/
|
|
11634
11654
|
attributes?: {
|
|
11635
11655
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaCustomAttribute;
|
|
@@ -12132,6 +12152,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
12132
12152
|
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.
|
|
12133
12153
|
*/
|
|
12134
12154
|
name?: string | null;
|
|
12155
|
+
/**
|
|
12156
|
+
* Output only. The version-independent label of the connector backing this collection, mirroring `DataConnector.tag`. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As `DataConnector.tag` documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying `DataConnector`. Populated only when `ConnectorsFeature.enable_connector_tag` is on.
|
|
12157
|
+
*/
|
|
12158
|
+
tag?: string | null;
|
|
12135
12159
|
}
|
|
12136
12160
|
/**
|
|
12137
12161
|
* Read-only connector in CollectionComponent auth state.
|
|
@@ -12458,6 +12482,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
12458
12482
|
* The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.
|
|
12459
12483
|
*/
|
|
12460
12484
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
12485
|
+
/**
|
|
12486
|
+
* Output only. The `model_id` a client must send when the end-user picks the "Auto" entry (the empty `model_id`). Populated only for surfaces known to have no true "Auto" mode, where leaving the model unset would fall back to a platform default rather than a backend-chosen model. Empty on every other surface, where "Auto" is resolved server-side, and when none of the surface's ranked models is available. When set, it is always one of the non-empty `model_id`s present in `resolved_models`.
|
|
12487
|
+
*/
|
|
12488
|
+
autoModelId?: string | null;
|
|
12461
12489
|
/**
|
|
12462
12490
|
* Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`.
|
|
12463
12491
|
*/
|
|
@@ -16456,7 +16484,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
16456
16484
|
*/
|
|
16457
16485
|
syncMode?: string | null;
|
|
16458
16486
|
/**
|
|
16459
|
-
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
16487
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
16460
16488
|
*/
|
|
16461
16489
|
tag?: string | null;
|
|
16462
16490
|
/**
|
|
@@ -46946,6 +46974,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
46946
46974
|
context: APIRequestContext;
|
|
46947
46975
|
analytics: Resource$Projects$Locations$Collections$Engines$Analytics;
|
|
46948
46976
|
assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
|
|
46977
|
+
collaborativeProjects: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
|
|
46949
46978
|
completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
|
|
46950
46979
|
controls: Resource$Projects$Locations$Collections$Engines$Controls;
|
|
46951
46980
|
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
@@ -46963,6 +46992,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
46963
46992
|
new Resource$Projects$Locations$Collections$Engines$Assistants(
|
|
46964
46993
|
this.context
|
|
46965
46994
|
);
|
|
46995
|
+
this.collaborativeProjects =
|
|
46996
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects(
|
|
46997
|
+
this.context
|
|
46998
|
+
);
|
|
46966
46999
|
this.completionConfig =
|
|
46967
47000
|
new Resource$Projects$Locations$Collections$Engines$Completionconfig(
|
|
46968
47001
|
this.context
|
|
@@ -49419,7 +49452,8 @@ export namespace discoveryengine_v1alpha {
|
|
|
49419
49452
|
* requestBody: {
|
|
49420
49453
|
* // request body parameters
|
|
49421
49454
|
* // {
|
|
49422
|
-
* // "outputConfig": {}
|
|
49455
|
+
* // "outputConfig": {},
|
|
49456
|
+
* // "startDate": {}
|
|
49423
49457
|
* // }
|
|
49424
49458
|
* },
|
|
49425
49459
|
* },
|
|
@@ -51000,6 +51034,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
51000
51034
|
context: APIRequestContext;
|
|
51001
51035
|
files: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files;
|
|
51002
51036
|
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
51037
|
+
toolCalls: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls;
|
|
51003
51038
|
constructor(context: APIRequestContext) {
|
|
51004
51039
|
this.context = context;
|
|
51005
51040
|
this.files =
|
|
@@ -51010,6 +51045,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
51010
51045
|
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations(
|
|
51011
51046
|
this.context
|
|
51012
51047
|
);
|
|
51048
|
+
this.toolCalls =
|
|
51049
|
+
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls(
|
|
51050
|
+
this.context
|
|
51051
|
+
);
|
|
51013
51052
|
}
|
|
51014
51053
|
|
|
51015
51054
|
/**
|
|
@@ -52326,6 +52365,182 @@ export namespace discoveryengine_v1alpha {
|
|
|
52326
52365
|
name?: string;
|
|
52327
52366
|
}
|
|
52328
52367
|
|
|
52368
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls {
|
|
52369
|
+
context: APIRequestContext;
|
|
52370
|
+
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations;
|
|
52371
|
+
constructor(context: APIRequestContext) {
|
|
52372
|
+
this.context = context;
|
|
52373
|
+
this.operations =
|
|
52374
|
+
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations(
|
|
52375
|
+
this.context
|
|
52376
|
+
);
|
|
52377
|
+
}
|
|
52378
|
+
}
|
|
52379
|
+
|
|
52380
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations {
|
|
52381
|
+
context: APIRequestContext;
|
|
52382
|
+
constructor(context: APIRequestContext) {
|
|
52383
|
+
this.context = context;
|
|
52384
|
+
}
|
|
52385
|
+
|
|
52386
|
+
/**
|
|
52387
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
52388
|
+
* @example
|
|
52389
|
+
* ```js
|
|
52390
|
+
* // Before running the sample:
|
|
52391
|
+
* // - Enable the API at:
|
|
52392
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
52393
|
+
* // - Login into gcloud by running:
|
|
52394
|
+
* // ```sh
|
|
52395
|
+
* // $ gcloud auth application-default login
|
|
52396
|
+
* // ```
|
|
52397
|
+
* // - Install the npm module by running:
|
|
52398
|
+
* // ```sh
|
|
52399
|
+
* // $ npm install googleapis
|
|
52400
|
+
* // ```
|
|
52401
|
+
*
|
|
52402
|
+
* const {google} = require('googleapis');
|
|
52403
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
52404
|
+
*
|
|
52405
|
+
* async function main() {
|
|
52406
|
+
* const auth = new google.auth.GoogleAuth({
|
|
52407
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
52408
|
+
* scopes: [
|
|
52409
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
52410
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
52411
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
52412
|
+
* ],
|
|
52413
|
+
* });
|
|
52414
|
+
*
|
|
52415
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
52416
|
+
* const authClient = await auth.getClient();
|
|
52417
|
+
* google.options({auth: authClient});
|
|
52418
|
+
*
|
|
52419
|
+
* // Do the magic
|
|
52420
|
+
* const res =
|
|
52421
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.toolCalls.operations.get(
|
|
52422
|
+
* {
|
|
52423
|
+
* // The name of the operation resource.
|
|
52424
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent/toolCalls/my-toolCall/operations/my-operation',
|
|
52425
|
+
* },
|
|
52426
|
+
* );
|
|
52427
|
+
* console.log(res.data);
|
|
52428
|
+
*
|
|
52429
|
+
* // Example response
|
|
52430
|
+
* // {
|
|
52431
|
+
* // "done": false,
|
|
52432
|
+
* // "error": {},
|
|
52433
|
+
* // "metadata": {},
|
|
52434
|
+
* // "name": "my_name",
|
|
52435
|
+
* // "response": {}
|
|
52436
|
+
* // }
|
|
52437
|
+
* }
|
|
52438
|
+
*
|
|
52439
|
+
* main().catch(e => {
|
|
52440
|
+
* console.error(e);
|
|
52441
|
+
* throw e;
|
|
52442
|
+
* });
|
|
52443
|
+
*
|
|
52444
|
+
* ```
|
|
52445
|
+
*
|
|
52446
|
+
* @param params - Parameters for request
|
|
52447
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
52448
|
+
* @param callback - Optional callback that handles the response.
|
|
52449
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
52450
|
+
*/
|
|
52451
|
+
get(
|
|
52452
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get,
|
|
52453
|
+
options: StreamMethodOptions
|
|
52454
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
52455
|
+
get(
|
|
52456
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get,
|
|
52457
|
+
options?: MethodOptions
|
|
52458
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
52459
|
+
get(
|
|
52460
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get,
|
|
52461
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
52462
|
+
callback: BodyResponseCallback<Readable>
|
|
52463
|
+
): void;
|
|
52464
|
+
get(
|
|
52465
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get,
|
|
52466
|
+
options:
|
|
52467
|
+
MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
52468
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52469
|
+
): void;
|
|
52470
|
+
get(
|
|
52471
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get,
|
|
52472
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52473
|
+
): void;
|
|
52474
|
+
get(
|
|
52475
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52476
|
+
): void;
|
|
52477
|
+
get(
|
|
52478
|
+
paramsOrCallback?:
|
|
52479
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get
|
|
52480
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52481
|
+
| BodyResponseCallback<Readable>,
|
|
52482
|
+
optionsOrCallback?:
|
|
52483
|
+
| MethodOptions
|
|
52484
|
+
| StreamMethodOptions
|
|
52485
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52486
|
+
| BodyResponseCallback<Readable>,
|
|
52487
|
+
callback?:
|
|
52488
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
52489
|
+
| BodyResponseCallback<Readable>
|
|
52490
|
+
):
|
|
52491
|
+
| void
|
|
52492
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
52493
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
52494
|
+
let params = (paramsOrCallback ||
|
|
52495
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get;
|
|
52496
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
52497
|
+
|
|
52498
|
+
if (typeof paramsOrCallback === 'function') {
|
|
52499
|
+
callback = paramsOrCallback;
|
|
52500
|
+
params =
|
|
52501
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get;
|
|
52502
|
+
options = {};
|
|
52503
|
+
}
|
|
52504
|
+
|
|
52505
|
+
if (typeof optionsOrCallback === 'function') {
|
|
52506
|
+
callback = optionsOrCallback;
|
|
52507
|
+
options = {};
|
|
52508
|
+
}
|
|
52509
|
+
|
|
52510
|
+
const rootUrl =
|
|
52511
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
52512
|
+
const parameters = {
|
|
52513
|
+
options: Object.assign(
|
|
52514
|
+
{
|
|
52515
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
52516
|
+
method: 'GET',
|
|
52517
|
+
apiVersion: '',
|
|
52518
|
+
},
|
|
52519
|
+
options
|
|
52520
|
+
),
|
|
52521
|
+
params,
|
|
52522
|
+
requiredParams: ['name'],
|
|
52523
|
+
pathParams: ['name'],
|
|
52524
|
+
context: this.context,
|
|
52525
|
+
};
|
|
52526
|
+
if (callback) {
|
|
52527
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
52528
|
+
parameters,
|
|
52529
|
+
callback as BodyResponseCallback<unknown>
|
|
52530
|
+
);
|
|
52531
|
+
} else {
|
|
52532
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
52533
|
+
}
|
|
52534
|
+
}
|
|
52535
|
+
}
|
|
52536
|
+
|
|
52537
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get extends StandardParameters {
|
|
52538
|
+
/**
|
|
52539
|
+
* The name of the operation resource.
|
|
52540
|
+
*/
|
|
52541
|
+
name?: string;
|
|
52542
|
+
}
|
|
52543
|
+
|
|
52329
52544
|
export class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries {
|
|
52330
52545
|
context: APIRequestContext;
|
|
52331
52546
|
constructor(context: APIRequestContext) {
|
|
@@ -53217,6 +53432,194 @@ export namespace discoveryengine_v1alpha {
|
|
|
53217
53432
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
|
|
53218
53433
|
}
|
|
53219
53434
|
|
|
53435
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
|
|
53436
|
+
context: APIRequestContext;
|
|
53437
|
+
knowledgeSpaces: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
|
|
53438
|
+
constructor(context: APIRequestContext) {
|
|
53439
|
+
this.context = context;
|
|
53440
|
+
this.knowledgeSpaces =
|
|
53441
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces(
|
|
53442
|
+
this.context
|
|
53443
|
+
);
|
|
53444
|
+
}
|
|
53445
|
+
}
|
|
53446
|
+
|
|
53447
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
|
|
53448
|
+
context: APIRequestContext;
|
|
53449
|
+
operations: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
|
|
53450
|
+
constructor(context: APIRequestContext) {
|
|
53451
|
+
this.context = context;
|
|
53452
|
+
this.operations =
|
|
53453
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations(
|
|
53454
|
+
this.context
|
|
53455
|
+
);
|
|
53456
|
+
}
|
|
53457
|
+
}
|
|
53458
|
+
|
|
53459
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
|
|
53460
|
+
context: APIRequestContext;
|
|
53461
|
+
constructor(context: APIRequestContext) {
|
|
53462
|
+
this.context = context;
|
|
53463
|
+
}
|
|
53464
|
+
|
|
53465
|
+
/**
|
|
53466
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
53467
|
+
* @example
|
|
53468
|
+
* ```js
|
|
53469
|
+
* // Before running the sample:
|
|
53470
|
+
* // - Enable the API at:
|
|
53471
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
53472
|
+
* // - Login into gcloud by running:
|
|
53473
|
+
* // ```sh
|
|
53474
|
+
* // $ gcloud auth application-default login
|
|
53475
|
+
* // ```
|
|
53476
|
+
* // - Install the npm module by running:
|
|
53477
|
+
* // ```sh
|
|
53478
|
+
* // $ npm install googleapis
|
|
53479
|
+
* // ```
|
|
53480
|
+
*
|
|
53481
|
+
* const {google} = require('googleapis');
|
|
53482
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
53483
|
+
*
|
|
53484
|
+
* async function main() {
|
|
53485
|
+
* const auth = new google.auth.GoogleAuth({
|
|
53486
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
53487
|
+
* scopes: [
|
|
53488
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
53489
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
53490
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
53491
|
+
* ],
|
|
53492
|
+
* });
|
|
53493
|
+
*
|
|
53494
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
53495
|
+
* const authClient = await auth.getClient();
|
|
53496
|
+
* google.options({auth: authClient});
|
|
53497
|
+
*
|
|
53498
|
+
* // Do the magic
|
|
53499
|
+
* const res =
|
|
53500
|
+
* await discoveryengine.projects.locations.collections.engines.collaborativeProjects.knowledgeSpaces.operations.get(
|
|
53501
|
+
* {
|
|
53502
|
+
* // The name of the operation resource.
|
|
53503
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/collaborativeProjects/my-collaborativeProject/knowledgeSpaces/my-knowledgeSpace/operations/my-operation',
|
|
53504
|
+
* },
|
|
53505
|
+
* );
|
|
53506
|
+
* console.log(res.data);
|
|
53507
|
+
*
|
|
53508
|
+
* // Example response
|
|
53509
|
+
* // {
|
|
53510
|
+
* // "done": false,
|
|
53511
|
+
* // "error": {},
|
|
53512
|
+
* // "metadata": {},
|
|
53513
|
+
* // "name": "my_name",
|
|
53514
|
+
* // "response": {}
|
|
53515
|
+
* // }
|
|
53516
|
+
* }
|
|
53517
|
+
*
|
|
53518
|
+
* main().catch(e => {
|
|
53519
|
+
* console.error(e);
|
|
53520
|
+
* throw e;
|
|
53521
|
+
* });
|
|
53522
|
+
*
|
|
53523
|
+
* ```
|
|
53524
|
+
*
|
|
53525
|
+
* @param params - Parameters for request
|
|
53526
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
53527
|
+
* @param callback - Optional callback that handles the response.
|
|
53528
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
53529
|
+
*/
|
|
53530
|
+
get(
|
|
53531
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
|
|
53532
|
+
options: StreamMethodOptions
|
|
53533
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
53534
|
+
get(
|
|
53535
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
|
|
53536
|
+
options?: MethodOptions
|
|
53537
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
53538
|
+
get(
|
|
53539
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
|
|
53540
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
53541
|
+
callback: BodyResponseCallback<Readable>
|
|
53542
|
+
): void;
|
|
53543
|
+
get(
|
|
53544
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
|
|
53545
|
+
options:
|
|
53546
|
+
MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
53547
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53548
|
+
): void;
|
|
53549
|
+
get(
|
|
53550
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
|
|
53551
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53552
|
+
): void;
|
|
53553
|
+
get(
|
|
53554
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53555
|
+
): void;
|
|
53556
|
+
get(
|
|
53557
|
+
paramsOrCallback?:
|
|
53558
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get
|
|
53559
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53560
|
+
| BodyResponseCallback<Readable>,
|
|
53561
|
+
optionsOrCallback?:
|
|
53562
|
+
| MethodOptions
|
|
53563
|
+
| StreamMethodOptions
|
|
53564
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53565
|
+
| BodyResponseCallback<Readable>,
|
|
53566
|
+
callback?:
|
|
53567
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
53568
|
+
| BodyResponseCallback<Readable>
|
|
53569
|
+
):
|
|
53570
|
+
| void
|
|
53571
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
53572
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
53573
|
+
let params = (paramsOrCallback ||
|
|
53574
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get;
|
|
53575
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
53576
|
+
|
|
53577
|
+
if (typeof paramsOrCallback === 'function') {
|
|
53578
|
+
callback = paramsOrCallback;
|
|
53579
|
+
params =
|
|
53580
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get;
|
|
53581
|
+
options = {};
|
|
53582
|
+
}
|
|
53583
|
+
|
|
53584
|
+
if (typeof optionsOrCallback === 'function') {
|
|
53585
|
+
callback = optionsOrCallback;
|
|
53586
|
+
options = {};
|
|
53587
|
+
}
|
|
53588
|
+
|
|
53589
|
+
const rootUrl =
|
|
53590
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
53591
|
+
const parameters = {
|
|
53592
|
+
options: Object.assign(
|
|
53593
|
+
{
|
|
53594
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
53595
|
+
method: 'GET',
|
|
53596
|
+
apiVersion: '',
|
|
53597
|
+
},
|
|
53598
|
+
options
|
|
53599
|
+
),
|
|
53600
|
+
params,
|
|
53601
|
+
requiredParams: ['name'],
|
|
53602
|
+
pathParams: ['name'],
|
|
53603
|
+
context: this.context,
|
|
53604
|
+
};
|
|
53605
|
+
if (callback) {
|
|
53606
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
53607
|
+
parameters,
|
|
53608
|
+
callback as BodyResponseCallback<unknown>
|
|
53609
|
+
);
|
|
53610
|
+
} else {
|
|
53611
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
53612
|
+
}
|
|
53613
|
+
}
|
|
53614
|
+
}
|
|
53615
|
+
|
|
53616
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get extends StandardParameters {
|
|
53617
|
+
/**
|
|
53618
|
+
* The name of the operation resource.
|
|
53619
|
+
*/
|
|
53620
|
+
name?: string;
|
|
53621
|
+
}
|
|
53622
|
+
|
|
53220
53623
|
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
53221
53624
|
context: APIRequestContext;
|
|
53222
53625
|
constructor(context: APIRequestContext) {
|
|
@@ -81737,6 +82140,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
81737
82140
|
* // {
|
|
81738
82141
|
* // "alertPolicyResourceConfig": {},
|
|
81739
82142
|
* // "autoRenew": false,
|
|
82143
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
81740
82144
|
* // "earlyTerminated": false,
|
|
81741
82145
|
* // "earlyTerminationDate": {},
|
|
81742
82146
|
* // "endDate": {},
|
|
@@ -81758,6 +82162,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
81758
82162
|
* // {
|
|
81759
82163
|
* // "alertPolicyResourceConfig": {},
|
|
81760
82164
|
* // "autoRenew": false,
|
|
82165
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
81761
82166
|
* // "earlyTerminated": false,
|
|
81762
82167
|
* // "earlyTerminationDate": {},
|
|
81763
82168
|
* // "endDate": {},
|
|
@@ -81923,6 +82328,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
81923
82328
|
* // {
|
|
81924
82329
|
* // "alertPolicyResourceConfig": {},
|
|
81925
82330
|
* // "autoRenew": false,
|
|
82331
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
81926
82332
|
* // "earlyTerminated": false,
|
|
81927
82333
|
* // "earlyTerminationDate": {},
|
|
81928
82334
|
* // "endDate": {},
|
|
@@ -82246,6 +82652,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
82246
82652
|
* // {
|
|
82247
82653
|
* // "alertPolicyResourceConfig": {},
|
|
82248
82654
|
* // "autoRenew": false,
|
|
82655
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
82249
82656
|
* // "earlyTerminated": false,
|
|
82250
82657
|
* // "earlyTerminationDate": {},
|
|
82251
82658
|
* // "endDate": {},
|
|
@@ -82267,6 +82674,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
82267
82674
|
* // {
|
|
82268
82675
|
* // "alertPolicyResourceConfig": {},
|
|
82269
82676
|
* // "autoRenew": false,
|
|
82677
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
82270
82678
|
* // "earlyTerminated": false,
|
|
82271
82679
|
* // "earlyTerminationDate": {},
|
|
82272
82680
|
* // "endDate": {},
|