A REST API-referencia tallózása

Végpont:POST https://api.microsoft.ai/v3/browse

Mintakérés:

curl -X POST "https://api.microsoft.ai/v3/browse" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "url": "https://news.microsoft.com/source/",
    "maxLength": 3000,
    "language": "en",
    "region": "US",
    "contentFormat": "html"
  }'

Parameters

Paraméter Required Típus Default Description
url Yes karakterlánc - A böngészni kívánt weblap URL-címe.
maximális hosszúság No egész szám 10000 A válaszban szereplő tartalommezőben szereplő karakterek maximális száma. A maximális érték 5000000 karakter.
liveCrawl No karakterlánc "nincs" Szabályozza az élő bejárási viselkedést. Értékek: "nincs" (csak indexelt tartalmat ad vissza), "tartalék" (bejárás, ha az URL-cím nem található az indexben), "force" (új bejárás kérése akkor is, ha indexelt tartalom létezik). Vegye figyelembe, hogy a "nincs" érték esetén, ha az URL-cím nem található az indexben, az API 404-es hibakódot ad vissza (az URL nem található).
includeWebLinks No boolean false Adjon meg kimenő hivatkozásokat a lapról.
renderDynamicPages No boolean false Engedélyezze a JavaScript-renderelést a dinamikus tartalom képernyőképéhez. Csak akkor működik, ha a liveCrawl értéke "tartalék".
includeImageLinks No boolean false Adjon meg kép URL-címeket a lapról.
nyelv No karakterlánc "en" A nyelvi kód (2 betűs ISO 639-1). A teljes lista támogatott nyelvei című témakörben talál további információt.
régió No karakterlánc "US" A régió kódja (2 betűs ország-/régiókód). A teljes listát a Támogatott régiók című témakörben találja.
contentFormat No karakterlánc "html" A visszaadni kívánt weblaptartalom formátuma. Lehet "text", "html" vagy "markdown".

Kérelemfejlécek

Field Típus Description
állomás karakterlánc Gazdagép Microsoft AI API-khoz: api.microsoft.ai.
x-apikey vagy Engedélyezés karakterlánc Az API-kulcs vagy Entra ID hozzáférési jogkivonat hitelesítéshez.
tartalomtípus karakterlánc A kérelem törzsének MIME-típusa. Használja a application/json.

Response

Field Típus Description
url karakterlánc A weblap URL-címe.
title karakterlánc A weblap címe.
tartalom karakterlánc A weboldal kinyert tartalma (más néven földelés).
utolsóFrissítveAt karakterlánc A weblap utolsó frissített dátuma ISO8601 formátumot követi.
crawledAt karakterlánc A weblap utolsó bejárt dátuma ISO8601 formátumot követi.
liveCrawlSucceeded logikai (nem kötelező) Csak akkor jelenik meg, mint false amikor egy sikeres kérés liveCrawl: "force" elavult oldalt ad vissza. Nem elavult lapok esetén kihagyva; soha nem bocsát ki .true Kihagyva "none", "fallback"kihagyott/null módú, majd újrapróbálkozási (202) válaszok.
traceId karakterlánc Nyomkövetési azonosító a hibakereséshez.
retryAfter karakterlánc Várakozási idő az újrapróbálkozás előtt, másodpercben megadott időtartamként formázva az "s" utótaggal (például "60s" 60 másodperc várakozást jelent). Csak akkor jelenik meg, ha igény szerinti bejárás van folyamatban.
isAdult boolean Azt jelzi, hogy a weblap felnőtt tartalmat tartalmaz-e.

Note

A title, content, isAdult, lastUpdatedAtés crawledAt mezők csak sikeres (200) válaszokban vannak jelen. Az újrapróbálkozásból (202) származó válaszok nem jelennek meg.

Egy sikeres kérés "liveCrawl": "force" például csak akkor érvényes "liveCrawlSucceeded": false , ha elavult tartalmat ad vissza. A nem elavult lapok a visszatérés truehelyett kihagyják ezt a mezőt. Ez a mező ugyanazzal a jelentéssel rendelkezik a Browse MCP eszköz strukturált válaszában.

Hibakódok

Állapotkód Hibakategória Description Gyakori okok
200 Success A kérés sikeres volt. -
202 Elfogadott Feldolgozásra elfogadott kérés (élő bejárás). Igény szerinti bejárás folyamatban
400 Hibás kérés Érvénytelen kérelemparaméterek. Hiányzó kötelező mezők, érvénytelen paraméterértékek, hibásan formázott JSON
401 Unauthorized A hitelesítés sikertelen vagy hiányzik. Érvénytelen API-kulcs, hiányzó x-apikey fejléc
403 Forbidden Érvényes hitelesítő adatok, de a kérés nem teljesíthető. Az API-kulcs nem rendelkezik szükséges engedélyekkel, a szabályzat által letiltott URL-cím, szűrt tartalom
404 Nem található A dokumentum nem található. Érvénytelen vagy elérhetetlen URL-cím
410 Eltűnt HTTPS szükséges. HTTPS helyett HTTP-en keresztül küldött kérelem
415 Nem támogatott médiatípus A tartalomtípus nem támogatott. Hiányzó vagy helytelen tartalomtípusú fejléc
429 Túl sok kérés Túllépte a sebességkorlátot. Túl sok kérés az időablakban
430 Túl sok igény szerinti bejárás Túl sok igény szerinti bejárás. Túlzott élő bejárási kérelmek
500 Belső kiszolgálóhiba Váratlan kiszolgálóhiba. Ideiglenes kiszolgálóval kapcsolatos probléma
503 A szolgáltatás nem érhető el A szolgáltatás átmenetileg nem érhető el. Karbantartás vagy ideiglenes kimaradás
504 Átjáró időkorlát túllépve A kérés túllépte az időkorlátot. Upstream szolgáltatás időtúllépése

A hibakezeléssel kapcsolatos részletes útmutatásért tekintse meg a Hibakezelés című témakört.

Lásd még:Web Search | Videók keresése Hírek | keresése | Képek keresése | MCP

  • Utolsó frissítés időpontja: