@google-cloud/discoveryengine 1.10.0 → 1.11.0

package/build/src/v1beta/search_service_client.js

@@ -150,10 +150,12 @@ class SearchServiceClient {
         // Create useful helper objects for these.
         this.pathTemplates = {
             enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
+            evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
             projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
             projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
             projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
             projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
             projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
             projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -172,6 +174,7 @@ class SearchServiceClient {
             projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
             projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
             projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
             projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
             projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -182,6 +185,8 @@ class SearchServiceClient {
             projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
             projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
             projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
+            sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
+            sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
         };
         // Some of the methods on this service return "paged" results,
         // (e.g. 50 results at a time, with tokens to get subsequent
@@ -483,20 +488,26 @@ class SearchServiceClient {
      *   documents. This overrides
      *   {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
      *   The ranking expression is a single function or multiple functions that are
-     *   joint by "+".
+     *   joined by "+".
+     *
      *     * ranking_expression = function, { " + ", function };
+     *
      *   Supported functions:
+     *
      *     * double * relevance_score
      *     * double * dotProduct(embedding_field_path)
+     *
      *   Function variables:
-     *     `relevance_score`: pre-defined keywords, used for measure relevance
+     *
+     *     * `relevance_score`: pre-defined keywords, used for measure relevance
      *     between query and document.
-     *     `embedding_field_path`: the document embedding field
+     *     * `embedding_field_path`: the document embedding field
      *     used with query embedding vector.
-     *     `dotProduct`: embedding function between embedding_field_path and query
+     *     * `dotProduct`: embedding function between embedding_field_path and query
      *     embedding vector.
      *
      *    Example ranking expression:
+     *
      *      If document has an embedding field doc_embedding, the ranking expression
      *      could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
      * @param {boolean} request.safeSearch
@@ -710,20 +721,26 @@ class SearchServiceClient {
      *   documents. This overrides
      *   {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
      *   The ranking expression is a single function or multiple functions that are
-     *   joint by "+".
+     *   joined by "+".
+     *
      *     * ranking_expression = function, { " + ", function };
+     *
      *   Supported functions:
+     *
      *     * double * relevance_score
      *     * double * dotProduct(embedding_field_path)
+     *
      *   Function variables:
-     *     `relevance_score`: pre-defined keywords, used for measure relevance
+     *
+     *     * `relevance_score`: pre-defined keywords, used for measure relevance
      *     between query and document.
-     *     `embedding_field_path`: the document embedding field
+     *     * `embedding_field_path`: the document embedding field
      *     used with query embedding vector.
-     *     `dotProduct`: embedding function between embedding_field_path and query
+     *     * `dotProduct`: embedding function between embedding_field_path and query
      *     embedding vector.
      *
      *    Example ranking expression:
+     *
      *      If document has an embedding field doc_embedding, the ranking expression
      *      could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
      * @param {boolean} request.safeSearch
@@ -889,6 +906,54 @@ class SearchServiceClient {
     matchEngineFromEngineName(engineName) {
         return this.pathTemplates.enginePathTemplate.match(engineName).engine;
     }
+    /**
+     * Return a fully-qualified evaluation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} evaluation
+     * @returns {string} Resource name string.
+     */
+    evaluationPath(project, location, evaluation) {
+        return this.pathTemplates.evaluationPathTemplate.render({
+            project: project,
+            location: location,
+            evaluation: evaluation,
+        });
+    }
+    /**
+     * Parse the project from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromEvaluationName(evaluationName) {
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
+            .project;
+    }
+    /**
+     * Parse the location from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromEvaluationName(evaluationName) {
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
+            .location;
+    }
+    /**
+     * Parse the evaluation from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the evaluation.
+     */
+    matchEvaluationFromEvaluationName(evaluationName) {
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
+            .evaluation;
+    }
     /**
      * Return a fully-qualified project resource name string.
      *
@@ -1117,6 +1182,99 @@ class SearchServiceClient {
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @param {string} chunk
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            branch: branch,
+            document: document,
+            chunk: chunk,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
+    }
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
+    }
+    /**
+     * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
+    }
+    /**
+     * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the chunk.
+     */
+    matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
      *
@@ -2323,6 +2481,87 @@ class SearchServiceClient {
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @param {string} chunk
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            branch: branch,
+            document: document,
+            chunk: chunk,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
+    }
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
+    }
+    /**
+     * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
+    }
+    /**
+     * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the chunk.
+     */
+    matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreControl resource name string.
      *
@@ -2881,6 +3120,112 @@ class SearchServiceClient {
     matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
         return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
     }
+    /**
+     * Return a fully-qualified sampleQuery resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} sample_query_set
+     * @param {string} sample_query
+     * @returns {string} Resource name string.
+     */
+    sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
+        return this.pathTemplates.sampleQueryPathTemplate.render({
+            project: project,
+            location: location,
+            sample_query_set: sampleQuerySet,
+            sample_query: sampleQuery,
+        });
+    }
+    /**
+     * Parse the project from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromSampleQueryName(sampleQueryName) {
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
+            .project;
+    }
+    /**
+     * Parse the location from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromSampleQueryName(sampleQueryName) {
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
+            .location;
+    }
+    /**
+     * Parse the sample_query_set from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the sample_query_set.
+     */
+    matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
+            .sample_query_set;
+    }
+    /**
+     * Parse the sample_query from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the sample_query.
+     */
+    matchSampleQueryFromSampleQueryName(sampleQueryName) {
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
+            .sample_query;
+    }
+    /**
+     * Return a fully-qualified sampleQuerySet resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} sample_query_set
+     * @returns {string} Resource name string.
+     */
+    sampleQuerySetPath(project, location, sampleQuerySet) {
+        return this.pathTemplates.sampleQuerySetPathTemplate.render({
+            project: project,
+            location: location,
+            sample_query_set: sampleQuerySet,
+        });
+    }
+    /**
+     * Parse the project from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromSampleQuerySetName(sampleQuerySetName) {
+        return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
+    }
+    /**
+     * Parse the location from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromSampleQuerySetName(sampleQuerySetName) {
+        return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
+    }
+    /**
+     * Parse the sample_query_set from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the sample_query_set.
+     */
+    matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
+        return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
+    }
     /**
      * Terminate the gRPC channel and close the client.
      *