Method: projects.locations.setDedicatedCrawlRate

crawlRateScope の専用クロール頻度を設定します。専用クロール頻度が設定されていない場合、これにより、Vertex AI のクロールボットがクロールに新しい専用クロール頻度を使用できるようになります。専用クロール頻度が設定されている場合、Vertex AI のクロールボットは頻度を新しい値に更新しようとします。新しい値が高すぎると、ユーザーのウェブサイトの過負荷を避けるために、クロールボットのクロール頻度が低くなることがあります。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

クロールタイプは、ユーザーがトリガーしたクロールと自動更新を区別するために使用されます。ユーザーがトリガーするクロール頻度は、ユーザーが指定した URL やサイトマップをクロールするなどの決定的ユースケースを対象としています。自動更新のクロール頻度は、URL を定期的に更新するなどのベスト エフォートのユースケースを対象としています。

列挙型
CRAWL_TYPE_UNSPECIFIED クロールタイプが指定されていません。
USER_TRIGGERED クロールタイプはユーザー トリガーです。
AUTO_REFRESH クロールタイプは自動更新です。

モード

頻度がユーザーによって明示的に設定されているか、Vertex AI によって設定されているか。

列挙型
MODE_UNSPECIFIED モードが指定されていません。モードを指定しない場合は、デフォルトで AUTOMATIC になります。
AUTOMATIC Vertex AI は、crawlRate をユーザー トリガーと自動更新に自動的に分割します。モードが AUTOMATIC の場合、ユーザーは SetDedicatedCrawlRateRequest.CrawlType を指定する必要はありません。
EXPLICIT ユーザーがユーザー トリガーまたは自動更新のクロール頻度を明示的に設定しています。