@google-cloud/discoveryengine 1.10.0 → 1.12.0

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

@@ -272,6 +272,97 @@ export declare class CompletionServiceClient {
      * region_tag:discoveryengine_v1beta_generated_CompletionService_PurgeSuggestionDenyListEntries_async
      */
     checkPurgeSuggestionDenyListEntriesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesResponse, protos.google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesMetadata>>;
+    /**
+     * Imports
+     * {@link protos.google.cloud.discoveryengine.v1beta.CompletionSuggestion|CompletionSuggestion}s
+     * for a DataStore.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.discoveryengine.v1beta.ImportCompletionSuggestionsRequest.InlineSource} request.inlineSource
+     *   The Inline source for suggestion entries.
+     * @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
+     *   Cloud Storage location for the input content.
+     * @param {google.cloud.discoveryengine.v1beta.BigQuerySource} request.bigquerySource
+     *   BigQuery input source.
+     * @param {string} request.parent
+     *   Required. The parent data store resource name for which to import customer
+     *   autocomplete suggestions.
+     *
+     *   Follows pattern `projects/* /locations/* /collections/* /dataStores/*`
+     * @param {google.cloud.discoveryengine.v1beta.ImportErrorConfig} request.errorConfig
+     *   The desired location of errors incurred during the Import.
+     * @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.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/completion_service.import_completion_suggestions.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_CompletionService_ImportCompletionSuggestions_async
+     */
+    importCompletionSuggestions(request?: protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    importCompletionSuggestions(request: protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    importCompletionSuggestions(request: protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IImportCompletionSuggestionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `importCompletionSuggestions()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/completion_service.import_completion_suggestions.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_CompletionService_ImportCompletionSuggestions_async
+     */
+    checkImportCompletionSuggestionsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.ImportCompletionSuggestionsMetadata>>;
+    /**
+     * Permanently deletes all
+     * {@link protos.google.cloud.discoveryengine.v1beta.CompletionSuggestion|CompletionSuggestion}s
+     * for a DataStore.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent data store resource name for which to purge completion
+     *   suggestions. Follows pattern
+     *   projects/* /locations/* /collections/* /dataStores/*.
+     * @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.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/completion_service.purge_completion_suggestions.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_CompletionService_PurgeCompletionSuggestions_async
+     */
+    purgeCompletionSuggestions(request?: protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    purgeCompletionSuggestions(request: protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    purgeCompletionSuggestions(request: protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeCompletionSuggestionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `purgeCompletionSuggestions()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/completion_service.purge_completion_suggestions.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_CompletionService_PurgeCompletionSuggestions_async
+     */
+    checkPurgeCompletionSuggestionsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsMetadata>>;
     /**
      * Gets information about a location.
      *
@@ -485,6 +576,39 @@ export declare class CompletionServiceClient {
      * @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.
      *
@@ -602,6 +726,75 @@ export declare class CompletionServiceClient {
      * @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.
      *
@@ -1451,6 +1644,66 @@ export declare class CompletionServiceClient {
      * @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.
      *
@@ -1862,6 +2115,81 @@ export declare class CompletionServiceClient {
      * @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.
      *