@google-cloud/discoveryengine 1.0.0 → 1.1.0

package/build/src/v1/conversational_search_service_client_config.json

@@ -0,0 +1,68 @@
+{
+    "interfaces": {
+        "google.cloud.discoveryengine.v1.ConversationalSearchService": {
+            "retry_codes": {
+                "non_idempotent": [],
+                "idempotent": [
+                    "DEADLINE_EXCEEDED",
+                    "UNAVAILABLE"
+                ],
+                "unavailable": [
+                    "UNAVAILABLE"
+                ]
+            },
+            "retry_params": {
+                "default": {
+                    "initial_retry_delay_millis": 100,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 60000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
+                },
+                "ce5b960a6ed052e690863808e4f0deff3dc7d49f": {
+                    "initial_retry_delay_millis": 1000,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 10000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
+                }
+            },
+            "methods": {
+                "ConverseConversation": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "CreateConversation": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "DeleteConversation": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "UpdateConversation": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "GetConversation": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "ListConversations": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                }
+            }
+        }
+    }
+}

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type * as gax from 'google-gax';
-import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
 import { Transform } from 'stream';
 import * as protos from '../../protos/protos';
 /**
@@ -23,6 +23,7 @@ export declare class DocumentServiceClient {
     innerApiCalls: {
         [name: string]: Function;
     };
+    locationsClient: LocationsClient;
     pathTemplates: {
         [name: string]: gax.PathTemplate;
     };
@@ -58,8 +59,7 @@ export declare class DocumentServiceClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -67,7 +67,7 @@ export declare class DocumentServiceClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new DocumentServiceClient({fallback: 'rest'}, gax);
+     *     const client = new DocumentServiceClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
@@ -293,7 +293,7 @@ export declare class DocumentServiceClient {
      *   `false`, {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s have
      *   to be specified using
      *   {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
-     *   otherwises, documents without IDs will fail to be imported.
+     *   otherwise, documents without IDs fail to be imported.
      *
      *   Only set this field when using
      *   {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
@@ -301,7 +301,7 @@ export declare class DocumentServiceClient {
      *   {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
      *   or
      *   {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
-     *   is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+     *   is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
      * @param {string} request.idField
      *   The field in the Cloud Storage and BigQuery sources that indicates the
      *   unique IDs of the documents.
@@ -311,12 +311,12 @@ export declare class DocumentServiceClient {
      *   For {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
      *   the column name of the BigQuery table where the unique ids are stored.
      *
-     *   The values of the JSON field or the BigQuery column will be used as the
+     *   The values of the JSON field or the BigQuery column are used as the
      *   {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
      *   or the BigQuery 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 will fail to
-     *   be imported.
+     *   with 1-63 characters. Otherwise, documents without valid IDs fail to be
+     *   imported.
      *
      *   Only set this field when using
      *   {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
@@ -431,9 +431,10 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link protos.|Documents}s under this
-     *   branch, regardless of whether or not this branch exists, a
-     *   `PERMISSION_DENIED` error is returned.
+     *   If the caller does not have permission to list
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
+     *   regardless of whether or not this branch exists, a `PERMISSION_DENIED`
+     *   error is returned.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
@@ -480,9 +481,10 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link protos.|Documents}s under this
-     *   branch, regardless of whether or not this branch exists, a
-     *   `PERMISSION_DENIED` error is returned.
+     *   If the caller does not have permission to list
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
+     *   regardless of whether or not this branch exists, a `PERMISSION_DENIED`
+     *   error is returned.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
@@ -524,9 +526,10 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link protos.|Documents}s under this
-     *   branch, regardless of whether or not this branch exists, a
-     *   `PERMISSION_DENIED` error is returned.
+     *   If the caller does not have permission to list
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
+     *   regardless of whether or not this branch exists, a `PERMISSION_DENIED`
+     *   error is returned.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
@@ -557,6 +560,57 @@ export declare class DocumentServiceClient {
      * region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async
      */
     listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IDocument>;
+    /**
+     * Gets information about a location.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Resource name for the location.
+     * @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 {@link google.cloud.location.Location | Location}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.getLocation(request);
+     * ```
+     */
+    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Lists information about the supported locations for this service. Returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The resource that owns the locations collection, if applicable.
+     * @param {string} request.filter
+     *   The standard list filter.
+     * @param {number} request.pageSize
+     *   The standard list page size.
+     * @param {string} request.pageToken
+     *   The standard list page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example
+     * ```
+     * const iterable = client.listLocationsAsync(request);
+     * for await (const response of iterable) {
+     *   // process response
+     * }
+     * ```
+     */
+    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
     /**
      * Gets the latest state of a long-running operation.  Clients can use this
      * method to poll the operation result at intervals as recommended by the API
@@ -788,6 +842,57 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
      *
@@ -932,6 +1037,48 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSchema resource name string.
      *