@maxim_mazurok/gapi.client.discoveryengine-v1 0.2.20260317 → 0.2.20260531
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +559 -85
- package/package.json +1 -1
- package/readme.md +20 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260531
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -417,7 +417,7 @@ declare namespace gapi.client {
|
|
|
417
417
|
}
|
|
418
418
|
interface GoogleApiDistributionExemplar {
|
|
419
419
|
/** Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */
|
|
420
|
-
attachments?:
|
|
420
|
+
attachments?: {[P in string]: any}[];
|
|
421
421
|
/** The observation (sampling) time of the above value. */
|
|
422
422
|
timestamp?: string;
|
|
423
423
|
/** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
|
|
@@ -435,7 +435,7 @@ declare namespace gapi.client {
|
|
|
435
435
|
/** The HTTP request/response body as raw binary. */
|
|
436
436
|
data?: string;
|
|
437
437
|
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
438
|
-
extensions?:
|
|
438
|
+
extensions?: {[P in string]: any}[];
|
|
439
439
|
}
|
|
440
440
|
interface GoogleApiMetric {
|
|
441
441
|
/** The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values. */
|
|
@@ -528,6 +528,8 @@ declare namespace gapi.client {
|
|
|
528
528
|
interface GoogleCloudDiscoveryengineV1ActionConfig {
|
|
529
529
|
/** Optional. Action parameters in structured json format. */
|
|
530
530
|
actionParams?: {[P in string]: any};
|
|
531
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
532
|
+
createBapConnection?: boolean;
|
|
531
533
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
532
534
|
isActionConfigured?: boolean;
|
|
533
535
|
/** Optional. Action parameters in json string format. */
|
|
@@ -710,6 +712,8 @@ declare namespace gapi.client {
|
|
|
710
712
|
interface GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
711
713
|
/** Optional. Action parameters in structured json format. */
|
|
712
714
|
actionParams?: {[P in string]: any};
|
|
715
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
716
|
+
createBapConnection?: boolean;
|
|
713
717
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
714
718
|
isActionConfigured?: boolean;
|
|
715
719
|
/** Optional. Action parameters in json string format. */
|
|
@@ -796,7 +800,7 @@ declare namespace gapi.client {
|
|
|
796
800
|
| 'UNHELPFUL_ANSWER'[];
|
|
797
801
|
/** The textual answer. */
|
|
798
802
|
answerText?: string;
|
|
799
|
-
/** List of blob attachments in the answer. */
|
|
803
|
+
/** Output only. List of blob attachments in the answer. */
|
|
800
804
|
blobAttachments?: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment[];
|
|
801
805
|
/** Citations. */
|
|
802
806
|
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
@@ -1014,7 +1018,8 @@ declare namespace gapi.client {
|
|
|
1014
1018
|
| 'IN_PROGRESS'
|
|
1015
1019
|
| 'FAILED'
|
|
1016
1020
|
| 'SUCCEEDED'
|
|
1017
|
-
| 'SKIPPED'
|
|
1021
|
+
| 'SKIPPED'
|
|
1022
|
+
| 'CANCELLED';
|
|
1018
1023
|
}
|
|
1019
1024
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
1020
1025
|
/** Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. */
|
|
@@ -1039,6 +1044,8 @@ declare namespace gapi.client {
|
|
|
1039
1044
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
1040
1045
|
}
|
|
1041
1046
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
1047
|
+
/** The time when the reply was created. */
|
|
1048
|
+
createTime?: string;
|
|
1042
1049
|
/** Possibly grounded response text or media from the assistant. */
|
|
1043
1050
|
groundedContent?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
1044
1051
|
/** Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. */
|
|
@@ -1099,8 +1106,12 @@ declare namespace gapi.client {
|
|
|
1099
1106
|
references?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
1100
1107
|
/** Grounding information for parts of the text. */
|
|
1101
1108
|
segments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
1109
|
+
/** Grounding information for parts of the visual content. */
|
|
1110
|
+
visualSegments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
1102
1111
|
}
|
|
1103
1112
|
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
1113
|
+
/** Chunk of code snippet from the referenced document. */
|
|
1114
|
+
codeSnippet?: string;
|
|
1104
1115
|
/** Referenced text content. */
|
|
1105
1116
|
content?: string;
|
|
1106
1117
|
/** Document metadata. */
|
|
@@ -1111,6 +1122,7 @@ declare namespace gapi.client {
|
|
|
1111
1122
|
document?: string;
|
|
1112
1123
|
/** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
|
|
1113
1124
|
domain?: string;
|
|
1125
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
1114
1126
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
1115
1127
|
mimeType?: string;
|
|
1116
1128
|
/** Page identifier. */
|
|
@@ -1132,6 +1144,12 @@ declare namespace gapi.client {
|
|
|
1132
1144
|
/** The text segment itself. */
|
|
1133
1145
|
text?: string;
|
|
1134
1146
|
}
|
|
1147
|
+
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
1148
|
+
/** The content id of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field. */
|
|
1149
|
+
contentId?: string;
|
|
1150
|
+
/** References for the visual segment. */
|
|
1151
|
+
referenceIndices?: number[];
|
|
1152
|
+
}
|
|
1135
1153
|
interface GoogleCloudDiscoveryengineV1alphaBAPConfig {
|
|
1136
1154
|
/** Optional. The actions enabled on the associated BAP connection. */
|
|
1137
1155
|
enabledActions?: string[];
|
|
@@ -1141,6 +1159,14 @@ declare namespace gapi.client {
|
|
|
1141
1159
|
| 'DATA_INGESTION'
|
|
1142
1160
|
| 'ACTIONS'
|
|
1143
1161
|
| 'END_USER_AUTHENTICATION'[];
|
|
1162
|
+
/** Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first). */
|
|
1163
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
1164
|
+
}
|
|
1165
|
+
interface GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
1166
|
+
/** Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first. */
|
|
1167
|
+
baseVersion?: string;
|
|
1168
|
+
/** Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. */
|
|
1169
|
+
tools?: {[P in string]: any}[];
|
|
1144
1170
|
}
|
|
1145
1171
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
1146
1172
|
/** Operation create time. */
|
|
@@ -1186,6 +1212,10 @@ declare namespace gapi.client {
|
|
|
1186
1212
|
/** Output only. List of citations. */
|
|
1187
1213
|
citations?: GoogleCloudDiscoveryengineV1alphaCitation[];
|
|
1188
1214
|
}
|
|
1215
|
+
interface GoogleCloudDiscoveryengineV1alphaCliConfig {
|
|
1216
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
1217
|
+
enabledActions?: string[];
|
|
1218
|
+
}
|
|
1189
1219
|
interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
|
|
1190
1220
|
/** Output only. The default CmekConfig for the Customer. */
|
|
1191
1221
|
isDefault?: boolean;
|
|
@@ -1483,6 +1513,8 @@ declare namespace gapi.client {
|
|
|
1483
1513
|
| 'ALLOWLIST_STATIC_IP'
|
|
1484
1514
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
1485
1515
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
1516
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
1517
|
+
cliConfig?: GoogleCloudDiscoveryengineV1alphaCliConfig;
|
|
1486
1518
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
1487
1519
|
connectorModes?:
|
|
1488
1520
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -1491,6 +1523,8 @@ declare namespace gapi.client {
|
|
|
1491
1523
|
| 'FEDERATED'
|
|
1492
1524
|
| 'EUA'
|
|
1493
1525
|
| 'FEDERATED_AND_EUA'[];
|
|
1526
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
1527
|
+
connectorSourceId?: string;
|
|
1494
1528
|
/** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
|
|
1495
1529
|
connectorType?:
|
|
1496
1530
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -1520,7 +1554,7 @@ declare namespace gapi.client {
|
|
|
1520
1554
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
1521
1555
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
1522
1556
|
dynamicTools?: GoogleCloudDiscoveryengineV1alphaDynamicTool[];
|
|
1523
|
-
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.
|
|
1557
|
+
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. */
|
|
1524
1558
|
egressFqdns?: string[];
|
|
1525
1559
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
1526
1560
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
@@ -1548,7 +1582,7 @@ declare namespace gapi.client {
|
|
|
1548
1582
|
lastSyncTime?: string;
|
|
1549
1583
|
/** Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. */
|
|
1550
1584
|
latestPauseTime?: string;
|
|
1551
|
-
/**
|
|
1585
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
1552
1586
|
name?: string;
|
|
1553
1587
|
/** Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. */
|
|
1554
1588
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -1590,7 +1624,7 @@ declare namespace gapi.client {
|
|
|
1590
1624
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
1591
1625
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
1592
1626
|
updateTime?: string;
|
|
1593
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
1627
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
1594
1628
|
vpcscEnabled?: boolean;
|
|
1595
1629
|
}
|
|
1596
1630
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
@@ -1678,6 +1712,8 @@ declare namespace gapi.client {
|
|
|
1678
1712
|
| 'GOOGLE_WORKSPACE';
|
|
1679
1713
|
/** Output only. Timestamp the DataStore was created at. */
|
|
1680
1714
|
createTime?: string;
|
|
1715
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
1716
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
1681
1717
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
1682
1718
|
defaultSchemaId?: string;
|
|
1683
1719
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
@@ -1988,7 +2024,7 @@ declare namespace gapi.client {
|
|
|
1988
2024
|
disableAnalytics?: boolean;
|
|
1989
2025
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
1990
2026
|
displayName?: string;
|
|
1991
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
2027
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
1992
2028
|
features?: {
|
|
1993
2029
|
[P in string]:
|
|
1994
2030
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2265,7 +2301,7 @@ declare namespace gapi.client {
|
|
|
2265
2301
|
| 'RETRIEVABLE_DISABLED';
|
|
2266
2302
|
/** Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished */
|
|
2267
2303
|
schemaOrgPaths?: string[];
|
|
2268
|
-
/** Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. */
|
|
2304
|
+
/** Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). */
|
|
2269
2305
|
searchableFieldImportance?:
|
|
2270
2306
|
| 'SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED'
|
|
2271
2307
|
| 'VERY_LOW_IMPORTANCE'
|
|
@@ -2402,7 +2438,7 @@ declare namespace gapi.client {
|
|
|
2402
2438
|
failureCount?: string;
|
|
2403
2439
|
/** Count of entries that were processed successfully. */
|
|
2404
2440
|
successCount?: string;
|
|
2405
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2441
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
2406
2442
|
updateTime?: string;
|
|
2407
2443
|
}
|
|
2408
2444
|
interface GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse {
|
|
@@ -2491,7 +2527,7 @@ declare namespace gapi.client {
|
|
|
2491
2527
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
2492
2528
|
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
2493
2529
|
filter?: string;
|
|
2494
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
2530
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
2495
2531
|
orderBy?: string;
|
|
2496
2532
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
2497
2533
|
pageSize?: number;
|
|
@@ -2571,6 +2607,13 @@ declare namespace gapi.client {
|
|
|
2571
2607
|
startTime?: string;
|
|
2572
2608
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
2573
2609
|
terminateTime?: string;
|
|
2610
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
2611
|
+
updateType?:
|
|
2612
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
2613
|
+
| 'CREATE'
|
|
2614
|
+
| 'DELETE'
|
|
2615
|
+
| 'SCALE_UP'
|
|
2616
|
+
| 'SCALE_DOWN';
|
|
2574
2617
|
}
|
|
2575
2618
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
2576
2619
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -2696,6 +2739,8 @@ declare namespace gapi.client {
|
|
|
2696
2739
|
top5?: number;
|
|
2697
2740
|
}
|
|
2698
2741
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
2742
|
+
/** Output only. The time at which the server accepted this query. */
|
|
2743
|
+
createTime?: string;
|
|
2699
2744
|
/** Query content parts. */
|
|
2700
2745
|
parts?: GoogleCloudDiscoveryengineV1alphaQueryPart[];
|
|
2701
2746
|
/** Output only. Unique Id for the query. */
|
|
@@ -2896,12 +2941,16 @@ declare namespace gapi.client {
|
|
|
2896
2941
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
2897
2942
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
2898
2943
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2944
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
2945
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams;
|
|
2899
2946
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
2900
2947
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
2901
2948
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
2902
2949
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
2903
2950
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
2904
2951
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
2952
|
+
/** Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. */
|
|
2953
|
+
entity?: string;
|
|
2905
2954
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
2906
2955
|
facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
2907
2956
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -2934,7 +2983,7 @@ declare namespace gapi.client {
|
|
|
2934
2983
|
query?: string;
|
|
2935
2984
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
2936
2985
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
2937
|
-
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result */
|
|
2986
|
+
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results */
|
|
2938
2987
|
rankingExpression?: string;
|
|
2939
2988
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
2940
2989
|
rankingExpressionBackend?:
|
|
@@ -3099,6 +3148,10 @@ declare namespace gapi.client {
|
|
|
3099
3148
|
| 'DROP_CROWDED_RESULTS'
|
|
3100
3149
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
3101
3150
|
}
|
|
3151
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams {
|
|
3152
|
+
/** Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. */
|
|
3153
|
+
expressionsToPrecompute?: string[];
|
|
3154
|
+
}
|
|
3102
3155
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
3103
3156
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
3104
3157
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -3171,7 +3224,7 @@ declare namespace gapi.client {
|
|
|
3171
3224
|
| 'CONDITION_UNSPECIFIED'
|
|
3172
3225
|
| 'DISABLED'
|
|
3173
3226
|
| 'ENABLED';
|
|
3174
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
3227
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
3175
3228
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
3176
3229
|
}
|
|
3177
3230
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec {
|
|
@@ -3238,6 +3291,8 @@ declare namespace gapi.client {
|
|
|
3238
3291
|
labels?: string[];
|
|
3239
3292
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
3240
3293
|
name?: string;
|
|
3294
|
+
/** Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes. */
|
|
3295
|
+
pendingAsyncAssistOperationId?: string;
|
|
3241
3296
|
/** Output only. The time the session started. */
|
|
3242
3297
|
startTime?: string;
|
|
3243
3298
|
/** The state of the session. */
|
|
@@ -3254,6 +3309,8 @@ declare namespace gapi.client {
|
|
|
3254
3309
|
detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
3255
3310
|
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. */
|
|
3256
3311
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
3312
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
3313
|
+
live?: boolean;
|
|
3257
3314
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
3258
3315
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
3259
3316
|
/** Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix "google." is reserved for Google-developed functionality. */
|
|
@@ -3400,6 +3457,8 @@ declare namespace gapi.client {
|
|
|
3400
3457
|
updateTime?: string;
|
|
3401
3458
|
}
|
|
3402
3459
|
interface GoogleCloudDiscoveryengineV1alphaUserInfo {
|
|
3460
|
+
/** Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. */
|
|
3461
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation;
|
|
3403
3462
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
3404
3463
|
timeZone?: string;
|
|
3405
3464
|
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
@@ -3407,6 +3466,12 @@ declare namespace gapi.client {
|
|
|
3407
3466
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
|
|
3408
3467
|
userId?: string;
|
|
3409
3468
|
}
|
|
3469
|
+
interface GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
3470
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
3471
|
+
address?: string;
|
|
3472
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
3473
|
+
point?: GoogleTypeLatLng;
|
|
3474
|
+
}
|
|
3410
3475
|
interface GoogleCloudDiscoveryengineV1alphaUserLicense {
|
|
3411
3476
|
/** Output only. User created timestamp. */
|
|
3412
3477
|
createTime?: string;
|
|
@@ -3430,7 +3495,7 @@ declare namespace gapi.client {
|
|
|
3430
3495
|
userProfile?: string;
|
|
3431
3496
|
}
|
|
3432
3497
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
3433
|
-
/** Obfuscated Dasher customer ID. */
|
|
3498
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
3434
3499
|
dasherCustomerId?: string;
|
|
3435
3500
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
3436
3501
|
superAdminEmailAddress?: string;
|
|
@@ -3911,7 +3976,8 @@ declare namespace gapi.client {
|
|
|
3911
3976
|
| 'IN_PROGRESS'
|
|
3912
3977
|
| 'FAILED'
|
|
3913
3978
|
| 'SUCCEEDED'
|
|
3914
|
-
| 'SKIPPED'
|
|
3979
|
+
| 'SKIPPED'
|
|
3980
|
+
| 'CANCELLED';
|
|
3915
3981
|
}
|
|
3916
3982
|
interface GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult {
|
|
3917
3983
|
/** Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. */
|
|
@@ -3936,10 +4002,14 @@ declare namespace gapi.client {
|
|
|
3936
4002
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
3937
4003
|
}
|
|
3938
4004
|
interface GoogleCloudDiscoveryengineV1AssistAnswerReply {
|
|
4005
|
+
/** The time when the reply was created. */
|
|
4006
|
+
createTime?: string;
|
|
3939
4007
|
/** Possibly grounded response text or media from the assistant. */
|
|
3940
4008
|
groundedContent?: GoogleCloudDiscoveryengineV1AssistantGroundedContent;
|
|
3941
4009
|
}
|
|
3942
4010
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
4011
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
4012
|
+
createTime?: string;
|
|
3943
4013
|
/** Optional. Customer policy for the assistant. */
|
|
3944
4014
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
3945
4015
|
/** Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. */
|
|
@@ -3956,6 +4026,8 @@ declare namespace gapi.client {
|
|
|
3956
4026
|
generationConfig?: GoogleCloudDiscoveryengineV1AssistantGenerationConfig;
|
|
3957
4027
|
/** Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
3958
4028
|
name?: string;
|
|
4029
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
4030
|
+
updateTime?: string;
|
|
3959
4031
|
/** Optional. The type of web grounding to use. */
|
|
3960
4032
|
webGroundingType?:
|
|
3961
4033
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -4057,8 +4129,12 @@ declare namespace gapi.client {
|
|
|
4057
4129
|
references?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference[];
|
|
4058
4130
|
/** Grounding information for parts of the text. */
|
|
4059
4131
|
segments?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment[];
|
|
4132
|
+
/** Grounding information for parts of the visual content. */
|
|
4133
|
+
visualSegments?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
4060
4134
|
}
|
|
4061
4135
|
interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference {
|
|
4136
|
+
/** Chunk of code snippet from the referenced document. */
|
|
4137
|
+
codeSnippet?: string;
|
|
4062
4138
|
/** Referenced text content. */
|
|
4063
4139
|
content?: string;
|
|
4064
4140
|
/** Document metadata. */
|
|
@@ -4069,6 +4145,7 @@ declare namespace gapi.client {
|
|
|
4069
4145
|
document?: string;
|
|
4070
4146
|
/** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
|
|
4071
4147
|
domain?: string;
|
|
4148
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
4072
4149
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
4073
4150
|
mimeType?: string;
|
|
4074
4151
|
/** Page identifier. */
|
|
@@ -4090,6 +4167,12 @@ declare namespace gapi.client {
|
|
|
4090
4167
|
/** The text segment itself. */
|
|
4091
4168
|
text?: string;
|
|
4092
4169
|
}
|
|
4170
|
+
interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
4171
|
+
/** The content id of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field. */
|
|
4172
|
+
contentId?: string;
|
|
4173
|
+
/** References for the visual segment. */
|
|
4174
|
+
referenceIndices?: number[];
|
|
4175
|
+
}
|
|
4093
4176
|
interface GoogleCloudDiscoveryengineV1AssistantToolInfo {
|
|
4094
4177
|
/** The display name of the tool. */
|
|
4095
4178
|
toolDisplayName?: string;
|
|
@@ -4115,6 +4198,14 @@ declare namespace gapi.client {
|
|
|
4115
4198
|
| 'DATA_INGESTION'
|
|
4116
4199
|
| 'ACTIONS'
|
|
4117
4200
|
| 'END_USER_AUTHENTICATION'[];
|
|
4201
|
+
/** Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first). */
|
|
4202
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
4203
|
+
}
|
|
4204
|
+
interface GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
4205
|
+
/** Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first. */
|
|
4206
|
+
baseVersion?: string;
|
|
4207
|
+
/** Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. */
|
|
4208
|
+
tools?: {[P in string]: any}[];
|
|
4118
4209
|
}
|
|
4119
4210
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
4120
4211
|
/** Operation create time. */
|
|
@@ -4672,7 +4763,7 @@ declare namespace gapi.client {
|
|
|
4672
4763
|
disableAnalytics?: boolean;
|
|
4673
4764
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
4674
4765
|
displayName?: string;
|
|
4675
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
4766
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
4676
4767
|
features?: {
|
|
4677
4768
|
[P in string]:
|
|
4678
4769
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -4967,7 +5058,7 @@ declare namespace gapi.client {
|
|
|
4967
5058
|
failureCount?: string;
|
|
4968
5059
|
/** Count of entries that were processed successfully. */
|
|
4969
5060
|
successCount?: string;
|
|
4970
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
5061
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
4971
5062
|
updateTime?: string;
|
|
4972
5063
|
}
|
|
4973
5064
|
interface GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
@@ -5106,6 +5197,13 @@ declare namespace gapi.client {
|
|
|
5106
5197
|
startTime?: string;
|
|
5107
5198
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
5108
5199
|
terminateTime?: string;
|
|
5200
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
5201
|
+
updateType?:
|
|
5202
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
5203
|
+
| 'CREATE'
|
|
5204
|
+
| 'DELETE'
|
|
5205
|
+
| 'SCALE_UP'
|
|
5206
|
+
| 'SCALE_DOWN';
|
|
5109
5207
|
}
|
|
5110
5208
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
5111
5209
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -5249,12 +5347,16 @@ declare namespace gapi.client {
|
|
|
5249
5347
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
5250
5348
|
/** Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. */
|
|
5251
5349
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
5350
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
5351
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams;
|
|
5252
5352
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
5253
5353
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
5254
5354
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
5255
5355
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
5256
5356
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
5257
5357
|
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
5358
|
+
/** Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. */
|
|
5359
|
+
entity?: string;
|
|
5258
5360
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
5259
5361
|
facetSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
5260
5362
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -5287,7 +5389,7 @@ declare namespace gapi.client {
|
|
|
5287
5389
|
query?: string;
|
|
5288
5390
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
5289
5391
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
5290
|
-
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result */
|
|
5392
|
+
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results */
|
|
5291
5393
|
rankingExpression?: string;
|
|
5292
5394
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
5293
5395
|
rankingExpressionBackend?:
|
|
@@ -5450,6 +5552,10 @@ declare namespace gapi.client {
|
|
|
5450
5552
|
| 'DROP_CROWDED_RESULTS'
|
|
5451
5553
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
5452
5554
|
}
|
|
5555
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams {
|
|
5556
|
+
/** Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. */
|
|
5557
|
+
expressionsToPrecompute?: string[];
|
|
5558
|
+
}
|
|
5453
5559
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
5454
5560
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
5455
5561
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -5522,7 +5628,7 @@ declare namespace gapi.client {
|
|
|
5522
5628
|
| 'CONDITION_UNSPECIFIED'
|
|
5523
5629
|
| 'DISABLED'
|
|
5524
5630
|
| 'ENABLED';
|
|
5525
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
5631
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
5526
5632
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
5527
5633
|
}
|
|
5528
5634
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec {
|
|
@@ -5685,6 +5791,8 @@ declare namespace gapi.client {
|
|
|
5685
5791
|
updateTime?: string;
|
|
5686
5792
|
}
|
|
5687
5793
|
interface GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
5794
|
+
/** Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. */
|
|
5795
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation;
|
|
5688
5796
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
5689
5797
|
timeZone?: string;
|
|
5690
5798
|
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
@@ -5692,6 +5800,12 @@ declare namespace gapi.client {
|
|
|
5692
5800
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
|
|
5693
5801
|
userId?: string;
|
|
5694
5802
|
}
|
|
5803
|
+
interface GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
5804
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
5805
|
+
address?: string;
|
|
5806
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
5807
|
+
point?: GoogleTypeLatLng;
|
|
5808
|
+
}
|
|
5695
5809
|
interface GoogleCloudDiscoveryengineV1betaUserLicense {
|
|
5696
5810
|
/** Output only. User created timestamp. */
|
|
5697
5811
|
createTime?: string;
|
|
@@ -5727,7 +5841,7 @@ declare namespace gapi.client {
|
|
|
5727
5841
|
name?: string;
|
|
5728
5842
|
}
|
|
5729
5843
|
interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
5730
|
-
/** Obfuscated Dasher customer ID. */
|
|
5844
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
5731
5845
|
dasherCustomerId?: string;
|
|
5732
5846
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
5733
5847
|
superAdminEmailAddress?: string;
|
|
@@ -5937,6 +6051,10 @@ declare namespace gapi.client {
|
|
|
5937
6051
|
/** Output only. List of citations. */
|
|
5938
6052
|
citations?: GoogleCloudDiscoveryengineV1Citation[];
|
|
5939
6053
|
}
|
|
6054
|
+
interface GoogleCloudDiscoveryengineV1CliConfig {
|
|
6055
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
6056
|
+
enabledActions?: string[];
|
|
6057
|
+
}
|
|
5940
6058
|
interface GoogleCloudDiscoveryengineV1CloudSqlSource {
|
|
5941
6059
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
5942
6060
|
databaseId?: string;
|
|
@@ -6275,6 +6393,8 @@ declare namespace gapi.client {
|
|
|
6275
6393
|
| 'ALLOWLIST_STATIC_IP'
|
|
6276
6394
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
6277
6395
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
6396
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
6397
|
+
cliConfig?: GoogleCloudDiscoveryengineV1CliConfig;
|
|
6278
6398
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
6279
6399
|
connectorModes?:
|
|
6280
6400
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -6283,6 +6403,8 @@ declare namespace gapi.client {
|
|
|
6283
6403
|
| 'FEDERATED'
|
|
6284
6404
|
| 'EUA'
|
|
6285
6405
|
| 'FEDERATED_AND_EUA'[];
|
|
6406
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
6407
|
+
connectorSourceId?: string;
|
|
6286
6408
|
/** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
|
|
6287
6409
|
connectorType?:
|
|
6288
6410
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -6310,7 +6432,7 @@ declare namespace gapi.client {
|
|
|
6310
6432
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
6311
6433
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
6312
6434
|
dynamicTools?: GoogleCloudDiscoveryengineV1DynamicTool[];
|
|
6313
|
-
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.
|
|
6435
|
+
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. */
|
|
6314
6436
|
egressFqdns?: string[];
|
|
6315
6437
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
6316
6438
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
@@ -6338,7 +6460,7 @@ declare namespace gapi.client {
|
|
|
6338
6460
|
lastSyncTime?: string;
|
|
6339
6461
|
/** Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. */
|
|
6340
6462
|
latestPauseTime?: string;
|
|
6341
|
-
/**
|
|
6463
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
6342
6464
|
name?: string;
|
|
6343
6465
|
/** Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. */
|
|
6344
6466
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -6380,7 +6502,7 @@ declare namespace gapi.client {
|
|
|
6380
6502
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
6381
6503
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
6382
6504
|
updateTime?: string;
|
|
6383
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
6505
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
6384
6506
|
vpcscEnabled?: boolean;
|
|
6385
6507
|
}
|
|
6386
6508
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
@@ -6638,6 +6760,20 @@ declare namespace gapi.client {
|
|
|
6638
6760
|
}
|
|
6639
6761
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest {}
|
|
6640
6762
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
6763
|
+
interface GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest {
|
|
6764
|
+
/** Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config. */
|
|
6765
|
+
licenseConfigId?: string;
|
|
6766
|
+
/** Required. The number of licenses to distribute. */
|
|
6767
|
+
licenseCount?: string;
|
|
6768
|
+
/** Required. The target GCP project region to distribute the license config to. */
|
|
6769
|
+
location?: string;
|
|
6770
|
+
/** Required. The target GCP project number to distribute the license config to. */
|
|
6771
|
+
projectNumber?: string;
|
|
6772
|
+
}
|
|
6773
|
+
interface GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse {
|
|
6774
|
+
/** The updated or created LicenseConfig. */
|
|
6775
|
+
licenseConfig?: GoogleCloudDiscoveryengineV1LicenseConfig;
|
|
6776
|
+
}
|
|
6641
6777
|
interface GoogleCloudDiscoveryengineV1Document {
|
|
6642
6778
|
/** Access control information for the document. */
|
|
6643
6779
|
aclInfo?: GoogleCloudDiscoveryengineV1DocumentAclInfo;
|
|
@@ -6649,7 +6785,7 @@ declare namespace gapi.client {
|
|
|
6649
6785
|
id?: string;
|
|
6650
6786
|
/** Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. */
|
|
6651
6787
|
indexStatus?: GoogleCloudDiscoveryengineV1DocumentIndexStatus;
|
|
6652
|
-
/** Output only. The
|
|
6788
|
+
/** Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed. */
|
|
6653
6789
|
indexTime?: string;
|
|
6654
6790
|
/** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
6655
6791
|
jsonData?: string;
|
|
@@ -6683,7 +6819,7 @@ declare namespace gapi.client {
|
|
|
6683
6819
|
interface GoogleCloudDiscoveryengineV1DocumentIndexStatus {
|
|
6684
6820
|
/** A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. */
|
|
6685
6821
|
errorSamples?: GoogleRpcStatus[];
|
|
6686
|
-
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. */
|
|
6822
|
+
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. */
|
|
6687
6823
|
indexTime?: string;
|
|
6688
6824
|
/** Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. */
|
|
6689
6825
|
pendingMessage?: string;
|
|
@@ -6808,7 +6944,7 @@ declare namespace gapi.client {
|
|
|
6808
6944
|
disableAnalytics?: boolean;
|
|
6809
6945
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
6810
6946
|
displayName?: string;
|
|
6811
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
6947
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
6812
6948
|
features?: {
|
|
6813
6949
|
[P in string]:
|
|
6814
6950
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6979,6 +7115,51 @@ declare namespace gapi.client {
|
|
|
6979
7115
|
/** The URI of the source. */
|
|
6980
7116
|
uri?: string;
|
|
6981
7117
|
}
|
|
7118
|
+
interface GoogleCloudDiscoveryengineV1Feedback {
|
|
7119
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
7120
|
+
comment?: string;
|
|
7121
|
+
/** Optional. The version of the component that this report is being sent from. */
|
|
7122
|
+
componentVersion?: string;
|
|
7123
|
+
/** The related conversation information when user gives feedback. */
|
|
7124
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1FeedbackConversationInfo;
|
|
7125
|
+
/** Optional. Whether the customer accepted data use terms. */
|
|
7126
|
+
dataTermsAccepted?: boolean;
|
|
7127
|
+
/** Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. */
|
|
7128
|
+
feedbackSource?:
|
|
7129
|
+
| 'FEEDBACK_SOURCE_UNSPECIFIED'
|
|
7130
|
+
| 'GOOGLE_CONSOLE'
|
|
7131
|
+
| 'GOOGLE_WIDGET'
|
|
7132
|
+
| 'GOOGLE_WEBAPP'
|
|
7133
|
+
| 'GOOGLE_AGENTSPACE_MOBILE';
|
|
7134
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
7135
|
+
feedbackType?: 'FEEDBACK_TYPE_UNSPECIFIED' | 'LIKE' | 'DISLIKE';
|
|
7136
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
7137
|
+
llmModelVersion?: string;
|
|
7138
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
7139
|
+
reasons?:
|
|
7140
|
+
| 'REASON_UNSPECIFIED'
|
|
7141
|
+
| 'INACCURATE_RESPONSE'
|
|
7142
|
+
| 'NOT_RELEVANT'
|
|
7143
|
+
| 'INCOMPREHENSIVE'
|
|
7144
|
+
| 'OFFENSIVE_OR_UNSAFE'
|
|
7145
|
+
| 'FORMAT_AND_STYLES'
|
|
7146
|
+
| 'BAD_CITATION'
|
|
7147
|
+
| 'CANVAS_NOT_GENERATED'
|
|
7148
|
+
| 'CANVAS_QUALITY_BAD'
|
|
7149
|
+
| 'CANVAS_EXPORT_FAILED'[];
|
|
7150
|
+
}
|
|
7151
|
+
interface GoogleCloudDiscoveryengineV1FeedbackConversationInfo {
|
|
7152
|
+
/** Optional. The token which could be used to fetch the answer log. */
|
|
7153
|
+
answerQueryToken?: string;
|
|
7154
|
+
/** Optional. The token which could be used to fetch the assistant log. */
|
|
7155
|
+
assistToken?: string;
|
|
7156
|
+
/** Required. The user's search query. */
|
|
7157
|
+
query?: GoogleCloudDiscoveryengineV1Query;
|
|
7158
|
+
/** The index of the user input within the conversation messages. */
|
|
7159
|
+
questionIndex?: number;
|
|
7160
|
+
/** Name of the newly generated or continued session. */
|
|
7161
|
+
session?: string;
|
|
7162
|
+
}
|
|
6982
7163
|
interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
|
|
6983
7164
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
6984
7165
|
nextPageToken?: string;
|
|
@@ -7211,7 +7392,7 @@ declare namespace gapi.client {
|
|
|
7211
7392
|
failureCount?: string;
|
|
7212
7393
|
/** Count of entries that were processed successfully. */
|
|
7213
7394
|
successCount?: string;
|
|
7214
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
7395
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
7215
7396
|
updateTime?: string;
|
|
7216
7397
|
}
|
|
7217
7398
|
interface GoogleCloudDiscoveryengineV1ImportUserEventsRequest {
|
|
@@ -7361,6 +7542,12 @@ declare namespace gapi.client {
|
|
|
7361
7542
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
7362
7543
|
nextPageToken?: string;
|
|
7363
7544
|
}
|
|
7545
|
+
interface GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse {
|
|
7546
|
+
/** All the customer's LicenseConfigs. */
|
|
7547
|
+
licenseConfigs?: GoogleCloudDiscoveryengineV1LicenseConfig[];
|
|
7548
|
+
/** Not supported. */
|
|
7549
|
+
nextPageToken?: string;
|
|
7550
|
+
}
|
|
7364
7551
|
interface GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
|
|
7365
7552
|
/** All the customer's LicenseConfigUsageStats. */
|
|
7366
7553
|
licenseConfigUsageStats?: GoogleCloudDiscoveryengineV1LicenseConfigUsageStats[];
|
|
@@ -7472,6 +7659,13 @@ declare namespace gapi.client {
|
|
|
7472
7659
|
startTime?: string;
|
|
7473
7660
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
7474
7661
|
terminateTime?: string;
|
|
7662
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
7663
|
+
updateType?:
|
|
7664
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
7665
|
+
| 'CREATE'
|
|
7666
|
+
| 'DELETE'
|
|
7667
|
+
| 'SCALE_UP'
|
|
7668
|
+
| 'SCALE_DOWN';
|
|
7475
7669
|
}
|
|
7476
7670
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
7477
7671
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -7625,7 +7819,7 @@ declare namespace gapi.client {
|
|
|
7625
7819
|
content?: string;
|
|
7626
7820
|
/** The unique ID to represent the record. */
|
|
7627
7821
|
id?: string;
|
|
7628
|
-
/** The score of this record based on the given query and selected model. The score will be rounded to
|
|
7822
|
+
/** The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset. */
|
|
7629
7823
|
score?: number;
|
|
7630
7824
|
/** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
7631
7825
|
title?: string;
|
|
@@ -7690,6 +7884,18 @@ declare namespace gapi.client {
|
|
|
7690
7884
|
/** Summary based on search results. */
|
|
7691
7885
|
summary?: GoogleCloudDiscoveryengineV1SearchResponseSummary;
|
|
7692
7886
|
}
|
|
7887
|
+
interface GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest {
|
|
7888
|
+
/** Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count. */
|
|
7889
|
+
fullRetract?: boolean;
|
|
7890
|
+
/** Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`. */
|
|
7891
|
+
licenseConfig?: string;
|
|
7892
|
+
/** Optional. The number of licenses to retract. Only used when full_retract is false. */
|
|
7893
|
+
licenseCount?: string;
|
|
7894
|
+
}
|
|
7895
|
+
interface GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse {
|
|
7896
|
+
/** The updated LicenseConfig. */
|
|
7897
|
+
licenseConfig?: GoogleCloudDiscoveryengineV1LicenseConfig;
|
|
7898
|
+
}
|
|
7693
7899
|
interface GoogleCloudDiscoveryengineV1SafetyRating {
|
|
7694
7900
|
/** Output only. Indicates whether the content was filtered out because of this rating. */
|
|
7695
7901
|
blocked?: boolean;
|
|
@@ -7761,10 +7967,14 @@ declare namespace gapi.client {
|
|
|
7761
7967
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
7762
7968
|
/** Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. */
|
|
7763
7969
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec[];
|
|
7970
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
7971
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams;
|
|
7764
7972
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
7765
7973
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[];
|
|
7766
7974
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
7767
7975
|
displaySpec?: GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec;
|
|
7976
|
+
/** Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. */
|
|
7977
|
+
entity?: string;
|
|
7768
7978
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
7769
7979
|
facetSpecs?: GoogleCloudDiscoveryengineV1SearchRequestFacetSpec[];
|
|
7770
7980
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -7795,7 +8005,7 @@ declare namespace gapi.client {
|
|
|
7795
8005
|
query?: string;
|
|
7796
8006
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
7797
8007
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec;
|
|
7798
|
-
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result */
|
|
8008
|
+
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results */
|
|
7799
8009
|
rankingExpression?: string;
|
|
7800
8010
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
7801
8011
|
rankingExpressionBackend?:
|
|
@@ -7940,6 +8150,10 @@ declare namespace gapi.client {
|
|
|
7940
8150
|
| 'DROP_CROWDED_RESULTS'
|
|
7941
8151
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
7942
8152
|
}
|
|
8153
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams {
|
|
8154
|
+
/** Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. */
|
|
8155
|
+
expressionsToPrecompute?: string[];
|
|
8156
|
+
}
|
|
7943
8157
|
interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
|
|
7944
8158
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
7945
8159
|
boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
|
|
@@ -8002,7 +8216,7 @@ declare namespace gapi.client {
|
|
|
8002
8216
|
| 'CONDITION_UNSPECIFIED'
|
|
8003
8217
|
| 'DISABLED'
|
|
8004
8218
|
| 'ENABLED';
|
|
8005
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
8219
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
8006
8220
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
8007
8221
|
}
|
|
8008
8222
|
interface GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec {
|
|
@@ -8174,6 +8388,8 @@ declare namespace gapi.client {
|
|
|
8174
8388
|
keywordSimilarityScore?: number;
|
|
8175
8389
|
/** Optional. Predicted conversion rate adjustment as a rank. */
|
|
8176
8390
|
pctrRank?: number;
|
|
8391
|
+
/** Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. */
|
|
8392
|
+
precomputedExpressionValues?: number[];
|
|
8177
8393
|
/** Optional. Semantic relevance adjustment. */
|
|
8178
8394
|
relevanceScore?: number;
|
|
8179
8395
|
/** Optional. Semantic similarity adjustment. */
|
|
@@ -8335,6 +8551,8 @@ declare namespace gapi.client {
|
|
|
8335
8551
|
labels?: string[];
|
|
8336
8552
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
8337
8553
|
name?: string;
|
|
8554
|
+
/** Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes. */
|
|
8555
|
+
pendingAsyncAssistOperationId?: string;
|
|
8338
8556
|
/** Output only. The time the session started. */
|
|
8339
8557
|
startTime?: string;
|
|
8340
8558
|
/** The state of the session. */
|
|
@@ -8351,6 +8569,8 @@ declare namespace gapi.client {
|
|
|
8351
8569
|
detailedAnswer?: GoogleCloudDiscoveryengineV1Answer;
|
|
8352
8570
|
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. */
|
|
8353
8571
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1AssistAnswer;
|
|
8572
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
8573
|
+
live?: boolean;
|
|
8354
8574
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
8355
8575
|
query?: GoogleCloudDiscoveryengineV1Query;
|
|
8356
8576
|
/** Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix "google." is reserved for Google-developed functionality. */
|
|
@@ -8445,9 +8665,17 @@ declare namespace gapi.client {
|
|
|
8445
8665
|
assistToken?: string;
|
|
8446
8666
|
/** The tool names of the tools that were invoked. */
|
|
8447
8667
|
invocationTools?: string[];
|
|
8668
|
+
/** The skills executed during the turn. */
|
|
8669
|
+
invokedSkills?: GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill[];
|
|
8448
8670
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
8449
8671
|
sessionInfo?: GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo;
|
|
8450
8672
|
}
|
|
8673
|
+
interface GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill {
|
|
8674
|
+
/** The display name of the skill. */
|
|
8675
|
+
displayName?: string;
|
|
8676
|
+
/** The resource name of the skill. */
|
|
8677
|
+
name?: string;
|
|
8678
|
+
}
|
|
8451
8679
|
interface GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo {
|
|
8452
8680
|
/** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
|
|
8453
8681
|
session?: string;
|
|
@@ -8602,6 +8830,8 @@ declare namespace gapi.client {
|
|
|
8602
8830
|
eventTime?: string;
|
|
8603
8831
|
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */
|
|
8604
8832
|
eventType?: string;
|
|
8833
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
8834
|
+
feedback?: GoogleCloudDiscoveryengineV1Feedback;
|
|
8605
8835
|
/** Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
8606
8836
|
filter?: string;
|
|
8607
8837
|
/** Media-specific info. */
|
|
@@ -8628,6 +8858,8 @@ declare namespace gapi.client {
|
|
|
8628
8858
|
userPseudoId?: string;
|
|
8629
8859
|
}
|
|
8630
8860
|
interface GoogleCloudDiscoveryengineV1UserInfo {
|
|
8861
|
+
/** Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. */
|
|
8862
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1UserInfoPreciseLocation;
|
|
8631
8863
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
8632
8864
|
timeZone?: string;
|
|
8633
8865
|
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
@@ -8635,6 +8867,12 @@ declare namespace gapi.client {
|
|
|
8635
8867
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
|
|
8636
8868
|
userId?: string;
|
|
8637
8869
|
}
|
|
8870
|
+
interface GoogleCloudDiscoveryengineV1UserInfoPreciseLocation {
|
|
8871
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
8872
|
+
address?: string;
|
|
8873
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
8874
|
+
point?: GoogleTypeLatLng;
|
|
8875
|
+
}
|
|
8638
8876
|
interface GoogleCloudDiscoveryengineV1UserLicense {
|
|
8639
8877
|
/** Output only. User created timestamp. */
|
|
8640
8878
|
createTime?: string;
|
|
@@ -8911,7 +9149,7 @@ declare namespace gapi.client {
|
|
|
8911
9149
|
enableSearchAsYouType?: boolean;
|
|
8912
9150
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
8913
9151
|
enableVisualContentSummary?: boolean;
|
|
8914
|
-
/** Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
9152
|
+
/** Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
8915
9153
|
features?: {
|
|
8916
9154
|
[P in string]:
|
|
8917
9155
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -8926,6 +9164,8 @@ declare namespace gapi.client {
|
|
|
8926
9164
|
| 'SEARCH_ONLY'
|
|
8927
9165
|
| 'SEARCH_WITH_ANSWER'
|
|
8928
9166
|
| 'SEARCH_WITH_FOLLOW_UPS';
|
|
9167
|
+
/** Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. */
|
|
9168
|
+
modelConfigInfo?: GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo;
|
|
8929
9169
|
/** Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
8930
9170
|
modelConfigs?: {
|
|
8931
9171
|
[P in string]:
|
|
@@ -8965,8 +9205,26 @@ declare namespace gapi.client {
|
|
|
8965
9205
|
/** The number of top results to generate the answer from. Up to 10. */
|
|
8966
9206
|
resultCount?: number;
|
|
8967
9207
|
}
|
|
9208
|
+
interface GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo {
|
|
9209
|
+
/** 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`. */
|
|
9210
|
+
defaultModelId?: string;
|
|
9211
|
+
/** Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. */
|
|
9212
|
+
resolvedModels?: GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel[];
|
|
9213
|
+
}
|
|
9214
|
+
interface GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel {
|
|
9215
|
+
/** Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. */
|
|
9216
|
+
description?: string;
|
|
9217
|
+
/** Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. */
|
|
9218
|
+
displayName?: string;
|
|
9219
|
+
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
9220
|
+
icon?: string;
|
|
9221
|
+
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
9222
|
+
isPreview?: boolean;
|
|
9223
|
+
/** Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. */
|
|
9224
|
+
modelId?: string;
|
|
9225
|
+
}
|
|
8968
9226
|
interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
8969
|
-
/** Obfuscated Dasher customer ID. */
|
|
9227
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
8970
9228
|
dasherCustomerId?: string;
|
|
8971
9229
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
8972
9230
|
superAdminEmailAddress?: string;
|
|
@@ -9079,7 +9337,7 @@ declare namespace gapi.client {
|
|
|
9079
9337
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
9080
9338
|
code?: number;
|
|
9081
9339
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
9082
|
-
details?:
|
|
9340
|
+
details?: {[P in string]: any}[];
|
|
9083
9341
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
9084
9342
|
message?: string;
|
|
9085
9343
|
}
|
|
@@ -9121,12 +9379,139 @@ declare namespace gapi.client {
|
|
|
9121
9379
|
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
9122
9380
|
title?: string;
|
|
9123
9381
|
}
|
|
9382
|
+
interface GoogleTypeLatLng {
|
|
9383
|
+
/** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
|
|
9384
|
+
latitude?: number;
|
|
9385
|
+
/** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
|
|
9386
|
+
longitude?: number;
|
|
9387
|
+
}
|
|
9124
9388
|
interface GoogleTypeTimeZone {
|
|
9125
9389
|
/** IANA Time Zone Database time zone. For example "America/New_York". */
|
|
9126
9390
|
id?: string;
|
|
9127
9391
|
/** Optional. IANA Time Zone Database version number. For example "2019a". */
|
|
9128
9392
|
version?: string;
|
|
9129
9393
|
}
|
|
9394
|
+
interface BillingAccountLicenseConfigsResource {
|
|
9395
|
+
/** Distributes a LicenseConfig from billing account level to project level. */
|
|
9396
|
+
distributeLicenseConfig(request: {
|
|
9397
|
+
/** V1 error format. */
|
|
9398
|
+
'$.xgafv'?: '1' | '2';
|
|
9399
|
+
/** OAuth access token. */
|
|
9400
|
+
access_token?: string;
|
|
9401
|
+
/** Data format for response. */
|
|
9402
|
+
alt?: 'json' | 'media' | 'proto';
|
|
9403
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
9404
|
+
billingAccountLicenseConfig: string;
|
|
9405
|
+
/** JSONP */
|
|
9406
|
+
callback?: string;
|
|
9407
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9408
|
+
fields?: string;
|
|
9409
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9410
|
+
key?: string;
|
|
9411
|
+
/** OAuth 2.0 token for the current user. */
|
|
9412
|
+
oauth_token?: string;
|
|
9413
|
+
/** Returns response with indentations and line breaks. */
|
|
9414
|
+
prettyPrint?: boolean;
|
|
9415
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9416
|
+
quotaUser?: string;
|
|
9417
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9418
|
+
upload_protocol?: string;
|
|
9419
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9420
|
+
uploadType?: string;
|
|
9421
|
+
/** Request body */
|
|
9422
|
+
resource: GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest;
|
|
9423
|
+
}): Request<GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse>;
|
|
9424
|
+
distributeLicenseConfig(
|
|
9425
|
+
request: {
|
|
9426
|
+
/** V1 error format. */
|
|
9427
|
+
'$.xgafv'?: '1' | '2';
|
|
9428
|
+
/** OAuth access token. */
|
|
9429
|
+
access_token?: string;
|
|
9430
|
+
/** Data format for response. */
|
|
9431
|
+
alt?: 'json' | 'media' | 'proto';
|
|
9432
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
9433
|
+
billingAccountLicenseConfig: string;
|
|
9434
|
+
/** JSONP */
|
|
9435
|
+
callback?: string;
|
|
9436
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9437
|
+
fields?: string;
|
|
9438
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9439
|
+
key?: string;
|
|
9440
|
+
/** OAuth 2.0 token for the current user. */
|
|
9441
|
+
oauth_token?: string;
|
|
9442
|
+
/** Returns response with indentations and line breaks. */
|
|
9443
|
+
prettyPrint?: boolean;
|
|
9444
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9445
|
+
quotaUser?: string;
|
|
9446
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9447
|
+
upload_protocol?: string;
|
|
9448
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9449
|
+
uploadType?: string;
|
|
9450
|
+
},
|
|
9451
|
+
body: GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest,
|
|
9452
|
+
): Request<GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse>;
|
|
9453
|
+
/** This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account. */
|
|
9454
|
+
retractLicenseConfig(request: {
|
|
9455
|
+
/** V1 error format. */
|
|
9456
|
+
'$.xgafv'?: '1' | '2';
|
|
9457
|
+
/** OAuth access token. */
|
|
9458
|
+
access_token?: string;
|
|
9459
|
+
/** Data format for response. */
|
|
9460
|
+
alt?: 'json' | 'media' | 'proto';
|
|
9461
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
9462
|
+
billingAccountLicenseConfig: string;
|
|
9463
|
+
/** JSONP */
|
|
9464
|
+
callback?: string;
|
|
9465
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9466
|
+
fields?: string;
|
|
9467
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9468
|
+
key?: string;
|
|
9469
|
+
/** OAuth 2.0 token for the current user. */
|
|
9470
|
+
oauth_token?: string;
|
|
9471
|
+
/** Returns response with indentations and line breaks. */
|
|
9472
|
+
prettyPrint?: boolean;
|
|
9473
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9474
|
+
quotaUser?: string;
|
|
9475
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9476
|
+
upload_protocol?: string;
|
|
9477
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9478
|
+
uploadType?: string;
|
|
9479
|
+
/** Request body */
|
|
9480
|
+
resource: GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest;
|
|
9481
|
+
}): Request<GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse>;
|
|
9482
|
+
retractLicenseConfig(
|
|
9483
|
+
request: {
|
|
9484
|
+
/** V1 error format. */
|
|
9485
|
+
'$.xgafv'?: '1' | '2';
|
|
9486
|
+
/** OAuth access token. */
|
|
9487
|
+
access_token?: string;
|
|
9488
|
+
/** Data format for response. */
|
|
9489
|
+
alt?: 'json' | 'media' | 'proto';
|
|
9490
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
9491
|
+
billingAccountLicenseConfig: string;
|
|
9492
|
+
/** JSONP */
|
|
9493
|
+
callback?: string;
|
|
9494
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9495
|
+
fields?: string;
|
|
9496
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9497
|
+
key?: string;
|
|
9498
|
+
/** OAuth 2.0 token for the current user. */
|
|
9499
|
+
oauth_token?: string;
|
|
9500
|
+
/** Returns response with indentations and line breaks. */
|
|
9501
|
+
prettyPrint?: boolean;
|
|
9502
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9503
|
+
quotaUser?: string;
|
|
9504
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9505
|
+
upload_protocol?: string;
|
|
9506
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9507
|
+
uploadType?: string;
|
|
9508
|
+
},
|
|
9509
|
+
body: GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest,
|
|
9510
|
+
): Request<GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse>;
|
|
9511
|
+
}
|
|
9512
|
+
interface BillingAccountsResource {
|
|
9513
|
+
billingAccountLicenseConfigs: BillingAccountLicenseConfigsResource;
|
|
9514
|
+
}
|
|
9130
9515
|
interface CmekConfigsResource {
|
|
9131
9516
|
/** De-provisions a CmekConfig. */
|
|
9132
9517
|
delete(request?: {
|
|
@@ -9337,6 +9722,40 @@ declare namespace gapi.client {
|
|
|
9337
9722
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
9338
9723
|
}
|
|
9339
9724
|
interface DataConnectorResource {
|
|
9725
|
+
/** ServeMcpDeleteRequest serves a MCP DELETE request. */
|
|
9726
|
+
mcp(request?: {
|
|
9727
|
+
/** V1 error format. */
|
|
9728
|
+
'$.xgafv'?: '1' | '2';
|
|
9729
|
+
/** OAuth access token. */
|
|
9730
|
+
access_token?: string;
|
|
9731
|
+
/** Data format for response. */
|
|
9732
|
+
alt?: 'json' | 'media' | 'proto';
|
|
9733
|
+
/** JSONP */
|
|
9734
|
+
callback?: string;
|
|
9735
|
+
collectionsId: string;
|
|
9736
|
+
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
9737
|
+
contentType?: string;
|
|
9738
|
+
/** The HTTP request/response body as raw binary. */
|
|
9739
|
+
data?: string;
|
|
9740
|
+
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
9741
|
+
extensions?: {[P in string]: any};
|
|
9742
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9743
|
+
fields?: string;
|
|
9744
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9745
|
+
key?: string;
|
|
9746
|
+
locationsId: string;
|
|
9747
|
+
/** OAuth 2.0 token for the current user. */
|
|
9748
|
+
oauth_token?: string;
|
|
9749
|
+
/** Returns response with indentations and line breaks. */
|
|
9750
|
+
prettyPrint?: boolean;
|
|
9751
|
+
projectsId: string;
|
|
9752
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9753
|
+
quotaUser?: string;
|
|
9754
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9755
|
+
upload_protocol?: string;
|
|
9756
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9757
|
+
uploadType?: string;
|
|
9758
|
+
}): Request<GoogleApiHttpBody>;
|
|
9340
9759
|
operations: OperationsResource;
|
|
9341
9760
|
}
|
|
9342
9761
|
interface DocumentsResource {
|
|
@@ -10944,7 +11363,7 @@ declare namespace gapi.client {
|
|
|
10944
11363
|
prettyPrint?: boolean;
|
|
10945
11364
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
10946
11365
|
quotaUser?: string;
|
|
10947
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11366
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
10948
11367
|
servingConfig: string;
|
|
10949
11368
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10950
11369
|
upload_protocol?: string;
|
|
@@ -10973,7 +11392,7 @@ declare namespace gapi.client {
|
|
|
10973
11392
|
prettyPrint?: boolean;
|
|
10974
11393
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
10975
11394
|
quotaUser?: string;
|
|
10976
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11395
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
10977
11396
|
servingConfig: string;
|
|
10978
11397
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10979
11398
|
upload_protocol?: string;
|
|
@@ -11385,7 +11804,7 @@ declare namespace gapi.client {
|
|
|
11385
11804
|
prettyPrint?: boolean;
|
|
11386
11805
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11387
11806
|
quotaUser?: string;
|
|
11388
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11807
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11389
11808
|
servingConfig: string;
|
|
11390
11809
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11391
11810
|
upload_protocol?: string;
|
|
@@ -11414,7 +11833,7 @@ declare namespace gapi.client {
|
|
|
11414
11833
|
prettyPrint?: boolean;
|
|
11415
11834
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11416
11835
|
quotaUser?: string;
|
|
11417
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11836
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11418
11837
|
servingConfig: string;
|
|
11419
11838
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11420
11839
|
upload_protocol?: string;
|
|
@@ -11476,6 +11895,8 @@ declare namespace gapi.client {
|
|
|
11476
11895
|
prettyPrint?: boolean;
|
|
11477
11896
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11478
11897
|
quotaUser?: string;
|
|
11898
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
11899
|
+
sessionId?: string;
|
|
11479
11900
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11480
11901
|
upload_protocol?: string;
|
|
11481
11902
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11505,6 +11926,8 @@ declare namespace gapi.client {
|
|
|
11505
11926
|
prettyPrint?: boolean;
|
|
11506
11927
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11507
11928
|
quotaUser?: string;
|
|
11929
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
11930
|
+
sessionId?: string;
|
|
11508
11931
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11509
11932
|
upload_protocol?: string;
|
|
11510
11933
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11586,7 +12009,7 @@ declare namespace gapi.client {
|
|
|
11586
12009
|
key?: string;
|
|
11587
12010
|
/** OAuth 2.0 token for the current user. */
|
|
11588
12011
|
oauth_token?: string;
|
|
11589
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
12012
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
11590
12013
|
orderBy?: string;
|
|
11591
12014
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
11592
12015
|
pageSize?: number;
|
|
@@ -13349,35 +13772,6 @@ declare namespace gapi.client {
|
|
|
13349
13772
|
body: A2aV1SendMessageRequest,
|
|
13350
13773
|
): Request<A2aV1StreamResponse>;
|
|
13351
13774
|
}
|
|
13352
|
-
interface OperationsResource {
|
|
13353
|
-
/** 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. */
|
|
13354
|
-
get(request?: {
|
|
13355
|
-
/** V1 error format. */
|
|
13356
|
-
'$.xgafv'?: '1' | '2';
|
|
13357
|
-
/** OAuth access token. */
|
|
13358
|
-
access_token?: string;
|
|
13359
|
-
/** Data format for response. */
|
|
13360
|
-
alt?: 'json' | 'media' | 'proto';
|
|
13361
|
-
/** JSONP */
|
|
13362
|
-
callback?: string;
|
|
13363
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
13364
|
-
fields?: string;
|
|
13365
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
13366
|
-
key?: string;
|
|
13367
|
-
/** The name of the operation resource. */
|
|
13368
|
-
name: string;
|
|
13369
|
-
/** OAuth 2.0 token for the current user. */
|
|
13370
|
-
oauth_token?: string;
|
|
13371
|
-
/** Returns response with indentations and line breaks. */
|
|
13372
|
-
prettyPrint?: boolean;
|
|
13373
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
13374
|
-
quotaUser?: string;
|
|
13375
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13376
|
-
upload_protocol?: string;
|
|
13377
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13378
|
-
uploadType?: string;
|
|
13379
|
-
}): Request<GoogleLongrunningOperation>;
|
|
13380
|
-
}
|
|
13381
13775
|
interface PushNotificationConfigsResource {
|
|
13382
13776
|
/** Set a push notification config for a task. */
|
|
13383
13777
|
create(request: {
|
|
@@ -13662,7 +14056,7 @@ declare namespace gapi.client {
|
|
|
13662
14056
|
}): Request<A2aV1StreamResponse>;
|
|
13663
14057
|
pushNotificationConfigs: PushNotificationConfigsResource;
|
|
13664
14058
|
}
|
|
13665
|
-
interface
|
|
14059
|
+
interface V1Resource {
|
|
13666
14060
|
/** GetAgentCard returns the agent card for the agent. */
|
|
13667
14061
|
getCard(request?: {
|
|
13668
14062
|
/** V1 error format. */
|
|
@@ -13691,9 +14085,44 @@ declare namespace gapi.client {
|
|
|
13691
14085
|
uploadType?: string;
|
|
13692
14086
|
}): Request<A2aV1AgentCard>;
|
|
13693
14087
|
message: MessageResource;
|
|
13694
|
-
operations: OperationsResource;
|
|
13695
14088
|
tasks: TasksResource;
|
|
13696
14089
|
}
|
|
14090
|
+
interface A2aResource {
|
|
14091
|
+
v1: V1Resource;
|
|
14092
|
+
}
|
|
14093
|
+
interface OperationsResource {
|
|
14094
|
+
/** 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. */
|
|
14095
|
+
get(request?: {
|
|
14096
|
+
/** V1 error format. */
|
|
14097
|
+
'$.xgafv'?: '1' | '2';
|
|
14098
|
+
/** OAuth access token. */
|
|
14099
|
+
access_token?: string;
|
|
14100
|
+
/** Data format for response. */
|
|
14101
|
+
alt?: 'json' | 'media' | 'proto';
|
|
14102
|
+
/** JSONP */
|
|
14103
|
+
callback?: string;
|
|
14104
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
14105
|
+
fields?: string;
|
|
14106
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
14107
|
+
key?: string;
|
|
14108
|
+
/** The name of the operation resource. */
|
|
14109
|
+
name: string;
|
|
14110
|
+
/** OAuth 2.0 token for the current user. */
|
|
14111
|
+
oauth_token?: string;
|
|
14112
|
+
/** Returns response with indentations and line breaks. */
|
|
14113
|
+
prettyPrint?: boolean;
|
|
14114
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
14115
|
+
quotaUser?: string;
|
|
14116
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14117
|
+
upload_protocol?: string;
|
|
14118
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14119
|
+
uploadType?: string;
|
|
14120
|
+
}): Request<GoogleLongrunningOperation>;
|
|
14121
|
+
}
|
|
14122
|
+
interface AgentsResource {
|
|
14123
|
+
a2a: A2aResource;
|
|
14124
|
+
operations: OperationsResource;
|
|
14125
|
+
}
|
|
13697
14126
|
interface AssistantsResource {
|
|
13698
14127
|
/** Creates an Assistant. */
|
|
13699
14128
|
create(request: {
|
|
@@ -14649,7 +15078,7 @@ declare namespace gapi.client {
|
|
|
14649
15078
|
prettyPrint?: boolean;
|
|
14650
15079
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
14651
15080
|
quotaUser?: string;
|
|
14652
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15081
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
14653
15082
|
servingConfig: string;
|
|
14654
15083
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14655
15084
|
upload_protocol?: string;
|
|
@@ -14678,7 +15107,7 @@ declare namespace gapi.client {
|
|
|
14678
15107
|
prettyPrint?: boolean;
|
|
14679
15108
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
14680
15109
|
quotaUser?: string;
|
|
14681
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15110
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
14682
15111
|
servingConfig: string;
|
|
14683
15112
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14684
15113
|
upload_protocol?: string;
|
|
@@ -15090,7 +15519,7 @@ declare namespace gapi.client {
|
|
|
15090
15519
|
prettyPrint?: boolean;
|
|
15091
15520
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
15092
15521
|
quotaUser?: string;
|
|
15093
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15522
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15094
15523
|
servingConfig: string;
|
|
15095
15524
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15096
15525
|
upload_protocol?: string;
|
|
@@ -15119,7 +15548,7 @@ declare namespace gapi.client {
|
|
|
15119
15548
|
prettyPrint?: boolean;
|
|
15120
15549
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
15121
15550
|
quotaUser?: string;
|
|
15122
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15551
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
15123
15552
|
servingConfig: string;
|
|
15124
15553
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15125
15554
|
upload_protocol?: string;
|
|
@@ -15181,6 +15610,8 @@ declare namespace gapi.client {
|
|
|
15181
15610
|
prettyPrint?: boolean;
|
|
15182
15611
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
15183
15612
|
quotaUser?: string;
|
|
15613
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
15614
|
+
sessionId?: string;
|
|
15184
15615
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15185
15616
|
upload_protocol?: string;
|
|
15186
15617
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -15210,6 +15641,8 @@ declare namespace gapi.client {
|
|
|
15210
15641
|
prettyPrint?: boolean;
|
|
15211
15642
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
15212
15643
|
quotaUser?: string;
|
|
15644
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
15645
|
+
sessionId?: string;
|
|
15213
15646
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15214
15647
|
upload_protocol?: string;
|
|
15215
15648
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -15291,7 +15724,7 @@ declare namespace gapi.client {
|
|
|
15291
15724
|
key?: string;
|
|
15292
15725
|
/** OAuth 2.0 token for the current user. */
|
|
15293
15726
|
oauth_token?: string;
|
|
15294
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
15727
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
15295
15728
|
orderBy?: string;
|
|
15296
15729
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
15297
15730
|
pageSize?: number;
|
|
@@ -15708,7 +16141,7 @@ declare namespace gapi.client {
|
|
|
15708
16141
|
},
|
|
15709
16142
|
body: GoogleCloudDiscoveryengineV1Engine,
|
|
15710
16143
|
): Request<GoogleCloudDiscoveryengineV1Engine>;
|
|
15711
|
-
/** Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user`
|
|
16144
|
+
/** Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. */
|
|
15712
16145
|
setIamPolicy(
|
|
15713
16146
|
request: {
|
|
15714
16147
|
/** V1 error format. */
|
|
@@ -15880,7 +16313,7 @@ declare namespace gapi.client {
|
|
|
15880
16313
|
fields?: string;
|
|
15881
16314
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
15882
16315
|
key?: string;
|
|
15883
|
-
/**
|
|
16316
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
15884
16317
|
name: string;
|
|
15885
16318
|
/** OAuth 2.0 token for the current user. */
|
|
15886
16319
|
oauth_token?: string;
|
|
@@ -15911,7 +16344,7 @@ declare namespace gapi.client {
|
|
|
15911
16344
|
fields?: string;
|
|
15912
16345
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
15913
16346
|
key?: string;
|
|
15914
|
-
/**
|
|
16347
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
15915
16348
|
name: string;
|
|
15916
16349
|
/** OAuth 2.0 token for the current user. */
|
|
15917
16350
|
oauth_token?: string;
|
|
@@ -17444,7 +17877,7 @@ declare namespace gapi.client {
|
|
|
17444
17877
|
prettyPrint?: boolean;
|
|
17445
17878
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
17446
17879
|
quotaUser?: string;
|
|
17447
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17880
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17448
17881
|
servingConfig: string;
|
|
17449
17882
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17450
17883
|
upload_protocol?: string;
|
|
@@ -17473,7 +17906,7 @@ declare namespace gapi.client {
|
|
|
17473
17906
|
prettyPrint?: boolean;
|
|
17474
17907
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
17475
17908
|
quotaUser?: string;
|
|
17476
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17909
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17477
17910
|
servingConfig: string;
|
|
17478
17911
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17479
17912
|
upload_protocol?: string;
|
|
@@ -17885,7 +18318,7 @@ declare namespace gapi.client {
|
|
|
17885
18318
|
prettyPrint?: boolean;
|
|
17886
18319
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
17887
18320
|
quotaUser?: string;
|
|
17888
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
18321
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17889
18322
|
servingConfig: string;
|
|
17890
18323
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17891
18324
|
upload_protocol?: string;
|
|
@@ -17914,7 +18347,7 @@ declare namespace gapi.client {
|
|
|
17914
18347
|
prettyPrint?: boolean;
|
|
17915
18348
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
17916
18349
|
quotaUser?: string;
|
|
17917
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
18350
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17918
18351
|
servingConfig: string;
|
|
17919
18352
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17920
18353
|
upload_protocol?: string;
|
|
@@ -17976,6 +18409,8 @@ declare namespace gapi.client {
|
|
|
17976
18409
|
prettyPrint?: boolean;
|
|
17977
18410
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
17978
18411
|
quotaUser?: string;
|
|
18412
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
18413
|
+
sessionId?: string;
|
|
17979
18414
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17980
18415
|
upload_protocol?: string;
|
|
17981
18416
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -18005,6 +18440,8 @@ declare namespace gapi.client {
|
|
|
18005
18440
|
prettyPrint?: boolean;
|
|
18006
18441
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
18007
18442
|
quotaUser?: string;
|
|
18443
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
18444
|
+
sessionId?: string;
|
|
18008
18445
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18009
18446
|
upload_protocol?: string;
|
|
18010
18447
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -18086,7 +18523,7 @@ declare namespace gapi.client {
|
|
|
18086
18523
|
key?: string;
|
|
18087
18524
|
/** OAuth 2.0 token for the current user. */
|
|
18088
18525
|
oauth_token?: string;
|
|
18089
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
18526
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
18090
18527
|
orderBy?: string;
|
|
18091
18528
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
18092
18529
|
pageSize?: number;
|
|
@@ -19972,6 +20409,39 @@ declare namespace gapi.client {
|
|
|
19972
20409
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19973
20410
|
uploadType?: string;
|
|
19974
20411
|
}): Request<GoogleCloudDiscoveryengineV1LicenseConfig>;
|
|
20412
|
+
/** Lists all the LicenseConfigs associated with the project. */
|
|
20413
|
+
list(request?: {
|
|
20414
|
+
/** V1 error format. */
|
|
20415
|
+
'$.xgafv'?: '1' | '2';
|
|
20416
|
+
/** OAuth access token. */
|
|
20417
|
+
access_token?: string;
|
|
20418
|
+
/** Data format for response. */
|
|
20419
|
+
alt?: 'json' | 'media' | 'proto';
|
|
20420
|
+
/** JSONP */
|
|
20421
|
+
callback?: string;
|
|
20422
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
20423
|
+
fields?: string;
|
|
20424
|
+
/** Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. */
|
|
20425
|
+
filter?: string;
|
|
20426
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
20427
|
+
key?: string;
|
|
20428
|
+
/** OAuth 2.0 token for the current user. */
|
|
20429
|
+
oauth_token?: string;
|
|
20430
|
+
/** Optional. Not supported. */
|
|
20431
|
+
pageSize?: number;
|
|
20432
|
+
/** Optional. Not supported. */
|
|
20433
|
+
pageToken?: string;
|
|
20434
|
+
/** Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. */
|
|
20435
|
+
parent: string;
|
|
20436
|
+
/** Returns response with indentations and line breaks. */
|
|
20437
|
+
prettyPrint?: boolean;
|
|
20438
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
20439
|
+
quotaUser?: string;
|
|
20440
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20441
|
+
upload_protocol?: string;
|
|
20442
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
20443
|
+
uploadType?: string;
|
|
20444
|
+
}): Request<GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>;
|
|
19975
20445
|
/** Updates the LicenseConfig */
|
|
19976
20446
|
patch(request: {
|
|
19977
20447
|
/** V1 error format. */
|
|
@@ -20388,13 +20858,15 @@ declare namespace gapi.client {
|
|
|
20388
20858
|
callback?: string;
|
|
20389
20859
|
/** Selector specifying which fields to include in a partial response. */
|
|
20390
20860
|
fields?: string;
|
|
20861
|
+
/** Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`. */
|
|
20862
|
+
filter?: string;
|
|
20391
20863
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
20392
20864
|
key?: string;
|
|
20393
20865
|
/** OAuth 2.0 token for the current user. */
|
|
20394
20866
|
oauth_token?: string;
|
|
20395
|
-
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields
|
|
20867
|
+
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order. */
|
|
20396
20868
|
orderBy?: string;
|
|
20397
|
-
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
20869
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. */
|
|
20398
20870
|
pageSize?: number;
|
|
20399
20871
|
/** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
|
|
20400
20872
|
pageToken?: string;
|
|
@@ -21057,6 +21529,8 @@ declare namespace gapi.client {
|
|
|
21057
21529
|
operations: OperationsResource;
|
|
21058
21530
|
}
|
|
21059
21531
|
|
|
21532
|
+
const billingAccounts: BillingAccountsResource;
|
|
21533
|
+
|
|
21060
21534
|
const projects: ProjectsResource;
|
|
21061
21535
|
}
|
|
21062
21536
|
}
|