@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20250401 → 0.0.20250419
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 +190 -6
- package/package.json +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: 20250419
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -453,7 +453,7 @@ declare namespace gapi.client {
|
|
|
453
453
|
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
454
454
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
455
455
|
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
456
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
456
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
457
457
|
queryRegex?: string;
|
|
458
458
|
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
459
459
|
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
@@ -636,6 +636,8 @@ declare namespace gapi.client {
|
|
|
636
636
|
enableSearchAdaptor?: boolean;
|
|
637
637
|
}
|
|
638
638
|
interface GoogleCloudDiscoveryengineV1alphaDataConnector {
|
|
639
|
+
/** Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. */
|
|
640
|
+
aclEnabled?: boolean;
|
|
639
641
|
/** Optional. Action configurations to make the connector support actions. */
|
|
640
642
|
actionConfig?: GoogleCloudDiscoveryengineV1alphaActionConfig;
|
|
641
643
|
/** Optional. The connector level alert config. */
|
|
@@ -646,6 +648,8 @@ declare namespace gapi.client {
|
|
|
646
648
|
bapConfig?: GoogleCloudDiscoveryengineV1alphaBAPConfig;
|
|
647
649
|
/** Output only. User actions that must be completed before the connector can start syncing data. */
|
|
648
650
|
blockingReasons?: string[];
|
|
651
|
+
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
652
|
+
connectorModes?: string[];
|
|
649
653
|
/** 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 notmutable once set by system. */
|
|
650
654
|
connectorType?: string;
|
|
651
655
|
/** Output only. Timestamp the DataConnector was created at. */
|
|
@@ -654,6 +658,8 @@ declare namespace gapi.client {
|
|
|
654
658
|
dataSource?: string;
|
|
655
659
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
656
660
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
661
|
+
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
662
|
+
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
657
663
|
/** List of entities from the connected data source to ingest. */
|
|
658
664
|
entities?: GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity[];
|
|
659
665
|
/** Output only. The errors from initialization or from the latest connector run. */
|
|
@@ -693,6 +699,12 @@ declare namespace gapi.client {
|
|
|
693
699
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
694
700
|
updateTime?: string;
|
|
695
701
|
}
|
|
702
|
+
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
703
|
+
/** Optional. Any additional parameters needed for EUA. */
|
|
704
|
+
additionalParams?: {[P in string]: any};
|
|
705
|
+
/** Optional. Any authentication parameters specific to EUA connectors. */
|
|
706
|
+
authParams?: {[P in string]: any};
|
|
707
|
+
}
|
|
696
708
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig {
|
|
697
709
|
/** Optional. The ID of the Secret Manager secret used for webhook secret. */
|
|
698
710
|
realtimeSyncSecret?: string;
|
|
@@ -896,6 +908,12 @@ declare namespace gapi.client {
|
|
|
896
908
|
enableImageAnnotation?: boolean;
|
|
897
909
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
898
910
|
enableTableAnnotation?: boolean;
|
|
911
|
+
/** Optional. List of HTML classes to exclude from the parsed content. */
|
|
912
|
+
excludeHtmlClasses?: string[];
|
|
913
|
+
/** Optional. List of HTML elements to exclude from the parsed content. */
|
|
914
|
+
excludeHtmlElements?: string[];
|
|
915
|
+
/** Optional. List of HTML ids to exclude from the parsed content. */
|
|
916
|
+
excludeHtmlIds?: string[];
|
|
899
917
|
}
|
|
900
918
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
901
919
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
@@ -969,6 +987,8 @@ declare namespace gapi.client {
|
|
|
969
987
|
companyName?: string;
|
|
970
988
|
}
|
|
971
989
|
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
990
|
+
/** Optional. Additional engine features config. */
|
|
991
|
+
engineFeaturesConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig;
|
|
972
992
|
/** The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` */
|
|
973
993
|
optimizationObjective?: string;
|
|
974
994
|
/** Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). */
|
|
@@ -978,12 +998,26 @@ declare namespace gapi.client {
|
|
|
978
998
|
/** Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. */
|
|
979
999
|
type?: string;
|
|
980
1000
|
}
|
|
1001
|
+
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig {
|
|
1002
|
+
/** Most popular engine feature config. */
|
|
1003
|
+
mostPopularConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig;
|
|
1004
|
+
/** Recommended for you engine feature config. */
|
|
1005
|
+
recommendedForYouConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig;
|
|
1006
|
+
}
|
|
1007
|
+
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig {
|
|
1008
|
+
/** The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. */
|
|
1009
|
+
timeWindowDays?: string;
|
|
1010
|
+
}
|
|
981
1011
|
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
|
|
982
1012
|
/** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
|
|
983
1013
|
targetField?: string;
|
|
984
1014
|
/** Required. The threshold to be applied to the target (e.g., 0.5). */
|
|
985
1015
|
targetFieldValueFloat?: number;
|
|
986
1016
|
}
|
|
1017
|
+
interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig {
|
|
1018
|
+
/** The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. */
|
|
1019
|
+
contextEventType?: string;
|
|
1020
|
+
}
|
|
987
1021
|
interface GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
|
|
988
1022
|
/** Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. */
|
|
989
1023
|
dataState?: string;
|
|
@@ -1449,6 +1483,8 @@ declare namespace gapi.client {
|
|
|
1449
1483
|
interface GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion {
|
|
1450
1484
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
1451
1485
|
description?: string;
|
|
1486
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
1487
|
+
document?: string;
|
|
1452
1488
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
1453
1489
|
enabled?: boolean;
|
|
1454
1490
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -1885,6 +1921,28 @@ declare namespace gapi.client {
|
|
|
1885
1921
|
/** The Google Workspace data source. */
|
|
1886
1922
|
type?: string;
|
|
1887
1923
|
}
|
|
1924
|
+
interface GoogleCloudDiscoveryengineV1AnswerGenerationSpec {
|
|
1925
|
+
/** Optional. The specification for user specified classifier spec. */
|
|
1926
|
+
userDefinedClassifierSpec?: GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec;
|
|
1927
|
+
}
|
|
1928
|
+
interface GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec {
|
|
1929
|
+
/** Optional. Whether or not to enable and include user defined classifier. */
|
|
1930
|
+
enableUserDefinedClassifier?: boolean;
|
|
1931
|
+
/** Optional. The model id to be used for the user defined classifier. */
|
|
1932
|
+
modelId?: string;
|
|
1933
|
+
/** Optional. The preamble to be used for the user defined classifier. */
|
|
1934
|
+
preamble?: string;
|
|
1935
|
+
/** Optional. The seed value to be used for the user defined classifier. */
|
|
1936
|
+
seed?: number;
|
|
1937
|
+
/** Optional. The task marker to be used for the user defined classifier. */
|
|
1938
|
+
taskMarker?: string;
|
|
1939
|
+
/** Optional. The temperature value to be used for the user defined classifier. */
|
|
1940
|
+
temperature?: number;
|
|
1941
|
+
/** Optional. The top-k value to be used for the user defined classifier. */
|
|
1942
|
+
topK?: string;
|
|
1943
|
+
/** Optional. The top-p value to be used for the user defined classifier. */
|
|
1944
|
+
topP?: number;
|
|
1945
|
+
}
|
|
1888
1946
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
1889
1947
|
/** Operation create time. */
|
|
1890
1948
|
createTime?: string;
|
|
@@ -1898,6 +1956,8 @@ declare namespace gapi.client {
|
|
|
1898
1956
|
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest {
|
|
1899
1957
|
/** Optional. Specification to boost suggestions matching the condition. */
|
|
1900
1958
|
boostSpec?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec;
|
|
1959
|
+
/** Optional. Experiment ids for this request. */
|
|
1960
|
+
experimentIds?: string[];
|
|
1901
1961
|
/** Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. */
|
|
1902
1962
|
includeTailSuggestions?: boolean;
|
|
1903
1963
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. */
|
|
@@ -2067,6 +2127,28 @@ declare namespace gapi.client {
|
|
|
2067
2127
|
/** ID of the citation source. */
|
|
2068
2128
|
referenceId?: string;
|
|
2069
2129
|
}
|
|
2130
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec {
|
|
2131
|
+
/** Optional. The specification for user specified classifier spec. */
|
|
2132
|
+
userDefinedClassifierSpec?: GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec;
|
|
2133
|
+
}
|
|
2134
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec {
|
|
2135
|
+
/** Optional. Whether or not to enable and include user defined classifier. */
|
|
2136
|
+
enableUserDefinedClassifier?: boolean;
|
|
2137
|
+
/** Optional. The model id to be used for the user defined classifier. */
|
|
2138
|
+
modelId?: string;
|
|
2139
|
+
/** Optional. The preamble to be used for the user defined classifier. */
|
|
2140
|
+
preamble?: string;
|
|
2141
|
+
/** Optional. The seed value to be used for the user defined classifier. */
|
|
2142
|
+
seed?: number;
|
|
2143
|
+
/** Optional. The task marker to be used for the user defined classifier. */
|
|
2144
|
+
taskMarker?: string;
|
|
2145
|
+
/** Optional. The temperature value to be used for the user defined classifier. */
|
|
2146
|
+
temperature?: number;
|
|
2147
|
+
/** Optional. The top-k value to be used for the user defined classifier. */
|
|
2148
|
+
topK?: string;
|
|
2149
|
+
/** Optional. The top-p value to be used for the user defined classifier. */
|
|
2150
|
+
topP?: number;
|
|
2151
|
+
}
|
|
2070
2152
|
interface GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport {
|
|
2071
2153
|
/** Required. End of the claim, exclusive. */
|
|
2072
2154
|
endIndex?: string;
|
|
@@ -2533,18 +2615,26 @@ declare namespace gapi.client {
|
|
|
2533
2615
|
endPos?: number;
|
|
2534
2616
|
/** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned. */
|
|
2535
2617
|
groundingCheckRequired?: boolean;
|
|
2618
|
+
/** Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. */
|
|
2619
|
+
score?: number;
|
|
2536
2620
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */
|
|
2537
2621
|
startPos?: number;
|
|
2538
2622
|
}
|
|
2539
2623
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
2540
2624
|
/** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
|
|
2541
2625
|
citationThreshold?: number;
|
|
2626
|
+
/** The control flag that enables claim-level grounding score in the response. */
|
|
2627
|
+
enableClaimLevelScore?: boolean;
|
|
2542
2628
|
}
|
|
2543
2629
|
interface GoogleCloudDiscoveryengineV1betaChunk {
|
|
2630
|
+
/** Output only. Annotation contents if the current chunk contains annotations. */
|
|
2631
|
+
annotationContents?: string[];
|
|
2544
2632
|
/** Output only. Metadata of the current chunk. */
|
|
2545
2633
|
chunkMetadata?: GoogleCloudDiscoveryengineV1betaChunkChunkMetadata;
|
|
2546
2634
|
/** Content is a string from a document (parsed content). */
|
|
2547
2635
|
content?: string;
|
|
2636
|
+
/** Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
|
|
2637
|
+
dataUrls?: string[];
|
|
2548
2638
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
2549
2639
|
derivedStructData?: {[P in string]: any};
|
|
2550
2640
|
/** Metadata of the document from the current chunk. */
|
|
@@ -2647,7 +2737,7 @@ declare namespace gapi.client {
|
|
|
2647
2737
|
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
2648
2738
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
2649
2739
|
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
2650
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
2740
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
2651
2741
|
queryRegex?: string;
|
|
2652
2742
|
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
2653
2743
|
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
@@ -2976,7 +3066,7 @@ declare namespace gapi.client {
|
|
|
2976
3066
|
interface GoogleCloudDiscoveryengineV1betaDocument {
|
|
2977
3067
|
/** Access control information for the document. */
|
|
2978
3068
|
aclInfo?: GoogleCloudDiscoveryengineV1betaDocumentAclInfo;
|
|
2979
|
-
/** The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
3069
|
+
/** The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
2980
3070
|
content?: GoogleCloudDiscoveryengineV1betaDocumentContent;
|
|
2981
3071
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
2982
3072
|
derivedStructData?: {[P in string]: any};
|
|
@@ -3008,7 +3098,7 @@ declare namespace gapi.client {
|
|
|
3008
3098
|
principals?: GoogleCloudDiscoveryengineV1betaPrincipal[];
|
|
3009
3099
|
}
|
|
3010
3100
|
interface GoogleCloudDiscoveryengineV1betaDocumentContent {
|
|
3011
|
-
/** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `
|
|
3101
|
+
/** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
3012
3102
|
mimeType?: string;
|
|
3013
3103
|
/** The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. */
|
|
3014
3104
|
rawBytes?: string;
|
|
@@ -3075,6 +3165,12 @@ declare namespace gapi.client {
|
|
|
3075
3165
|
enableImageAnnotation?: boolean;
|
|
3076
3166
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
3077
3167
|
enableTableAnnotation?: boolean;
|
|
3168
|
+
/** Optional. List of HTML classes to exclude from the parsed content. */
|
|
3169
|
+
excludeHtmlClasses?: string[];
|
|
3170
|
+
/** Optional. List of HTML elements to exclude from the parsed content. */
|
|
3171
|
+
excludeHtmlElements?: string[];
|
|
3172
|
+
/** Optional. List of HTML ids to exclude from the parsed content. */
|
|
3173
|
+
excludeHtmlIds?: string[];
|
|
3078
3174
|
}
|
|
3079
3175
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
3080
3176
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
@@ -3115,6 +3211,8 @@ declare namespace gapi.client {
|
|
|
3115
3211
|
displayName?: string;
|
|
3116
3212
|
/** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
3117
3213
|
industryVertical?: string;
|
|
3214
|
+
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
3215
|
+
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
3118
3216
|
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
3119
3217
|
name?: string;
|
|
3120
3218
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
@@ -3150,6 +3248,38 @@ declare namespace gapi.client {
|
|
|
3150
3248
|
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
3151
3249
|
companyName?: string;
|
|
3152
3250
|
}
|
|
3251
|
+
interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig {
|
|
3252
|
+
/** Optional. Additional engine features config. */
|
|
3253
|
+
engineFeaturesConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig;
|
|
3254
|
+
/** The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` */
|
|
3255
|
+
optimizationObjective?: string;
|
|
3256
|
+
/** Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). */
|
|
3257
|
+
optimizationObjectiveConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
|
|
3258
|
+
/** The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before. */
|
|
3259
|
+
trainingState?: string;
|
|
3260
|
+
/** Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. */
|
|
3261
|
+
type?: string;
|
|
3262
|
+
}
|
|
3263
|
+
interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig {
|
|
3264
|
+
/** Most popular engine feature config. */
|
|
3265
|
+
mostPopularConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig;
|
|
3266
|
+
/** Recommended for you engine feature config. */
|
|
3267
|
+
recommendedForYouConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig;
|
|
3268
|
+
}
|
|
3269
|
+
interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig {
|
|
3270
|
+
/** The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. */
|
|
3271
|
+
timeWindowDays?: string;
|
|
3272
|
+
}
|
|
3273
|
+
interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
|
|
3274
|
+
/** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
|
|
3275
|
+
targetField?: string;
|
|
3276
|
+
/** Required. The threshold to be applied to the target (e.g., 0.5). */
|
|
3277
|
+
targetFieldValueFloat?: number;
|
|
3278
|
+
}
|
|
3279
|
+
interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig {
|
|
3280
|
+
/** The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. */
|
|
3281
|
+
contextEventType?: string;
|
|
3282
|
+
}
|
|
3153
3283
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
3154
3284
|
/** The add-on that this search engine enables. */
|
|
3155
3285
|
searchAddOns?: string[];
|
|
@@ -3187,12 +3317,18 @@ declare namespace gapi.client {
|
|
|
3187
3317
|
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
3188
3318
|
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
3189
3319
|
chunkText?: string;
|
|
3320
|
+
/** The domain of the source. */
|
|
3321
|
+
domain?: string;
|
|
3190
3322
|
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
3191
3323
|
index?: number;
|
|
3192
3324
|
/** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
|
|
3193
3325
|
source?: string;
|
|
3194
3326
|
/** More fine-grained information for the source reference. */
|
|
3195
3327
|
sourceMetadata?: {[P in string]: string};
|
|
3328
|
+
/** The title of the source. */
|
|
3329
|
+
title?: string;
|
|
3330
|
+
/** The URI of the source. */
|
|
3331
|
+
uri?: string;
|
|
3196
3332
|
}
|
|
3197
3333
|
interface GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
3198
3334
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
@@ -3955,6 +4091,8 @@ declare namespace gapi.client {
|
|
|
3955
4091
|
interface GoogleCloudDiscoveryengineV1betaSearchLinkPromotion {
|
|
3956
4092
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
3957
4093
|
description?: string;
|
|
4094
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
4095
|
+
document?: string;
|
|
3958
4096
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
3959
4097
|
enabled?: boolean;
|
|
3960
4098
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -4464,6 +4602,8 @@ declare namespace gapi.client {
|
|
|
4464
4602
|
summary?: string;
|
|
4465
4603
|
}
|
|
4466
4604
|
interface GoogleCloudDiscoveryengineV1betaServingConfig {
|
|
4605
|
+
/** Optional. The specification for answer generation. */
|
|
4606
|
+
answerGenerationSpec?: GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec;
|
|
4467
4607
|
/** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
|
|
4468
4608
|
boostControlIds?: string[];
|
|
4469
4609
|
/** Output only. ServingConfig created timestamp. */
|
|
@@ -4804,7 +4944,7 @@ declare namespace gapi.client {
|
|
|
4804
4944
|
interface GoogleCloudDiscoveryengineV1Condition {
|
|
4805
4945
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
4806
4946
|
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
4807
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
4947
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
4808
4948
|
queryRegex?: string;
|
|
4809
4949
|
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
4810
4950
|
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
@@ -5066,6 +5206,12 @@ declare namespace gapi.client {
|
|
|
5066
5206
|
enableImageAnnotation?: boolean;
|
|
5067
5207
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
5068
5208
|
enableTableAnnotation?: boolean;
|
|
5209
|
+
/** Optional. List of HTML classes to exclude from the parsed content. */
|
|
5210
|
+
excludeHtmlClasses?: string[];
|
|
5211
|
+
/** Optional. List of HTML elements to exclude from the parsed content. */
|
|
5212
|
+
excludeHtmlElements?: string[];
|
|
5213
|
+
/** Optional. List of HTML ids to exclude from the parsed content. */
|
|
5214
|
+
excludeHtmlIds?: string[];
|
|
5069
5215
|
}
|
|
5070
5216
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
5071
5217
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
@@ -5097,6 +5243,8 @@ declare namespace gapi.client {
|
|
|
5097
5243
|
displayName?: string;
|
|
5098
5244
|
/** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
5099
5245
|
industryVertical?: string;
|
|
5246
|
+
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
5247
|
+
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
5100
5248
|
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
5101
5249
|
name?: string;
|
|
5102
5250
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
@@ -5132,6 +5280,38 @@ declare namespace gapi.client {
|
|
|
5132
5280
|
/** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
|
|
5133
5281
|
companyName?: string;
|
|
5134
5282
|
}
|
|
5283
|
+
interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig {
|
|
5284
|
+
/** Optional. Additional engine features config. */
|
|
5285
|
+
engineFeaturesConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig;
|
|
5286
|
+
/** The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` */
|
|
5287
|
+
optimizationObjective?: string;
|
|
5288
|
+
/** Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). */
|
|
5289
|
+
optimizationObjectiveConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
|
|
5290
|
+
/** The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before. */
|
|
5291
|
+
trainingState?: string;
|
|
5292
|
+
/** Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. */
|
|
5293
|
+
type?: string;
|
|
5294
|
+
}
|
|
5295
|
+
interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig {
|
|
5296
|
+
/** Most popular engine feature config. */
|
|
5297
|
+
mostPopularConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig;
|
|
5298
|
+
/** Recommended for you engine feature config. */
|
|
5299
|
+
recommendedForYouConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig;
|
|
5300
|
+
}
|
|
5301
|
+
interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig {
|
|
5302
|
+
/** The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. */
|
|
5303
|
+
timeWindowDays?: string;
|
|
5304
|
+
}
|
|
5305
|
+
interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
|
|
5306
|
+
/** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
|
|
5307
|
+
targetField?: string;
|
|
5308
|
+
/** Required. The threshold to be applied to the target (e.g., 0.5). */
|
|
5309
|
+
targetFieldValueFloat?: number;
|
|
5310
|
+
}
|
|
5311
|
+
interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig {
|
|
5312
|
+
/** The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. */
|
|
5313
|
+
contextEventType?: string;
|
|
5314
|
+
}
|
|
5135
5315
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
5136
5316
|
/** The add-on that this search engine enables. */
|
|
5137
5317
|
searchAddOns?: string[];
|
|
@@ -5306,6 +5486,8 @@ declare namespace gapi.client {
|
|
|
5306
5486
|
interface GoogleCloudDiscoveryengineV1SearchLinkPromotion {
|
|
5307
5487
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
5308
5488
|
description?: string;
|
|
5489
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
5490
|
+
document?: string;
|
|
5309
5491
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
5310
5492
|
enabled?: boolean;
|
|
5311
5493
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -5384,6 +5566,8 @@ declare namespace gapi.client {
|
|
|
5384
5566
|
version?: string;
|
|
5385
5567
|
}
|
|
5386
5568
|
interface GoogleCloudDiscoveryengineV1ServingConfig {
|
|
5569
|
+
/** Optional. The specification for answer generation. */
|
|
5570
|
+
answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerGenerationSpec;
|
|
5387
5571
|
/** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
|
|
5388
5572
|
boostControlIds?: string[];
|
|
5389
5573
|
/** Output only. ServingConfig created timestamp. */
|