@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240612 → 0.0.20240621

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: 20240612
+// Revision: 20240621
 
 /// <reference types="gapi.client" />
 
@@ -587,6 +587,22 @@ declare namespace gapi.client {
       /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
       workforcePoolName?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Count of CompletionSuggestions that failed to be imported. */
+      failureCount?: string;
+      /** Count of CompletionSuggestions successfully imported. */
+      successCount?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
+      /** The desired location of errors incurred during the Import. */
+      errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -682,6 +698,18 @@ declare namespace gapi.client {
       version?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
+    interface GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse {
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+      /** Whether the completion suggestions were successfully purged. */
+      purgeSucceeded?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1430,6 +1458,22 @@ 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 GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Count of CompletionSuggestions that failed to be imported. */
+      failureCount?: string;
+      /** Count of CompletionSuggestions successfully imported. */
+      successCount?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse {
+      /** The desired location of errors incurred during the Import. */
+      errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+    }
     interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1790,6 +1834,22 @@ declare namespace gapi.client {
       /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
       selectedSuggestion?: string;
     }
+    interface GoogleCloudDiscoveryengineV1CompletionSuggestion {
+      /** Alternative matching phrases for this suggestion. */
+      alternativePhrases?: string[];
+      /** Frequency of this suggestion. Will be used to rank suggestions when score is not available. */
+      frequency?: string;
+      /** Global score of this suggestion. Control how this suggestion would be scored / ranked. */
+      globalScore?: number;
+      /** If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. */
+      groupId?: string;
+      /** The score of this suggestion within its group. */
+      groupScore?: number;
+      /** BCP-47 language code of this suggestion. */
+      languageCode?: string;
+      /** Required. The suggestion text. */
+      suggestion?: string;
+    }
     interface GoogleCloudDiscoveryengineV1Condition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
@@ -2019,7 +2079,7 @@ declare namespace gapi.client {
       mimeType?: string;
       /** The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. */
       rawBytes?: string;
-      /** The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats. */
+      /** The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. */
       uri?: string;
     }
     interface GoogleCloudDiscoveryengineV1DocumentInfo {
@@ -2180,6 +2240,36 @@ declare namespace gapi.client {
       /** Text content of the fact. Can be at most 10K characters long. */
       factText?: string;
     }
+    interface GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Count of CompletionSuggestions that failed to be imported. */
+      failureCount?: string;
+      /** Count of CompletionSuggestions successfully imported. */
+      successCount?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest {
+      /** BigQuery input source. */
+      bigquerySource?: GoogleCloudDiscoveryengineV1BigQuerySource;
+      /** The desired location of errors incurred during the Import. */
+      errorConfig?: GoogleCloudDiscoveryengineV1ImportErrorConfig;
+      /** Cloud Storage location for the input content. */
+      gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
+      /** The Inline source for suggestion entries. */
+      inlineSource?: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource;
+    }
+    interface GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource {
+      /** Required. A list of all denylist entries to import. Max of 1000 items. */
+      suggestions?: GoogleCloudDiscoveryengineV1CompletionSuggestion[];
+    }
+    interface GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse {
+      /** The desired location of errors incurred during the Import. */
+      errorConfig?: GoogleCloudDiscoveryengineV1ImportErrorConfig;
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+    }
     interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2411,6 +2501,19 @@ declare namespace gapi.client {
       /** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
       dataUseTermsVersion?: string;
     }
+    interface GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest {}
+    interface GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse {
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+      /** Whether the completion suggestions were successfully purged. */
+      purgeSucceeded?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2667,7 +2770,7 @@ declare namespace gapi.client {
       excludedFilterKeys?: string[];
       /** Required. The facet key specification. */
       facetKey?: GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey;
-      /** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
+      /** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       limit?: number;
     }
     interface GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey {
@@ -3520,6 +3623,124 @@ declare namespace gapi.client {
       documents: DocumentsResource;
       operations: OperationsResource;
     }
+    interface CompletionSuggestionsResource {
+      /** Imports CompletionSuggestions for a DataStore. */
+      import(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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*‍/locations/*‍/collections/*‍/dataStores/*` */
+        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 body */
+        resource: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      import(
+        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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*‍/locations/*‍/collections/*‍/dataStores/*` */
+          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;
+        },
+        body: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest
+      ): Request<GoogleLongrunningOperation>;
+      /** Permanently deletes all CompletionSuggestions for a DataStore. */
+      purge(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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
+        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 body */
+        resource: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      purge(
+        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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
+          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;
+        },
+        body: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest
+      ): Request<GoogleLongrunningOperation>;
+    }
     interface ControlsResource {
       /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
       create(request: {
@@ -6025,6 +6246,7 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1DataStore
       ): Request<GoogleCloudDiscoveryengineV1DataStore>;
       branches: BranchesResource;
+      completionSuggestions: CompletionSuggestionsResource;
       controls: ControlsResource;
       conversations: ConversationsResource;
       models: ModelsResource;
@@ -7738,6 +7960,124 @@ declare namespace gapi.client {
       documents: DocumentsResource;
       operations: OperationsResource;
     }
+    interface CompletionSuggestionsResource {
+      /** Imports CompletionSuggestions for a DataStore. */
+      import(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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*‍/locations/*‍/collections/*‍/dataStores/*` */
+        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 body */
+        resource: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      import(
+        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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*‍/locations/*‍/collections/*‍/dataStores/*` */
+          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;
+        },
+        body: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest
+      ): Request<GoogleLongrunningOperation>;
+      /** Permanently deletes all CompletionSuggestions for a DataStore. */
+      purge(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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
+        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 body */
+        resource: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      purge(
+        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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
+          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;
+        },
+        body: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest
+      ): Request<GoogleLongrunningOperation>;
+    }
     interface ControlsResource {
       /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
       create(request: {
@@ -9965,6 +10305,7 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1DataStore
       ): Request<GoogleCloudDiscoveryengineV1DataStore>;
       branches: BranchesResource;
+      completionSuggestions: CompletionSuggestionsResource;
       controls: ControlsResource;
       conversations: ConversationsResource;
       models: ModelsResource;

package/package.json

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