@google-cloud/discoveryengine 1.3.1 → 1.4.1

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

@@ -16,6 +16,8 @@ export declare class SearchServiceClient {
     private _gaxGrpc;
     private _protos;
     private _defaults;
+    private _universeDomain;
+    private _servicePath;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -85,15 +87,22 @@ export declare class SearchServiceClient {
     }>;
     /**
      * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get servicePath(): string;
     /**
-     * The DNS address for this API service - same as servicePath(),
-     * exists for compatibility reasons.
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
     /**
      * The port for this API service.
      * @returns {number} The default port for this service.
@@ -154,6 +163,8 @@ export declare class SearchServiceClient {
      *   is unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {number[]} request.dataStoreSpecs
+     *   A list of data store specs to apply on a search call.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -249,12 +260,13 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -297,6 +309,8 @@ export declare class SearchServiceClient {
      *   See [Google Cloud
      *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
      *   for more details.
+     * @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
+     *   Custom fine tuning configs.
      * @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.
@@ -362,6 +376,8 @@ export declare class SearchServiceClient {
      *   is unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {number[]} request.dataStoreSpecs
+     *   A list of data store specs to apply on a search call.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -457,12 +473,13 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -505,6 +522,8 @@ export declare class SearchServiceClient {
      *   See [Google Cloud
      *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
      *   for more details.
+     * @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
+     *   Custom fine tuning configs.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -565,6 +584,8 @@ export declare class SearchServiceClient {
      *   is unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {number[]} request.dataStoreSpecs
+     *   A list of data store specs to apply on a search call.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -660,12 +681,13 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -708,6 +730,8 @@ export declare class SearchServiceClient {
      *   See [Google Cloud
      *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
      *   for more details.
+     * @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
+     *   Custom fine tuning configs.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -772,6 +796,30 @@ export declare class SearchServiceClient {
      * ```
      */
     listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Return a fully-qualified aclConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @returns {string} Resource name string.
+     */
+    aclConfigPath(project: string, location: string): string;
+    /**
+     * Parse the project from AclConfig resource.
+     *
+     * @param {string} aclConfigName
+     *   A fully-qualified path representing AclConfig resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromAclConfigName(aclConfigName: string): string | number;
+    /**
+     * Parse the location from AclConfig resource.
+     *
+     * @param {string} aclConfigName
+     *   A fully-qualified path representing AclConfig resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromAclConfigName(aclConfigName: string): string | number;
     /**
      * Return a fully-qualified engine resource name string.
      *
@@ -967,6 +1015,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 projectLocationCollectionDataStoreConversation resource name string.
      *
@@ -1018,6 +1135,48 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreDocumentProcessingConfigPath(project: string, location: string, collection: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
      *
@@ -1441,6 +1600,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 projectLocationDataStoreConversation resource name string.
      *
@@ -1483,6 +1702,39 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreDocumentProcessingConfigPath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreDocumentProcessingConfigName
+     *   A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSchema resource name string.
      *