@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +452 -50
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260531
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -74,7 +74,7 @@ declare namespace gapi.client {
|
|
|
74
74
|
}
|
|
75
75
|
interface GoogleApiDistributionExemplar {
|
|
76
76
|
/** 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. */
|
|
77
|
-
attachments?:
|
|
77
|
+
attachments?: {[P in string]: any}[];
|
|
78
78
|
/** The observation (sampling) time of the above value. */
|
|
79
79
|
timestamp?: string;
|
|
80
80
|
/** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
|
|
@@ -92,7 +92,7 @@ declare namespace gapi.client {
|
|
|
92
92
|
/** The HTTP request/response body as raw binary. */
|
|
93
93
|
data?: string;
|
|
94
94
|
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
95
|
-
extensions?:
|
|
95
|
+
extensions?: {[P in string]: any}[];
|
|
96
96
|
}
|
|
97
97
|
interface GoogleApiMetric {
|
|
98
98
|
/** The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values. */
|
|
@@ -185,6 +185,8 @@ declare namespace gapi.client {
|
|
|
185
185
|
interface GoogleCloudDiscoveryengineV1ActionConfig {
|
|
186
186
|
/** Optional. Action parameters in structured json format. */
|
|
187
187
|
actionParams?: {[P in string]: any};
|
|
188
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
189
|
+
createBapConnection?: boolean;
|
|
188
190
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
189
191
|
isActionConfigured?: boolean;
|
|
190
192
|
/** Optional. Action parameters in json string format. */
|
|
@@ -237,6 +239,8 @@ declare namespace gapi.client {
|
|
|
237
239
|
interface GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
238
240
|
/** Optional. Action parameters in structured json format. */
|
|
239
241
|
actionParams?: {[P in string]: any};
|
|
242
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
243
|
+
createBapConnection?: boolean;
|
|
240
244
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
241
245
|
isActionConfigured?: boolean;
|
|
242
246
|
/** Optional. Action parameters in json string format. */
|
|
@@ -323,7 +327,7 @@ declare namespace gapi.client {
|
|
|
323
327
|
| 'UNHELPFUL_ANSWER'[];
|
|
324
328
|
/** The textual answer. */
|
|
325
329
|
answerText?: string;
|
|
326
|
-
/** List of blob attachments in the answer. */
|
|
330
|
+
/** Output only. List of blob attachments in the answer. */
|
|
327
331
|
blobAttachments?: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment[];
|
|
328
332
|
/** Citations. */
|
|
329
333
|
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
@@ -541,7 +545,8 @@ declare namespace gapi.client {
|
|
|
541
545
|
| 'IN_PROGRESS'
|
|
542
546
|
| 'FAILED'
|
|
543
547
|
| 'SUCCEEDED'
|
|
544
|
-
| 'SKIPPED'
|
|
548
|
+
| 'SKIPPED'
|
|
549
|
+
| 'CANCELLED';
|
|
545
550
|
}
|
|
546
551
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
547
552
|
/** 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. */
|
|
@@ -566,6 +571,8 @@ declare namespace gapi.client {
|
|
|
566
571
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
567
572
|
}
|
|
568
573
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
574
|
+
/** The time when the reply was created. */
|
|
575
|
+
createTime?: string;
|
|
569
576
|
/** Possibly grounded response text or media from the assistant. */
|
|
570
577
|
groundedContent?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
571
578
|
/** 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. */
|
|
@@ -626,8 +633,12 @@ declare namespace gapi.client {
|
|
|
626
633
|
references?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
627
634
|
/** Grounding information for parts of the text. */
|
|
628
635
|
segments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
636
|
+
/** Grounding information for parts of the visual content. */
|
|
637
|
+
visualSegments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
629
638
|
}
|
|
630
639
|
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
640
|
+
/** Chunk of code snippet from the referenced document. */
|
|
641
|
+
codeSnippet?: string;
|
|
631
642
|
/** Referenced text content. */
|
|
632
643
|
content?: string;
|
|
633
644
|
/** Document metadata. */
|
|
@@ -638,6 +649,7 @@ declare namespace gapi.client {
|
|
|
638
649
|
document?: string;
|
|
639
650
|
/** 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. */
|
|
640
651
|
domain?: string;
|
|
652
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
641
653
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
642
654
|
mimeType?: string;
|
|
643
655
|
/** Page identifier. */
|
|
@@ -659,6 +671,12 @@ declare namespace gapi.client {
|
|
|
659
671
|
/** The text segment itself. */
|
|
660
672
|
text?: string;
|
|
661
673
|
}
|
|
674
|
+
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
675
|
+
/** 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. */
|
|
676
|
+
contentId?: string;
|
|
677
|
+
/** References for the visual segment. */
|
|
678
|
+
referenceIndices?: number[];
|
|
679
|
+
}
|
|
662
680
|
interface GoogleCloudDiscoveryengineV1alphaBAPConfig {
|
|
663
681
|
/** Optional. The actions enabled on the associated BAP connection. */
|
|
664
682
|
enabledActions?: string[];
|
|
@@ -668,6 +686,14 @@ declare namespace gapi.client {
|
|
|
668
686
|
| 'DATA_INGESTION'
|
|
669
687
|
| 'ACTIONS'
|
|
670
688
|
| 'END_USER_AUTHENTICATION'[];
|
|
689
|
+
/** 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). */
|
|
690
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
691
|
+
}
|
|
692
|
+
interface GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
693
|
+
/** 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. */
|
|
694
|
+
baseVersion?: string;
|
|
695
|
+
/** 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. */
|
|
696
|
+
tools?: {[P in string]: any}[];
|
|
671
697
|
}
|
|
672
698
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
673
699
|
/** Operation create time. */
|
|
@@ -713,6 +739,10 @@ declare namespace gapi.client {
|
|
|
713
739
|
/** Output only. List of citations. */
|
|
714
740
|
citations?: GoogleCloudDiscoveryengineV1alphaCitation[];
|
|
715
741
|
}
|
|
742
|
+
interface GoogleCloudDiscoveryengineV1alphaCliConfig {
|
|
743
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
744
|
+
enabledActions?: string[];
|
|
745
|
+
}
|
|
716
746
|
interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
|
|
717
747
|
/** Output only. The default CmekConfig for the Customer. */
|
|
718
748
|
isDefault?: boolean;
|
|
@@ -1010,6 +1040,8 @@ declare namespace gapi.client {
|
|
|
1010
1040
|
| 'ALLOWLIST_STATIC_IP'
|
|
1011
1041
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
1012
1042
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
1043
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
1044
|
+
cliConfig?: GoogleCloudDiscoveryengineV1alphaCliConfig;
|
|
1013
1045
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
1014
1046
|
connectorModes?:
|
|
1015
1047
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -1018,6 +1050,8 @@ declare namespace gapi.client {
|
|
|
1018
1050
|
| 'FEDERATED'
|
|
1019
1051
|
| 'EUA'
|
|
1020
1052
|
| 'FEDERATED_AND_EUA'[];
|
|
1053
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
1054
|
+
connectorSourceId?: string;
|
|
1021
1055
|
/** 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. */
|
|
1022
1056
|
connectorType?:
|
|
1023
1057
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -1047,7 +1081,7 @@ declare namespace gapi.client {
|
|
|
1047
1081
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
1048
1082
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
1049
1083
|
dynamicTools?: GoogleCloudDiscoveryengineV1alphaDynamicTool[];
|
|
1050
|
-
/** 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.
|
|
1084
|
+
/** 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. */
|
|
1051
1085
|
egressFqdns?: string[];
|
|
1052
1086
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
1053
1087
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
@@ -1075,7 +1109,7 @@ declare namespace gapi.client {
|
|
|
1075
1109
|
lastSyncTime?: string;
|
|
1076
1110
|
/** 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. */
|
|
1077
1111
|
latestPauseTime?: string;
|
|
1078
|
-
/**
|
|
1112
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
1079
1113
|
name?: string;
|
|
1080
1114
|
/** 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. */
|
|
1081
1115
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -1117,7 +1151,7 @@ declare namespace gapi.client {
|
|
|
1117
1151
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
1118
1152
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
1119
1153
|
updateTime?: string;
|
|
1120
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
1154
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
1121
1155
|
vpcscEnabled?: boolean;
|
|
1122
1156
|
}
|
|
1123
1157
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
@@ -1205,6 +1239,8 @@ declare namespace gapi.client {
|
|
|
1205
1239
|
| 'GOOGLE_WORKSPACE';
|
|
1206
1240
|
/** Output only. Timestamp the DataStore was created at. */
|
|
1207
1241
|
createTime?: string;
|
|
1242
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
1243
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
1208
1244
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
1209
1245
|
defaultSchemaId?: string;
|
|
1210
1246
|
/** 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. */
|
|
@@ -1515,7 +1551,7 @@ declare namespace gapi.client {
|
|
|
1515
1551
|
disableAnalytics?: boolean;
|
|
1516
1552
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
1517
1553
|
displayName?: string;
|
|
1518
|
-
/** 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` */
|
|
1554
|
+
/** 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` */
|
|
1519
1555
|
features?: {
|
|
1520
1556
|
[P in string]:
|
|
1521
1557
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -1792,7 +1828,7 @@ declare namespace gapi.client {
|
|
|
1792
1828
|
| 'RETRIEVABLE_DISABLED';
|
|
1793
1829
|
/** 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 */
|
|
1794
1830
|
schemaOrgPaths?: string[];
|
|
1795
|
-
/** 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`. */
|
|
1831
|
+
/** 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). */
|
|
1796
1832
|
searchableFieldImportance?:
|
|
1797
1833
|
| 'SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED'
|
|
1798
1834
|
| 'VERY_LOW_IMPORTANCE'
|
|
@@ -1929,7 +1965,7 @@ declare namespace gapi.client {
|
|
|
1929
1965
|
failureCount?: string;
|
|
1930
1966
|
/** Count of entries that were processed successfully. */
|
|
1931
1967
|
successCount?: string;
|
|
1932
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1968
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
1933
1969
|
updateTime?: string;
|
|
1934
1970
|
}
|
|
1935
1971
|
interface GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse {
|
|
@@ -2018,7 +2054,7 @@ declare namespace gapi.client {
|
|
|
2018
2054
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
2019
2055
|
/** 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"` */
|
|
2020
2056
|
filter?: string;
|
|
2021
|
-
/** 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. */
|
|
2057
|
+
/** 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. */
|
|
2022
2058
|
orderBy?: string;
|
|
2023
2059
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
2024
2060
|
pageSize?: number;
|
|
@@ -2098,6 +2134,13 @@ declare namespace gapi.client {
|
|
|
2098
2134
|
startTime?: string;
|
|
2099
2135
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
2100
2136
|
terminateTime?: string;
|
|
2137
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
2138
|
+
updateType?:
|
|
2139
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
2140
|
+
| 'CREATE'
|
|
2141
|
+
| 'DELETE'
|
|
2142
|
+
| 'SCALE_UP'
|
|
2143
|
+
| 'SCALE_DOWN';
|
|
2101
2144
|
}
|
|
2102
2145
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
2103
2146
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -2223,6 +2266,8 @@ declare namespace gapi.client {
|
|
|
2223
2266
|
top5?: number;
|
|
2224
2267
|
}
|
|
2225
2268
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
2269
|
+
/** Output only. The time at which the server accepted this query. */
|
|
2270
|
+
createTime?: string;
|
|
2226
2271
|
/** Query content parts. */
|
|
2227
2272
|
parts?: GoogleCloudDiscoveryengineV1alphaQueryPart[];
|
|
2228
2273
|
/** Output only. Unique Id for the query. */
|
|
@@ -2423,12 +2468,16 @@ declare namespace gapi.client {
|
|
|
2423
2468
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
2424
2469
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
2425
2470
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2471
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
2472
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams;
|
|
2426
2473
|
/** 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. */
|
|
2427
2474
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
2428
2475
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
2429
2476
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
2430
2477
|
/** 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. */
|
|
2431
2478
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
2479
|
+
/** 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. */
|
|
2480
|
+
entity?: string;
|
|
2432
2481
|
/** 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. */
|
|
2433
2482
|
facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
2434
2483
|
/** 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) */
|
|
@@ -2461,7 +2510,7 @@ declare namespace gapi.client {
|
|
|
2461
2510
|
query?: string;
|
|
2462
2511
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
2463
2512
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
2464
|
-
/** 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 */
|
|
2513
|
+
/** 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 */
|
|
2465
2514
|
rankingExpression?: string;
|
|
2466
2515
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
2467
2516
|
rankingExpressionBackend?:
|
|
@@ -2626,6 +2675,10 @@ declare namespace gapi.client {
|
|
|
2626
2675
|
| 'DROP_CROWDED_RESULTS'
|
|
2627
2676
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
2628
2677
|
}
|
|
2678
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams {
|
|
2679
|
+
/** 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. */
|
|
2680
|
+
expressionsToPrecompute?: string[];
|
|
2681
|
+
}
|
|
2629
2682
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2630
2683
|
/** 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) */
|
|
2631
2684
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -2698,7 +2751,7 @@ declare namespace gapi.client {
|
|
|
2698
2751
|
| 'CONDITION_UNSPECIFIED'
|
|
2699
2752
|
| 'DISABLED'
|
|
2700
2753
|
| 'ENABLED';
|
|
2701
|
-
/** 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`.
|
|
2754
|
+
/** 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`. */
|
|
2702
2755
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
2703
2756
|
}
|
|
2704
2757
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec {
|
|
@@ -2765,6 +2818,8 @@ declare namespace gapi.client {
|
|
|
2765
2818
|
labels?: string[];
|
|
2766
2819
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
2767
2820
|
name?: string;
|
|
2821
|
+
/** 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. */
|
|
2822
|
+
pendingAsyncAssistOperationId?: string;
|
|
2768
2823
|
/** Output only. The time the session started. */
|
|
2769
2824
|
startTime?: string;
|
|
2770
2825
|
/** The state of the session. */
|
|
@@ -2781,6 +2836,8 @@ declare namespace gapi.client {
|
|
|
2781
2836
|
detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
2782
2837
|
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. */
|
|
2783
2838
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
2839
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
2840
|
+
live?: boolean;
|
|
2784
2841
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
2785
2842
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
2786
2843
|
/** 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. */
|
|
@@ -2927,6 +2984,8 @@ declare namespace gapi.client {
|
|
|
2927
2984
|
updateTime?: string;
|
|
2928
2985
|
}
|
|
2929
2986
|
interface GoogleCloudDiscoveryengineV1alphaUserInfo {
|
|
2987
|
+
/** 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. */
|
|
2988
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation;
|
|
2930
2989
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
2931
2990
|
timeZone?: string;
|
|
2932
2991
|
/** 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. */
|
|
@@ -2934,6 +2993,12 @@ declare namespace gapi.client {
|
|
|
2934
2993
|
/** 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. */
|
|
2935
2994
|
userId?: string;
|
|
2936
2995
|
}
|
|
2996
|
+
interface GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
2997
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
2998
|
+
address?: string;
|
|
2999
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
3000
|
+
point?: GoogleTypeLatLng;
|
|
3001
|
+
}
|
|
2937
3002
|
interface GoogleCloudDiscoveryengineV1alphaUserLicense {
|
|
2938
3003
|
/** Output only. User created timestamp. */
|
|
2939
3004
|
createTime?: string;
|
|
@@ -2957,7 +3022,7 @@ declare namespace gapi.client {
|
|
|
2957
3022
|
userProfile?: string;
|
|
2958
3023
|
}
|
|
2959
3024
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
2960
|
-
/** Obfuscated Dasher customer ID. */
|
|
3025
|
+
/** 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. */
|
|
2961
3026
|
dasherCustomerId?: string;
|
|
2962
3027
|
/** 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. */
|
|
2963
3028
|
superAdminEmailAddress?: string;
|
|
@@ -2998,6 +3063,8 @@ declare namespace gapi.client {
|
|
|
2998
3063
|
topP?: number;
|
|
2999
3064
|
}
|
|
3000
3065
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
3066
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
3067
|
+
createTime?: string;
|
|
3001
3068
|
/** Optional. Customer policy for the assistant. */
|
|
3002
3069
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
3003
3070
|
/** 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. */
|
|
@@ -3014,6 +3081,8 @@ declare namespace gapi.client {
|
|
|
3014
3081
|
generationConfig?: GoogleCloudDiscoveryengineV1AssistantGenerationConfig;
|
|
3015
3082
|
/** 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. */
|
|
3016
3083
|
name?: string;
|
|
3084
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
3085
|
+
updateTime?: string;
|
|
3017
3086
|
/** Optional. The type of web grounding to use. */
|
|
3018
3087
|
webGroundingType?:
|
|
3019
3088
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -3079,6 +3148,14 @@ declare namespace gapi.client {
|
|
|
3079
3148
|
| 'DATA_INGESTION'
|
|
3080
3149
|
| 'ACTIONS'
|
|
3081
3150
|
| 'END_USER_AUTHENTICATION'[];
|
|
3151
|
+
/** 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). */
|
|
3152
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
3153
|
+
}
|
|
3154
|
+
interface GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
3155
|
+
/** 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. */
|
|
3156
|
+
baseVersion?: string;
|
|
3157
|
+
/** 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. */
|
|
3158
|
+
tools?: {[P in string]: any}[];
|
|
3082
3159
|
}
|
|
3083
3160
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
3084
3161
|
/** Operation create time. */
|
|
@@ -3273,7 +3350,7 @@ declare namespace gapi.client {
|
|
|
3273
3350
|
| 'UNHELPFUL_ANSWER'[];
|
|
3274
3351
|
/** The textual answer. */
|
|
3275
3352
|
answerText?: string;
|
|
3276
|
-
/** List of blob attachments in the answer. */
|
|
3353
|
+
/** Output only. List of blob attachments in the answer. */
|
|
3277
3354
|
blobAttachments?: GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment[];
|
|
3278
3355
|
/** Citations. */
|
|
3279
3356
|
citations?: GoogleCloudDiscoveryengineV1betaAnswerCitation[];
|
|
@@ -3749,7 +3826,8 @@ declare namespace gapi.client {
|
|
|
3749
3826
|
| 'IN_PROGRESS'
|
|
3750
3827
|
| 'FAILED'
|
|
3751
3828
|
| 'SUCCEEDED'
|
|
3752
|
-
| 'SKIPPED'
|
|
3829
|
+
| 'SKIPPED'
|
|
3830
|
+
| 'CANCELLED';
|
|
3753
3831
|
}
|
|
3754
3832
|
interface GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult {
|
|
3755
3833
|
/** 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. */
|
|
@@ -3774,10 +3852,14 @@ declare namespace gapi.client {
|
|
|
3774
3852
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
3775
3853
|
}
|
|
3776
3854
|
interface GoogleCloudDiscoveryengineV1betaAssistAnswerReply {
|
|
3855
|
+
/** The time when the reply was created. */
|
|
3856
|
+
createTime?: string;
|
|
3777
3857
|
/** Possibly grounded response text or media from the assistant. */
|
|
3778
3858
|
groundedContent?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContent;
|
|
3779
3859
|
}
|
|
3780
3860
|
interface GoogleCloudDiscoveryengineV1betaAssistant {
|
|
3861
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
3862
|
+
createTime?: string;
|
|
3781
3863
|
/** Optional. Customer policy for the assistant. */
|
|
3782
3864
|
customerPolicy?: GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
|
|
3783
3865
|
/** 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. */
|
|
@@ -3794,6 +3876,8 @@ declare namespace gapi.client {
|
|
|
3794
3876
|
generationConfig?: GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig;
|
|
3795
3877
|
/** 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. */
|
|
3796
3878
|
name?: string;
|
|
3879
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
3880
|
+
updateTime?: string;
|
|
3797
3881
|
/** Optional. The type of web grounding to use. */
|
|
3798
3882
|
webGroundingType?:
|
|
3799
3883
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -3895,8 +3979,12 @@ declare namespace gapi.client {
|
|
|
3895
3979
|
references?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
3896
3980
|
/** Grounding information for parts of the text. */
|
|
3897
3981
|
segments?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
3982
|
+
/** Grounding information for parts of the visual content. */
|
|
3983
|
+
visualSegments?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
3898
3984
|
}
|
|
3899
3985
|
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference {
|
|
3986
|
+
/** Chunk of code snippet from the referenced document. */
|
|
3987
|
+
codeSnippet?: string;
|
|
3900
3988
|
/** Referenced text content. */
|
|
3901
3989
|
content?: string;
|
|
3902
3990
|
/** Document metadata. */
|
|
@@ -3907,6 +3995,7 @@ declare namespace gapi.client {
|
|
|
3907
3995
|
document?: string;
|
|
3908
3996
|
/** 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. */
|
|
3909
3997
|
domain?: string;
|
|
3998
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
3910
3999
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
3911
4000
|
mimeType?: string;
|
|
3912
4001
|
/** Page identifier. */
|
|
@@ -3928,6 +4017,12 @@ declare namespace gapi.client {
|
|
|
3928
4017
|
/** The text segment itself. */
|
|
3929
4018
|
text?: string;
|
|
3930
4019
|
}
|
|
4020
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
4021
|
+
/** 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. */
|
|
4022
|
+
contentId?: string;
|
|
4023
|
+
/** References for the visual segment. */
|
|
4024
|
+
referenceIndices?: number[];
|
|
4025
|
+
}
|
|
3931
4026
|
interface GoogleCloudDiscoveryengineV1betaAssistantToolInfo {
|
|
3932
4027
|
/** The display name of the tool. */
|
|
3933
4028
|
toolDisplayName?: string;
|
|
@@ -4700,6 +4795,20 @@ declare namespace gapi.client {
|
|
|
4700
4795
|
}
|
|
4701
4796
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {}
|
|
4702
4797
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
4798
|
+
interface GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest {
|
|
4799
|
+
/** 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. */
|
|
4800
|
+
licenseConfigId?: string;
|
|
4801
|
+
/** Required. The number of licenses to distribute. */
|
|
4802
|
+
licenseCount?: string;
|
|
4803
|
+
/** Required. The target GCP project region to distribute the license config to. */
|
|
4804
|
+
location?: string;
|
|
4805
|
+
/** Required. The target GCP project number to distribute the license config to. */
|
|
4806
|
+
projectNumber?: string;
|
|
4807
|
+
}
|
|
4808
|
+
interface GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse {
|
|
4809
|
+
/** The updated or created LicenseConfig. */
|
|
4810
|
+
licenseConfig?: GoogleCloudDiscoveryengineV1betaLicenseConfig;
|
|
4811
|
+
}
|
|
4703
4812
|
interface GoogleCloudDiscoveryengineV1betaDocument {
|
|
4704
4813
|
/** Access control information for the document. */
|
|
4705
4814
|
aclInfo?: GoogleCloudDiscoveryengineV1betaDocumentAclInfo;
|
|
@@ -4711,7 +4820,7 @@ declare namespace gapi.client {
|
|
|
4711
4820
|
id?: string;
|
|
4712
4821
|
/** 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. */
|
|
4713
4822
|
indexStatus?: GoogleCloudDiscoveryengineV1betaDocumentIndexStatus;
|
|
4714
|
-
/** Output only. The
|
|
4823
|
+
/** 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. */
|
|
4715
4824
|
indexTime?: string;
|
|
4716
4825
|
/** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
4717
4826
|
jsonData?: string;
|
|
@@ -4745,7 +4854,7 @@ declare namespace gapi.client {
|
|
|
4745
4854
|
interface GoogleCloudDiscoveryengineV1betaDocumentIndexStatus {
|
|
4746
4855
|
/** A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. */
|
|
4747
4856
|
errorSamples?: GoogleRpcStatus[];
|
|
4748
|
-
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. */
|
|
4857
|
+
/** 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. */
|
|
4749
4858
|
indexTime?: string;
|
|
4750
4859
|
/** Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. */
|
|
4751
4860
|
pendingMessage?: string;
|
|
@@ -4864,7 +4973,7 @@ declare namespace gapi.client {
|
|
|
4864
4973
|
disableAnalytics?: boolean;
|
|
4865
4974
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
4866
4975
|
displayName?: string;
|
|
4867
|
-
/** 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` */
|
|
4976
|
+
/** 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` */
|
|
4868
4977
|
features?: {
|
|
4869
4978
|
[P in string]:
|
|
4870
4979
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -5068,6 +5177,51 @@ declare namespace gapi.client {
|
|
|
5068
5177
|
/** The URI of the source. */
|
|
5069
5178
|
uri?: string;
|
|
5070
5179
|
}
|
|
5180
|
+
interface GoogleCloudDiscoveryengineV1betaFeedback {
|
|
5181
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
5182
|
+
comment?: string;
|
|
5183
|
+
/** Optional. The version of the component that this report is being sent from. */
|
|
5184
|
+
componentVersion?: string;
|
|
5185
|
+
/** The related conversation information when user gives feedback. */
|
|
5186
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo;
|
|
5187
|
+
/** Optional. Whether the customer accepted data use terms. */
|
|
5188
|
+
dataTermsAccepted?: boolean;
|
|
5189
|
+
/** Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. */
|
|
5190
|
+
feedbackSource?:
|
|
5191
|
+
| 'FEEDBACK_SOURCE_UNSPECIFIED'
|
|
5192
|
+
| 'GOOGLE_CONSOLE'
|
|
5193
|
+
| 'GOOGLE_WIDGET'
|
|
5194
|
+
| 'GOOGLE_WEBAPP'
|
|
5195
|
+
| 'GOOGLE_AGENTSPACE_MOBILE';
|
|
5196
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
5197
|
+
feedbackType?: 'FEEDBACK_TYPE_UNSPECIFIED' | 'LIKE' | 'DISLIKE';
|
|
5198
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
5199
|
+
llmModelVersion?: string;
|
|
5200
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
5201
|
+
reasons?:
|
|
5202
|
+
| 'REASON_UNSPECIFIED'
|
|
5203
|
+
| 'INACCURATE_RESPONSE'
|
|
5204
|
+
| 'NOT_RELEVANT'
|
|
5205
|
+
| 'INCOMPREHENSIVE'
|
|
5206
|
+
| 'OFFENSIVE_OR_UNSAFE'
|
|
5207
|
+
| 'FORMAT_AND_STYLES'
|
|
5208
|
+
| 'BAD_CITATION'
|
|
5209
|
+
| 'CANVAS_NOT_GENERATED'
|
|
5210
|
+
| 'CANVAS_QUALITY_BAD'
|
|
5211
|
+
| 'CANVAS_EXPORT_FAILED'[];
|
|
5212
|
+
}
|
|
5213
|
+
interface GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo {
|
|
5214
|
+
/** Optional. The token which could be used to fetch the answer log. */
|
|
5215
|
+
answerQueryToken?: string;
|
|
5216
|
+
/** Optional. The token which could be used to fetch the assistant log. */
|
|
5217
|
+
assistToken?: string;
|
|
5218
|
+
/** Required. The user's search query. */
|
|
5219
|
+
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
5220
|
+
/** The index of the user input within the conversation messages. */
|
|
5221
|
+
questionIndex?: number;
|
|
5222
|
+
/** Name of the newly generated or continued session. */
|
|
5223
|
+
session?: string;
|
|
5224
|
+
}
|
|
5071
5225
|
interface GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
5072
5226
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
5073
5227
|
nextPageToken?: string;
|
|
@@ -5326,7 +5480,7 @@ declare namespace gapi.client {
|
|
|
5326
5480
|
failureCount?: string;
|
|
5327
5481
|
/** Count of entries that were processed successfully. */
|
|
5328
5482
|
successCount?: string;
|
|
5329
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
5483
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
5330
5484
|
updateTime?: string;
|
|
5331
5485
|
}
|
|
5332
5486
|
interface GoogleCloudDiscoveryengineV1betaImportUserEventsRequest {
|
|
@@ -5504,6 +5658,12 @@ declare namespace gapi.client {
|
|
|
5504
5658
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
5505
5659
|
nextPageToken?: string;
|
|
5506
5660
|
}
|
|
5661
|
+
interface GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse {
|
|
5662
|
+
/** All the customer's LicenseConfigs. */
|
|
5663
|
+
licenseConfigs?: GoogleCloudDiscoveryengineV1betaLicenseConfig[];
|
|
5664
|
+
/** Not supported. */
|
|
5665
|
+
nextPageToken?: string;
|
|
5666
|
+
}
|
|
5507
5667
|
interface GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse {
|
|
5508
5668
|
/** All the customer's LicenseConfigUsageStats. */
|
|
5509
5669
|
licenseConfigUsageStats?: GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats[];
|
|
@@ -5648,6 +5808,13 @@ declare namespace gapi.client {
|
|
|
5648
5808
|
startTime?: string;
|
|
5649
5809
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
5650
5810
|
terminateTime?: string;
|
|
5811
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
5812
|
+
updateType?:
|
|
5813
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
5814
|
+
| 'CREATE'
|
|
5815
|
+
| 'DELETE'
|
|
5816
|
+
| 'SCALE_UP'
|
|
5817
|
+
| 'SCALE_DOWN';
|
|
5651
5818
|
}
|
|
5652
5819
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
5653
5820
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -5811,7 +5978,7 @@ declare namespace gapi.client {
|
|
|
5811
5978
|
content?: string;
|
|
5812
5979
|
/** The unique ID to represent the record. */
|
|
5813
5980
|
id?: string;
|
|
5814
|
-
/** The score of this record based on the given query and selected model. The score will be rounded to
|
|
5981
|
+
/** 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. */
|
|
5815
5982
|
score?: number;
|
|
5816
5983
|
/** 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. */
|
|
5817
5984
|
title?: string;
|
|
@@ -5920,6 +6087,18 @@ declare namespace gapi.client {
|
|
|
5920
6087
|
uri?: string;
|
|
5921
6088
|
}
|
|
5922
6089
|
interface GoogleCloudDiscoveryengineV1betaResumeEngineRequest {}
|
|
6090
|
+
interface GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest {
|
|
6091
|
+
/** Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count. */
|
|
6092
|
+
fullRetract?: boolean;
|
|
6093
|
+
/** Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`. */
|
|
6094
|
+
licenseConfig?: string;
|
|
6095
|
+
/** Optional. The number of licenses to retract. Only used when full_retract is false. */
|
|
6096
|
+
licenseCount?: string;
|
|
6097
|
+
}
|
|
6098
|
+
interface GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse {
|
|
6099
|
+
/** The updated LicenseConfig. */
|
|
6100
|
+
licenseConfig?: GoogleCloudDiscoveryengineV1betaLicenseConfig;
|
|
6101
|
+
}
|
|
5923
6102
|
interface GoogleCloudDiscoveryengineV1betaSafetyRating {
|
|
5924
6103
|
/** Output only. Indicates whether the content was filtered out because of this rating. */
|
|
5925
6104
|
blocked?: boolean;
|
|
@@ -6023,12 +6202,16 @@ declare namespace gapi.client {
|
|
|
6023
6202
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
6024
6203
|
/** 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. */
|
|
6025
6204
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
6205
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
6206
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams;
|
|
6026
6207
|
/** 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. */
|
|
6027
6208
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
6028
6209
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
6029
6210
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
6030
6211
|
/** 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. */
|
|
6031
6212
|
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
6213
|
+
/** 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. */
|
|
6214
|
+
entity?: string;
|
|
6032
6215
|
/** 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. */
|
|
6033
6216
|
facetSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
6034
6217
|
/** 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) */
|
|
@@ -6061,7 +6244,7 @@ declare namespace gapi.client {
|
|
|
6061
6244
|
query?: string;
|
|
6062
6245
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
6063
6246
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
6064
|
-
/** 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 */
|
|
6247
|
+
/** 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 */
|
|
6065
6248
|
rankingExpression?: string;
|
|
6066
6249
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
6067
6250
|
rankingExpressionBackend?:
|
|
@@ -6224,6 +6407,10 @@ declare namespace gapi.client {
|
|
|
6224
6407
|
| 'DROP_CROWDED_RESULTS'
|
|
6225
6408
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
6226
6409
|
}
|
|
6410
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams {
|
|
6411
|
+
/** 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. */
|
|
6412
|
+
expressionsToPrecompute?: string[];
|
|
6413
|
+
}
|
|
6227
6414
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
6228
6415
|
/** 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) */
|
|
6229
6416
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -6296,7 +6483,7 @@ declare namespace gapi.client {
|
|
|
6296
6483
|
| 'CONDITION_UNSPECIFIED'
|
|
6297
6484
|
| 'DISABLED'
|
|
6298
6485
|
| 'ENABLED';
|
|
6299
|
-
/** 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`.
|
|
6486
|
+
/** 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`. */
|
|
6300
6487
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
6301
6488
|
}
|
|
6302
6489
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec {
|
|
@@ -6535,6 +6722,8 @@ declare namespace gapi.client {
|
|
|
6535
6722
|
keywordSimilarityScore?: number;
|
|
6536
6723
|
/** Optional. Predicted conversion rate adjustment as a rank. */
|
|
6537
6724
|
pctrRank?: number;
|
|
6725
|
+
/** 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`. */
|
|
6726
|
+
precomputedExpressionValues?: number[];
|
|
6538
6727
|
/** Optional. Semantic relevance adjustment. */
|
|
6539
6728
|
relevanceScore?: number;
|
|
6540
6729
|
/** Optional. Semantic similarity adjustment. */
|
|
@@ -6716,6 +6905,8 @@ declare namespace gapi.client {
|
|
|
6716
6905
|
labels?: string[];
|
|
6717
6906
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
6718
6907
|
name?: string;
|
|
6908
|
+
/** 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. */
|
|
6909
|
+
pendingAsyncAssistOperationId?: string;
|
|
6719
6910
|
/** Output only. The time the session started. */
|
|
6720
6911
|
startTime?: string;
|
|
6721
6912
|
/** The state of the session. */
|
|
@@ -6732,6 +6923,8 @@ declare namespace gapi.client {
|
|
|
6732
6923
|
detailedAnswer?: GoogleCloudDiscoveryengineV1betaAnswer;
|
|
6733
6924
|
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. */
|
|
6734
6925
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1betaAssistAnswer;
|
|
6926
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
6927
|
+
live?: boolean;
|
|
6735
6928
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
6736
6929
|
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
6737
6930
|
/** 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. */
|
|
@@ -6839,9 +7032,17 @@ declare namespace gapi.client {
|
|
|
6839
7032
|
assistToken?: string;
|
|
6840
7033
|
/** The tool names of the tools that were invoked. */
|
|
6841
7034
|
invocationTools?: string[];
|
|
7035
|
+
/** The skills executed during the turn. */
|
|
7036
|
+
invokedSkills?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill[];
|
|
6842
7037
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
6843
7038
|
sessionInfo?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
6844
7039
|
}
|
|
7040
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill {
|
|
7041
|
+
/** The display name of the skill. */
|
|
7042
|
+
displayName?: string;
|
|
7043
|
+
/** The resource name of the skill. */
|
|
7044
|
+
name?: string;
|
|
7045
|
+
}
|
|
6845
7046
|
interface GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo {
|
|
6846
7047
|
/** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
|
|
6847
7048
|
session?: string;
|
|
@@ -6990,6 +7191,8 @@ declare namespace gapi.client {
|
|
|
6990
7191
|
eventTime?: string;
|
|
6991
7192
|
/** 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. */
|
|
6992
7193
|
eventType?: string;
|
|
7194
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
7195
|
+
feedback?: GoogleCloudDiscoveryengineV1betaFeedback;
|
|
6993
7196
|
/** 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. */
|
|
6994
7197
|
filter?: string;
|
|
6995
7198
|
/** Media-specific info. */
|
|
@@ -7016,6 +7219,8 @@ declare namespace gapi.client {
|
|
|
7016
7219
|
userPseudoId?: string;
|
|
7017
7220
|
}
|
|
7018
7221
|
interface GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
7222
|
+
/** 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. */
|
|
7223
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation;
|
|
7019
7224
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
7020
7225
|
timeZone?: string;
|
|
7021
7226
|
/** 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. */
|
|
@@ -7023,6 +7228,12 @@ declare namespace gapi.client {
|
|
|
7023
7228
|
/** 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. */
|
|
7024
7229
|
userId?: string;
|
|
7025
7230
|
}
|
|
7231
|
+
interface GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
7232
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
7233
|
+
address?: string;
|
|
7234
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
7235
|
+
point?: GoogleTypeLatLng;
|
|
7236
|
+
}
|
|
7026
7237
|
interface GoogleCloudDiscoveryengineV1betaUserLicense {
|
|
7027
7238
|
/** Output only. User created timestamp. */
|
|
7028
7239
|
createTime?: string;
|
|
@@ -7058,7 +7269,7 @@ declare namespace gapi.client {
|
|
|
7058
7269
|
name?: string;
|
|
7059
7270
|
}
|
|
7060
7271
|
interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
7061
|
-
/** Obfuscated Dasher customer ID. */
|
|
7272
|
+
/** 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. */
|
|
7062
7273
|
dasherCustomerId?: string;
|
|
7063
7274
|
/** 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. */
|
|
7064
7275
|
superAdminEmailAddress?: string;
|
|
@@ -7076,6 +7287,10 @@ declare namespace gapi.client {
|
|
|
7076
7287
|
| 'GOOGLE_KEEP'
|
|
7077
7288
|
| 'GOOGLE_PEOPLE';
|
|
7078
7289
|
}
|
|
7290
|
+
interface GoogleCloudDiscoveryengineV1CliConfig {
|
|
7291
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
7292
|
+
enabledActions?: string[];
|
|
7293
|
+
}
|
|
7079
7294
|
interface GoogleCloudDiscoveryengineV1CmekConfig {
|
|
7080
7295
|
/** Output only. The default CmekConfig for the Customer. */
|
|
7081
7296
|
isDefault?: boolean;
|
|
@@ -7274,6 +7489,8 @@ declare namespace gapi.client {
|
|
|
7274
7489
|
| 'ALLOWLIST_STATIC_IP'
|
|
7275
7490
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
7276
7491
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
7492
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
7493
|
+
cliConfig?: GoogleCloudDiscoveryengineV1CliConfig;
|
|
7277
7494
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
7278
7495
|
connectorModes?:
|
|
7279
7496
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -7282,6 +7499,8 @@ declare namespace gapi.client {
|
|
|
7282
7499
|
| 'FEDERATED'
|
|
7283
7500
|
| 'EUA'
|
|
7284
7501
|
| 'FEDERATED_AND_EUA'[];
|
|
7502
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
7503
|
+
connectorSourceId?: string;
|
|
7285
7504
|
/** 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. */
|
|
7286
7505
|
connectorType?:
|
|
7287
7506
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -7309,7 +7528,7 @@ declare namespace gapi.client {
|
|
|
7309
7528
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
7310
7529
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
7311
7530
|
dynamicTools?: GoogleCloudDiscoveryengineV1DynamicTool[];
|
|
7312
|
-
/** 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.
|
|
7531
|
+
/** 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. */
|
|
7313
7532
|
egressFqdns?: string[];
|
|
7314
7533
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
7315
7534
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
@@ -7337,7 +7556,7 @@ declare namespace gapi.client {
|
|
|
7337
7556
|
lastSyncTime?: string;
|
|
7338
7557
|
/** 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. */
|
|
7339
7558
|
latestPauseTime?: string;
|
|
7340
|
-
/**
|
|
7559
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
7341
7560
|
name?: string;
|
|
7342
7561
|
/** 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. */
|
|
7343
7562
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -7379,7 +7598,7 @@ declare namespace gapi.client {
|
|
|
7379
7598
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
7380
7599
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
7381
7600
|
updateTime?: string;
|
|
7382
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
7601
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
7383
7602
|
vpcscEnabled?: boolean;
|
|
7384
7603
|
}
|
|
7385
7604
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
@@ -7735,7 +7954,7 @@ declare namespace gapi.client {
|
|
|
7735
7954
|
disableAnalytics?: boolean;
|
|
7736
7955
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
7737
7956
|
displayName?: string;
|
|
7738
|
-
/** 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` */
|
|
7957
|
+
/** 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` */
|
|
7739
7958
|
features?: {
|
|
7740
7959
|
[P in string]:
|
|
7741
7960
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -7985,7 +8204,7 @@ declare namespace gapi.client {
|
|
|
7985
8204
|
failureCount?: string;
|
|
7986
8205
|
/** Count of entries that were processed successfully. */
|
|
7987
8206
|
successCount?: string;
|
|
7988
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
8207
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
7989
8208
|
updateTime?: string;
|
|
7990
8209
|
}
|
|
7991
8210
|
interface GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
|
|
@@ -8088,6 +8307,13 @@ declare namespace gapi.client {
|
|
|
8088
8307
|
startTime?: string;
|
|
8089
8308
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
8090
8309
|
terminateTime?: string;
|
|
8310
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
8311
|
+
updateType?:
|
|
8312
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
8313
|
+
| 'CREATE'
|
|
8314
|
+
| 'DELETE'
|
|
8315
|
+
| 'SCALE_UP'
|
|
8316
|
+
| 'SCALE_DOWN';
|
|
8091
8317
|
}
|
|
8092
8318
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
8093
8319
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -8472,7 +8698,7 @@ declare namespace gapi.client {
|
|
|
8472
8698
|
name?: string;
|
|
8473
8699
|
}
|
|
8474
8700
|
interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
8475
|
-
/** Obfuscated Dasher customer ID. */
|
|
8701
|
+
/** 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. */
|
|
8476
8702
|
dasherCustomerId?: string;
|
|
8477
8703
|
/** 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. */
|
|
8478
8704
|
superAdminEmailAddress?: string;
|
|
@@ -8585,7 +8811,7 @@ declare namespace gapi.client {
|
|
|
8585
8811
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
8586
8812
|
code?: number;
|
|
8587
8813
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
8588
|
-
details?:
|
|
8814
|
+
details?: {[P in string]: any}[];
|
|
8589
8815
|
/** 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. */
|
|
8590
8816
|
message?: string;
|
|
8591
8817
|
}
|
|
@@ -8627,12 +8853,139 @@ declare namespace gapi.client {
|
|
|
8627
8853
|
/** 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. */
|
|
8628
8854
|
title?: string;
|
|
8629
8855
|
}
|
|
8856
|
+
interface GoogleTypeLatLng {
|
|
8857
|
+
/** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
|
|
8858
|
+
latitude?: number;
|
|
8859
|
+
/** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
|
|
8860
|
+
longitude?: number;
|
|
8861
|
+
}
|
|
8630
8862
|
interface GoogleTypeTimeZone {
|
|
8631
8863
|
/** IANA Time Zone Database time zone. For example "America/New_York". */
|
|
8632
8864
|
id?: string;
|
|
8633
8865
|
/** Optional. IANA Time Zone Database version number. For example "2019a". */
|
|
8634
8866
|
version?: string;
|
|
8635
8867
|
}
|
|
8868
|
+
interface BillingAccountLicenseConfigsResource {
|
|
8869
|
+
/** Distributes a LicenseConfig from billing account level to project level. */
|
|
8870
|
+
distributeLicenseConfig(request: {
|
|
8871
|
+
/** V1 error format. */
|
|
8872
|
+
'$.xgafv'?: '1' | '2';
|
|
8873
|
+
/** OAuth access token. */
|
|
8874
|
+
access_token?: string;
|
|
8875
|
+
/** Data format for response. */
|
|
8876
|
+
alt?: 'json' | 'media' | 'proto';
|
|
8877
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
8878
|
+
billingAccountLicenseConfig: string;
|
|
8879
|
+
/** JSONP */
|
|
8880
|
+
callback?: string;
|
|
8881
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8882
|
+
fields?: string;
|
|
8883
|
+
/** 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. */
|
|
8884
|
+
key?: string;
|
|
8885
|
+
/** OAuth 2.0 token for the current user. */
|
|
8886
|
+
oauth_token?: string;
|
|
8887
|
+
/** Returns response with indentations and line breaks. */
|
|
8888
|
+
prettyPrint?: boolean;
|
|
8889
|
+
/** 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. */
|
|
8890
|
+
quotaUser?: string;
|
|
8891
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8892
|
+
upload_protocol?: string;
|
|
8893
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8894
|
+
uploadType?: string;
|
|
8895
|
+
/** Request body */
|
|
8896
|
+
resource: GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest;
|
|
8897
|
+
}): Request<GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse>;
|
|
8898
|
+
distributeLicenseConfig(
|
|
8899
|
+
request: {
|
|
8900
|
+
/** V1 error format. */
|
|
8901
|
+
'$.xgafv'?: '1' | '2';
|
|
8902
|
+
/** OAuth access token. */
|
|
8903
|
+
access_token?: string;
|
|
8904
|
+
/** Data format for response. */
|
|
8905
|
+
alt?: 'json' | 'media' | 'proto';
|
|
8906
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
8907
|
+
billingAccountLicenseConfig: string;
|
|
8908
|
+
/** JSONP */
|
|
8909
|
+
callback?: string;
|
|
8910
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8911
|
+
fields?: string;
|
|
8912
|
+
/** 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. */
|
|
8913
|
+
key?: string;
|
|
8914
|
+
/** OAuth 2.0 token for the current user. */
|
|
8915
|
+
oauth_token?: string;
|
|
8916
|
+
/** Returns response with indentations and line breaks. */
|
|
8917
|
+
prettyPrint?: boolean;
|
|
8918
|
+
/** 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. */
|
|
8919
|
+
quotaUser?: string;
|
|
8920
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8921
|
+
upload_protocol?: string;
|
|
8922
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8923
|
+
uploadType?: string;
|
|
8924
|
+
},
|
|
8925
|
+
body: GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest,
|
|
8926
|
+
): Request<GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse>;
|
|
8927
|
+
/** This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account. */
|
|
8928
|
+
retractLicenseConfig(request: {
|
|
8929
|
+
/** V1 error format. */
|
|
8930
|
+
'$.xgafv'?: '1' | '2';
|
|
8931
|
+
/** OAuth access token. */
|
|
8932
|
+
access_token?: string;
|
|
8933
|
+
/** Data format for response. */
|
|
8934
|
+
alt?: 'json' | 'media' | 'proto';
|
|
8935
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
8936
|
+
billingAccountLicenseConfig: string;
|
|
8937
|
+
/** JSONP */
|
|
8938
|
+
callback?: string;
|
|
8939
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8940
|
+
fields?: string;
|
|
8941
|
+
/** 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. */
|
|
8942
|
+
key?: string;
|
|
8943
|
+
/** OAuth 2.0 token for the current user. */
|
|
8944
|
+
oauth_token?: string;
|
|
8945
|
+
/** Returns response with indentations and line breaks. */
|
|
8946
|
+
prettyPrint?: boolean;
|
|
8947
|
+
/** 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. */
|
|
8948
|
+
quotaUser?: string;
|
|
8949
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8950
|
+
upload_protocol?: string;
|
|
8951
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8952
|
+
uploadType?: string;
|
|
8953
|
+
/** Request body */
|
|
8954
|
+
resource: GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest;
|
|
8955
|
+
}): Request<GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse>;
|
|
8956
|
+
retractLicenseConfig(
|
|
8957
|
+
request: {
|
|
8958
|
+
/** V1 error format. */
|
|
8959
|
+
'$.xgafv'?: '1' | '2';
|
|
8960
|
+
/** OAuth access token. */
|
|
8961
|
+
access_token?: string;
|
|
8962
|
+
/** Data format for response. */
|
|
8963
|
+
alt?: 'json' | 'media' | 'proto';
|
|
8964
|
+
/** Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. */
|
|
8965
|
+
billingAccountLicenseConfig: string;
|
|
8966
|
+
/** JSONP */
|
|
8967
|
+
callback?: string;
|
|
8968
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8969
|
+
fields?: string;
|
|
8970
|
+
/** 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. */
|
|
8971
|
+
key?: string;
|
|
8972
|
+
/** OAuth 2.0 token for the current user. */
|
|
8973
|
+
oauth_token?: string;
|
|
8974
|
+
/** Returns response with indentations and line breaks. */
|
|
8975
|
+
prettyPrint?: boolean;
|
|
8976
|
+
/** 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. */
|
|
8977
|
+
quotaUser?: string;
|
|
8978
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8979
|
+
upload_protocol?: string;
|
|
8980
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8981
|
+
uploadType?: string;
|
|
8982
|
+
},
|
|
8983
|
+
body: GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest,
|
|
8984
|
+
): Request<GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse>;
|
|
8985
|
+
}
|
|
8986
|
+
interface BillingAccountsResource {
|
|
8987
|
+
billingAccountLicenseConfigs: BillingAccountLicenseConfigsResource;
|
|
8988
|
+
}
|
|
8636
8989
|
interface CmekConfigsResource {
|
|
8637
8990
|
/** De-provisions a CmekConfig. */
|
|
8638
8991
|
delete(request?: {
|
|
@@ -10450,7 +10803,7 @@ declare namespace gapi.client {
|
|
|
10450
10803
|
prettyPrint?: boolean;
|
|
10451
10804
|
/** 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. */
|
|
10452
10805
|
quotaUser?: string;
|
|
10453
|
-
/** 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. */
|
|
10806
|
+
/** 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. */
|
|
10454
10807
|
servingConfig: string;
|
|
10455
10808
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10456
10809
|
upload_protocol?: string;
|
|
@@ -10479,7 +10832,7 @@ declare namespace gapi.client {
|
|
|
10479
10832
|
prettyPrint?: boolean;
|
|
10480
10833
|
/** 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. */
|
|
10481
10834
|
quotaUser?: string;
|
|
10482
|
-
/** 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. */
|
|
10835
|
+
/** 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. */
|
|
10483
10836
|
servingConfig: string;
|
|
10484
10837
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10485
10838
|
upload_protocol?: string;
|
|
@@ -10891,7 +11244,7 @@ declare namespace gapi.client {
|
|
|
10891
11244
|
prettyPrint?: boolean;
|
|
10892
11245
|
/** 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. */
|
|
10893
11246
|
quotaUser?: string;
|
|
10894
|
-
/** 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. */
|
|
11247
|
+
/** 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. */
|
|
10895
11248
|
servingConfig: string;
|
|
10896
11249
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10897
11250
|
upload_protocol?: string;
|
|
@@ -10920,7 +11273,7 @@ declare namespace gapi.client {
|
|
|
10920
11273
|
prettyPrint?: boolean;
|
|
10921
11274
|
/** 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. */
|
|
10922
11275
|
quotaUser?: string;
|
|
10923
|
-
/** 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. */
|
|
11276
|
+
/** 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. */
|
|
10924
11277
|
servingConfig: string;
|
|
10925
11278
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10926
11279
|
upload_protocol?: string;
|
|
@@ -10982,6 +11335,8 @@ declare namespace gapi.client {
|
|
|
10982
11335
|
prettyPrint?: boolean;
|
|
10983
11336
|
/** 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. */
|
|
10984
11337
|
quotaUser?: string;
|
|
11338
|
+
/** 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. */
|
|
11339
|
+
sessionId?: string;
|
|
10985
11340
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10986
11341
|
upload_protocol?: string;
|
|
10987
11342
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11011,6 +11366,8 @@ declare namespace gapi.client {
|
|
|
11011
11366
|
prettyPrint?: boolean;
|
|
11012
11367
|
/** 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. */
|
|
11013
11368
|
quotaUser?: string;
|
|
11369
|
+
/** 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. */
|
|
11370
|
+
sessionId?: string;
|
|
11014
11371
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11015
11372
|
upload_protocol?: string;
|
|
11016
11373
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11092,7 +11449,7 @@ declare namespace gapi.client {
|
|
|
11092
11449
|
key?: string;
|
|
11093
11450
|
/** OAuth 2.0 token for the current user. */
|
|
11094
11451
|
oauth_token?: string;
|
|
11095
|
-
/** 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. */
|
|
11452
|
+
/** 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. */
|
|
11096
11453
|
orderBy?: string;
|
|
11097
11454
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
11098
11455
|
pageSize?: number;
|
|
@@ -13628,7 +13985,7 @@ declare namespace gapi.client {
|
|
|
13628
13985
|
prettyPrint?: boolean;
|
|
13629
13986
|
/** 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. */
|
|
13630
13987
|
quotaUser?: string;
|
|
13631
|
-
/** 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. */
|
|
13988
|
+
/** 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. */
|
|
13632
13989
|
servingConfig: string;
|
|
13633
13990
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13634
13991
|
upload_protocol?: string;
|
|
@@ -13657,7 +14014,7 @@ declare namespace gapi.client {
|
|
|
13657
14014
|
prettyPrint?: boolean;
|
|
13658
14015
|
/** 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. */
|
|
13659
14016
|
quotaUser?: string;
|
|
13660
|
-
/** 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. */
|
|
14017
|
+
/** 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. */
|
|
13661
14018
|
servingConfig: string;
|
|
13662
14019
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13663
14020
|
upload_protocol?: string;
|
|
@@ -14069,7 +14426,7 @@ declare namespace gapi.client {
|
|
|
14069
14426
|
prettyPrint?: boolean;
|
|
14070
14427
|
/** 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. */
|
|
14071
14428
|
quotaUser?: string;
|
|
14072
|
-
/** 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. */
|
|
14429
|
+
/** 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. */
|
|
14073
14430
|
servingConfig: string;
|
|
14074
14431
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14075
14432
|
upload_protocol?: string;
|
|
@@ -14098,7 +14455,7 @@ declare namespace gapi.client {
|
|
|
14098
14455
|
prettyPrint?: boolean;
|
|
14099
14456
|
/** 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. */
|
|
14100
14457
|
quotaUser?: string;
|
|
14101
|
-
/** 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. */
|
|
14458
|
+
/** 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. */
|
|
14102
14459
|
servingConfig: string;
|
|
14103
14460
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14104
14461
|
upload_protocol?: string;
|
|
@@ -14160,6 +14517,8 @@ declare namespace gapi.client {
|
|
|
14160
14517
|
prettyPrint?: boolean;
|
|
14161
14518
|
/** 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. */
|
|
14162
14519
|
quotaUser?: string;
|
|
14520
|
+
/** 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. */
|
|
14521
|
+
sessionId?: string;
|
|
14163
14522
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14164
14523
|
upload_protocol?: string;
|
|
14165
14524
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -14189,6 +14548,8 @@ declare namespace gapi.client {
|
|
|
14189
14548
|
prettyPrint?: boolean;
|
|
14190
14549
|
/** 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. */
|
|
14191
14550
|
quotaUser?: string;
|
|
14551
|
+
/** 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. */
|
|
14552
|
+
sessionId?: string;
|
|
14192
14553
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14193
14554
|
upload_protocol?: string;
|
|
14194
14555
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -14270,7 +14631,7 @@ declare namespace gapi.client {
|
|
|
14270
14631
|
key?: string;
|
|
14271
14632
|
/** OAuth 2.0 token for the current user. */
|
|
14272
14633
|
oauth_token?: string;
|
|
14273
|
-
/** 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. */
|
|
14634
|
+
/** 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. */
|
|
14274
14635
|
orderBy?: string;
|
|
14275
14636
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
14276
14637
|
pageSize?: number;
|
|
@@ -14708,7 +15069,7 @@ declare namespace gapi.client {
|
|
|
14708
15069
|
},
|
|
14709
15070
|
body: GoogleCloudDiscoveryengineV1betaResumeEngineRequest,
|
|
14710
15071
|
): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
14711
|
-
/** 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`
|
|
15072
|
+
/** 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. */
|
|
14712
15073
|
setIamPolicy(
|
|
14713
15074
|
request: {
|
|
14714
15075
|
/** V1 error format. */
|
|
@@ -16385,7 +16746,7 @@ declare namespace gapi.client {
|
|
|
16385
16746
|
prettyPrint?: boolean;
|
|
16386
16747
|
/** 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. */
|
|
16387
16748
|
quotaUser?: string;
|
|
16388
|
-
/** 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. */
|
|
16749
|
+
/** 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. */
|
|
16389
16750
|
servingConfig: string;
|
|
16390
16751
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16391
16752
|
upload_protocol?: string;
|
|
@@ -16414,7 +16775,7 @@ declare namespace gapi.client {
|
|
|
16414
16775
|
prettyPrint?: boolean;
|
|
16415
16776
|
/** 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. */
|
|
16416
16777
|
quotaUser?: string;
|
|
16417
|
-
/** 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. */
|
|
16778
|
+
/** 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. */
|
|
16418
16779
|
servingConfig: string;
|
|
16419
16780
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16420
16781
|
upload_protocol?: string;
|
|
@@ -16826,7 +17187,7 @@ declare namespace gapi.client {
|
|
|
16826
17187
|
prettyPrint?: boolean;
|
|
16827
17188
|
/** 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. */
|
|
16828
17189
|
quotaUser?: string;
|
|
16829
|
-
/** 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. */
|
|
17190
|
+
/** 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. */
|
|
16830
17191
|
servingConfig: string;
|
|
16831
17192
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16832
17193
|
upload_protocol?: string;
|
|
@@ -16855,7 +17216,7 @@ declare namespace gapi.client {
|
|
|
16855
17216
|
prettyPrint?: boolean;
|
|
16856
17217
|
/** 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. */
|
|
16857
17218
|
quotaUser?: string;
|
|
16858
|
-
/** 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. */
|
|
17219
|
+
/** 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. */
|
|
16859
17220
|
servingConfig: string;
|
|
16860
17221
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16861
17222
|
upload_protocol?: string;
|
|
@@ -16917,6 +17278,8 @@ declare namespace gapi.client {
|
|
|
16917
17278
|
prettyPrint?: boolean;
|
|
16918
17279
|
/** 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. */
|
|
16919
17280
|
quotaUser?: string;
|
|
17281
|
+
/** 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. */
|
|
17282
|
+
sessionId?: string;
|
|
16920
17283
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16921
17284
|
upload_protocol?: string;
|
|
16922
17285
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -16946,6 +17309,8 @@ declare namespace gapi.client {
|
|
|
16946
17309
|
prettyPrint?: boolean;
|
|
16947
17310
|
/** 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. */
|
|
16948
17311
|
quotaUser?: string;
|
|
17312
|
+
/** 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. */
|
|
17313
|
+
sessionId?: string;
|
|
16949
17314
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16950
17315
|
upload_protocol?: string;
|
|
16951
17316
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -17027,7 +17392,7 @@ declare namespace gapi.client {
|
|
|
17027
17392
|
key?: string;
|
|
17028
17393
|
/** OAuth 2.0 token for the current user. */
|
|
17029
17394
|
oauth_token?: string;
|
|
17030
|
-
/** 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. */
|
|
17395
|
+
/** 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. */
|
|
17031
17396
|
orderBy?: string;
|
|
17032
17397
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
17033
17398
|
pageSize?: number;
|
|
@@ -18996,6 +19361,39 @@ declare namespace gapi.client {
|
|
|
18996
19361
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18997
19362
|
uploadType?: string;
|
|
18998
19363
|
}): Request<GoogleCloudDiscoveryengineV1betaLicenseConfig>;
|
|
19364
|
+
/** Lists all the LicenseConfigs associated with the project. */
|
|
19365
|
+
list(request?: {
|
|
19366
|
+
/** V1 error format. */
|
|
19367
|
+
'$.xgafv'?: '1' | '2';
|
|
19368
|
+
/** OAuth access token. */
|
|
19369
|
+
access_token?: string;
|
|
19370
|
+
/** Data format for response. */
|
|
19371
|
+
alt?: 'json' | 'media' | 'proto';
|
|
19372
|
+
/** JSONP */
|
|
19373
|
+
callback?: string;
|
|
19374
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
19375
|
+
fields?: string;
|
|
19376
|
+
/** 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. */
|
|
19377
|
+
filter?: string;
|
|
19378
|
+
/** 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. */
|
|
19379
|
+
key?: string;
|
|
19380
|
+
/** OAuth 2.0 token for the current user. */
|
|
19381
|
+
oauth_token?: string;
|
|
19382
|
+
/** Optional. Not supported. */
|
|
19383
|
+
pageSize?: number;
|
|
19384
|
+
/** Optional. Not supported. */
|
|
19385
|
+
pageToken?: string;
|
|
19386
|
+
/** Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. */
|
|
19387
|
+
parent: string;
|
|
19388
|
+
/** Returns response with indentations and line breaks. */
|
|
19389
|
+
prettyPrint?: boolean;
|
|
19390
|
+
/** 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. */
|
|
19391
|
+
quotaUser?: string;
|
|
19392
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19393
|
+
upload_protocol?: string;
|
|
19394
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19395
|
+
uploadType?: string;
|
|
19396
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>;
|
|
18999
19397
|
/** Updates the LicenseConfig */
|
|
19000
19398
|
patch(request: {
|
|
19001
19399
|
/** V1 error format. */
|
|
@@ -19923,13 +20321,15 @@ declare namespace gapi.client {
|
|
|
19923
20321
|
callback?: string;
|
|
19924
20322
|
/** Selector specifying which fields to include in a partial response. */
|
|
19925
20323
|
fields?: string;
|
|
20324
|
+
/** 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`. */
|
|
20325
|
+
filter?: string;
|
|
19926
20326
|
/** 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. */
|
|
19927
20327
|
key?: string;
|
|
19928
20328
|
/** OAuth 2.0 token for the current user. */
|
|
19929
20329
|
oauth_token?: string;
|
|
19930
|
-
/** 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
|
|
20330
|
+
/** 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. */
|
|
19931
20331
|
orderBy?: string;
|
|
19932
|
-
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
20332
|
+
/** 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. */
|
|
19933
20333
|
pageSize?: number;
|
|
19934
20334
|
/** 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. */
|
|
19935
20335
|
pageToken?: string;
|
|
@@ -20586,6 +20986,8 @@ declare namespace gapi.client {
|
|
|
20586
20986
|
operations: OperationsResource;
|
|
20587
20987
|
}
|
|
20588
20988
|
|
|
20989
|
+
const billingAccounts: BillingAccountsResource;
|
|
20990
|
+
|
|
20589
20991
|
const projects: ProjectsResource;
|
|
20590
20992
|
}
|
|
20591
20993
|
}
|