@google-cloud/discoveryengine 0.6.0 → 0.7.0

package/build/src/v1/user_event_service_client_config.json

@@ -0,0 +1,62 @@
+{
+    "interfaces": {
+        "google.cloud.discoveryengine.v1.UserEventService": {
+            "retry_codes": {
+                "non_idempotent": [],
+                "idempotent": [
+                    "DEADLINE_EXCEEDED",
+                    "UNAVAILABLE"
+                ],
+                "unavailable": [
+                    "UNAVAILABLE"
+                ]
+            },
+            "retry_params": {
+                "default": {
+                    "initial_retry_delay_millis": 100,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 60000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
+                },
+                "ce5b960a6ed052e690863808e4f0deff3dc7d49f": {
+                    "initial_retry_delay_millis": 1000,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 10000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
+                },
+                "e6a9f61a856ca7c2128ab9550ca4fb9e97c77876": {
+                    "initial_retry_delay_millis": 1000,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 30000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
+                }
+            },
+            "methods": {
+                "WriteUserEvent": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "CollectUserEvent": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "ImportUserEvents": {
+                    "timeout_millis": 300000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "e6a9f61a856ca7c2128ab9550ca4fb9e97c77876"
+                }
+            }
+        }
+    }
+}

package/build/src/v1beta/document_service_client.d.ts

