@google-cloud/discoveryengine 1.6.0 → 1.7.0

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

@@ -140,11 +140,15 @@ export declare class SearchServiceClient {
      *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
-     *   unspecified, defaults to a reasonable value. The maximum allowed value is
-     *   100. Values above 100 are coerced to 100.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. The
+     *   maximum allowed value depends on the data type. Values above the maximum
+     *   value are coerced to the maximum value.
      *
-     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     *   * Websites with basic indexing: Default `10`, Maximum `25`.
+     *   * Websites with advanced indexing: Default `25`, Maximum `50`.
+     *   * Other: Default `50`, Maximum `100`.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT` is returned.
      * @param {string} request.pageToken
      *   A page token received from a previous
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
@@ -266,7 +270,8 @@ export declare class SearchServiceClient {
      *
      *   If
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
-     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
+     *   is not provided, it will use
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -353,11 +358,15 @@ export declare class SearchServiceClient {
      *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
-     *   unspecified, defaults to a reasonable value. The maximum allowed value is
-     *   100. Values above 100 are coerced to 100.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. The
+     *   maximum allowed value depends on the data type. Values above the maximum
+     *   value are coerced to the maximum value.
      *
-     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     *   * Websites with basic indexing: Default `10`, Maximum `25`.
+     *   * Websites with advanced indexing: Default `25`, Maximum `50`.
+     *   * Other: Default `50`, Maximum `100`.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT` is returned.
      * @param {string} request.pageToken
      *   A page token received from a previous
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
@@ -479,7 +488,8 @@ export declare class SearchServiceClient {
      *
      *   If
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
-     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
+     *   is not provided, it will use
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -561,11 +571,15 @@ export declare class SearchServiceClient {
      *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
-     *   unspecified, defaults to a reasonable value. The maximum allowed value is
-     *   100. Values above 100 are coerced to 100.
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. The
+     *   maximum allowed value depends on the data type. Values above the maximum
+     *   value are coerced to the maximum value.
      *
-     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     *   * Websites with basic indexing: Default `10`, Maximum `25`.
+     *   * Websites with advanced indexing: Default `25`, Maximum `50`.
+     *   * Other: Default `50`, Maximum `100`.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT` is returned.
      * @param {string} request.pageToken
      *   A page token received from a previous
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
@@ -687,7 +701,8 @@ export declare class SearchServiceClient {
      *
      *   If
      *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
-     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
+     *   is not provided, it will use
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
      *   documents. This overrides
@@ -862,6 +877,21 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project: string): string;
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -1279,6 +1309,117 @@ export declare class SearchServiceClient {
      * @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.
      *
@@ -1474,6 +1615,117 @@ export declare class SearchServiceClient {
      * @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.
      *
@@ -1819,6 +2071,99 @@ export declare class SearchServiceClient {
      * @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.
      *