@google-cloud/discoveryengine 1.7.0 → 1.9.0

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

@@ -126,7 +126,7 @@ export declare class RecommendationServiceClient {
      *   `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
      *
      *   One default serving config is created along with your recommendation engine
-     *   creation. The engine ID will be used as the ID of the default serving
+     *   creation. The engine ID is used as the ID of the default serving
      *   config. For example, for Engine
      *   `projects/* /locations/global/collections/* /engines/my-engine`, you can use
      *   `projects/* /locations/global/collections/* /engines/my-engine/servingConfigs/my-engine`
@@ -152,9 +152,9 @@ export declare class RecommendationServiceClient {
      *   unset.
      * @param {number} request.pageSize
      *   Maximum number of results to return. Set this property
-     *   to the number of recommendation results needed. If zero, the service will
-     *   choose a reasonable default. The maximum allowed value is 100. Values
-     *   above 100 will be coerced to 100.
+     *   to the number of recommendation results needed. If zero, the service
+     *   chooses a reasonable default. The maximum allowed value is 100. Values
+     *   above 100 are set to 100.
      * @param {string} request.filter
      *   Filter for restricting recommendation results with a length limit of 5,000
      *   characters. Currently, only filter expressions on the `filter_tags`
@@ -174,18 +174,18 @@ export declare class RecommendationServiceClient {
      *    * (available: true) AND
      *      (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
      *
-     *   If your filter blocks all results, the API will return generic
+     *   If your filter blocks all results, the API returns generic
      *   (unfiltered) popular Documents. If you only want results strictly matching
-     *   the filters, set `strictFiltering` to True in
+     *   the filters, set `strictFiltering` to `true` in
      *   {@link protos.google.cloud.discoveryengine.v1beta.RecommendRequest.params|RecommendRequest.params}
      *   to receive empty results instead.
      *
-     *   Note that the API will never return
+     *   Note that the API never returns
      *   {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s with
-     *   `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
+     *   `storageStatus` as `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.
+     *   Use validate only mode for this recommendation query. If set to `true`, a
+     *   fake model is used that returns arbitrary Document IDs.
      *   Note that the validate only mode should only be used for testing the API,
      *   or if the model is not ready.
      * @param {number[]} request.params
@@ -193,16 +193,17 @@ export declare class RecommendationServiceClient {
      *
      *   Allowed values:
      *
-     *   * `returnDocument`: Boolean. If set to true, the associated Document
-     *      object will be returned in
+     *   * `returnDocument`: Boolean. If set to `true`, the associated Document
+     *      object is returned in
      *      {@link protos.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
+     *   * `returnScore`: Boolean. If set to true, the recommendation score
+     *      corresponding to each returned Document is set in
      *      {@link protos.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
+     *      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
+     *      returns 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:
@@ -343,6 +344,21 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project: string): string;
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -445,6 +461,57 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreControlPath(project: string, location: string, collection: string, dataStore: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
      *
@@ -496,6 +563,57 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} custom_tuning_model
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the custom_tuning_model.
+     */
+    matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
      *
@@ -844,6 +962,57 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the target_site.
      */
     matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineControlPath(project: string, location: string, collection: string, engine: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
      *
@@ -1141,6 +1310,48 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreControlPath(project: string, location: string, dataStore: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreConversation resource name string.
      *
@@ -1183,6 +1394,48 @@ export declare class RecommendationServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} custom_tuning_model
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the custom_tuning_model.
+     */
+    matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
      *