@googleapis/discoveryengine 37.1.0 → 37.2.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@googleapis/discoveryengine",
3
- "version": "37.1.0",
3
+ "version": "37.2.0",
4
4
  "description": "discoveryengine",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
@@ -0,0 +1,10 @@
1
+ {
2
+ "extends": "../../../tsconfig.base.json",
3
+ "compilerOptions": {
4
+ "rootDir": ".",
5
+ "outDir": "../../../build/src/apis/discoveryengine"
6
+ },
7
+ "include": [
8
+ "*.ts"
9
+ ]
10
+ }
package/v1.ts CHANGED
@@ -2291,6 +2291,10 @@ export namespace discoveryengine_v1 {
2291
2291
  * Reasons for not answering the assist call.
2292
2292
  */
2293
2293
  assistSkippedReasons?: string[] | null;
2294
+ /**
2295
+ * 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.
2296
+ */
2297
+ connectorDisplayNames?: {[key: string]: string} | null;
2294
2298
  /**
2295
2299
  * 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.
2296
2300
  */
@@ -3363,7 +3367,7 @@ export namespace discoveryengine_v1 {
3363
3367
  */
3364
3368
  syncMode?: string | null;
3365
3369
  /**
3366
- * 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.
3370
+ * 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.
3367
3371
  */
3368
3372
  tag?: string | null;
3369
3373
  /**
@@ -4978,6 +4982,10 @@ export namespace discoveryengine_v1 {
4978
4982
  * Optional. Whether the license config should be auto renewed when it reaches the end date.
4979
4983
  */
4980
4984
  autoRenew?: boolean | null;
4985
+ /**
4986
+ * Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
4987
+ */
4988
+ billingAccountLicenseConfig?: string | null;
4981
4989
  /**
4982
4990
  * 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.
4983
4991
  */
@@ -7930,6 +7938,10 @@ export namespace discoveryengine_v1 {
7930
7938
  * Reasons for not answering the assist call.
7931
7939
  */
7932
7940
  assistSkippedReasons?: string[] | null;
7941
+ /**
7942
+ * 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.
7943
+ */
7944
+ connectorDisplayNames?: {[key: string]: string} | null;
7933
7945
  /**
7934
7946
  * 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.
7935
7947
  */
@@ -12122,7 +12134,7 @@ export namespace discoveryengine_v1 {
12122
12134
  */
12123
12135
  selectedPosition?: number | null;
12124
12136
  /**
12125
- * End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
12137
+ * Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
12126
12138
  */
12127
12139
  selectedSuggestion?: string | null;
12128
12140
  }
@@ -12780,7 +12792,7 @@ export namespace discoveryengine_v1 {
12780
12792
  */
12781
12793
  syncMode?: string | null;
12782
12794
  /**
12783
- * 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.
12795
+ * 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.
12784
12796
  */
12785
12797
  tag?: string | null;
12786
12798
  /**
@@ -15661,7 +15673,7 @@ export namespace discoveryengine_v1 {
15661
15673
  */
15662
15674
  orderBy?: string | null;
15663
15675
  /**
15664
- * 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.
15676
+ * 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.
15665
15677
  */
15666
15678
  searchQuery?: string | null;
15667
15679
  }
@@ -17528,7 +17540,7 @@ export namespace discoveryengine_v1 {
17528
17540
  */
17529
17541
  export interface Schema$GoogleCloudDiscoveryengineV1UserEvent {
17530
17542
  /**
17531
- * 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.
17543
+ * 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.
17532
17544
  */
17533
17545
  attributes?: {
17534
17546
  [key: string]: Schema$GoogleCloudDiscoveryengineV1CustomAttribute;
@@ -17994,6 +18006,10 @@ export namespace discoveryengine_v1 {
17994
18006
  * 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.
17995
18007
  */
17996
18008
  name?: string | null;
18009
+ /**
18010
+ * 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.
18011
+ */
18012
+ tag?: string | null;
17997
18013
  }
17998
18014
  /**
17999
18015
  * Read-only connector in CollectionComponent auth state.
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.
@@ -7308,6 +7320,10 @@ export namespace discoveryengine_v1alpha {
7308
7320
  * Optional. Whether the license config should be auto renewed when it reaches the end date.
7309
7321
  */
7310
7322
  autoRenew?: boolean | null;
7323
+ /**
7324
+ * Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
7325
+ */
7326
+ billingAccountLicenseConfig?: string | null;
7311
7327
  /**
7312
7328
  * 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
7329
  */
@@ -9382,7 +9398,7 @@ export namespace discoveryengine_v1alpha {
9382
9398
  */
9383
9399
  orderBy?: string | null;
9384
9400
  /**
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.
9401
+ * 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
9402
  */
9387
9403
  searchQuery?: string | null;
9388
9404
  }
@@ -11629,7 +11645,7 @@ export namespace discoveryengine_v1alpha {
11629
11645
  */
11630
11646
  export interface Schema$GoogleCloudDiscoveryengineV1alphaUserEvent {
11631
11647
  /**
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.
11648
+ * 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
11649
  */
11634
11650
  attributes?: {
11635
11651
  [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaCustomAttribute;
@@ -12132,6 +12148,10 @@ export namespace discoveryengine_v1alpha {
12132
12148
  * 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
12149
  */
12134
12150
  name?: string | null;
12151
+ /**
12152
+ * 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.
12153
+ */
12154
+ tag?: string | null;
12135
12155
  }
12136
12156
  /**
12137
12157
  * Read-only connector in CollectionComponent auth state.
@@ -16456,7 +16476,7 @@ export namespace discoveryengine_v1alpha {
16456
16476
  */
16457
16477
  syncMode?: string | null;
16458
16478
  /**
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.
16479
+ * 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
16480
  */
16461
16481
  tag?: string | null;
16462
16482
  /**
@@ -46946,6 +46966,7 @@ export namespace discoveryengine_v1alpha {
46946
46966
  context: APIRequestContext;
46947
46967
  analytics: Resource$Projects$Locations$Collections$Engines$Analytics;
46948
46968
  assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
46969
+ collaborativeProjects: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
46949
46970
  completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
46950
46971
  controls: Resource$Projects$Locations$Collections$Engines$Controls;
46951
46972
  conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
@@ -46963,6 +46984,10 @@ export namespace discoveryengine_v1alpha {
46963
46984
  new Resource$Projects$Locations$Collections$Engines$Assistants(
46964
46985
  this.context
46965
46986
  );
46987
+ this.collaborativeProjects =
46988
+ new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects(
46989
+ this.context
46990
+ );
46966
46991
  this.completionConfig =
46967
46992
  new Resource$Projects$Locations$Collections$Engines$Completionconfig(
46968
46993
  this.context
@@ -49419,7 +49444,8 @@ export namespace discoveryengine_v1alpha {
49419
49444
  * requestBody: {
49420
49445
  * // request body parameters
49421
49446
  * // {
49422
- * // "outputConfig": {}
49447
+ * // "outputConfig": {},
49448
+ * // "startDate": {}
49423
49449
  * // }
49424
49450
  * },
49425
49451
  * },
@@ -53217,6 +53243,194 @@ export namespace discoveryengine_v1alpha {
53217
53243
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
53218
53244
  }
53219
53245
 
53246
+ export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
53247
+ context: APIRequestContext;
53248
+ knowledgeSpaces: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
53249
+ constructor(context: APIRequestContext) {
53250
+ this.context = context;
53251
+ this.knowledgeSpaces =
53252
+ new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces(
53253
+ this.context
53254
+ );
53255
+ }
53256
+ }
53257
+
53258
+ export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
53259
+ context: APIRequestContext;
53260
+ operations: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
53261
+ constructor(context: APIRequestContext) {
53262
+ this.context = context;
53263
+ this.operations =
53264
+ new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations(
53265
+ this.context
53266
+ );
53267
+ }
53268
+ }
53269
+
53270
+ export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
53271
+ context: APIRequestContext;
53272
+ constructor(context: APIRequestContext) {
53273
+ this.context = context;
53274
+ }
53275
+
53276
+ /**
53277
+ * 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.
53278
+ * @example
53279
+ * ```js
53280
+ * // Before running the sample:
53281
+ * // - Enable the API at:
53282
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
53283
+ * // - Login into gcloud by running:
53284
+ * // ```sh
53285
+ * // $ gcloud auth application-default login
53286
+ * // ```
53287
+ * // - Install the npm module by running:
53288
+ * // ```sh
53289
+ * // $ npm install googleapis
53290
+ * // ```
53291
+ *
53292
+ * const {google} = require('googleapis');
53293
+ * const discoveryengine = google.discoveryengine('v1alpha');
53294
+ *
53295
+ * async function main() {
53296
+ * const auth = new google.auth.GoogleAuth({
53297
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
53298
+ * scopes: [
53299
+ * 'https://www.googleapis.com/auth/cloud-platform',
53300
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
53301
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
53302
+ * ],
53303
+ * });
53304
+ *
53305
+ * // Acquire an auth client, and bind it to all future calls
53306
+ * const authClient = await auth.getClient();
53307
+ * google.options({auth: authClient});
53308
+ *
53309
+ * // Do the magic
53310
+ * const res =
53311
+ * await discoveryengine.projects.locations.collections.engines.collaborativeProjects.knowledgeSpaces.operations.get(
53312
+ * {
53313
+ * // The name of the operation resource.
53314
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/collaborativeProjects/my-collaborativeProject/knowledgeSpaces/my-knowledgeSpace/operations/my-operation',
53315
+ * },
53316
+ * );
53317
+ * console.log(res.data);
53318
+ *
53319
+ * // Example response
53320
+ * // {
53321
+ * // "done": false,
53322
+ * // "error": {},
53323
+ * // "metadata": {},
53324
+ * // "name": "my_name",
53325
+ * // "response": {}
53326
+ * // }
53327
+ * }
53328
+ *
53329
+ * main().catch(e => {
53330
+ * console.error(e);
53331
+ * throw e;
53332
+ * });
53333
+ *
53334
+ * ```
53335
+ *
53336
+ * @param params - Parameters for request
53337
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
53338
+ * @param callback - Optional callback that handles the response.
53339
+ * @returns A promise if used with async/await, or void if used with a callback.
53340
+ */
53341
+ get(
53342
+ params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
53343
+ options: StreamMethodOptions
53344
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
53345
+ get(
53346
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
53347
+ options?: MethodOptions
53348
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
53349
+ get(
53350
+ params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
53351
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
53352
+ callback: BodyResponseCallback<Readable>
53353
+ ): void;
53354
+ get(
53355
+ params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
53356
+ options:
53357
+ MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
53358
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
53359
+ ): void;
53360
+ get(
53361
+ params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get,
53362
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
53363
+ ): void;
53364
+ get(
53365
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
53366
+ ): void;
53367
+ get(
53368
+ paramsOrCallback?:
53369
+ | Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get
53370
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
53371
+ | BodyResponseCallback<Readable>,
53372
+ optionsOrCallback?:
53373
+ | MethodOptions
53374
+ | StreamMethodOptions
53375
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
53376
+ | BodyResponseCallback<Readable>,
53377
+ callback?:
53378
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
53379
+ | BodyResponseCallback<Readable>
53380
+ ):
53381
+ | void
53382
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
53383
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
53384
+ let params = (paramsOrCallback ||
53385
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get;
53386
+ let options = (optionsOrCallback || {}) as MethodOptions;
53387
+
53388
+ if (typeof paramsOrCallback === 'function') {
53389
+ callback = paramsOrCallback;
53390
+ params =
53391
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get;
53392
+ options = {};
53393
+ }
53394
+
53395
+ if (typeof optionsOrCallback === 'function') {
53396
+ callback = optionsOrCallback;
53397
+ options = {};
53398
+ }
53399
+
53400
+ const rootUrl =
53401
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
53402
+ const parameters = {
53403
+ options: Object.assign(
53404
+ {
53405
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
53406
+ method: 'GET',
53407
+ apiVersion: '',
53408
+ },
53409
+ options
53410
+ ),
53411
+ params,
53412
+ requiredParams: ['name'],
53413
+ pathParams: ['name'],
53414
+ context: this.context,
53415
+ };
53416
+ if (callback) {
53417
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
53418
+ parameters,
53419
+ callback as BodyResponseCallback<unknown>
53420
+ );
53421
+ } else {
53422
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
53423
+ }
53424
+ }
53425
+ }
53426
+
53427
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get extends StandardParameters {
53428
+ /**
53429
+ * The name of the operation resource.
53430
+ */
53431
+ name?: string;
53432
+ }
53433
+
53220
53434
  export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
53221
53435
  context: APIRequestContext;
53222
53436
  constructor(context: APIRequestContext) {
@@ -81737,6 +81951,7 @@ export namespace discoveryengine_v1alpha {
81737
81951
  * // {
81738
81952
  * // "alertPolicyResourceConfig": {},
81739
81953
  * // "autoRenew": false,
81954
+ * // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
81740
81955
  * // "earlyTerminated": false,
81741
81956
  * // "earlyTerminationDate": {},
81742
81957
  * // "endDate": {},
@@ -81758,6 +81973,7 @@ export namespace discoveryengine_v1alpha {
81758
81973
  * // {
81759
81974
  * // "alertPolicyResourceConfig": {},
81760
81975
  * // "autoRenew": false,
81976
+ * // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
81761
81977
  * // "earlyTerminated": false,
81762
81978
  * // "earlyTerminationDate": {},
81763
81979
  * // "endDate": {},
@@ -81923,6 +82139,7 @@ export namespace discoveryengine_v1alpha {
81923
82139
  * // {
81924
82140
  * // "alertPolicyResourceConfig": {},
81925
82141
  * // "autoRenew": false,
82142
+ * // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
81926
82143
  * // "earlyTerminated": false,
81927
82144
  * // "earlyTerminationDate": {},
81928
82145
  * // "endDate": {},
@@ -82246,6 +82463,7 @@ export namespace discoveryengine_v1alpha {
82246
82463
  * // {
82247
82464
  * // "alertPolicyResourceConfig": {},
82248
82465
  * // "autoRenew": false,
82466
+ * // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
82249
82467
  * // "earlyTerminated": false,
82250
82468
  * // "earlyTerminationDate": {},
82251
82469
  * // "endDate": {},
@@ -82267,6 +82485,7 @@ export namespace discoveryengine_v1alpha {
82267
82485
  * // {
82268
82486
  * // "alertPolicyResourceConfig": {},
82269
82487
  * // "autoRenew": false,
82488
+ * // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
82270
82489
  * // "earlyTerminated": false,
82271
82490
  * // "earlyTerminationDate": {},
82272
82491
  * // "endDate": {},
package/v1beta.ts CHANGED
@@ -1420,6 +1420,10 @@ export namespace discoveryengine_v1beta {
1420
1420
  * Reasons for not answering the assist call.
1421
1421
  */
1422
1422
  assistSkippedReasons?: string[] | null;
1423
+ /**
1424
+ * 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.
1425
+ */
1426
+ connectorDisplayNames?: {[key: string]: string} | null;
1423
1427
  /**
1424
1428
  * 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.
1425
1429
  */
@@ -2492,7 +2496,7 @@ export namespace discoveryengine_v1beta {
2492
2496
  */
2493
2497
  syncMode?: string | null;
2494
2498
  /**
2495
- * 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.
2499
+ * 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.
2496
2500
  */
2497
2501
  tag?: string | null;
2498
2502
  /**
@@ -4107,6 +4111,10 @@ export namespace discoveryengine_v1beta {
4107
4111
  * Optional. Whether the license config should be auto renewed when it reaches the end date.
4108
4112
  */
4109
4113
  autoRenew?: boolean | null;
4114
+ /**
4115
+ * Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
4116
+ */
4117
+ billingAccountLicenseConfig?: string | null;
4110
4118
  /**
4111
4119
  * 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.
4112
4120
  */
@@ -7674,6 +7682,10 @@ export namespace discoveryengine_v1beta {
7674
7682
  * Reasons for not answering the assist call.
7675
7683
  */
7676
7684
  assistSkippedReasons?: string[] | null;
7685
+ /**
7686
+ * 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.
7687
+ */
7688
+ connectorDisplayNames?: {[key: string]: string} | null;
7677
7689
  /**
7678
7690
  * 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.
7679
7691
  */
@@ -8724,7 +8736,7 @@ export namespace discoveryengine_v1beta {
8724
8736
  */
8725
8737
  selectedPosition?: number | null;
8726
8738
  /**
8727
- * End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
8739
+ * Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
8728
8740
  */
8729
8741
  selectedSuggestion?: string | null;
8730
8742
  }
@@ -12342,7 +12354,7 @@ export namespace discoveryengine_v1beta {
12342
12354
  */
12343
12355
  orderBy?: string | null;
12344
12356
  /**
12345
- * 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.
12357
+ * 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.
12346
12358
  */
12347
12359
  searchQuery?: string | null;
12348
12360
  }
@@ -14389,7 +14401,7 @@ export namespace discoveryengine_v1beta {
14389
14401
  */
14390
14402
  export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent {
14391
14403
  /**
14392
- * 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.
14404
+ * 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.
14393
14405
  */
14394
14406
  attributes?: {
14395
14407
  [key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute;
@@ -15108,7 +15120,7 @@ export namespace discoveryengine_v1beta {
15108
15120
  */
15109
15121
  syncMode?: string | null;
15110
15122
  /**
15111
- * 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.
15123
+ * 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.
15112
15124
  */
15113
15125
  tag?: string | null;
15114
15126
  /**