Discovery Engine API (discoveryengine:v1beta)

2025-02-18

4 new methods

Additions

    Methods
  • discoveryengine.projects.locations.obtainCrawlRate

      Path : v1beta/{+location}:obtainCrawlRate

      Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate

      HTTP Method : POST

      Parameters :

        location

          Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : location

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

      Description : Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.

  • discoveryengine.projects.locations.setDedicatedCrawlRate

      Path : v1beta/{+location}:setDedicatedCrawlRate

      Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate

      HTTP Method : POST

      Parameters :

        location

          Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : location

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

      Description : Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.

  • discoveryengine.projects.locations.removeDedicatedCrawlRate

      Path : v1beta/{+location}:removeDedicatedCrawlRate

      Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate

      HTTP Method : POST

      Parameters :

        location

          Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : location

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

      Description : Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.

  • discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion

      Path : v1beta/{+completionConfig}:removeSuggestion

      Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion

      HTTP Method : POST

      Parameters :

        completionConfig

          Description : Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : completionConfig

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

      Description : Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.