Method: projects.locations.setDedicatedCrawlRate

Définit la vitesse d'exploration dédiée pour un crawlRateScope. Si le taux d'exploration dédié n'a pas été défini, cela permettra au robot d'exploration de Vertex AI d'utiliser le nouveau taux d'exploration dédié pour l'exploration. Si le taux d'exploration dédié a été défini, le robot d'exploration de Vertex AI tentera de le modifier pour lui attribuer la nouvelle valeur. Si la nouvelle valeur est trop élevée, le robot d'exploration peut explorer le site à un rythme plus lent pour éviter de le surcharger.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
location

string

Obligatoire. Ressource d'emplacement où la gestion du taux d'exploration sera effectuée. Format : projects/{project}/locations/{location}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "crawlRateScope": string,
  "crawlRate": integer,
  "crawlType": enum (CrawlType),
  "mode": enum (Mode)
}
Champs
crawlRateScope

string

Obligatoire. Portée du taux d'exploration que l'utilisateur souhaite configurer. Pour le moment, seuls le nom de domaine et le nom d'hôte sont acceptés. Exemple de nom de domaine : example.com. Exemple de nom d'hôte : www.example.com. Veuillez ne pas inclure / dans le nom de domaine ou d'hôte.
crawlRate

integer

Facultatif. RPS d'exploration défini par l'utilisateur. Il n'est pas garanti que le robot d'exploration Vertex explorera à ce RPS. Si le taux d'exploration est trop élevé, le RPS réel peut être inférieur à la valeur définie par l'utilisateur afin d'éviter de surcharger son site Web.
crawlType

enum (CrawlType)

Facultatif. Qu'il s'agisse du taux d'exploration des actualisations automatiques ou déclenchées par l'utilisateur.
mode

enum (Mode)

Facultatif. Indique si le taux est défini explicitement par les utilisateurs ou par Vertex AI.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

CrawlType

Le type d'exploration permet de distinguer les actualisations déclenchées par l'utilisateur de celles qui sont automatiques. Le taux d'exploration déclenché par l'utilisateur est destiné aux cas d'utilisation déterministes, comme l'exploration d'URL ou de sitemaps spécifiés par les utilisateurs. La fréquence d'exploration avec actualisation automatique est destinée aux cas d'utilisation les plus efficaces, comme l'actualisation périodique des URL.

Enums
CRAWL_TYPE_UNSPECIFIED Le type d'exploration n'est pas spécifié.
USER_TRIGGERED Le type d'exploration est déclenché par l'utilisateur.
AUTO_REFRESH Le type d'exploration est "Actualisation automatique".

Mode

Indique si le taux est défini explicitement par les utilisateurs ou par Vertex AI.

Enums
MODE_UNSPECIFIED Le mode n'est pas spécifié. Si l'utilisateur ne spécifie pas le mode, définissez AUTOMATIC par défaut.
AUTOMATIC Vertex AI divise automatiquement crawlRate en "déclenchement par l'utilisateur" et "actualisation automatique". Les utilisateurs n'ont pas besoin de spécifier SetDedicatedCrawlRateRequest.CrawlType si le mode est AUTOMATIC.
EXPLICIT Les utilisateurs définissent explicitement le taux d'exploration déclenché par l'utilisateur ou l'actualisation automatique.