@google-cloud/discoveryengine 0.4.0 → 0.5.0

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

@@ -112,7 +112,7 @@ export declare class RecommendationServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. Full resource name of the format:
-     *   projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*
+     *   `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
      *
      *   Before you can request recommendations from your model, you must create at
      *   least one serving config  for it.
@@ -146,8 +146,8 @@ export declare class RecommendationServiceClient {
      *
      *   Examples:
      *
-     *    * (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))
-     *    * (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))
+     *    * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
+     *    * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
      *
      *   If your filter blocks all results, the API will return generic
      *   (unfiltered) popular Documents. If you only want results strictly matching
@@ -155,8 +155,9 @@ export declare class RecommendationServiceClient {
      *   {@link google.cloud.discoveryengine.v1beta.RecommendRequest.params|RecommendRequest.params}
      *   to receive empty results instead.
      *
-     *   Note that the API will never return Documents with storageStatus of
-     *   "EXPIRED" or "DELETED" regardless of filter choices.
+     *   Note that the API will never return
+     *   {@link google.cloud.discoveryengine.v1beta.Document|Document}s with
+     *   `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
      * @param {boolean} request.validateOnly
      *   Use validate only mode for this recommendation query. If set to true, a
      *   fake model will be used that returns arbitrary Document IDs.
@@ -169,22 +170,22 @@ export declare class RecommendationServiceClient {
      *
      *   * `returnDocument`: Boolean. If set to true, the associated Document
      *      object will be returned in
-     *      {@link RecommendationResult.document|RecommendResponse.results.document}.
+     *      {@link google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document|RecommendResponse.RecommendationResult.document}.
      *   * `returnScore`: Boolean. If set to true, the recommendation 'score'
      *      corresponding to each returned Document will be set in
-     *      {@link RecommendationResult.metadata|RecommendResponse.results.metadata}. The
-     *      given 'score' indicates the probability of a Document conversion given
-     *      the user's context and history.
+     *      {@link google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata|RecommendResponse.RecommendationResult.metadata}.
+     *      The given 'score' indicates the probability of a Document conversion
+     *      given the user's context and history.
      *   * `strictFiltering`: Boolean. True by default. If set to false, the service
      *      will return generic (unfiltered) popular Documents instead of empty if
      *      your filter blocks all recommendation results.
      *   * `diversityLevel`: String. Default empty. If set to be non-empty, then
      *      it needs to be one of:
-     *      *  'no-diversity'
-     *      *  'low-diversity'
-     *      *  'medium-diversity'
-     *      *  'high-diversity'
-     *      *  'auto-diversity'
+     *       *  `no-diversity`
+     *       *  `low-diversity`
+     *       *  `medium-diversity`
+     *       *  `high-diversity`
+     *       *  `auto-diversity`
      *      This gives request-level control and adjusts recommendation results
      *      based on Document category.
      * @param {number[]} request.userLabels
@@ -282,6 +283,57 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
      *
@@ -384,6 +436,48 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
      *

package/build/src/v1beta/recommendation_service_client.js

@@ -140,8 +140,10 @@ class RecommendationServiceClient {
         // Create useful helper objects for these.
         this.pathTemplates = {
             projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
             projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
         };
         // Put together the default options sent with requests.
@@ -341,6 +343,75 @@ class RecommendationServiceClient {
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            schema: schema,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
+    }
+    /**
+     * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
      *
@@ -479,6 +550,63 @@ class RecommendationServiceClient {
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            schema: schema,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
+    }
+    /**
+     * Parse the schema from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
      *