@google-cloud/discoveryengine 1.10.0 → 1.11.0

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

@@ -278,20 +278,26 @@ export declare 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
@@ -496,20 +502,26 @@ export declare 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
@@ -709,20 +721,26 @@ export declare 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
@@ -852,6 +870,39 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified evaluation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} evaluation
+     * @returns {string} Resource name string.
+     */
+    evaluationPath(project: string, location: string, evaluation: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified project resource name string.
      *
@@ -1020,6 +1071,75 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * 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: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
      *
@@ -1911,6 +2031,66 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * 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: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreControl resource name string.
      *
@@ -2322,6 +2502,81 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the target_site.
      */
     matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * 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: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string, location: string, sampleQuerySet: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Terminate the gRPC channel and close the client.
      *