API Servizio e capacità

Pronto per il servizio. Un host in fase di svuotamento risponde con 421 server_draining e Retry-After: 1. Un guasto a una dipendenza richiesta risponde con 500 not_ready e Retry-After. Uno schema di database attivo che non soddisfa questa versione (un indice desiderato mancante o diverso da più di due minuti) risponde con 500 schema_incompatible senza Retry-After: non si risolve aspettando.

Cerca nella documentazione ufficiale di screenRIG, nelle pagine di screenrig.ai/docs, nei tipi di problema, nei prezzi e nelle altre pagine per i clienti, e restituisce le sezioni più pertinenti, le migliori per prime, al massimo limit (8 per impostazione predefinita). Pubblico: non serve alcuna credenziale e la chiamata non viene mai addebitata.

L’url di un risultato è la sua pagina (con il frammento della sezione dove la pagina ne indica uno), section è il titolo e snippet mostra il testo attorno alla corrispondenza; leggi la pagina o la sezione con getDocsPage. Limitato a 120 richieste per IP client al minuto (IPv6 raggruppati per /64).

Il corpus si ricarica ogni 15 minuti; prima del primo caricamento la rotta risponde 500 not_ready con Retry-After.

Restituisce una pagina della documentazione ufficiale o, con section, una sola sua sezione con le sezioni al suo interno, come Markdown. url è l’indirizzo della pagina come lo restituisce searchDocs, la sua forma .md, oppure solo il suo percorso, con o senza #fragment (un frammento indica la sezione quando section non è indicato). section è un titolo o un’ancora della pagina, o parte di un titolo.

Una sezione viene tagliata a fine riga entro 48 KiB, con truncated true; una pagina intera di oltre 48 KiB risponde con la sua introduzione e la sua struttura, con truncated true. sections elenca i titoli da leggere dopo (quelli della pagina, o i sottotitoli della sezione stessa). Le pagine e le sezioni sconosciute rispondono 404 not_found.

Pubblico, mai addebitato e limitato alle stesse 120 richieste per IP client al minuto di searchDocs.