Method: projects.locations.setDedicatedCrawlRate

Establece la frecuencia de rastreo dedicada para un objeto crawlRateScope. Si no se configuró la tasa de rastreo dedicada, se habilitará el bot de rastreo de Vertex AI para que use la nueva tasa de rastreo dedicada para el rastreo. Si se estableció la tasa de rastreo dedicada, el bot de rastreo de Vertex AI intentará actualizar la tasa al valor nuevo. Si el valor nuevo es demasiado alto, es posible que el bot de rastreo rastree a una velocidad 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 de acceso

Parámetros
location

string

Obligatorio. Es el recurso de ubicación en el que se realizará la administración de la velocidad 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. Es el alcance de la tasa de rastreo que el usuario desea configurar. Actualmente, solo se admiten el dominio y el nombre de host. Un ejemplo de nombre de dominio es example.com. Un ejemplo de nombre de host es www.example.com. No incluyas / en el nombre de dominio o de host.

crawlRate

integer

Opcional. Es la cantidad de QPS de rastreo que establece el usuario. No se garantiza que el robot de rastreo de Vertex rastree con este QPS. Si la tasa de rastreo es demasiado alta, es posible que la QPS real sea inferior al valor establecido por el usuario para evitar sobrecargar su sitio web.

crawlType

enum (CrawlType)

Opcional. Indica si se trata de la frecuencia de rastreo de la actualización automática o activada por el usuario.

mode

enum (Mode)

Opcional. Indica si la tasa la establecen los usuarios de forma explícita o si la establece 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

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

CrawlType

El tipo de rastreo se usa para distinguir entre las actualizaciones automáticas y las activadas por el usuario. La frecuencia de rastreo activada por el usuario se utiliza para casos de uso determinísticos, como el rastreo de 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 la actualización periódica de URLs.

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

Modo

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

Enums
MODE_UNSPECIFIED El modo no está especificado. Si el usuario no especifica el modo, se usará AUTOMATIC de forma predeterminada.
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 tasa de rastreo activada por el usuario o de actualización automática.