Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Eindpunt:POST https://api.microsoft.ai/v3/browse
Voorbeeldaanvraag:
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
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| url | Yes | string | - | De URL van de webpagina om te bladeren. |
| maximale lengte | No | integer | 10000 | Het maximum aantal tekens in het inhoudsveld in antwoord. De maximumwaarde is 500000 tekens. |
| liveCrawl | No | string | "geen" | Hiermee bepaalt u live verkenningsgedrag. Waarden: 'none' (retourneert alleen geïndexeerde inhoud), 'terugval' (verkenning als de URL niet in de index is gevonden), 'forceren' (vraag een nieuwe verkenning aan, zelfs als geïndexeerde inhoud bestaat). Als de URL niet in de index wordt gevonden, retourneert API 404-foutcode (URL niet gevonden). |
| includeWebLinks | No | boolean | onwaar | Uitgaande hyperlinks van de pagina opnemen. |
| renderDynamicPages | No | boolean | onwaar | JavaScript-rendering inschakelen voor schermafbeelding van dynamische inhoud. Werkt alleen als liveCrawl is ingesteld op 'fallback'. |
| includeImageLinks | No | boolean | onwaar | Afbeeldings-URL's van de pagina opnemen. |
| taal | No | string | "en" | De taalcode (ISO 639-1 met 2 letters). Zie Ondersteunde talen voor de volledige lijst. |
| region | No | string | "US" | De regiocode (land-/regiocode van 2 letters). Zie Ondersteunde regio's voor de volledige lijst. |
| inhoudOpmaak | No | string | "html" | De indeling van de webpagina-inhoud die moet worden geretourneerd. Kan 'text', 'html' of 'markdown' zijn. |
Aanvraagheaders
| Veld | Type | Description |
|---|---|---|
| host | string | Host voor Microsoft AI-API's: api.microsoft.ai. |
| x-apikey of autorisatie | string | Uw API-sleutel of Entra ID toegangstoken voor verificatie. |
| inhoudstype | string | MIME-type van de aanvraagbody. Gebruik application/json. |
Antwoord
| Veld | Type | Description |
|---|---|---|
| url | string | De URL van de webpagina. |
| title | string | De titel van de webpagina. |
| inhoud | string | De geëxtraheerde inhoud van de webpagina (ook wel grounding genoemd). |
| laatsteBijgewerktOp | string | De laatst bijgewerkte datum van de webpagina volgt ISO8601 indeling. |
| crawledAt | string | De laatste verkende datum van de webpagina volgt ISO8601 indeling. |
| liveCrawlSucceeded | Booleaanse waarde (optioneel) | Alleen aanwezig als false wanneer een geslaagde aanvraag met liveCrawl: "force" een verlopen pagina retourneert. Weggelaten voor niet-verouderde pagina's; nooit verzonden als true. Weggelaten voor "none", "fallback"een weggelaten/null-modus en antwoorden (202) opnieuw proberen. |
| traceId | string | Tracerings-id voor foutopsporing. |
| opnieuw proberen Daarna | string | Tijd die moet worden gewacht voordat u het opnieuw probeert, opgemaakt als een duur in seconden met het "s" achtervoegsel (betekent bijvoorbeeld "60s" 60 seconden wachten). Alleen aanwezig wanneer verkenning op aanvraag wordt uitgevoerd. |
| isAdult | boolean | Geeft aan of de webpagina inhoud voor volwassenen bevat. |
Note
De titlevelden , content, lastUpdatedAtisAdulten crawledAt velden zijn alleen aanwezig in geslaagde (200) antwoorden. Ze worden weggelaten uit antwoorden voor opnieuw proberen (202).
Een geslaagde aanvraag met "liveCrawl": "force" bevat "liveCrawlSucceeded": false bijvoorbeeld alleen wanneer verouderde inhoud wordt geretourneerd. Een niet-verouderde pagina laat dit veld weg in plaats van terug te keren true. Dit veld heeft dezelfde betekenis in het gestructureerde antwoord van het mcP-hulpprogramma bladeren.
Foutcodes
| Statuscode | Foutcategorie | Description | Veelvoorkomende oorzaken |
|---|---|---|---|
| 200 | Success | Het verzoek slaagde. | - |
| 202 | Accepted | Aanvraag geaccepteerd voor verwerking (live verkenning). | Verkennen op aanvraag wordt uitgevoerd |
| 400 | Onjuiste aanvraag | Ongeldige aanvraagparameters. | Ontbrekende vereiste velden, ongeldige parameterwaarden, ongeldige JSON |
| 401 | Niet geautoriseerd | Verificatie is mislukt of ontbreekt. | Ongeldige API-sleutel, ontbrekende x-apikey-header |
| 403 | Verboden | Geldige referenties, maar de aanvraag kan niet worden voltooid. | API-sleutel ontbreekt vereiste machtigingen, URL geblokkeerd door beleid, gefilterde inhoud |
| 404 | Niet gevonden | Het document is niet gevonden. | Ongeldige of niet-toegankelijke URL |
| 410 | Weg | HTTPS vereist. | Aanvraag via HTTP in plaats van HTTPS |
| 415 | Niet-ondersteund mediatype | Inhoudstype wordt niet ondersteund. | Ontbrekende of onjuiste header van inhoudstype |
| 429 | Te veel aanvragen | De snelheidslimiet is overschreden. | Te veel aanvragen in tijdvenster |
| 430 | Te veel verkenningen op aanvraag | Te veel verkenningen op aanvraag. | Overmatige live verkenningsaanvragen |
| 500 | Interne serverfout | Onverwachte serverfout. | Probleem met tijdelijke server |
| 503 | Service niet beschikbaar | Service is tijdelijk niet beschikbaar. | Onderhoud of tijdelijke storing |
| 504 | Gateway-time-out | Er is een time-out opgetreden voor het verzoek. | Time-out van upstream-service |
Zie Foutafhandeling voor gedetailleerde richtlijnen voor foutafhandeling.
Zie ook:Webzoekvideo's | zoeken naarnieuws zoeken | | afbeeldingen zoeken | MCP