@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20241208 → 0.0.20241216

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: 20241208
+// Revision: 20241216
 
 /// <reference types="gapi.client" />
 
@@ -165,6 +165,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 GoogleCloudDiscoveryengineV1alphaActionConfig {
+      /** Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. */
+      actionParams?: {[P in string]: any};
+      /** Output only. The connector contains the necessary parameters and is configured to support actions. */
+      isActionConfigured?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
       /** If set true, automatic refresh is disabled for the DataStore. */
       disableAutomaticRefresh?: boolean;
@@ -362,9 +368,21 @@ declare namespace gapi.client {
       lastRotationTimestampMicros?: string;
       /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
       name?: string;
+      /** Optional. Single-regional CMEKs that are required for some VAIS features. */
+      singleRegionKeys?: GoogleCloudDiscoveryengineV1alphaSingleRegionKey[];
       /** Output only. State of the CmekConfig. */
       state?: string;
     }
+    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. */
+      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;
+      /** Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaCondition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
@@ -385,6 +403,48 @@ declare namespace gapi.client {
       /** Start of time range. Range is inclusive. */
       startTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaConnectorRun {
+      /** Output only. The time when the connector run ended. */
+      endTime?: string;
+      /** Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities. */
+      entityRuns?: GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun[];
+      /** Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field. */
+      errors?: GoogleRpcStatus[];
+      /** Output only. The time when the connector run was most recently paused. */
+      latestPauseTime?: string;
+      /** Output only. The full resource name of the Connector Run. Format: `projects/*‍/locations/*‍/collections/*‍/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated. */
+      name?: string;
+      /** Output only. The time when the connector run started. */
+      startTime?: string;
+      /** Output only. The state of the sync run. */
+      state?: string;
+      /** Timestamp at which the connector run sync state was last updated. */
+      stateUpdateTime?: string;
+      /** Output only. The trigger for this ConnectorRun. */
+      trigger?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun {
+      /** The name of the source entity. */
+      entityName?: string;
+      /** The total number of documents failed at sync at any stage (extraction, indexing, etc). */
+      errorRecordCount?: string;
+      /** The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message. */
+      errors?: GoogleRpcStatus[];
+      /** The number of documents extracted from connector source, ready to be ingested to UCS. */
+      extractedRecordCount?: string;
+      /** The number of documents indexed. */
+      indexedRecordCount?: string;
+      /** The number of requests sent to 3p API. */
+      sourceApiRequestCount?: string;
+      /** The state of the entity's sync run. */
+      state?: string;
+      /** Timestamp at which the entity sync state was last updated. */
+      stateUpdateTime?: string;
+      /** The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated. */
+      statsUpdateTime?: string;
+      /** Sync type of this run. */
+      syncType?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaControl {
       /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
       associatedServingConfigIds?: string[];
@@ -476,6 +536,64 @@ declare namespace gapi.client {
       /** Whether or not to enable and include custom fine tuned search adaptor model. */
       enableSearchAdaptor?: boolean;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDataConnector {
+      /** Optional. Action configurations to make the connector support actions. */
+      actionConfig?: GoogleCloudDiscoveryengineV1alphaActionConfig;
+      /** Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */
+      autoRunDisabled?: boolean;
+      /** Output only. User actions that must be completed before the connector can start syncing data. */
+      blockingReasons?: string[];
+      /** Output only. Timestamp the DataConnector was created at. */
+      createTime?: string;
+      /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
+      dataSource?: string;
+      /** Optional. Any target destinations used to connect to third-party services. */
+      destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
+      /** List of entities from the connected data source to ingest. */
+      entities?: GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity[];
+      /** Output only. The errors from initialization or from the latest connector run. */
+      errors?: GoogleRpcStatus[];
+      /** 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. */
+      identityRefreshInterval?: string;
+      /** The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */
+      identityScheduleConfig?: GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig;
+      /** Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */
+      kmsKeyName?: string;
+      /** Output only. For periodic connectors only, the last time a data sync was completed. */
+      lastSyncTime?: string;
+      /** Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. */
+      latestPauseTime?: string;
+      /** Output only. The full resource name of the Data Connector. Format: `projects/*‍/locations/*‍/collections/*‍/dataConnector`. */
+      name?: string;
+      /** 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;
+      /** Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. */
+      params?: {[P in string]: any};
+      /** Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */
+      privateConnectivityProjectId?: string;
+      /** Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. */
+      refreshInterval?: string;
+      /** Output only. State of the connector. */
+      state?: string;
+      /** Output only. The static IP addresses used by this connector. */
+      staticIpAddresses?: string[];
+      /** Optional. Whether customer has enabled static IP addresses for this connector. */
+      staticIpEnabled?: boolean;
+      /** The data synchronization mode supported by the data connector. */
+      syncMode?: string;
+      /** Output only. Timestamp the DataConnector was last updated. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity {
+      /** Output only. The full resource name of the associated data store for the source entity. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity. */
+      dataStore?: string;
+      /** The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` */
+      entityName?: string;
+      /** Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */
+      keyPropertyMappings?: {[P in string]: string};
+      /** The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. */
+      params?: {[P in string]: any};
+    }
     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;
@@ -499,6 +617,8 @@ declare namespace gapi.client {
       idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Optional. If set, this DataStore is an Infobot FAQ DataStore. */
+      isInfobotFaqDataStore?: boolean;
       /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
       kmsKeyName?: string;
       /** Language info for DataStore. */
@@ -540,6 +660,12 @@ declare namespace gapi.client {
       /** Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */
       userTriggeredCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -574,6 +700,20 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDestinationConfig {
+      /** Optional. The destinations for the corresponding key. */
+      destinations?: GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[];
+      /** Optional. Unique destination identifier that is supported by the connector. */
+      key?: string;
+      /** Optional. Additional parameters for this destination config. */
+      params?: {[P in string]: any};
+    }
+    interface GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination {
+      /** Publicly routable host. */
+      host?: string;
+      /** Optional. Target port number accepted by the destination. */
+      port?: number;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -797,6 +937,10 @@ declare namespace gapi.client {
       /** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
       documentDataMap?: {[P in string]: {[P in string]: any}};
     }
+    interface GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig {
+      /** 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;
+    }
     interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
       /** External Identity provider config. */
       externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
@@ -1394,6 +1538,7 @@ declare namespace gapi.client {
       /** The user query. */
       query?: GoogleCloudDiscoveryengineV1alphaQuery;
     }
+    interface GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata {}
     interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1401,6 +1546,10 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {}
+    interface GoogleCloudDiscoveryengineV1alphaSingleRegionKey {
+      /** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSitemap {
       /** Output only. The sitemap's creation time. */
       createTime?: string;
@@ -1474,6 +1623,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2137,6 +2292,8 @@ declare namespace gapi.client {
       lastRotationTimestampMicros?: string;
       /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
       name?: string;
+      /** Optional. Single-regional CMEKs that are required for some VAIS features. */
+      singleRegionKeys?: GoogleCloudDiscoveryengineV1betaSingleRegionKey[];
       /** Output only. State of the CmekConfig. */
       state?: string;
     }
@@ -2382,6 +2539,8 @@ declare namespace gapi.client {
       documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Optional. If set, this DataStore is an Infobot FAQ DataStore. */
+      isInfobotFaqDataStore?: boolean;
       /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
       kmsKeyName?: string;
       /** Language info for DataStore. */
@@ -2462,7 +2621,7 @@ declare namespace gapi.client {
       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. */
       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, index_status is unset. */
+      /** 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;
       /** Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */
       indexTime?: string;
@@ -2490,6 +2649,8 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** The time when the document was indexed. If this field is populated, it means the document has been indexed. */
       indexTime?: string;
+      /** Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. */
+      pendingMessage?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaDocumentInfo {
       /** Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type. */
@@ -2697,6 +2858,146 @@ declare namespace gapi.client {
       /** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
       inputUris?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest {
+      /** Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. */
+      contents?: GoogleCloudDiscoveryengineV1betaGroundedGenerationContent[];
+      /** Content generation specification. */
+      generationSpec?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec;
+      /** Grounding specification. */
+      groundingSpec?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec;
+      /** Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them. */
+      systemInstruction?: GoogleCloudDiscoveryengineV1betaGroundedGenerationContent;
+      /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
+      userLabels?: {[P in string]: string};
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration {
+      /** Specification for the predictor for dynamic retrieval. */
+      predictor?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor {
+      /** The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source. */
+      threshold?: number;
+      /** The version of the predictor to be used in dynamic retrieval. */
+      version?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec {
+      /** If specified, custom value for frequency penalty will be used. */
+      frequencyPenalty?: number;
+      /** Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). */
+      languageCode?: string;
+      /** If specified, custom value for max output tokens will be used. */
+      maxOutputTokens?: number;
+      /** Specifies which Vertex model id to use for generation. */
+      modelId?: string;
+      /** If specified, custom value for presence penalty will be used. */
+      presencePenalty?: number;
+      /** If specified, custom value for the seed will be used. */
+      seed?: number;
+      /** If specified, custom value for the temperature will be used. */
+      temperature?: number;
+      /** If specified, custom value for top-k sampling will be used. */
+      topK?: number;
+      /** If specified, custom value for nucleus sampling will be used. */
+      topP?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource {
+      /** If set, grounding is performed with Google Search. */
+      googleSearchSource?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource;
+      /** If set, grounding is performed with inline content. */
+      inlineSource?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource;
+      /** If set, grounding is performed with Vertex AI Search. */
+      searchSource?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource {
+      /** Optional. Specifies the dynamic retrieval configuration for the given source. */
+      dynamicRetrievalConfig?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource {
+      /** Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content). */
+      attributes?: {[P in string]: string};
+      /** List of facts to be used for grounding. */
+      groundingFacts?: GoogleCloudDiscoveryengineV1betaGroundingFact[];
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource {
+      /** Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. */
+      filter?: string;
+      /** Number of search results to return. The default value is 10. The maximumm allowed value is 10. */
+      maxResultCount?: number;
+      /** If set, safe search is enabled in Vertex AI Search requests. */
+      safeSearch?: boolean;
+      /** The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
+      servingConfig?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec {
+      /** Grounding sources. */
+      groundingSources?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource[];
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse {
+      /** Generated candidates. */
+      candidates?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate[];
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate {
+      /** Content of the candidate. */
+      content?: GoogleCloudDiscoveryengineV1betaGroundedGenerationContent;
+      /** Grounding metadata for the generated content. */
+      groundingMetadata?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata;
+      /** The overall grounding score for the candidate, in the range of [0, 1]. */
+      groundingScore?: number;
+      /** Index of the candidate. */
+      index?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata {
+      /** GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. */
+      groundingSupport?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport[];
+      /** Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. */
+      retrievalMetadata?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata[];
+      /** Google search entry for the following-up web searches. */
+      searchEntryPoint?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint;
+      /** List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. */
+      supportChunks?: GoogleCloudDiscoveryengineV1betaFactChunk[];
+      /** Web search queries for the following-up web search. */
+      webSearchQueries?: string[];
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata {
+      /** Metadata for the dynamic retrieval predictor. */
+      predictorMetadata?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata {
+      /** The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. */
+      prediction?: number;
+      /** The version of the predictor which was used in dynamic retrieval. */
+      version?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport {
+      /** Text for the claim in the candidate. Always provided when a support is found. */
+      claimText?: string;
+      /** A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim. */
+      supportChunkIndices?: number[];
+      /** A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks. */
+      supportScore?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata {
+      /** Metadata for dynamic retrieval. */
+      dynamicRetrievalMetadata?: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata;
+      /** Describes the source to which the metadata is referring to. */
+      source?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint {
+      /** Web content snippet that can be embedded in a web page or an app webview. */
+      renderedContent?: string;
+      /** Base64 encoded JSON representing array of tuple. */
+      sdkBlob?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGroundedGenerationContent {
+      /** Ordered `Parts` that constitute a single message. */
+      parts?: GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart[];
+      /** Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. */
+      role?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart {
+      /** Inline text. */
+      text?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaGroundingFact {
       /** Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. */
       attributes?: {[P in string]: string};
@@ -3823,6 +4124,10 @@ declare namespace gapi.client {
       /** The user query. */
       query?: GoogleCloudDiscoveryengineV1betaQuery;
     }
+    interface GoogleCloudDiscoveryengineV1betaSingleRegionKey {
+      /** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaSitemap {
       /** Output only. The sitemap's creation time. */
       createTime?: string;
@@ -4040,6 +4345,8 @@ declare namespace gapi.client {
       lastRotationTimestampMicros?: string;
       /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
       name?: string;
+      /** Optional. Single-regional CMEKs that are required for some VAIS features. */
+      singleRegionKeys?: GoogleCloudDiscoveryengineV1SingleRegionKey[];
       /** Output only. State of the CmekConfig. */
       state?: string;
     }
@@ -4158,6 +4465,8 @@ declare namespace gapi.client {
       documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Optional. If set, this DataStore is an Infobot FAQ DataStore. */
+      isInfobotFaqDataStore?: boolean;
       /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
       kmsKeyName?: string;
       /** 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. */
@@ -4604,6 +4913,10 @@ declare namespace gapi.client {
       /** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
       demotionEventType?: string;
     }
+    interface GoogleCloudDiscoveryengineV1SingleRegionKey {
+      /** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+    }
     interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
       /** Site verification state indicating the ownership and validity. */
       siteVerificationState?: string;
@@ -4764,6 +5077,32 @@ declare namespace gapi.client {
       /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
       year?: number;
     }
+    interface GoogleTypeDateTime {
+      /** Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. */
+      day?: number;
+      /** Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
+      hours?: number;
+      /** Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. */
+      minutes?: number;
+      /** Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. */
+      month?: number;
+      /** Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. */
+      nanos?: number;
+      /** Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. */
+      seconds?: number;
+      /** Time zone. */
+      timeZone?: GoogleTypeTimeZone;
+      /** UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. */
+      utcOffset?: string;
+      /** Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. */
+      year?: number;
+    }
+    interface GoogleTypeTimeZone {
+      /** IANA Time Zone Database time zone. For example "America/New_York". */
+      id?: string;
+      /** Optional. IANA Time Zone Database version number. For example "2019a". */
+      version?: string;
+    }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
       get(request?: {
@@ -14637,6 +14976,64 @@ declare namespace gapi.client {
       ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
     }
     interface LocationsResource {
+      /** Generates grounded content. */
+      generateGroundedContent(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Location resource. Format: `projects/{project}/locations/{location}`. */
+        location: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest;
+      }): Request<GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse>;
+      generateGroundedContent(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** Required. Location resource. Format: `projects/{project}/locations/{location}`. */
+          location: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest
+      ): Request<GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse>;
       collections: CollectionsResource;
       dataStores: DataStoresResource;
       evaluations: EvaluationsResource;

package/package.json

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