@google-cloud/discoveryengine 2.3.0 → 2.4.0

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

@@ -526,6 +526,9 @@ export declare class ConversationalSearchServiceClient {
      * @param {string} request.name
      *   Required. The resource name of the Session to get. Format:
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+     * @param {boolean} [request.includeAnswerDetails]
+     *   Optional. If set to true, the full session including all answer details
+     *   will be returned.
      * @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.
@@ -696,22 +699,39 @@ export declare class ConversationalSearchServiceClient {
     *   A page token, received from a previous `ListSessions` call.
     *   Provide this to retrieve the subsequent page.
     * @param {string} request.filter
-    *   A filter to apply on the list results. The supported features are:
-    *   user_pseudo_id, state.
+    *   A comma-separated list of fields to filter by, in EBNF grammar.
+    *   The supported fields are:
+    *   * `user_pseudo_id`
+    *   * `state`
+    *   * `display_name`
+    *   * `starred`
+    *   * `is_pinned`
+    *   * `labels`
+    *   * `create_time`
+    *   * `update_time`
     *
-    *   Example:
+    *   Examples:
     *   "user_pseudo_id = some_id"
+    *   "display_name = \"some_name\""
+    *   "starred = true"
+    *   "is_pinned=true AND (NOT labels:hidden)"
+    *   "create_time > \"1970-01-01T12:00:00Z\""
     * @param {string} request.orderBy
     *   A comma-separated list of fields to order by, sorted in ascending order.
     *   Use "desc" after a field name for descending.
     *   Supported fields:
+    *
     *     * `update_time`
     *     * `create_time`
     *     * `session_name`
+    *     * `is_pinned`
     *
     *   Example:
-    *   "update_time desc"
-    *   "create_time"
+    *
+    *   * "update_time desc"
+    *   * "create_time"
+    *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+    *      by update_time.
     * @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.
@@ -745,22 +765,39 @@ export declare class ConversationalSearchServiceClient {
      *   A page token, received from a previous `ListSessions` call.
      *   Provide this to retrieve the subsequent page.
      * @param {string} request.filter
-     *   A filter to apply on the list results. The supported features are:
-     *   user_pseudo_id, state.
-     *
-     *   Example:
+     *   A comma-separated list of fields to filter by, in EBNF grammar.
+     *   The supported fields are:
+     *   * `user_pseudo_id`
+     *   * `state`
+     *   * `display_name`
+     *   * `starred`
+     *   * `is_pinned`
+     *   * `labels`
+     *   * `create_time`
+     *   * `update_time`
+     *
+     *   Examples:
      *   "user_pseudo_id = some_id"
+     *   "display_name = \"some_name\""
+     *   "starred = true"
+     *   "is_pinned=true AND (NOT labels:hidden)"
+     *   "create_time > \"1970-01-01T12:00:00Z\""
      * @param {string} request.orderBy
      *   A comma-separated list of fields to order by, sorted in ascending order.
      *   Use "desc" after a field name for descending.
      *   Supported fields:
+     *
      *     * `update_time`
      *     * `create_time`
      *     * `session_name`
+     *     * `is_pinned`
      *
      *   Example:
-     *   "update_time desc"
-     *   "create_time"
+     *
+     *   * "update_time desc"
+     *   * "create_time"
+     *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+     *      by update_time.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -789,22 +826,39 @@ export declare class ConversationalSearchServiceClient {
      *   A page token, received from a previous `ListSessions` call.
      *   Provide this to retrieve the subsequent page.
      * @param {string} request.filter
-     *   A filter to apply on the list results. The supported features are:
-     *   user_pseudo_id, state.
-     *
-     *   Example:
+     *   A comma-separated list of fields to filter by, in EBNF grammar.
+     *   The supported fields are:
+     *   * `user_pseudo_id`
+     *   * `state`
+     *   * `display_name`
+     *   * `starred`
+     *   * `is_pinned`
+     *   * `labels`
+     *   * `create_time`
+     *   * `update_time`
+     *
+     *   Examples:
      *   "user_pseudo_id = some_id"
+     *   "display_name = \"some_name\""
+     *   "starred = true"
+     *   "is_pinned=true AND (NOT labels:hidden)"
+     *   "create_time > \"1970-01-01T12:00:00Z\""
      * @param {string} request.orderBy
      *   A comma-separated list of fields to order by, sorted in ascending order.
      *   Use "desc" after a field name for descending.
      *   Supported fields:
+     *
      *     * `update_time`
      *     * `create_time`
      *     * `session_name`
+     *     * `is_pinned`
      *
      *   Example:
-     *   "update_time desc"
-     *   "create_time"
+     *
+     *   * "update_time desc"
+     *   * "create_time"
+     *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+     *      by update_time.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -1460,57 +1514,6 @@ export declare class ConversationalSearchServiceClient {
      * @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.
      *
@@ -1571,6 +1574,57 @@ export declare class ConversationalSearchServiceClient {
      * @returns {string} A string representing the answer.
      */
     matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSessionsPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSessions resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionsName
+     *   A fully-qualified path representing project_location_collection_data_store_sessions resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSessions resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionsName
+     *   A fully-qualified path representing project_location_collection_data_store_sessions resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionsName
+     *   A fully-qualified path representing project_location_collection_data_store_sessions resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionsName
+     *   A fully-qualified path representing project_location_collection_data_store_sessions resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionDataStoreSessions resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSessionsName
+     *   A fully-qualified path representing project_location_collection_data_store_sessions resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
      *
@@ -1868,57 +1922,6 @@ export declare class ConversationalSearchServiceClient {
      * @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.
      *
@@ -1979,6 +1982,57 @@ export declare class ConversationalSearchServiceClient {
      * @returns {string} A string representing the answer.
      */
     matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineSessionsPath(project: string, location: string, collection: string, engine: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineSessions resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionsName
+     *   A fully-qualified path representing project_location_collection_engine_sessions resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineSessions resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionsName
+     *   A fully-qualified path representing project_location_collection_engine_sessions resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineSessions resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionsName
+     *   A fully-qualified path representing project_location_collection_engine_sessions resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineSessions resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionsName
+     *   A fully-qualified path representing project_location_collection_engine_sessions resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationCollectionEngineSessions resource.
+     *
+     * @param {string} projectLocationCollectionEngineSessionsName
+     *   A fully-qualified path representing project_location_collection_engine_sessions resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStore resource name string.
      *
@@ -2366,48 +2420,6 @@ export declare class ConversationalSearchServiceClient {
      * @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.
      *
@@ -2459,6 +2471,48 @@ export declare class ConversationalSearchServiceClient {
      * @returns {string} A string representing the answer.
      */
     matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSessions resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} session
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSessionsPath(project: string, location: string, dataStore: string, session: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSessions resource.
+     *
+     * @param {string} projectLocationDataStoreSessionsName
+     *   A fully-qualified path representing project_location_data_store_sessions resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSessions resource.
+     *
+     * @param {string} projectLocationDataStoreSessionsName
+     *   A fully-qualified path representing project_location_data_store_sessions resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSessions resource.
+     *
+     * @param {string} projectLocationDataStoreSessionsName
+     *   A fully-qualified path representing project_location_data_store_sessions resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
+    /**
+     * Parse the session from ProjectLocationDataStoreSessions resource.
+     *
+     * @param {string} projectLocationDataStoreSessionsName
+     *   A fully-qualified path representing project_location_data_store_sessions resource.
+     * @returns {string} A string representing the session.
+     */
+    matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
      *