@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.3.20260804 → 0.3.20260815
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 +83 -11
- package/package.json +1 -1
- package/readme.md +1 -1
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: 20260815
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -694,6 +694,9 @@ declare namespace gapi.client {
|
|
|
694
694
|
policyResults?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
695
695
|
/** Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. */
|
|
696
696
|
verdict?: 'UNSPECIFIED' | 'ALLOW' | 'BLOCK';
|
|
697
|
+
/** Output only. The source of the violation. */
|
|
698
|
+
violationSource?:
|
|
699
|
+
'VIOLATION_SOURCE_UNSPECIFIED' | 'SYSTEM' | 'PROMPT' | 'ATTACHMENT';
|
|
697
700
|
}
|
|
698
701
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
699
702
|
/** The banned phrases that were found in the query or the answer. */
|
|
@@ -1303,8 +1306,6 @@ declare namespace gapi.client {
|
|
|
1303
1306
|
vpcscEnabled?: boolean;
|
|
1304
1307
|
}
|
|
1305
1308
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
1306
|
-
/** Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. */
|
|
1307
|
-
authenticatedAccount?: string;
|
|
1308
1309
|
/** Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). */
|
|
1309
1310
|
author?: string;
|
|
1310
1311
|
/** Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. */
|
|
@@ -1721,7 +1722,7 @@ declare namespace gapi.client {
|
|
|
1721
1722
|
disableAnalytics?: boolean;
|
|
1722
1723
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
1723
1724
|
displayName?: string;
|
|
1724
|
-
/** 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` * `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` * `canvas-workspace` * `
|
|
1725
|
+
/** 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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
1725
1726
|
features?: {
|
|
1726
1727
|
[P in string]:
|
|
1727
1728
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -3476,7 +3477,10 @@ declare namespace gapi.client {
|
|
|
3476
3477
|
document?: GoogleCloudDiscoveryengineV1betaDocument;
|
|
3477
3478
|
/** The type of the person. */
|
|
3478
3479
|
personType?:
|
|
3479
|
-
|
|
3480
|
+
| 'PERSON_TYPE_UNSPECIFIED'
|
|
3481
|
+
| 'CLOUD_IDENTITY'
|
|
3482
|
+
| 'THIRD_PARTY_IDENTITY'
|
|
3483
|
+
| 'GOOGLE_GROUP';
|
|
3480
3484
|
/** The score of each suggestion. The score is in the range of [0, 1]. */
|
|
3481
3485
|
score?: number;
|
|
3482
3486
|
/** The suggestion for the query. */
|
|
@@ -4027,6 +4031,9 @@ declare namespace gapi.client {
|
|
|
4027
4031
|
policyResults?: GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
4028
4032
|
/** Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. */
|
|
4029
4033
|
verdict?: 'UNSPECIFIED' | 'ALLOW' | 'BLOCK';
|
|
4034
|
+
/** Output only. The source of the violation. */
|
|
4035
|
+
violationSource?:
|
|
4036
|
+
'VIOLATION_SOURCE_UNSPECIFIED' | 'SYSTEM' | 'PROMPT' | 'ATTACHMENT';
|
|
4030
4037
|
}
|
|
4031
4038
|
interface GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
4032
4039
|
/** The banned phrases that were found in the query or the answer. */
|
|
@@ -4280,7 +4287,7 @@ declare namespace gapi.client {
|
|
|
4280
4287
|
interface GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest {
|
|
4281
4288
|
/** Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. */
|
|
4282
4289
|
deleteUnassignedUserLicenses?: boolean;
|
|
4283
|
-
/** The inline source for the input content for
|
|
4290
|
+
/** The inline source for the input content for license assignment. */
|
|
4284
4291
|
inlineSource?: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource;
|
|
4285
4292
|
}
|
|
4286
4293
|
interface GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource {
|
|
@@ -5169,7 +5176,7 @@ declare namespace gapi.client {
|
|
|
5169
5176
|
disableAnalytics?: boolean;
|
|
5170
5177
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
5171
5178
|
displayName?: string;
|
|
5172
|
-
/** 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` * `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` * `canvas-workspace` * `
|
|
5179
|
+
/** 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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
5173
5180
|
features?: {
|
|
5174
5181
|
[P in string]:
|
|
5175
5182
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6749,7 +6756,7 @@ declare namespace gapi.client {
|
|
|
6749
6756
|
mode?: 'MODE_UNSPECIFIED' | 'SUGGESTION_ONLY' | 'AUTO';
|
|
6750
6757
|
}
|
|
6751
6758
|
interface GoogleCloudDiscoveryengineV1betaSearchResponse {
|
|
6752
|
-
/** Controls applied as part of the Control service. */
|
|
6759
|
+
/** Optional. Controls applied as part of the Control service. */
|
|
6753
6760
|
appliedControls?: string[];
|
|
6754
6761
|
/** A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. */
|
|
6755
6762
|
attributionToken?: string;
|
|
@@ -6917,6 +6924,8 @@ declare namespace gapi.client {
|
|
|
6917
6924
|
modelScores?: {[P in string]: GoogleCloudDiscoveryengineV1betaDoubleList};
|
|
6918
6925
|
/** Optional. A set of ranking signals associated with the result. */
|
|
6919
6926
|
rankSignals?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals;
|
|
6927
|
+
/** Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. */
|
|
6928
|
+
retrievalSignals?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRetrievalSignals;
|
|
6920
6929
|
}
|
|
6921
6930
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals {
|
|
6922
6931
|
/** Optional. Combined custom boosts for a doc. */
|
|
@@ -6946,6 +6955,13 @@ declare namespace gapi.client {
|
|
|
6946
6955
|
/** Optional. Float value representing the ranking signal (e.g. 1.25 for BM25). */
|
|
6947
6956
|
value?: number;
|
|
6948
6957
|
}
|
|
6958
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRetrievalSignals {
|
|
6959
|
+
/** Optional. Indicates how the result was retrieved. */
|
|
6960
|
+
retrievalSources?:
|
|
6961
|
+
'RETRIEVAL_SOURCE_UNSPECIFIED' | 'KEYWORD_SEARCH' | 'SEMANTIC_SEARCH'[];
|
|
6962
|
+
/** Optional. Relevance score used by the filter when semantic_relevance_threshold is set. */
|
|
6963
|
+
semanticRelevanceScore?: number;
|
|
6964
|
+
}
|
|
6949
6965
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo {
|
|
6950
6966
|
/** Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */
|
|
6951
6967
|
name?: string;
|
|
@@ -7827,8 +7843,6 @@ declare namespace gapi.client {
|
|
|
7827
7843
|
vpcscEnabled?: boolean;
|
|
7828
7844
|
}
|
|
7829
7845
|
interface GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
7830
|
-
/** Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. */
|
|
7831
|
-
authenticatedAccount?: string;
|
|
7832
7846
|
/** Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). */
|
|
7833
7847
|
author?: string;
|
|
7834
7848
|
/** Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. */
|
|
@@ -8197,7 +8211,7 @@ declare namespace gapi.client {
|
|
|
8197
8211
|
disableAnalytics?: boolean;
|
|
8198
8212
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
8199
8213
|
displayName?: string;
|
|
8200
|
-
/** 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` * `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` * `canvas-workspace` * `
|
|
8214
|
+
/** 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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
8201
8215
|
features?: {
|
|
8202
8216
|
[P in string]:
|
|
8203
8217
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -20876,6 +20890,64 @@ declare namespace gapi.client {
|
|
|
20876
20890
|
},
|
|
20877
20891
|
body: GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest,
|
|
20878
20892
|
): Request<GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>;
|
|
20893
|
+
/** Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. */
|
|
20894
|
+
provision(request: {
|
|
20895
|
+
/** V1 error format. */
|
|
20896
|
+
'$.xgafv'?: '1' | '2';
|
|
20897
|
+
/** OAuth access token. */
|
|
20898
|
+
access_token?: string;
|
|
20899
|
+
/** Data format for response. */
|
|
20900
|
+
alt?: 'json' | 'media' | 'proto';
|
|
20901
|
+
/** JSONP */
|
|
20902
|
+
callback?: string;
|
|
20903
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
20904
|
+
fields?: string;
|
|
20905
|
+
/** 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. */
|
|
20906
|
+
key?: string;
|
|
20907
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
20908
|
+
name: string;
|
|
20909
|
+
/** OAuth 2.0 token for the current user. */
|
|
20910
|
+
oauth_token?: string;
|
|
20911
|
+
/** Returns response with indentations and line breaks. */
|
|
20912
|
+
prettyPrint?: boolean;
|
|
20913
|
+
/** 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. */
|
|
20914
|
+
quotaUser?: string;
|
|
20915
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20916
|
+
upload_protocol?: string;
|
|
20917
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
20918
|
+
uploadType?: string;
|
|
20919
|
+
/** Request body */
|
|
20920
|
+
resource: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
|
|
20921
|
+
}): Request<GoogleLongrunningOperation>;
|
|
20922
|
+
provision(
|
|
20923
|
+
request: {
|
|
20924
|
+
/** V1 error format. */
|
|
20925
|
+
'$.xgafv'?: '1' | '2';
|
|
20926
|
+
/** OAuth access token. */
|
|
20927
|
+
access_token?: string;
|
|
20928
|
+
/** Data format for response. */
|
|
20929
|
+
alt?: 'json' | 'media' | 'proto';
|
|
20930
|
+
/** JSONP */
|
|
20931
|
+
callback?: string;
|
|
20932
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
20933
|
+
fields?: string;
|
|
20934
|
+
/** 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. */
|
|
20935
|
+
key?: string;
|
|
20936
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
20937
|
+
name: string;
|
|
20938
|
+
/** OAuth 2.0 token for the current user. */
|
|
20939
|
+
oauth_token?: string;
|
|
20940
|
+
/** Returns response with indentations and line breaks. */
|
|
20941
|
+
prettyPrint?: boolean;
|
|
20942
|
+
/** 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. */
|
|
20943
|
+
quotaUser?: string;
|
|
20944
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20945
|
+
upload_protocol?: string;
|
|
20946
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
20947
|
+
uploadType?: string;
|
|
20948
|
+
},
|
|
20949
|
+
body: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest,
|
|
20950
|
+
): Request<GoogleLongrunningOperation>;
|
|
20879
20951
|
/** Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. */
|
|
20880
20952
|
removeDedicatedCrawlRate(request: {
|
|
20881
20953
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -71,7 +71,7 @@ var client_id = '',
|
|
|
71
71
|
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
|
72
72
|
'https://www.googleapis.com/auth/cloud-platform',
|
|
73
73
|
|
|
74
|
-
// View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf.
|
|
74
|
+
// View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf. Also view the artifacts you access through NotebookLM Enterprise.
|
|
75
75
|
'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
76
76
|
|
|
77
77
|
// View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data.
|