@@ -287,6 +287,58 @@ export declare class DocumentServiceClient {
      *   The mode of reconciliation between existing documents and the documents to
      *   be imported. Defaults to
      *   {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
+     * @param {boolean} request.autoGenerateIds
+     *   Whether to automatically generate IDs for the documents if absent.
+     *
+     *   If set to `true`,
+     *   {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s are
+     *   automatically generated based on the hash of the payload, where IDs may not
+     *   be consistent during multiple imports. In which case
+     *   {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
+     *   is highly recommended to avoid duplicate contents. If unset or set to
+     *   `false`, {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s
+     *   have to be specified using
+     *   {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field|id_field},
+     *   otherwises, documents without IDs will fail to be imported.
+     *
+     *   Only set this field when using
+     *   {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
+     *   {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
+     *   when
+     *   {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
+     *   or
+     *   {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
+     *   is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     * @param {string} request.idField
+     *   The field in the Cloud Storage and BigQuery sources that indicates the
+     *   unique IDs of the documents.
+     *
+     *   For {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} it is the
+     *   key of the JSON field. For instance, `my_id` for JSON `{"my_id":
+     *   "some_uuid"}`. For
+     *   {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource} it is
+     *   the column name of the BigQuery table where the unique ids are stored.
+     *
+     *   The values of the JSON field or the BigQuery column will be used as the
+     *   {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s. The JSON
+     *   field or the BigQuery column must be of string type, and the values must be
+     *   set as valid strings conform to
+     *   [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
+     *   Otherwise, documents without valid IDs will fail to be imported.
+     *
+     *   Only set this field when using
+     *   {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
+     *   {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
+     *   when
+     *   {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
+     *   or
+     *   {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
+     *   is `custom`. And only set this field when
+     *   {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
+     *   is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *
+     *   If it is unset, a default value `_id` is used when importing from the
+     *   allowed data sources.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.

package/build/src/v1beta/document_service_client.js

@@ -174,6 +174,9 @@ class DocumentServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
                         },
@@ -197,6 +200,9 @@ class DocumentServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
                         },

package/build/src/v1beta/schema_service_client.js

@@ -172,6 +172,9 @@ class SchemaServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
                         },
@@ -195,6 +198,9 @@ class SchemaServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
                         },

package/build/src/v1beta/search_service_client.d.ts

@@ -162,6 +162,10 @@ export declare class SearchServiceClient {
      *   case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
      * @param {number[]} request.facetSpecs
      *   Facet specifications for faceted search. If empty, no facets are returned.
      *
@@ -172,16 +176,13 @@ export declare class SearchServiceClient {
      * @param {number[]} request.params
      *   Additional search parameters.
      *
-     *   For
-     *   {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
-     *   vertical, supported values are:
+     *   For public website search only, supported values are:
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *     depending on the value. The only valid non-default value is 1,
      *     which enables image searching.
-     *   This field is ignored for other verticals.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion will occur.
@@ -206,6 +207,27 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
      *   The content search spec that configs the desired behavior of content
      *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   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.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -280,6 +302,10 @@ export declare class SearchServiceClient {
      *   case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
      * @param {number[]} request.facetSpecs
      *   Facet specifications for faceted search. If empty, no facets are returned.
      *
@@ -290,16 +316,13 @@ export declare class SearchServiceClient {
      * @param {number[]} request.params
      *   Additional search parameters.
      *
-     *   For
-     *   {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
-     *   vertical, supported values are:
+     *   For public website search only, supported values are:
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *     depending on the value. The only valid non-default value is 1,
      *     which enables image searching.
-     *   This field is ignored for other verticals.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion will occur.
@@ -324,6 +347,27 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
      *   The content search spec that configs the desired behavior of content
      *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   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.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -393,6 +437,10 @@ export declare class SearchServiceClient {
      *   case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
      * @param {number[]} request.facetSpecs
      *   Facet specifications for faceted search. If empty, no facets are returned.
      *
@@ -403,16 +451,13 @@ export declare class SearchServiceClient {
      * @param {number[]} request.params
      *   Additional search parameters.
      *
-     *   For
-     *   {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
-     *   vertical, supported values are:
+     *   For public website search only, supported values are:
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *     depending on the value. The only valid non-default value is 1,
      *     which enables image searching.
-     *   This field is ignored for other verticals.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion will occur.
@@ -437,6 +482,27 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
      *   The content search spec that configs the desired behavior of content
      *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   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.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}

package/build/src/v1beta/search_service_client.js

@@ -320,6 +320,10 @@ class SearchServiceClient {
      *   case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
      * @param {number[]} request.facetSpecs
      *   Facet specifications for faceted search. If empty, no facets are returned.
      *
@@ -330,16 +334,13 @@ class SearchServiceClient {
      * @param {number[]} request.params
      *   Additional search parameters.
      *
-     *   For
-     *   {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
-     *   vertical, supported values are:
+     *   For public website search only, supported values are:
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *     depending on the value. The only valid non-default value is 1,
      *     which enables image searching.
-     *   This field is ignored for other verticals.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion will occur.
@@ -364,6 +365,27 @@ class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
      *   The content search spec that configs the desired behavior of content
      *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   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.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -447,6 +469,10 @@ class SearchServiceClient {
      *   case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
      * @param {number[]} request.facetSpecs
      *   Facet specifications for faceted search. If empty, no facets are returned.
      *
@@ -457,16 +483,13 @@ class SearchServiceClient {
      * @param {number[]} request.params
      *   Additional search parameters.
      *
-     *   For
-     *   {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
-     *   vertical, supported values are:
+     *   For public website search only, supported values are:
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *     depending on the value. The only valid non-default value is 1,
      *     which enables image searching.
-     *   This field is ignored for other verticals.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion will occur.
@@ -491,6 +514,27 @@ class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
      *   The content search spec that configs the desired behavior of content
      *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   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.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}

package/build/src/v1beta/user_event_service_client.js

@@ -166,6 +166,9 @@ class UserEventServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
                         },
@@ -189,6 +192,9 @@ class UserEventServiceClient {
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
                         },
+                        {
+                            get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
+                        },
                         {
                             get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
                         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",
@@ -57,7 +57,7 @@
     "jsdoc": "^4.0.0",
     "jsdoc-fresh": "^2.0.0",
     "jsdoc-region-tag": "^2.0.0",
-    "linkinator": "^4.0.0",
+    "linkinator": "4.1.2",
     "long": "^5.2.3",
     "mocha": "^9.2.2",
     "null-loader": "^4.0.1",