@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240801 → 0.0.20240813

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=v1alpha
-// Revision: 20240801
+// Revision: 20240813
 
 /// <reference types="gapi.client" />
 
@@ -161,7 +161,7 @@ declare namespace gapi.client {
       gcsStagingDir?: string;
       /** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
       locationId?: string;
-      /** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      /** The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
       /** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
       tableId?: string;
@@ -482,6 +482,22 @@ declare namespace gapi.client {
       /** TargetSites created. */
       targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse {
+      /** The metadata of the Documents. */
+      documentsMetadata?: GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata {
+      /** The timestamp of the last time the Document was last indexed. */
+      lastRefreshedTime?: string;
+      /** The value of the matcher that was used to match the Document. */
+      matcherValue?: GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
+      /** The status of the document. */
+      status?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
+      /** If match by URI, the URI of the Document. */
+      uri?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest {}
     interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
       /** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. */
@@ -492,7 +508,7 @@ declare namespace gapi.client {
       gcsStagingDir?: string;
       /** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */
       partitionDate?: GoogleTypeDate;
-      /** The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      /** The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
       /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
       tableId?: string;
@@ -530,7 +546,7 @@ declare namespace gapi.client {
       bigtableOptions?: GoogleCloudDiscoveryengineV1alphaBigtableOptions;
       /** Required. The instance ID of the Cloud Bigtable that needs to be imported. */
       instanceId?: string;
-      /** The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      /** The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
       /** Required. The table ID of the Cloud Bigtable that needs to be imported. */
       tableId?: string;
@@ -562,6 +578,8 @@ declare namespace gapi.client {
       endPos?: number;
       /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
       groundingCheckRequired?: boolean;
+      /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. */
+      score?: number;
       /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
       startPos?: number;
     }
@@ -646,7 +664,7 @@ declare namespace gapi.client {
       instanceId?: string;
       /** Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */
       offload?: boolean;
-      /** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      /** The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
       /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
       tableId?: string;
@@ -704,7 +722,7 @@ declare namespace gapi.client {
       startTime?: 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. */
+      /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
       associatedServingConfigIds?: string[];
       /** Defines a boost-type control */
       boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
@@ -885,6 +903,8 @@ declare namespace gapi.client {
       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). */
       startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
+      /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
+      workspaceConfig?: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig;
     }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -2312,6 +2332,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint {
       /** Name of the string field as defined in the schema. */
       fieldName?: string;
+      /** Identifies the keywords within the search query that match a filter. */
+      querySegment?: string;
       /** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
       values?: string[];
     }
@@ -2511,7 +2533,7 @@ declare namespace gapi.client {
       enableDataBoost?: boolean;
       /** Required. The instance ID of the source Spanner table. */
       instanceId?: string;
-      /** The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+      /** The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
       /** Required. The table name of the Spanner database that needs to be imported. */
       tableId?: string;
@@ -2678,6 +2700,12 @@ declare namespace gapi.client {
       /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
+      /** Obfuscated Dasher customer ID. */
+      dasherCustomerId?: string;
+      /** The Google Workspace data source. */
+      type?: string;
+    }
     interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2717,7 +2745,7 @@ declare namespace gapi.client {
       startTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaControl {
-      /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
+      /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
       associatedServingConfigIds?: string[];
       /** Defines a boost-type control */
       boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
@@ -2822,6 +2850,8 @@ declare namespace gapi.client {
       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). */
       startingSchema?: GoogleCloudDiscoveryengineV1betaSchema;
+      /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
+      workspaceConfig?: GoogleCloudDiscoveryengineV1betaWorkspaceConfig;
     }
     interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -3221,6 +3251,8 @@ declare namespace gapi.client {
       rankingExpression?: string;
       /** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
       regionCode?: string;
+      /** The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */
+      relevanceThreshold?: string;
       /** Whether to turn on safe search. This is only supported for website search. */
       safeSearch?: boolean;
       /** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
@@ -3481,6 +3513,12 @@ declare namespace gapi.client {
       /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
+      /** Obfuscated Dasher customer ID. */
+      dasherCustomerId?: string;
+      /** The Google Workspace data source. */
+      type?: string;
+    }
     interface GoogleCloudDiscoveryengineV1Condition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
@@ -3500,7 +3538,7 @@ declare namespace gapi.client {
       startTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1Control {
-      /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
+      /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
       associatedServingConfigIds?: string[];
       /** Defines a boost-type control */
       boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
@@ -3586,6 +3624,8 @@ declare namespace gapi.client {
       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). */
       startingSchema?: GoogleCloudDiscoveryengineV1Schema;
+      /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
+      workspaceConfig?: GoogleCloudDiscoveryengineV1WorkspaceConfig;
     }
     interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
       /** Operation create time. */
@@ -3900,6 +3940,24 @@ declare namespace gapi.client {
       /** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
       totalRequiredQuota?: string;
     }
+    interface GoogleCloudDiscoveryengineV1TrainCustomModelMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1TrainCustomModelResponse {
+      /** Echoes the destination for the complete errors in the request if set. */
+      errorConfig?: GoogleCloudDiscoveryengineV1ImportErrorConfig;
+      /** A sample of errors encountered while processing the data. */
+      errorSamples?: GoogleRpcStatus[];
+      /** The metrics of the trained model. */
+      metrics?: {[P in string]: number};
+      /** Fully qualified name of the CustomTuningModel. */
+      modelName?: string;
+      /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
+      modelStatus?: string;
+    }
     interface GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -3912,6 +3970,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
+      /** Obfuscated Dasher customer ID. */
+      dasherCustomerId?: string;
+      /** The Google Workspace data source. */
+      type?: string;
+    }
     interface GoogleLongrunningCancelOperationRequest {}
     interface GoogleLongrunningListOperationsResponse {
       /** The standard List next-page token. */
@@ -4579,6 +4643,35 @@ declare namespace gapi.client {
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
     interface BranchesResource {
+      /** Gets index freshness metadata for Documents. Supported for website search only. */
+      batchGetDocumentsMetadata(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;
+        /** The exact URIs to match by. */
+        'matcher.urisMatcher.uris'?: string | string[];
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
+        parent: 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<GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse>;
       documents: DocumentsResource;
       operations: OperationsResource;
     }
@@ -9746,6 +9839,35 @@ declare namespace gapi.client {
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
     interface BranchesResource {
+      /** Gets index freshness metadata for Documents. Supported for website search only. */
+      batchGetDocumentsMetadata(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;
+        /** The exact URIs to match by. */
+        'matcher.urisMatcher.uris'?: string | string[];
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
+        parent: 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<GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse>;
       documents: DocumentsResource;
       operations: OperationsResource;
     }
@@ -13471,6 +13593,71 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1alphaUserEvent
       ): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
     }
+    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?: {
+        /** 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;
+        /** The name of the operation resource. */
+        name: 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<GoogleLongrunningOperation>;
+      /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+      list(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;
+        /** The standard list filter. */
+        filter?: 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;
+        /** The name of the operation's parent resource. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** The standard list page size. */
+        pageSize?: number;
+        /** The standard list page token. */
+        pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+    }
+    interface UserStoresResource {
+      operations: OperationsResource;
+    }
     interface LocationsResource {
       /** Estimates the data size to be used by a customer. */
       estimateDataSize(request: {
@@ -13557,7 +13744,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
-      /** Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. */
+      /** Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. */
       updateAclConfig(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -13625,6 +13812,7 @@ declare namespace gapi.client {
       requirements: RequirementsResource;
       sampleQuerySets: SampleQuerySetsResource;
       userEvents: UserEventsResource;
+      userStores: UserStoresResource;
     }
     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. */

package/package.json

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