@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20250314 → 0.0.20250320
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 +14 -8
- 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250320
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -395,6 +395,8 @@ declare namespace gapi.client {
|
|
|
395
395
|
actionParams?: {[P in string]: any};
|
|
396
396
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
397
397
|
isActionConfigured?: boolean;
|
|
398
|
+
/** Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */
|
|
399
|
+
serviceName?: string;
|
|
398
400
|
}
|
|
399
401
|
interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest {
|
|
400
402
|
/** Optional. Specification to boost suggestions matching the condition. */
|
|
@@ -415,7 +417,7 @@ declare namespace gapi.client {
|
|
|
415
417
|
userPseudoId?: string;
|
|
416
418
|
}
|
|
417
419
|
interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
|
|
418
|
-
/** Condition boost specifications. If a suggestion matches multiple conditions in the
|
|
420
|
+
/** Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. */
|
|
419
421
|
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[];
|
|
420
422
|
}
|
|
421
423
|
interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec {
|
|
@@ -2986,7 +2988,7 @@ declare namespace gapi.client {
|
|
|
2986
2988
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2987
2989
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
2988
2990
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2989
|
-
/** Specifications that define the specific
|
|
2991
|
+
/** 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. */
|
|
2990
2992
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
2991
2993
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
2992
2994
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
@@ -3020,7 +3022,7 @@ declare namespace gapi.client {
|
|
|
3020
3022
|
query?: string;
|
|
3021
3023
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
3022
3024
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
3023
|
-
/** 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 BYOE. === BYOE === If
|
|
3025
|
+
/** 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */
|
|
3024
3026
|
rankingExpression?: string;
|
|
3025
3027
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
3026
3028
|
rankingExpressionBackend?: string;
|
|
@@ -3050,7 +3052,7 @@ declare namespace gapi.client {
|
|
|
3050
3052
|
userPseudoId?: string;
|
|
3051
3053
|
}
|
|
3052
3054
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec {
|
|
3053
|
-
/** Condition boost specifications. If a document matches multiple conditions in the
|
|
3055
|
+
/** Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */
|
|
3054
3056
|
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[];
|
|
3055
3057
|
}
|
|
3056
3058
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
@@ -4240,6 +4242,8 @@ declare namespace gapi.client {
|
|
|
4240
4242
|
updateTime?: string;
|
|
4241
4243
|
}
|
|
4242
4244
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
4245
|
+
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
4246
|
+
aclEnabled?: boolean;
|
|
4243
4247
|
/** Optional. Configuration for advanced site search. */
|
|
4244
4248
|
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig;
|
|
4245
4249
|
/** Output only. Data size estimation for billing. */
|
|
@@ -4749,7 +4753,7 @@ declare namespace gapi.client {
|
|
|
4749
4753
|
canonicalFilter?: string;
|
|
4750
4754
|
/** A specification for configuring the behavior of content search. */
|
|
4751
4755
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
4752
|
-
/** Specifications that define the specific
|
|
4756
|
+
/** 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. */
|
|
4753
4757
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
4754
4758
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
4755
4759
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
@@ -4783,7 +4787,7 @@ declare namespace gapi.client {
|
|
|
4783
4787
|
query?: string;
|
|
4784
4788
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
4785
4789
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
4786
|
-
/** 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 BYOE. === BYOE === If
|
|
4790
|
+
/** 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */
|
|
4787
4791
|
rankingExpression?: string;
|
|
4788
4792
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
4789
4793
|
rankingExpressionBackend?: string;
|
|
@@ -4813,7 +4817,7 @@ declare namespace gapi.client {
|
|
|
4813
4817
|
userPseudoId?: string;
|
|
4814
4818
|
}
|
|
4815
4819
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec {
|
|
4816
|
-
/** Condition boost specifications. If a document matches multiple conditions in the
|
|
4820
|
+
/** Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */
|
|
4817
4821
|
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[];
|
|
4818
4822
|
}
|
|
4819
4823
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
@@ -5252,6 +5256,8 @@ declare namespace gapi.client {
|
|
|
5252
5256
|
updateTime?: string;
|
|
5253
5257
|
}
|
|
5254
5258
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
5259
|
+
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
5260
|
+
aclEnabled?: boolean;
|
|
5255
5261
|
/** Optional. Configuration for advanced site search. */
|
|
5256
5262
|
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig;
|
|
5257
5263
|
/** Output only. Data size estimation for billing. */
|