Method: projects.locations.setDedicatedCrawlRate

Establece la frecuencia de rastreo dedicada para un crawlRateScope. Si no se estableció la frecuencia de rastreo dedicada, esto permitirá que el robot de rastreo de Vertex AI use la nueva frecuencia de rastreo dedicada para el rastreo. Si se estableció la frecuencia de rastreo dedicada, el robot de rastreo de Vertex AI intentará actualizar la frecuencia al valor nuevo. Si el valor nuevo es demasiado alto, es posible que el robot de rastreo rastree a una frecuencia más baja para evitar sobrecargar el sitio web del usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
location

string

Obligatorio. El recurso de ubicación en el que se realizará la administración de la frecuencia de rastreo. Formato: projects/{project}/locations/{location}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "crawlRateScope": string,
  "crawlRate": integer,
  "crawlType": enum (CrawlType),
  "mode": enum (Mode)
}
Campos
crawlRateScope

string

Obligatorio. El alcance de la frecuencia de rastreo que el usuario desea configurar. Actualmente, solo se admiten el dominio y el nombre de host. Un ejemplo de nombre de dominio: example.com. Un ejemplo de nombre de host: www.example.com. No incluyas / en el dominio ni en el nombre de host.
crawlRate

integer

Es opcional. El QPS de rastreo establecido por el usuario. No se garantiza que el robot de rastreo de Vertex rastree en este QPS. Si la frecuencia de rastreo es demasiado alta, es posible que el QPS real sea inferior al valor establecido por el usuario para evitar sobrecargar el sitio web del usuario.
crawlType

enum (CrawlType)

Es opcional. Indica si es la frecuencia de rastreo activada por el usuario o la actualización automática.
mode

enum (Mode)

Es opcional. Indica si la frecuencia la establecen los usuarios de forma explícita o Vertex AI.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

CrawlType

El tipo de rastreo se usa para distinguir entre el rastreo activado por el usuario y la actualización automática. La frecuencia de rastreo activada por el usuario es para casos de uso deterministas, como rastrear URLs o mapas del sitio especificados por los usuarios. La frecuencia de rastreo de actualización automática es para casos de uso de mejor esfuerzo, como actualizar URLs de forma periódica.

Enums
CRAWL_TYPE_UNSPECIFIED No se especificó el tipo de rastreo.
USER_TRIGGERED El tipo de rastreo es activado por el usuario.
AUTO_REFRESH El tipo de rastreo es de actualización automática.

Mode

Indica si la frecuencia la establecen los usuarios de forma explícita o Vertex AI.

Enums
MODE_UNSPECIFIED No se especificó el modo. Si el usuario no especifica el modo, se establece el valor predeterminado en AUTOMATIC.
AUTOMATIC Vertex AI divide automáticamente crawlRate en activado por el usuario y actualización automática. Los usuarios no necesitan especificar SetDedicatedCrawlRateRequest.CrawlType si el modo es AUTOMATIC.
EXPLICIT Los usuarios establecen de forma explícita la frecuencia de rastreo activada por el usuario o la actualización automática.