Discovery Engine API (discoveryengine:v1)

2024-10-30

3 new methods

Additions

    Methods

  • ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite

      Path: v1/{+servingConfig}:searchLite

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite

      HTTP Method: POST

      Parameters:

        servingConfig

          Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

          Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: servingConfig

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.

  • ▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite

      Path: v1/{+servingConfig}:searchLite

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite

      HTTP Method: POST

      Parameters:

        servingConfig

          Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

          Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: servingConfig

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.

  • ▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.searchLite

      Path: v1/{+servingConfig}:searchLite

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite

      HTTP Method: POST

      Parameters:

        servingConfig

          Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

          Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: servingConfig

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.