@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241014 → 0.0.20241020

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=v1
-// Revision: 20241014
+// Revision: 20241020
 
 /// <reference types="gapi.client" />
 
@@ -82,6 +82,7 @@ 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 GoogleCloudDiscoveryengineV1AlloyDbSource {
       /** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
       clusterId?: string;
@@ -102,6 +103,12 @@ declare namespace gapi.client {
       /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
+      /** 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 GoogleCloudDiscoveryengineV1alphaAnswer {
       /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
       answerSkippedReasons?: string[];
@@ -231,7 +238,7 @@ declare namespace gapi.client {
       document?: string;
       /** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
       snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
-      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */
+      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. */
       structData?: {[P in string]: any};
       /** Title. */
       title?: string;
@@ -283,7 +290,9 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaCondition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
-      /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
+      /** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
+      queryRegex?: string;
+      /** 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. */
       queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
     }
     interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
@@ -372,7 +381,7 @@ declare namespace gapi.client {
       enableSearchAdaptor?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
-      /** Timestamp the Model was created at. */
+      /** Deprecated: Timestamp the Model was created at. */
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
@@ -392,6 +401,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
       /** 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. */
       aclEnabled?: boolean;
+      /** Optional. Configuration for advanced site search. */
+      advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation;
       /** Output only. CMEK-related information for the DataStore. */
@@ -419,7 +430,7 @@ declare namespace gapi.client {
       /** Optional. Configuration for Natural Language Query Understanding. */
       naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
       /** Optional. Stores serving config at DataStore level. */
-      servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaServingConfigDataStore;
+      servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
       /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
@@ -441,6 +452,10 @@ declare namespace gapi.client {
       /** Last updated timestamp for websites. */
       websiteDataUpdateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore {
+      /** If set true, the DataStore will not be available for serving search requests. */
+      disabledForServing?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -914,8 +929,10 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
       /** Operation create time. */
       createTime?: string;
-      /** Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. */
+      /** Unique URIs in the request that have invalid format. Sample limited to 1000. */
       invalidUris?: string[];
+      /** Total number of unique URIs in the request that have invalid format. */
+      invalidUrisCount?: number;
       /** Total number of URIs that have yet to be crawled. */
       pendingCount?: number;
       /** Total number of URIs that were rejected due to insufficient indexing resources. */
@@ -924,6 +941,10 @@ declare namespace gapi.client {
       successCount?: number;
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
+      /** Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000. */
+      urisNotMatchingTargetSites?: string[];
+      /** Total number of URIs that don't match any TargetSites. */
+      urisNotMatchingTargetSitesCount?: number;
       /** Total number of unique URIs in the request that are not in invalid_uris. */
       validUrisCount?: number;
     }
@@ -1195,10 +1216,6 @@ declare namespace gapi.client {
       /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
       mode?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
-      /** If set true, the DataStore will not be available for serving search requests. */
-      disabledForServing?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1alphaSession {
       /** Output only. The time the session finished. */
       endTime?: string;
@@ -1604,7 +1621,7 @@ declare namespace gapi.client {
       document?: string;
       /** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
       snippetInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[];
-      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */
+      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. */
       structData?: {[P in string]: any};
       /** Title. */
       title?: string;
@@ -1658,12 +1675,13 @@ declare namespace gapi.client {
       state?: string;
     }
     interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
-      /** Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
+      /** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
       fhirResource?: string;
       /** If match by URI, the URI of the Document. */
       uri?: string;
     }
     interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
+    interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {}
     interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1691,7 +1709,9 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaCondition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
-      /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
+      /** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
+      queryRegex?: string;
+      /** 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. */
       queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
     }
     interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
@@ -1776,7 +1796,7 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
-      /** Timestamp the Model was created at. */
+      /** Deprecated: Timestamp the Model was created at. */
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
@@ -1794,6 +1814,8 @@ declare namespace gapi.client {
       trainingStartTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaDataStore {
+      /** Optional. Configuration for advanced site search. */
+      advancedSiteSearchConfig?: any;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
       /** Output only. CMEK-related information for the DataStore. */
@@ -1819,7 +1841,7 @@ declare namespace gapi.client {
       /** Optional. Configuration for Natural Language Query Understanding. */
       naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
       /** Optional. Stores serving config at DataStore level. */
-      servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaServingConfigDataStore;
+      servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
       /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
@@ -1841,6 +1863,10 @@ declare namespace gapi.client {
       /** Last updated timestamp for websites. */
       websiteDataUpdateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore {
+      /** If set true, the DataStore will not be available for serving search requests. */
+      disabledForServing?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2442,10 +2468,6 @@ declare namespace gapi.client {
       /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
       mode?: string;
     }
-    interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
-      /** If set true, the DataStore will not be available for serving search requests. */
-      disabledForServing?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
       /** Site verification state indicating the ownership and validity. */
       siteVerificationState?: string;
@@ -2586,7 +2608,7 @@ declare namespace gapi.client {
       tableId?: string;
     }
     interface GoogleCloudDiscoveryengineV1CheckGroundingRequest {
-      /** Answer candidate to check. Can have a maximum length of 1024 characters. */
+      /** Answer candidate to check. It can have a maximum length of 4096 tokens. */
       answerCandidate?: string;
       /** List of facts for the grounding check. We support up to 200 facts. */
       facts?: GoogleCloudDiscoveryengineV1GroundingFact[];
@@ -2597,7 +2619,7 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1CheckGroundingResponse {
       /** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
-      citedChunks?: GoogleCloudDiscoveryengineV1FactChunk[];
+      citedChunks?: GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk[];
       /** Claim texts and citation info across all claims in the answer candidate. */
       claims?: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim[];
       /** The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. */
@@ -2615,6 +2637,12 @@ declare namespace gapi.client {
       /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
       startPos?: number;
     }
+    interface GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk {
+      /** Text content of the fact chunk. Can be at most 10K characters long. */
+      chunkText?: string;
+      /** Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. */
+      source?: string;
+    }
     interface GoogleCloudDiscoveryengineV1CheckGroundingSpec {
       /** 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. */
       citationThreshold?: number;
@@ -2722,7 +2750,9 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1Condition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
-      /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
+      /** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
+      queryRegex?: string;
+      /** 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. */
       queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
     }
     interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
@@ -2872,7 +2902,7 @@ declare namespace gapi.client {
       text?: string[];
     }
     interface GoogleCloudDiscoveryengineV1CustomTuningModel {
-      /** Timestamp the Model was created at. */
+      /** Deprecated: Timestamp the Model was created at. */
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
@@ -2890,6 +2920,8 @@ declare namespace gapi.client {
       trainingStartTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1DataStore {
+      /** Optional. Configuration for advanced site search. */
+      advancedSiteSearchConfig?: any;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
       /** Output only. CMEK-related information for the DataStore. */
@@ -2911,7 +2943,7 @@ declare namespace gapi.client {
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** Optional. Stores serving config at DataStore level. */
-      servingConfigDataStore?: GoogleCloudDiscoveryengineV1ServingConfigDataStore;
+      servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
       /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
@@ -2933,6 +2965,10 @@ declare namespace gapi.client {
       /** Last updated timestamp for websites. */
       websiteDataUpdateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore {
+      /** If set true, the DataStore will not be available for serving search requests. */
+      disabledForServing?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -3117,16 +3153,6 @@ declare namespace gapi.client {
       /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
       searchTier?: string;
     }
-    interface GoogleCloudDiscoveryengineV1FactChunk {
-      /** Text content of the fact chunk. Can be at most 10K characters long. */
-      chunkText?: string;
-      /** The index of this chunk. Currently, only used for the streaming mode. */
-      index?: number;
-      /** 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. */
-      source?: string;
-      /** More fine-grained information for the source reference. */
-      sourceMetadata?: {[P in string]: string};
-    }
     interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
       /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
@@ -3910,10 +3936,6 @@ declare namespace gapi.client {
       /** Summary text with no citation information. */
       summary?: string;
     }
-    interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
-      /** If set true, the DataStore will not be available for serving search requests. */
-      disabledForServing?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1Session {
       /** Output only. The time the session finished. */
       endTime?: string;

package/package.json

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