Method: projects.locations.setDedicatedCrawlRate

為 crawlRateScope 設定專屬檢索頻率。如果未設定專屬檢索率,這會讓 Vertex AI 的檢索機器人使用新的專屬檢索率進行檢索。如果已設定專屬檢索率,Vertex AI 檢索機器人會嘗試將檢索率更新為新值。如果新值過高,為避免使用者網站過載,檢索機器人可能會降低檢索率。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1beta/{location=projects/*/locations/*}:setDedicatedCrawlRate

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
location

string

這是必要旗標,要執行檢索速率管理的商家檔案資源。格式:projects/{project}/locations/{location}

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "crawlRateScope": string,
  "crawlRate": integer,
  "crawlType": enum (CrawlType),
  "mode": enum (Mode)
}
欄位
crawlRateScope

string

這是必要旗標,使用者要設定的檢索速率範圍。目前僅支援網域和主機名稱。網域名稱範例:example.com。主機名稱範例:www.example.com。請勿在網域或主機名稱中加入 /

crawlRate

integer

(選用步驟) 使用者設定的檢索 QPS。Vertex 檢索機器人並不保證會以這個 QPS 檢索。如果檢索頻率過高,為避免使用者網站負載過重,實際 QPS 可能會低於使用者設定的值。

crawlType

enum (CrawlType)

(選用步驟) 無論是使用者觸發或自動重新整理的檢索率。

mode

enum (Mode)

(選用步驟) 速率是由使用者明確設定,還是由 Vertex AI 設定。

回應主體

如果成功,回應主體會包含 Operation 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview

CrawlType

系統會使用檢索類型來區分使用者觸發的檢索和自動重新整理。使用者觸發的檢索率適用於確定性用途,例如檢索使用者指定的網址或網站地圖。自動重新整理檢索率適用於盡可能取得的用途,例如定期重新整理網址。

列舉
CRAWL_TYPE_UNSPECIFIED 未指定檢索類型。
USER_TRIGGERED 檢索類型為使用者觸發。
AUTO_REFRESH 檢索類型為自動重新整理。

模式

速率是由使用者明確設定,還是由 Vertex AI 設定。

列舉
MODE_UNSPECIFIED 未指定模式,如果使用者未指定模式,則預設為 AUTOMATIC。
AUTOMATIC Vertex AI 會自動將 crawlRate 分成使用者觸發和自動重新整理。如果模式為 AUTOMATIC,使用者不需要指定 SetDedicatedCrawlRateRequest.CrawlType
EXPLICIT 使用者明確設定使用者觸發或自動重新整理的檢索率。