@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20241220 → 0.0.20250107

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
-// Revision: 20241220
+// Revision: 20250107
 
 /// <reference types="gapi.client" />
 
@@ -158,7 +158,12 @@ declare namespace gapi.client {
       /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
       functionName?: string;
     }
-    interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {}
+    interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
+      /** If set true, automatic refresh is disabled for the DataStore. */
+      disableAutomaticRefresh?: boolean;
+      /** If set true, initial indexing is disabled for the DataStore. */
+      disableInitialIndex?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1alphaAclConfig {
       /** Identity provider config. */
       idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
@@ -200,6 +205,8 @@ declare namespace gapi.client {
       references?: GoogleCloudDiscoveryengineV1alphaAnswerReference[];
       /** Suggested related questions. */
       relatedQuestions?: string[];
+      /** Optional. Safety ratings. */
+      safetyRatings?: GoogleCloudDiscoveryengineV1alphaSafetyRating[];
       /** The state of the answer generation. */
       state?: string;
       /** Answer generation steps. */
@@ -376,7 +383,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaCollection {
       /** Output only. Timestamp the Collection was created at. */
       createTime?: string;
-      /** Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnector.GetDataConnector method. */
+      /** Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. */
       dataConnector?: GoogleCloudDiscoveryengineV1alphaDataConnector;
       /** Required. The Collection 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. */
       displayName?: string;
@@ -470,12 +477,14 @@ declare namespace gapi.client {
       useCases?: string[];
     }
     interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
-      /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
       boost?: number;
       /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
       dataStore?: string;
       /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
       filter?: string;
+      /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      fixedBoost?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
       /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -678,6 +687,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -938,6 +953,8 @@ declare namespace gapi.client {
       documentDataMap?: {[P in string]: {[P in string]: any}};
     }
     interface GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig {
+      /** Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. */
+      nextSyncTime?: GoogleTypeDateTime;
       /** Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. */
       refreshInterval?: string;
     }
@@ -1248,6 +1265,32 @@ declare namespace gapi.client {
       /** Reason why the URI was not crawled. */
       errorMessage?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse {
+      /** Errors from service when handling the request. */
+      error?: GoogleRpcStatus;
+      /** Output only. The state of the response. */
+      state?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSafetyRating {
+      /** Output only. Indicates whether the content was filtered out because of this rating. */
+      blocked?: boolean;
+      /** Output only. Harm category. */
+      category?: string;
+      /** Output only. Harm probability levels in the content. */
+      probability?: string;
+      /** Output only. Harm probability score. */
+      probabilityScore?: number;
+      /** Output only. Harm severity levels in the content. */
+      severity?: string;
+      /** Output only. Harm severity score. */
+      severityScore?: number;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSchema {
       /** Output only. Configurations for fields of the schema. */
       fieldConfigs?: GoogleCloudDiscoveryengineV1alphaFieldConfig[];
@@ -1483,7 +1526,7 @@ declare namespace gapi.client {
       imageBytes?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
-      /** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
+      /** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
       filterExtractionCondition?: string;
       /** 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`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
       geoSearchQueryDetectionFieldNames?: string[];
@@ -1538,6 +1581,18 @@ declare namespace gapi.client {
       /** The user query. */
       query?: GoogleCloudDiscoveryengineV1alphaQuery;
     }
+    interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse {
+      /** Errors from service when handling the request. */
+      error?: GoogleRpcStatus;
+      /** Output only. The state of the response. */
+      state?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata {}
     interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata {
       /** Operation create time. */
@@ -1565,7 +1620,7 @@ declare namespace gapi.client {
       verifyTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaTargetSite {
-      /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
+      /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
       exactMatch?: boolean;
       /** Output only. Failure reason. */
       failureReason?: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason;
@@ -1745,7 +1800,12 @@ declare namespace gapi.client {
       /** The suggestion for the query. */
       suggestion?: string;
     }
-    interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {}
+    interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
+      /** If set true, automatic refresh is disabled for the DataStore. */
+      disableAutomaticRefresh?: boolean;
+      /** If set true, initial indexing is disabled for the DataStore. */
+      disableInitialIndex?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1betaAlloyDbSource {
       /** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
       clusterId?: string;
@@ -1783,6 +1843,8 @@ declare namespace gapi.client {
       references?: GoogleCloudDiscoveryengineV1betaAnswerReference[];
       /** Suggested related questions. */
       relatedQuestions?: string[];
+      /** Optional. Safety ratings. */
+      safetyRatings?: GoogleCloudDiscoveryengineV1betaSafetyRating[];
       /** The state of the answer generation. */
       state?: string;
       /** Answer generation steps. */
@@ -1897,6 +1959,14 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec {
       /** Enable the safety filtering on the answer response. It is false by default. */
       enable?: boolean;
+      /** Optional. Safety settings. This settings are effective only when the safety_spec.enable is true. */
+      safetySettings?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting[];
+    }
+    interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting {
+      /** Required. Harm category. */
+      category?: string;
+      /** Required. The harm block threshold. */
+      threshold?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec {
       /** Search parameters. */
@@ -2376,12 +2446,14 @@ declare namespace gapi.client {
       useCases?: string[];
     }
     interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
-      /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
       boost?: number;
       /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
       dataStore?: string;
       /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
       filter?: string;
+      /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      fixedBoost?: number;
     }
     interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
       /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -2522,7 +2594,7 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1betaDataStore {
       /** Optional. Configuration for advanced site search. */
-      advancedSiteSearchConfig?: any;
+      advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
       /** Output only. CMEK-related information for the DataStore. */
@@ -2588,6 +2660,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2619,7 +2697,7 @@ declare namespace gapi.client {
       content?: GoogleCloudDiscoveryengineV1betaDocumentContent;
       /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
       derivedStructData?: {[P in string]: any};
-      /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
+      /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. */
       id?: string;
       /** 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. */
       indexStatus?: GoogleCloudDiscoveryengineV1betaDocumentIndexStatus;
@@ -3235,7 +3313,7 @@ declare namespace gapi.client {
       nextPageToken?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse {
-      /** The EvaluationResults. */
+      /** The evaluation results for the SampleQuerys. */
       evaluationResults?: GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult[];
       /** A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
@@ -3501,7 +3579,7 @@ declare namespace gapi.client {
       metadata?: {[P in string]: any};
     }
     interface GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
-      /** Optional. Full resource name of the SiteCredential, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
+      /** Optional. Full resource name of the `SiteCredential`, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
       siteCredential?: string;
       /** Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */
       uris?: string[];
@@ -3525,6 +3603,20 @@ declare namespace gapi.client {
       uri?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaResumeEngineRequest {}
+    interface GoogleCloudDiscoveryengineV1betaSafetyRating {
+      /** Output only. Indicates whether the content was filtered out because of this rating. */
+      blocked?: boolean;
+      /** Output only. Harm category. */
+      category?: string;
+      /** Output only. Harm probability levels in the content. */
+      probability?: string;
+      /** Output only. Harm probability score. */
+      probabilityScore?: number;
+      /** Output only. Harm severity levels in the content. */
+      severity?: string;
+      /** Output only. Harm severity score. */
+      severityScore?: number;
+    }
     interface GoogleCloudDiscoveryengineV1betaSampleQuery {
       /** Output only. Timestamp the SampleQuery was created at. */
       createTime?: string;
@@ -3796,7 +3888,7 @@ declare namespace gapi.client {
       imageBytes?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
-      /** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
+      /** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
       filterExtractionCondition?: string;
       /** 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`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
       geoSearchQueryDetectionFieldNames?: string[];
@@ -4069,7 +4161,7 @@ declare namespace gapi.client {
       personalizationSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec;
       /** Condition promote specifications. Maximum number of specifications is 100. */
       promoteControlIds?: string[];
-      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is 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)`. */
+      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is 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)`. */
       rankingExpression?: string;
       /** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
       redirectControlIds?: string[];
@@ -4165,7 +4257,7 @@ declare namespace gapi.client {
       matchOperator?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaTargetSite {
-      /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
+      /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
       exactMatch?: boolean;
       /** Output only. Failure reason. */
       failureReason?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
@@ -4395,12 +4487,14 @@ declare namespace gapi.client {
       useCases?: string[];
     }
     interface GoogleCloudDiscoveryengineV1ControlBoostAction {
-      /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
       boost?: number;
       /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
       dataStore?: string;
       /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
       filter?: string;
+      /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
+      fixedBoost?: number;
     }
     interface GoogleCloudDiscoveryengineV1ControlFilterAction {
       /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -4448,7 +4542,7 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1DataStore {
       /** Optional. Configuration for advanced site search. */
-      advancedSiteSearchConfig?: any;
+      advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
       /** Output only. CMEK-related information for the DataStore. */
@@ -4510,6 +4604,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -4884,7 +4984,7 @@ declare namespace gapi.client {
       onewaySynonymsControlIds?: string[];
       /** Condition promote specifications. Maximum number of specifications is 100. */
       promoteControlIds?: string[];
-      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is 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)`. */
+      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is 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)`. */
       rankingExpression?: string;
       /** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
       redirectControlIds?: string[];
@@ -4924,7 +5024,7 @@ declare namespace gapi.client {
       verifyTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1TargetSite {
-      /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
+      /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
       exactMatch?: boolean;
       /** Output only. Failure reason. */
       failureReason?: GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
@@ -5179,7 +5279,7 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
+        /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
         documentId?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -5210,7 +5310,7 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
-          /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
+          /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
           documentId?: string;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
@@ -10565,7 +10665,7 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
+        /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
         documentId?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -10596,7 +10696,7 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
-          /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
+          /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
           documentId?: string;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
@@ -14039,7 +14139,7 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        /** Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. */
+        /** Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. */
         evaluation: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -14047,7 +14147,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
+        /** Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
         pageSize?: number;
         /** A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
         pageToken?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
-  "version": "0.0.20241220",
+  "version": "0.0.20250107",
   "description": "TypeScript typings for Discovery Engine API v1beta",
   "repository": {
     "type": "git",