Method: projects.locations.setDedicatedCrawlRate

Imposta la frequenza di scansione dedicata per un crawlRateScope. Se la frequenza di scansione dedicata non è stata impostata, il bot di scansione di Vertex AI potrà utilizzare la nuova frequenza di scansione dedicata per la scansione. Se la frequenza di scansione dedicata è stata impostata, il bot di scansione di Vertex AI tenterà di aggiornare la frequenza al nuovo valore. Se il nuovo valore è troppo alto, il bot di scansione potrebbe eseguire la scansione a una frequenza inferiore per evitare di sovraccaricare il sito web dell'utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
location

string

Obbligatorio. La risorsa di località in cui verrà eseguita la gestione della frequenza di scansione. Formato: projects/{project}/locations/{location}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "crawlRateScope": string,
  "crawlRate": integer,
  "crawlType": enum (CrawlType),
  "mode": enum (Mode)
}
Campi
crawlRateScope

string

Obbligatorio. L'ambito della frequenza di scansione che l'utente vuole configurare. Al momento sono supportati solo il nome di dominio e il nome host. Esempio di nome di dominio: example.com. Esempio di nome host: www.example.com. Non includere / nel nome di dominio o host.

crawlRate

integer

Facoltativo. Il QPS di scansione impostato dall'utente. Non è garantito che il bot di scansione di Vertex esegua la scansione a questo QPS. Se la frequenza di scansione è troppo elevata, il QPS effettivo potrebbe essere inferiore al valore impostato dall'utente per evitare di sovraccaricare il sito web dell'utente.

crawlType

enum (CrawlType)

Facoltativo. Indica se si tratta della frequenza di scansione attivata dall'utente o dell'aggiornamento automatico.

mode

enum (Mode)

Facoltativo. Indica se la frequenza è impostata esplicitamente dagli utenti o da Vertex AI.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

CrawlType

Il tipo di scansione viene utilizzato per distinguere la scansione attivata dall'utente e l'aggiornamento automatico. La frequenza di scansione attivata dall'utente è destinata a casi d'uso deterministici, come la scansione di URL o Sitemap specificati dagli utenti. La frequenza di scansione con aggiornamento automatico è destinata a casi d'uso di tipo "best effort", come l'aggiornamento periodico degli URL.

Enum
CRAWL_TYPE_UNSPECIFIED Il tipo di scansione non è specificato.
USER_TRIGGERED Il tipo di scansione è attivato dall'utente.
AUTO_REFRESH Il tipo di scansione è l'aggiornamento automatico.

Modalità

Indica se la frequenza è impostata esplicitamente dagli utenti o da Vertex AI.

Enum
MODE_UNSPECIFIED La modalità non è specificata. Se l'utente non specifica la modalità, viene impostata come predefinita AUTOMATIC.
AUTOMATIC Vertex AI suddivide automaticamente crawlRate in attivato dall'utente e aggiornamento automatico. Gli utenti non devono specificare SetDedicatedCrawlRateRequest.CrawlType se la modalità è AUTOMATIC.
EXPLICIT Gli utenti impostano esplicitamente la frequenza di scansione attivata dall'utente o con aggiornamento automatico.