@google-cloud/discoveryengine 1.6.0 → 1.7.0

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

@@ -217,6 +217,9 @@ export declare class DocumentServiceClient {
      *   {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} is not found, a
      *   new {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} will be
      *   created.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   Indicates which fields in the provided imported 'document' to update. If
+     *   not set, will by default update all fields.
      * @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.
@@ -282,6 +285,16 @@ export declare class DocumentServiceClient {
      *   Cloud Storage location for the input content.
      * @param {google.cloud.discoveryengine.v1beta.BigQuerySource} request.bigquerySource
      *   BigQuery input source.
+     * @param {google.cloud.discoveryengine.v1beta.FhirStoreSource} request.fhirStoreSource
+     *   FhirStore input source.
+     * @param {google.cloud.discoveryengine.v1beta.SpannerSource} request.spannerSource
+     *   Spanner input source.
+     * @param {google.cloud.discoveryengine.v1beta.CloudSqlSource} request.cloudSqlSource
+     *   Cloud SQL input source.
+     * @param {google.cloud.discoveryengine.v1beta.FirestoreSource} request.firestoreSource
+     *   Firestore input source.
+     * @param {google.cloud.discoveryengine.v1beta.BigtableSource} request.bigtableSource
+     *   Cloud Bigtable input source.
      * @param {string} request.parent
      *   Required. The parent branch resource name, such as
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -292,6 +305,9 @@ export declare class DocumentServiceClient {
      *   The mode of reconciliation between existing documents and the documents to
      *   be imported. Defaults to
      *   {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   Indicates which fields in the provided imported documents to update. If
+     *   not set, the default is to update all fields.
      * @param {boolean} request.autoGenerateIds
      *   Whether to automatically generate IDs for the documents if absent.
      *
@@ -306,44 +322,53 @@ export declare class DocumentServiceClient {
      *   {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field|id_field},
      *   otherwise, documents without IDs fail to be imported.
      *
-     *   Only set this field when using
-     *   {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
-     *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
-     *   when
+     *   Supported data sources:
+     *
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource}.
      *   {@link protos.google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
-     *   or
+     *   must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}.
      *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
-     *   is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.SpannerSource|SpannerSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.CloudSqlSource|CloudSqlSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.FirestoreSource|FirestoreSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.BigtableSource|BigtableSource}.
      * @param {string} request.idField
-     *   The field in the Cloud Storage and BigQuery sources that indicates the
-     *   unique IDs of the documents.
+     *   The field indicates the ID field or column to be used as unique IDs of
+     *   the documents.
      *
      *   For {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} it is the
      *   key of the JSON field. For instance, `my_id` for JSON `{"my_id":
-     *   "some_uuid"}`. For
-     *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource} it is
-     *   the column name of the BigQuery table where the unique ids are stored.
+     *   "some_uuid"}`. For others, it may be the column name of the table where the
+     *   unique ids are stored.
      *
-     *   The values of the JSON field or the BigQuery column are used as the
+     *   The values of the JSON field or the table column are used as the
      *   {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id}s. The JSON
-     *   field or the BigQuery column must be of string type, and the values must be
+     *   field or the table column must be of string type, and the values must be
      *   set as valid strings conform to
      *   [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
      *   Otherwise, documents without valid IDs fail to be imported.
      *
-     *   Only set this field when using
-     *   {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
-     *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
-     *   when
-     *   {@link protos.google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
-     *   or
-     *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
-     *   is `custom`. And only set this field when
+     *   Only set this field when
      *   {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
      *   is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
      *
      *   If it is unset, a default value `_id` is used when importing from the
      *   allowed data sources.
+     *
+     *   Supported data sources:
+     *
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
+     *   must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
+     *   must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.SpannerSource|SpannerSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.CloudSqlSource|CloudSqlSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.FirestoreSource|FirestoreSource}.
+     *   * {@link protos.google.cloud.discoveryengine.v1beta.BigtableSource|BigtableSource}.
      * @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.
@@ -1136,6 +1161,117 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the serving_config.
      */
     matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSession resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionName
+     *   A fully-qualified path representing project_location_collection_data_store_session resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSession resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionName
+     *   A fully-qualified path representing project_location_collection_data_store_session resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSession resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionName
+     *   A fully-qualified path representing project_location_collection_data_store_session resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionName
+     *   A fully-qualified path representing project_location_collection_data_store_session resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionDataStoreSession resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionName
+     *   A fully-qualified path representing project_location_collection_data_store_session resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} session
+     * @param {string} answer
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSessionAnswerPath(project: string, location: string, collection: string, dataStore: string, session: string, answer: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_data_store_session_answer resource.
+     * @returns {string} A string representing the answer.
+     */
+    matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
      *
@@ -1331,6 +1467,117 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the serving_config.
      */
     matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineSession resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionName
+     *   A fully-qualified path representing project_location_collection_engine_session resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineSession resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionName
+     *   A fully-qualified path representing project_location_collection_engine_session resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineSession resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionName
+     *   A fully-qualified path representing project_location_collection_engine_session resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineSession resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionName
+     *   A fully-qualified path representing project_location_collection_engine_session resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionEngineSession resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionName
+     *   A fully-qualified path representing project_location_collection_engine_session resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} session
+     * @param {string} answer
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineSessionAnswerPath(project: string, location: string, collection: string, engine: string, session: string, answer: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionAnswerName
+     *   A fully-qualified path representing project_location_collection_engine_session_answer resource.
+     * @returns {string} A string representing the answer.
+     */
+    matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStore resource name string.
      *
@@ -1616,6 +1863,99 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the serving_config.
      */
     matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSession resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSession resource.
+     *
+     * @param {string} projectLocationDataStoreSessionName
+     *   A fully-qualified path representing project_location_data_store_session resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSession resource.
+     *
+     * @param {string} projectLocationDataStoreSessionName
+     *   A fully-qualified path representing project_location_data_store_session resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSession resource.
+     *
+     * @param {string} projectLocationDataStoreSessionName
+     *   A fully-qualified path representing project_location_data_store_session resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationDataStoreSession resource.
+     *
+     * @param {string} projectLocationDataStoreSessionName
+     *   A fully-qualified path representing project_location_data_store_session resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} session
+     * @param {string} answer
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSessionAnswerPath(project: string, location: string, dataStore: string, session: string, answer: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_data_store_session_answer resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_data_store_session_answer resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_data_store_session_answer resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_data_store_session_answer resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Parse the answer from ProjectLocationDataStoreSessionAnswer resource.
+     *
+     * @param {string} projectLocationDataStoreSessionAnswerName
+     *   A fully-qualified path representing project_location_data_store_session_answer resource.
+     * @returns {string} A string representing the answer.
+     */
+    matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
      *