@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/build/v1alpha.d.ts
CHANGED
|
@@ -2378,6 +2378,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2378
2378
|
* Reasons for not answering the assist call.
|
|
2379
2379
|
*/
|
|
2380
2380
|
assistSkippedReasons?: string[] | null;
|
|
2381
|
+
/**
|
|
2382
|
+
* 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.
|
|
2383
|
+
*/
|
|
2384
|
+
connectorDisplayNames?: {
|
|
2385
|
+
[key: string]: string;
|
|
2386
|
+
} | null;
|
|
2381
2387
|
/**
|
|
2382
2388
|
* 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.
|
|
2383
2389
|
*/
|
|
@@ -2879,6 +2885,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2879
2885
|
* 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.
|
|
2880
2886
|
*/
|
|
2881
2887
|
authorizationUri?: string | null;
|
|
2888
|
+
/**
|
|
2889
|
+
* 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.
|
|
2890
|
+
*/
|
|
2891
|
+
basicAuthenticationEnabled?: boolean | null;
|
|
2882
2892
|
/**
|
|
2883
2893
|
* Required. The OAuth2 client ID.
|
|
2884
2894
|
*/
|
|
@@ -3880,7 +3890,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3880
3890
|
*/
|
|
3881
3891
|
selectedPosition?: number | null;
|
|
3882
3892
|
/**
|
|
3883
|
-
* End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
3893
|
+
* Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
3884
3894
|
*/
|
|
3885
3895
|
selectedSuggestion?: string | null;
|
|
3886
3896
|
}
|
|
@@ -4695,7 +4705,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4695
4705
|
*/
|
|
4696
4706
|
syncMode?: string | null;
|
|
4697
4707
|
/**
|
|
4698
|
-
* 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.
|
|
4708
|
+
* 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.
|
|
4699
4709
|
*/
|
|
4700
4710
|
tag?: string | null;
|
|
4701
4711
|
/**
|
|
@@ -6195,6 +6205,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6195
6205
|
* Required. The output location of the data.
|
|
6196
6206
|
*/
|
|
6197
6207
|
outputConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOutputConfig;
|
|
6208
|
+
/**
|
|
6209
|
+
* 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`.
|
|
6210
|
+
*/
|
|
6211
|
+
startDate?: Schema$GoogleTypeDate;
|
|
6198
6212
|
}
|
|
6199
6213
|
/**
|
|
6200
6214
|
* Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.
|
|
@@ -6358,6 +6372,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6358
6372
|
* Name of the newly generated or continued session.
|
|
6359
6373
|
*/
|
|
6360
6374
|
session?: string | null;
|
|
6375
|
+
/**
|
|
6376
|
+
* 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\}
|
|
6377
|
+
*/
|
|
6378
|
+
taskName?: string | null;
|
|
6361
6379
|
}
|
|
6362
6380
|
/**
|
|
6363
6381
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
@@ -7346,6 +7364,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7346
7364
|
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
7347
7365
|
*/
|
|
7348
7366
|
autoRenew?: boolean | null;
|
|
7367
|
+
/**
|
|
7368
|
+
* Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
|
|
7369
|
+
*/
|
|
7370
|
+
billingAccountLicenseConfig?: string | null;
|
|
7349
7371
|
/**
|
|
7350
7372
|
* 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.
|
|
7351
7373
|
*/
|
|
@@ -9436,7 +9458,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9436
9458
|
*/
|
|
9437
9459
|
orderBy?: string | null;
|
|
9438
9460
|
/**
|
|
9439
|
-
* 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.
|
|
9461
|
+
* 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.
|
|
9440
9462
|
*/
|
|
9441
9463
|
searchQuery?: string | null;
|
|
9442
9464
|
}
|
|
@@ -11705,7 +11727,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11705
11727
|
*/
|
|
11706
11728
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserEvent {
|
|
11707
11729
|
/**
|
|
11708
|
-
* 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.
|
|
11730
|
+
* 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.
|
|
11709
11731
|
*/
|
|
11710
11732
|
attributes?: {
|
|
11711
11733
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaCustomAttribute;
|
|
@@ -12206,6 +12228,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12206
12228
|
* 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.
|
|
12207
12229
|
*/
|
|
12208
12230
|
name?: string | null;
|
|
12231
|
+
/**
|
|
12232
|
+
* 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.
|
|
12233
|
+
*/
|
|
12234
|
+
tag?: string | null;
|
|
12209
12235
|
}
|
|
12210
12236
|
/**
|
|
12211
12237
|
* Read-only connector in CollectionComponent auth state.
|
|
@@ -12538,6 +12564,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12538
12564
|
* 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.
|
|
12539
12565
|
*/
|
|
12540
12566
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
12567
|
+
/**
|
|
12568
|
+
* 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`.
|
|
12569
|
+
*/
|
|
12570
|
+
autoModelId?: string | null;
|
|
12541
12571
|
/**
|
|
12542
12572
|
* 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`.
|
|
12543
12573
|
*/
|
|
@@ -16558,7 +16588,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16558
16588
|
*/
|
|
16559
16589
|
syncMode?: string | null;
|
|
16560
16590
|
/**
|
|
16561
|
-
* 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.
|
|
16591
|
+
* 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.
|
|
16562
16592
|
*/
|
|
16563
16593
|
tag?: string | null;
|
|
16564
16594
|
/**
|
|
@@ -33965,6 +33995,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33965
33995
|
context: APIRequestContext;
|
|
33966
33996
|
analytics: Resource$Projects$Locations$Collections$Engines$Analytics;
|
|
33967
33997
|
assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
|
|
33998
|
+
collaborativeProjects: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
|
|
33968
33999
|
completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
|
|
33969
34000
|
controls: Resource$Projects$Locations$Collections$Engines$Controls;
|
|
33970
34001
|
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
@@ -35283,7 +35314,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
35283
35314
|
* requestBody: {
|
|
35284
35315
|
* // request body parameters
|
|
35285
35316
|
* // {
|
|
35286
|
-
* // "outputConfig": {}
|
|
35317
|
+
* // "outputConfig": {},
|
|
35318
|
+
* // "startDate": {}
|
|
35287
35319
|
* // }
|
|
35288
35320
|
* },
|
|
35289
35321
|
* },
|
|
@@ -36077,6 +36109,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36077
36109
|
context: APIRequestContext;
|
|
36078
36110
|
files: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files;
|
|
36079
36111
|
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
36112
|
+
toolCalls: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls;
|
|
36080
36113
|
constructor(context: APIRequestContext);
|
|
36081
36114
|
/**
|
|
36082
36115
|
* Creates an Agent.
|
|
@@ -36783,6 +36816,92 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36783
36816
|
*/
|
|
36784
36817
|
name?: string;
|
|
36785
36818
|
}
|
|
36819
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls {
|
|
36820
|
+
context: APIRequestContext;
|
|
36821
|
+
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations;
|
|
36822
|
+
constructor(context: APIRequestContext);
|
|
36823
|
+
}
|
|
36824
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations {
|
|
36825
|
+
context: APIRequestContext;
|
|
36826
|
+
constructor(context: APIRequestContext);
|
|
36827
|
+
/**
|
|
36828
|
+
* 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.
|
|
36829
|
+
* @example
|
|
36830
|
+
* ```js
|
|
36831
|
+
* // Before running the sample:
|
|
36832
|
+
* // - Enable the API at:
|
|
36833
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
36834
|
+
* // - Login into gcloud by running:
|
|
36835
|
+
* // ```sh
|
|
36836
|
+
* // $ gcloud auth application-default login
|
|
36837
|
+
* // ```
|
|
36838
|
+
* // - Install the npm module by running:
|
|
36839
|
+
* // ```sh
|
|
36840
|
+
* // $ npm install googleapis
|
|
36841
|
+
* // ```
|
|
36842
|
+
*
|
|
36843
|
+
* const {google} = require('googleapis');
|
|
36844
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
36845
|
+
*
|
|
36846
|
+
* async function main() {
|
|
36847
|
+
* const auth = new google.auth.GoogleAuth({
|
|
36848
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
36849
|
+
* scopes: [
|
|
36850
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
36851
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
36852
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
36853
|
+
* ],
|
|
36854
|
+
* });
|
|
36855
|
+
*
|
|
36856
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
36857
|
+
* const authClient = await auth.getClient();
|
|
36858
|
+
* google.options({auth: authClient});
|
|
36859
|
+
*
|
|
36860
|
+
* // Do the magic
|
|
36861
|
+
* const res =
|
|
36862
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.toolCalls.operations.get(
|
|
36863
|
+
* {
|
|
36864
|
+
* // The name of the operation resource.
|
|
36865
|
+
* 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',
|
|
36866
|
+
* },
|
|
36867
|
+
* );
|
|
36868
|
+
* console.log(res.data);
|
|
36869
|
+
*
|
|
36870
|
+
* // Example response
|
|
36871
|
+
* // {
|
|
36872
|
+
* // "done": false,
|
|
36873
|
+
* // "error": {},
|
|
36874
|
+
* // "metadata": {},
|
|
36875
|
+
* // "name": "my_name",
|
|
36876
|
+
* // "response": {}
|
|
36877
|
+
* // }
|
|
36878
|
+
* }
|
|
36879
|
+
*
|
|
36880
|
+
* main().catch(e => {
|
|
36881
|
+
* console.error(e);
|
|
36882
|
+
* throw e;
|
|
36883
|
+
* });
|
|
36884
|
+
*
|
|
36885
|
+
* ```
|
|
36886
|
+
*
|
|
36887
|
+
* @param params - Parameters for request
|
|
36888
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36889
|
+
* @param callback - Optional callback that handles the response.
|
|
36890
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36891
|
+
*/
|
|
36892
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36893
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
36894
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36895
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36896
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36897
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36898
|
+
}
|
|
36899
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations$Get extends StandardParameters {
|
|
36900
|
+
/**
|
|
36901
|
+
* The name of the operation resource.
|
|
36902
|
+
*/
|
|
36903
|
+
name?: string;
|
|
36904
|
+
}
|
|
36786
36905
|
export class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries {
|
|
36787
36906
|
context: APIRequestContext;
|
|
36788
36907
|
constructor(context: APIRequestContext);
|
|
@@ -37242,6 +37361,97 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37242
37361
|
*/
|
|
37243
37362
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
|
|
37244
37363
|
}
|
|
37364
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
|
|
37365
|
+
context: APIRequestContext;
|
|
37366
|
+
knowledgeSpaces: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
|
|
37367
|
+
constructor(context: APIRequestContext);
|
|
37368
|
+
}
|
|
37369
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
|
|
37370
|
+
context: APIRequestContext;
|
|
37371
|
+
operations: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
|
|
37372
|
+
constructor(context: APIRequestContext);
|
|
37373
|
+
}
|
|
37374
|
+
export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
|
|
37375
|
+
context: APIRequestContext;
|
|
37376
|
+
constructor(context: APIRequestContext);
|
|
37377
|
+
/**
|
|
37378
|
+
* 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.
|
|
37379
|
+
* @example
|
|
37380
|
+
* ```js
|
|
37381
|
+
* // Before running the sample:
|
|
37382
|
+
* // - Enable the API at:
|
|
37383
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
37384
|
+
* // - Login into gcloud by running:
|
|
37385
|
+
* // ```sh
|
|
37386
|
+
* // $ gcloud auth application-default login
|
|
37387
|
+
* // ```
|
|
37388
|
+
* // - Install the npm module by running:
|
|
37389
|
+
* // ```sh
|
|
37390
|
+
* // $ npm install googleapis
|
|
37391
|
+
* // ```
|
|
37392
|
+
*
|
|
37393
|
+
* const {google} = require('googleapis');
|
|
37394
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
37395
|
+
*
|
|
37396
|
+
* async function main() {
|
|
37397
|
+
* const auth = new google.auth.GoogleAuth({
|
|
37398
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
37399
|
+
* scopes: [
|
|
37400
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
37401
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
37402
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
37403
|
+
* ],
|
|
37404
|
+
* });
|
|
37405
|
+
*
|
|
37406
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
37407
|
+
* const authClient = await auth.getClient();
|
|
37408
|
+
* google.options({auth: authClient});
|
|
37409
|
+
*
|
|
37410
|
+
* // Do the magic
|
|
37411
|
+
* const res =
|
|
37412
|
+
* await discoveryengine.projects.locations.collections.engines.collaborativeProjects.knowledgeSpaces.operations.get(
|
|
37413
|
+
* {
|
|
37414
|
+
* // The name of the operation resource.
|
|
37415
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/collaborativeProjects/my-collaborativeProject/knowledgeSpaces/my-knowledgeSpace/operations/my-operation',
|
|
37416
|
+
* },
|
|
37417
|
+
* );
|
|
37418
|
+
* console.log(res.data);
|
|
37419
|
+
*
|
|
37420
|
+
* // Example response
|
|
37421
|
+
* // {
|
|
37422
|
+
* // "done": false,
|
|
37423
|
+
* // "error": {},
|
|
37424
|
+
* // "metadata": {},
|
|
37425
|
+
* // "name": "my_name",
|
|
37426
|
+
* // "response": {}
|
|
37427
|
+
* // }
|
|
37428
|
+
* }
|
|
37429
|
+
*
|
|
37430
|
+
* main().catch(e => {
|
|
37431
|
+
* console.error(e);
|
|
37432
|
+
* throw e;
|
|
37433
|
+
* });
|
|
37434
|
+
*
|
|
37435
|
+
* ```
|
|
37436
|
+
*
|
|
37437
|
+
* @param params - Parameters for request
|
|
37438
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
37439
|
+
* @param callback - Optional callback that handles the response.
|
|
37440
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
37441
|
+
*/
|
|
37442
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
37443
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
37444
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
37445
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37446
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37447
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37448
|
+
}
|
|
37449
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get extends StandardParameters {
|
|
37450
|
+
/**
|
|
37451
|
+
* The name of the operation resource.
|
|
37452
|
+
*/
|
|
37453
|
+
name?: string;
|
|
37454
|
+
}
|
|
37245
37455
|
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
37246
37456
|
context: APIRequestContext;
|
|
37247
37457
|
constructor(context: APIRequestContext);
|
|
@@ -52181,6 +52391,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52181
52391
|
* // {
|
|
52182
52392
|
* // "alertPolicyResourceConfig": {},
|
|
52183
52393
|
* // "autoRenew": false,
|
|
52394
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
52184
52395
|
* // "earlyTerminated": false,
|
|
52185
52396
|
* // "earlyTerminationDate": {},
|
|
52186
52397
|
* // "endDate": {},
|
|
@@ -52202,6 +52413,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52202
52413
|
* // {
|
|
52203
52414
|
* // "alertPolicyResourceConfig": {},
|
|
52204
52415
|
* // "autoRenew": false,
|
|
52416
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
52205
52417
|
* // "earlyTerminated": false,
|
|
52206
52418
|
* // "earlyTerminationDate": {},
|
|
52207
52419
|
* // "endDate": {},
|
|
@@ -52279,6 +52491,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52279
52491
|
* // {
|
|
52280
52492
|
* // "alertPolicyResourceConfig": {},
|
|
52281
52493
|
* // "autoRenew": false,
|
|
52494
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
52282
52495
|
* // "earlyTerminated": false,
|
|
52283
52496
|
* // "earlyTerminationDate": {},
|
|
52284
52497
|
* // "endDate": {},
|
|
@@ -52429,6 +52642,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52429
52642
|
* // {
|
|
52430
52643
|
* // "alertPolicyResourceConfig": {},
|
|
52431
52644
|
* // "autoRenew": false,
|
|
52645
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
52432
52646
|
* // "earlyTerminated": false,
|
|
52433
52647
|
* // "earlyTerminationDate": {},
|
|
52434
52648
|
* // "endDate": {},
|
|
@@ -52450,6 +52664,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52450
52664
|
* // {
|
|
52451
52665
|
* // "alertPolicyResourceConfig": {},
|
|
52452
52666
|
* // "autoRenew": false,
|
|
52667
|
+
* // "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
|
|
52453
52668
|
* // "earlyTerminated": false,
|
|
52454
52669
|
* // "earlyTerminationDate": {},
|
|
52455
52670
|
* // "endDate": {},
|
package/build/v1alpha.js
CHANGED
|
@@ -5391,6 +5391,7 @@ var discoveryengine_v1alpha;
|
|
|
5391
5391
|
context;
|
|
5392
5392
|
analytics;
|
|
5393
5393
|
assistants;
|
|
5394
|
+
collaborativeProjects;
|
|
5394
5395
|
completionConfig;
|
|
5395
5396
|
controls;
|
|
5396
5397
|
conversations;
|
|
@@ -5404,6 +5405,8 @@ var discoveryengine_v1alpha;
|
|
|
5404
5405
|
new Resource$Projects$Locations$Collections$Engines$Analytics(this.context);
|
|
5405
5406
|
this.assistants =
|
|
5406
5407
|
new Resource$Projects$Locations$Collections$Engines$Assistants(this.context);
|
|
5408
|
+
this.collaborativeProjects =
|
|
5409
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects(this.context);
|
|
5407
5410
|
this.completionConfig =
|
|
5408
5411
|
new Resource$Projects$Locations$Collections$Engines$Completionconfig(this.context);
|
|
5409
5412
|
this.controls =
|
|
@@ -6171,12 +6174,15 @@ var discoveryengine_v1alpha;
|
|
|
6171
6174
|
context;
|
|
6172
6175
|
files;
|
|
6173
6176
|
operations;
|
|
6177
|
+
toolCalls;
|
|
6174
6178
|
constructor(context) {
|
|
6175
6179
|
this.context = context;
|
|
6176
6180
|
this.files =
|
|
6177
6181
|
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files(this.context);
|
|
6178
6182
|
this.operations =
|
|
6179
6183
|
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations(this.context);
|
|
6184
|
+
this.toolCalls =
|
|
6185
|
+
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls(this.context);
|
|
6180
6186
|
}
|
|
6181
6187
|
create(paramsOrCallback, optionsOrCallback, callback) {
|
|
6182
6188
|
let params = (paramsOrCallback ||
|
|
@@ -6425,6 +6431,56 @@ var discoveryengine_v1alpha;
|
|
|
6425
6431
|
}
|
|
6426
6432
|
}
|
|
6427
6433
|
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations = Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
6434
|
+
class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls {
|
|
6435
|
+
context;
|
|
6436
|
+
operations;
|
|
6437
|
+
constructor(context) {
|
|
6438
|
+
this.context = context;
|
|
6439
|
+
this.operations =
|
|
6440
|
+
new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations(this.context);
|
|
6441
|
+
}
|
|
6442
|
+
}
|
|
6443
|
+
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls = Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls;
|
|
6444
|
+
class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations {
|
|
6445
|
+
context;
|
|
6446
|
+
constructor(context) {
|
|
6447
|
+
this.context = context;
|
|
6448
|
+
}
|
|
6449
|
+
get(paramsOrCallback, optionsOrCallback, callback) {
|
|
6450
|
+
let params = (paramsOrCallback ||
|
|
6451
|
+
{});
|
|
6452
|
+
let options = (optionsOrCallback || {});
|
|
6453
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6454
|
+
callback = paramsOrCallback;
|
|
6455
|
+
params =
|
|
6456
|
+
{};
|
|
6457
|
+
options = {};
|
|
6458
|
+
}
|
|
6459
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6460
|
+
callback = optionsOrCallback;
|
|
6461
|
+
options = {};
|
|
6462
|
+
}
|
|
6463
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6464
|
+
const parameters = {
|
|
6465
|
+
options: Object.assign({
|
|
6466
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
6467
|
+
method: 'GET',
|
|
6468
|
+
apiVersion: '',
|
|
6469
|
+
}, options),
|
|
6470
|
+
params,
|
|
6471
|
+
requiredParams: ['name'],
|
|
6472
|
+
pathParams: ['name'],
|
|
6473
|
+
context: this.context,
|
|
6474
|
+
};
|
|
6475
|
+
if (callback) {
|
|
6476
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
6477
|
+
}
|
|
6478
|
+
else {
|
|
6479
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
6480
|
+
}
|
|
6481
|
+
}
|
|
6482
|
+
}
|
|
6483
|
+
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations = Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Toolcalls$Operations;
|
|
6428
6484
|
class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries {
|
|
6429
6485
|
context;
|
|
6430
6486
|
constructor(context) {
|
|
@@ -6597,6 +6653,66 @@ var discoveryengine_v1alpha;
|
|
|
6597
6653
|
}
|
|
6598
6654
|
}
|
|
6599
6655
|
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries = Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries;
|
|
6656
|
+
class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
|
|
6657
|
+
context;
|
|
6658
|
+
knowledgeSpaces;
|
|
6659
|
+
constructor(context) {
|
|
6660
|
+
this.context = context;
|
|
6661
|
+
this.knowledgeSpaces =
|
|
6662
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces(this.context);
|
|
6663
|
+
}
|
|
6664
|
+
}
|
|
6665
|
+
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
|
|
6666
|
+
class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
|
|
6667
|
+
context;
|
|
6668
|
+
operations;
|
|
6669
|
+
constructor(context) {
|
|
6670
|
+
this.context = context;
|
|
6671
|
+
this.operations =
|
|
6672
|
+
new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations(this.context);
|
|
6673
|
+
}
|
|
6674
|
+
}
|
|
6675
|
+
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
|
|
6676
|
+
class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
|
|
6677
|
+
context;
|
|
6678
|
+
constructor(context) {
|
|
6679
|
+
this.context = context;
|
|
6680
|
+
}
|
|
6681
|
+
get(paramsOrCallback, optionsOrCallback, callback) {
|
|
6682
|
+
let params = (paramsOrCallback ||
|
|
6683
|
+
{});
|
|
6684
|
+
let options = (optionsOrCallback || {});
|
|
6685
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6686
|
+
callback = paramsOrCallback;
|
|
6687
|
+
params =
|
|
6688
|
+
{};
|
|
6689
|
+
options = {};
|
|
6690
|
+
}
|
|
6691
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6692
|
+
callback = optionsOrCallback;
|
|
6693
|
+
options = {};
|
|
6694
|
+
}
|
|
6695
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6696
|
+
const parameters = {
|
|
6697
|
+
options: Object.assign({
|
|
6698
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
6699
|
+
method: 'GET',
|
|
6700
|
+
apiVersion: '',
|
|
6701
|
+
}, options),
|
|
6702
|
+
params,
|
|
6703
|
+
requiredParams: ['name'],
|
|
6704
|
+
pathParams: ['name'],
|
|
6705
|
+
context: this.context,
|
|
6706
|
+
};
|
|
6707
|
+
if (callback) {
|
|
6708
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
6709
|
+
}
|
|
6710
|
+
else {
|
|
6711
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
6712
|
+
}
|
|
6713
|
+
}
|
|
6714
|
+
}
|
|
6715
|
+
discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
|
|
6600
6716
|
class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
6601
6717
|
context;
|
|
6602
6718
|
constructor(context) {
|