Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Tipp
Auf der Microsoft Ignite 2026?Suchen Sie alle Web IQ-Ressourcen an einem zentralen Ort: Dokumentation, Schulungen, Codebeispiele und wie Sie das Team kontaktieren können.
Führen Sie ihren ersten Microsoft Web IQ API-Aufruf in ein paar Minuten aus. Durchsuchen Sie das Web, überprüfen Sie die Antwort, und extrahieren Sie abfrageorientierte Passagen aus einer bekannten URL. Weitere Beispiele zeigen Places Search und den automatischen Abruf von Belegen.
Wenn Sie noch keine Web IQ-Ressource haben, erstellen Sie eine ressource mithilfe des Azure Portals oder Azure CLI, bevor Sie fortfahren.
Wählen Sie oben auf dieser Seite ein SDK- oder REST-Beispiel aus, damit alle Beispiele gemeinsam umgeschaltet werden. Die SDKs übernehmen Authentifizierung, Wiederholungen und Antworttypen für Sie.
API-Schlüssel sind die schnellste Möglichkeit, Web IQ auszuwerten. Verwenden Sie für Produktionsworkloads Microsoft Entra ID.
Prerequisites
- Ein Web IQ-API-Schlüssel aus der Profilverwaltung.
Note
Wenn Ihre Anwendung in China ausgeführt wird, verwenden Sie für Suchendpunkte https://api.microsoftol.com/v3 statt https://api.microsoft.ai/v3. Ersetzen Sie in den REST-Beispielen die URL. Legen Sie beim Erstellen eines SDK-Clients dieselbe Basis-URL mit dem Python-Argument base_url, der TypeScript-Option baseUrl, Rusts WebIqClient::builder().base_url(...), Javas WebIQClientOptions.builder().baseUrl(...) oder der .NET-Eigenschaft WebIQClientOptions.BaseUrl fest. Siehe Basis-URL.
Tipp
Bevorzugen Sie einen geführten Start ohne Code? Folgen Sie den ersten Schritten im Web IQ Developer Portal: Wählen Sie Ihr App-Profil aus, erstellen Sie einen API-Schlüssel, senden Sie eine Anforderung vom Playground, kopieren Sie den generierten Code, und überprüfen Sie Ihre Nutzung.
1. API-Schlüssel speichern
Setzen Sie den Schlüssel in eine Umgebungsvariable, damit die Anforderungsbeispiele ihn nicht wiederholen oder ihn in Ihren Quellcode einfügen.
macOS oder Linux
export WEBIQ_API_KEY="your-api-key"
Windows PowerShell
$env:WEBIQ_API_KEY="your-api-key"
Warning
Checken Sie Ihren Schlüssel nicht in die Quellcodeverwaltung ein und machen Sie ihn nicht im Browser oder clientseitigen Code verfügbar. Speichern Sie Produktionsanmeldeinformationen in einem Secrets-Manager.
2. Das Web durchsuchen
Verwenden Sie die Websuche, wenn Sie eine Frage oder Abfrage haben und möchten, dass Web IQ relevante Seiten finden und einstufen soll.
Wir empfehlen die Einstellung maxResults = 10, contentFormat = passage und maxLength = 3000 bei jeder Anfrage als optimierten Betriebspunkt. Von dort aus können Sie diese Einstellungen basierend auf Ihrem Anwendungsfall optimieren.
Endpunkt:POST https://api.microsoft.ai/v3/search/web
curl --request POST "https://api.microsoft.ai/v3/search/web" \
--header "x-apikey: $WEBIQ_API_KEY" \
--header "content-type: application/json" \
--data '{
"query": "latest developments in retrieval augmented generation",
"maxResults": 10,
"contentFormat": "passage",
"maxLength": 3000
}'
Installieren Sie das SDK mit python -m pip install webiq==1.2.1 (Python 3.11 oder höher), und führen Sie dann Folgendes aus:
import os
from webiq import WebIQClient
from webiq.types import ContentFormat
with WebIQClient(api_key=os.environ["WEBIQ_API_KEY"]) as client:
results = client.web.search(
"latest developments in retrieval augmented generation",
max_results=10,
content_format=ContentFormat.passage,
max_length=3000,
)
for result in results.webResults or []:
print(result.title, result.url)
Installieren Sie das SDK mit npm install @microsoft/webiq@1.2.1 (Node.js 22.18+ auf 22.x oder 24+). Speichern Sie dieses Beispiel als search.mts und führen Sie es mit node search.mts.
import { WebIQClient, ContentFormat } from "@microsoft/webiq";
async function main() {
const client = new WebIQClient({ apiKey: process.env.WEBIQ_API_KEY });
try {
const results = await client.web.search(
"latest developments in retrieval augmented generation",
{
maxResults: 10,
contentFormat: ContentFormat.PASSAGE,
maxLength: 3000,
},
);
for (const result of results.webResults ?? []) {
console.log(result.title, result.url);
}
} finally {
await client.close();
}
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
Führen Sie in einem Rust 1.88- oder höher-Projekt cargo add webiq@1.2.1 und cargo add tokio --features macros,rt-multi-thread aus. Speichere dieses Beispiel als src/main.rs und führe cargo run aus.
use webiq::{ContentFormat, WebIqClient, WebSearchOptions};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = WebIqClient::new(std::env::var("WEBIQ_API_KEY")?)?;
let results = client.web().search(
"latest developments in retrieval augmented generation",
WebSearchOptions::new()
.max_results(10)
.content_format(ContentFormat::Passage)
.max_length(3000),
).await?;
for result in results.web_results.unwrap_or_default() {
println!("{:?} {:?}", result.title, result.url);
}
Ok(())
}
Fügen Sie in einem Maven-Projekt, das für Java 11 oder höher konfiguriert ist, diese Abhängigkeit zu pom.xml hinzu:
<dependency>
<groupId>com.microsoft.webiq</groupId>
<artifactId>webiq</artifactId>
<version>1.2.1</version>
</dependency>
Speichere dieses Beispiel als src/main/java/Search.java und führe mvn compile exec:java -Dexec.mainClass=Search aus.
import com.microsoft.webiq.WebIQClient;
import com.microsoft.webiq.models.ContentFormat;
import com.microsoft.webiq.models.WebResponse;
import com.microsoft.webiq.models.WebResult;
import com.microsoft.webiq.resources.WebSearchOptions;
public class Search {
public static void main(String[] args) {
try (WebIQClient client = WebIQClient.withApiKey(System.getenv("WEBIQ_API_KEY"))) {
WebResponse results = client.web.search(
"latest developments in retrieval augmented generation",
WebSearchOptions.builder()
.maxResults(10)
.contentFormat(ContentFormat.PASSAGE)
.maxLength(3000)
.build());
if (results.getWebResults() != null) {
for (WebResult result : results.getWebResults()) {
System.out.println(result.getTitle() + " " + result.getUrl());
}
}
}
}
}
Führen Sie in einem .NET 8- oder höheren Konsolenprojekt dotnet add package Microsoft.WebIQ --version 1.2.1 aus. Speichere dieses Beispiel als Program.cs und führe dotnet run aus.
using Microsoft.WebIQ;
using Microsoft.WebIQ.Models;
string apiKey = Environment.GetEnvironmentVariable("WEBIQ_API_KEY")
?? throw new InvalidOperationException("Set WEBIQ_API_KEY before running this example.");
using var client = new WebIQClient(apiKey);
var results = await client.Web.SearchAsync(
"latest developments in retrieval augmented generation",
request =>
{
request.MaxResults = 10;
request.ContentFormat = ContentFormat.Passage;
request.MaxLength = 3000;
});
foreach (var result in results.WebResults ?? [])
Console.WriteLine($"{result.Title} {result.Url}");
import os
import json
import requests
response = requests.post(
"https://api.microsoft.ai/v3/search/web",
headers={
"x-apikey": os.environ["WEBIQ_API_KEY"],
"content-type": "application/json",
},
json={
"query": "latest developments in retrieval augmented generation",
"maxResults": 10,
"contentFormat": "passage",
"maxLength": 3000,
},
timeout=30,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))
Speichern Sie dieses Beispiel als search.mjs und führen Sie es mit node search.mjs.
const response = await fetch("https://api.microsoft.ai/v3/search/web", {
method: "POST",
headers: {
"x-apikey": process.env.WEBIQ_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
query: "latest developments in retrieval augmented generation",
maxResults: 10,
contentFormat: "passage",
maxLength: 3000,
}),
});
if (!response.ok) {
throw new Error(`Web Search failed: ${response.status} ${await response.text()}`);
}
console.log(JSON.stringify(await response.json(), null, 2));
3. Die Antwort verstehen
Eine erfolgreiche Websuche gibt ein webResults Array zurück. Dieses gekürzte Beispiel zeigt die Felder, die Sie am häufigsten verwenden werden:
{
"webResults": [
{
"title": "Example result",
"url": "https://example.com/article",
"content": "The query-relevant passage extracted from the page...",
"crawledAt": "2026-07-18T12:00:00Z"
}
],
"traceId": "00000000000000000000000000000000"
}
-
titleundurlkennzeichnen die Quelle. -
contententhält die abfragerelevante Passage, da die Anforderung verwendet wurdecontentFormat: "passage". -
traceIdhilft Web IQ Support bei der Untersuchung einer Anfrage.
Für REST-Antworten und MCP-Toolergebnisse werden Modellfelder mit null oder leere Zeichenfolgenwerte ("") weggelassen, einschließlich Feldern geschachtelter Ergebnisobjekte; leere Listen-/Arrayfelder ([]) werden beibehalten, außer in "Orte", in denen Listenfelder ebenfalls nicht vorhanden sein können. Behandeln Sie ein nicht vorhandenes Feld als nicht verfügbar und eine leere oder nicht vorhandene Liste so, als hätte sie keine Elemente. Zeichenfolgen, die nur aus Leerraum bestehen, false, 0, leere Wörterbücher, einzelne Array-/Wörterbucheinträge und eingebettete ROH-JSON werden beibehalten. Root-Arrays und Protokollhüllensammlungen wie MCP content sind unverändert.
Siehe die Web Search API-Referenz für alle Parameter und Antwortfelder.
4. Wählen Sie einen Endpunkt aus.
| Mit | Verwenden | Was Sie bekommen |
|---|---|---|
| Eine Frage oder Suchabfrage | Websuche | Bewertete Seiten mit für die Suchanfrage relevantem Inhalt |
| Eine bestimmte URL | Durchsuchen | Extrahierte Inhalte dieser Seite |
| Eine Orts- oder Anfrage nach lokalen Unternehmen | Orte | Strukturierte Ortsdetails wie Adressen und Öffnungszeiten |
| Eine Abfrage, für die Antworttypen automatisch ausgewählt werden müssen | Auto über REST oder SDKs 1.2.1 und höher | Typisierte Nachweise mit ergebnisbezogenen Zitaten |
Ein gemeinsamer Erdungsworkflow verwendet beide Endpunkte: Suchen Sie nach relevanten Quellen, wählen Sie eine Ergebnis-URL aus, und durchsuchen Sie diese URL, um Passagen zu extrahieren, die für eine Nachverfolgungsfrage relevant sind.
5. Inhalte aus einer URL extrahieren
Verwenden Sie "Durchsuchen", wenn Sie bereits wissen, welche Seite Sie lesen möchten. Legen Sie contentFormat auf passage fest und geben Sie einen nicht leeren Wert für query an, um die Teile der Seite abzurufen, die für Ihre Frage am relevantesten sind.
liveCrawl: "fallback" fordert Web IQ auf, die Seite zu durchforsten, wenn sie noch nicht im Index verfügbar ist. Das Live-Crawling unterliegt Beschränkungen zur Schonung von Publishern und deren Verfügbarkeit; fallback garantiert kein tatsächliches Crawling.
Alle Beispiele fordern abfragefokussierte Passagen an, das empfohlene Format für Grounding. Die Auswahl query muss nicht leer sein und darf nicht mehr als 1000 Zeichen lang sein; maxLength steuert separat die Menge der zurückgegebenen Inhalte. Volldokumentformate (text, html und markdown) erfordern vollständigen Dokumentzugriff.
Endpunkt:POST https://api.microsoft.ai/v3/browse
curl --request POST "https://api.microsoft.ai/v3/browse" \
--header "x-apikey: $WEBIQ_API_KEY" \
--header "content-type: application/json" \
--data '{
"url": "https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
"query": "How fast is Web IQ",
"contentFormat": "passage",
"maxLength": 3000,
"liveCrawl": "fallback"
}'
Installieren Sie das SDK mit python -m pip install webiq==1.2.1 (Python 3.11 oder höher), und führen Sie dann Folgendes aus:
import os
from webiq import WebIQClient
from webiq.types import BrowseContentFormat
with WebIQClient(api_key=os.environ["WEBIQ_API_KEY"]) as client:
page = client.browse.fetch(
"https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
query="How fast is Web IQ",
content_format=BrowseContentFormat.passage,
max_length=3000,
live_crawl="fallback",
)
print(page.content)
Installieren Sie das SDK mit npm install @microsoft/webiq@1.2.1 (Node.js 22.18+ auf 22.x oder 24+). Speichern Sie dieses Beispiel als browse.mts und führen Sie es mit node browse.mts.
import { WebIQClient, BrowseContentFormat, LiveCrawlMode } from "@microsoft/webiq";
async function main() {
const client = new WebIQClient({ apiKey: process.env.WEBIQ_API_KEY });
try {
const page = await client.browse.fetch(
"https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
{
query: "How fast is Web IQ",
contentFormat: BrowseContentFormat.PASSAGE,
maxLength: 3000,
liveCrawl: LiveCrawlMode.FALLBACK,
},
);
console.log(JSON.stringify(page, null, 2));
} finally {
await client.close();
}
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
Führen Sie in einem Rust 1.88- oder höher-Projekt cargo add webiq@1.2.1 und cargo add tokio --features macros,rt-multi-thread aus. Speichere dieses Beispiel als src/main.rs und führe cargo run aus.
use webiq::{BrowseContentFormat, BrowseOptions, LiveCrawlMode, WebIqClient};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = WebIqClient::new(std::env::var("WEBIQ_API_KEY")?)?;
let page = client.browse().fetch(
"https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
BrowseOptions::new()
.query("How fast is Web IQ")
.content_format(BrowseContentFormat::Passage)
.max_length(3000)
.live_crawl(LiveCrawlMode::Fallback),
).await?;
println!("{}", page.content.unwrap_or_default());
Ok(())
}
Fügen Sie in einem Maven-Projekt, das für Java 11 oder höher konfiguriert ist, diese Abhängigkeit zu pom.xml hinzu:
<dependency>
<groupId>com.microsoft.webiq</groupId>
<artifactId>webiq</artifactId>
<version>1.2.1</version>
</dependency>
Speichere dieses Beispiel als src/main/java/Browse.java und führe mvn compile exec:java -Dexec.mainClass=Browse aus.
import com.microsoft.webiq.WebIQClient;
import com.microsoft.webiq.models.BrowseContentFormat;
import com.microsoft.webiq.models.BrowseResponse;
import com.microsoft.webiq.models.LiveCrawlMode;
import com.microsoft.webiq.resources.BrowseFetchOptions;
public class Browse {
public static void main(String[] args) {
try (WebIQClient client = WebIQClient.withApiKey(System.getenv("WEBIQ_API_KEY"))) {
BrowseResponse page = client.browse.fetch(
"https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
BrowseFetchOptions.builder()
.query("How fast is Web IQ")
.contentFormat(BrowseContentFormat.PASSAGE)
.maxLength(3000)
.liveCrawl(LiveCrawlMode.FALLBACK)
.build());
System.out.println(page.getContent());
}
}
}
Führen Sie in einem .NET 8- oder höheren Konsolenprojekt dotnet add package Microsoft.WebIQ --version 1.2.1 aus. Speichere dieses Beispiel als Program.cs und führe dotnet run aus.
using Microsoft.WebIQ;
using Microsoft.WebIQ.Models;
string apiKey = Environment.GetEnvironmentVariable("WEBIQ_API_KEY")
?? throw new InvalidOperationException("Set WEBIQ_API_KEY before running this example.");
using var client = new WebIQClient(apiKey);
var page = await client.Browse.FetchAsync(
"https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
request =>
{
request.ContentFormat = BrowseContentFormat.Passage;
request.Query = "How fast is Web IQ";
request.MaxLength = 3000;
request.LiveCrawl = LiveCrawlMode.Fallback;
});
Console.WriteLine(page.Content);
import os
import json
import requests
response = requests.post(
"https://api.microsoft.ai/v3/browse",
headers={
"x-apikey": os.environ["WEBIQ_API_KEY"],
"content-type": "application/json",
},
json={
"url": "https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
"query": "How fast is Web IQ",
"contentFormat": "passage",
"maxLength": 3000,
"liveCrawl": "fallback",
},
timeout=30,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))
Speichern Sie dieses Beispiel als browse.mjs und führen Sie es mit node browse.mjs.
const response = await fetch("https://api.microsoft.ai/v3/browse", {
method: "POST",
headers: {
"x-apikey": process.env.WEBIQ_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
url: "https://techcommunity.microsoft.com/blog/azuredevcommunityblog/why-ai-agents-need-external-grounding/4565283",
query: "How fast is Web IQ",
contentFormat: "passage",
maxLength: 3000,
liveCrawl: "fallback",
}),
});
if (!response.ok) {
throw new Error(`Browse failed: ${response.status} ${await response.text()}`);
}
console.log(JSON.stringify(await response.json(), null, 2));
Eine erfolgreiche 200 Antwort enthält die Seite url, title extrahierte content und eine traceId. Eine Live-Durchforstung kann retryAfter mit 202, einem ISO 8601-UTC-Zeitstempel, zurückgeben. Warten Sie bis zu diesem Zeitpunkt, und senden Sie dann die gleiche Anforderung erneut. Informationen zum vollständigen Antwortschema finden Sie in der Browse-API-Referenz.
6. Nach Orten suchen (optional)
Verwenden Sie Places Search für strukturierte Informationen zu lokalen Unternehmen und anderen Orten. In den SDK-Beispielen werden die in Schritt 2 installierten 1.2.1-Pakete verwendet.
Endpunkt:POST https://api.microsoft.ai/v3/search/places
curl --request POST "https://api.microsoft.ai/v3/search/places" \
--header "x-apikey: $WEBIQ_API_KEY" \
--header "content-type: application/json" \
--data '{
"query": "coffee in Seattle",
"maxResults": 5,
"language": "en",
"region": "US",
"location": "lat:47.6062;long:-122.3321"
}'
import os
from webiq import WebIQClient
with WebIQClient(api_key=os.environ["WEBIQ_API_KEY"]) as client:
places = client.places.search(
"coffee in Seattle",
max_results=5,
language="en",
region="US",
location="lat:47.6062;long:-122.3321",
)
for place in places.placeResults or []:
print(place.name, place.businessUrl)
Speichern Sie dieses Beispiel als places.mts und führen Sie es mit node places.mts.
import { WebIQClient } from "@microsoft/webiq";
async function main() {
const client = new WebIQClient({ apiKey: process.env.WEBIQ_API_KEY });
try {
const places = await client.places.search("coffee in Seattle", {
maxResults: 5,
language: "en",
region: "US",
location: "lat:47.6062;long:-122.3321",
});
for (const place of places.placeResults ?? []) {
console.log(place.name, place.businessUrl);
}
} finally {
await client.close();
}
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
Verwenden Sie das Tokio-Setup aus Schritt 2. Speichere dieses Beispiel als src/main.rs und führe cargo run aus.
use webiq::{PlacesSearchOptions, WebIqClient};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = WebIqClient::new(std::env::var("WEBIQ_API_KEY")?)?;
let places = client.places().search(
"coffee in Seattle",
PlacesSearchOptions::new()
.max_results(5)
.language("en")
.region("US")
.location("lat:47.6062;long:-122.3321"),
).await?;
for place in places.place_results.unwrap_or_default() {
println!("{:?} {:?}", place.name, place.business_url);
}
Ok(())
}
Speichern Sie dieses Beispiel wie src/main/java/Places.java im Maven-Projekt aus Schritt 2, und führen Sie es aus mvn compile exec:java -Dexec.mainClass=Places.
import com.microsoft.webiq.WebIQClient;
import com.microsoft.webiq.models.PlaceItem;
import com.microsoft.webiq.models.PlacesResponse;
import com.microsoft.webiq.resources.PlacesSearchOptions;
public class Places {
public static void main(String[] args) {
try (WebIQClient client = WebIQClient.withApiKey(System.getenv("WEBIQ_API_KEY"))) {
PlacesResponse places = client.places.search("coffee in Seattle",
PlacesSearchOptions.builder().maxResults(5)
.language("en").region("US")
.location("lat:47.6062;long:-122.3321").build());
if (places.getPlaceResults() != null) {
for (PlaceItem place : places.getPlaceResults()) {
System.out.println(place.getName() + " " + place.getBusinessUrl());
}
}
}
}
}
Speichern Sie im .NET Konsolenprojekt aus Schritt 2 dieses Beispiel als Program.cs und führen Sie dotnet run aus.
using Microsoft.WebIQ;
string apiKey = Environment.GetEnvironmentVariable("WEBIQ_API_KEY")
?? throw new InvalidOperationException("Set WEBIQ_API_KEY before running this example.");
using var client = new WebIQClient(apiKey);
var places = await client.Places.SearchAsync("coffee in Seattle", request =>
{
request.MaxResults = 5;
request.Language = "en";
request.Region = "US";
request.Location = "lat:47.6062;long:-122.3321";
});
foreach (var place in places.PlaceResults ?? [])
Console.WriteLine($"{place.Name} {place.BusinessUrl}");
import os
import json
import requests
response = requests.post(
"https://api.microsoft.ai/v3/search/places",
headers={
"x-apikey": os.environ["WEBIQ_API_KEY"],
"content-type": "application/json",
},
json={
"query": "coffee in Seattle",
"maxResults": 5,
"language": "en",
"region": "US",
"location": "lat:47.6062;long:-122.3321",
},
timeout=30,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))
Speichern Sie dieses Beispiel als places.mjs und führen Sie es mit node places.mjs.
const response = await fetch("https://api.microsoft.ai/v3/search/places", {
method: "POST",
headers: {
"x-apikey": process.env.WEBIQ_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
query: "coffee in Seattle",
maxResults: 5,
language: "en",
region: "US",
location: "lat:47.6062;long:-122.3321",
}),
});
if (!response.ok) {
throw new Error(`Places failed: ${response.status} ${await response.text()}`);
}
console.log(JSON.stringify(await response.json(), null, 2));
Lies Ergebnisse aus placeResults. Die Liste und einzelne Felder können nicht vorhanden sein, daher sollten Sie vor der Verwendung von Adressen, Öffnungszeiten oder anderen Details nach fehlenden Werten suchen. Weitere Informationen finden Sie in der Referenz zur Places API.
7. Abrufen von Nachweisen mit Auto
Verwenden Sie Auto, wenn Web IQ Abrufquellen auswählen und typisierte Nachweise mit unterstützenden Zitaten zurückgeben soll. Stellen Sie eine vollständige Frage in natürlicher Sprache, und behalten Sie relevante Einschränkungen wie Datumsangaben, Orte und Einheiten bei. In diesen Beispielen wird mode weggelassen, um die Standardeinstellung zu verwenden, und es werden 60 Sekunden pro Anforderungsversuch zugelassen. Legen Sie advanced auf mode für Auto Advanced fest, wenn Sie einen umfassenderen Abruf für komplexe Fragen benötigen.
Auto gibt für Ihre Anwendung automatisch Nachweise zurück, keine generierte endgültige Antwort. Lesen Sie jedes Beweisergebnis mit eigenen Zitaten; Behandeln Sie Zitate aus einem Ergebnis nicht als Unterstützung für ein anderes. Die SDK-Beispiele verwenden bei allen fünf SDKs die in Schritt 2 installierte Version 1.2.1.
Endpunkt:POST https://api.microsoft.ai/v3/auto
curl --request POST "https://api.microsoft.ai/v3/auto" \
--max-time 60 \
--header "x-apikey: $WEBIQ_API_KEY" \
--header "content-type: application/json" \
--data '{
"query": "What are the latest developments in retrieval-augmented generation?",
"maxResponseLength": 30000,
"maxCitations": 5
}'
import os
from webiq import WebIQClient
with WebIQClient(api_key=os.environ["WEBIQ_API_KEY"]) as client:
evidence = client.auto.search(
"What are the latest developments in retrieval-augmented generation?",
max_response_length=30000,
max_citations=5,
timeout=60.0,
)
for result in evidence.results or []:
print(result.evidence)
for citation in result.citations or []:
print(citation.title, citation.url)
Speichern Sie dieses Beispiel als auto.mts und führen Sie es mit node auto.mts.
import { WebIQClient } from "@microsoft/webiq";
async function main() {
const client = new WebIQClient({ apiKey: process.env.WEBIQ_API_KEY });
try {
const evidence = await client.auto.search(
"What are the latest developments in retrieval-augmented generation?",
{ maxResponseLength: 30000, maxCitations: 5, timeout: 60_000 },
);
for (const result of evidence.results ?? []) {
console.log(result.evidence);
for (const citation of result.citations ?? []) {
console.log(citation.title, citation.url);
}
}
} finally {
await client.close();
}
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
Verwenden Sie das Tokio-Setup aus Schritt 2. Speichere dieses Beispiel als src/main.rs und führe cargo run aus.
use webiq::{AutoSearchOptions, WebIqClient};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = WebIqClient::new(std::env::var("WEBIQ_API_KEY")?)?;
let evidence = client.auto().search(
"What are the latest developments in retrieval-augmented generation?",
AutoSearchOptions::new()
.max_response_length(30000)
.max_citations(5)
.timeout(std::time::Duration::from_secs(60)),
).await?;
for result in evidence.results.unwrap_or_default() {
println!("{:?}", result.evidence);
for citation in result.citations.unwrap_or_default() {
println!("{:?} {:?}", citation.title, citation.url);
}
}
Ok(())
}
Speichern Sie dieses Beispiel wie src/main/java/Auto.java im Maven-Projekt aus Schritt 2, und führen Sie es aus mvn compile exec:java -Dexec.mainClass=Auto.
import com.microsoft.webiq.WebIQClient;
import com.microsoft.webiq.models.AutoEvidenceCitation;
import com.microsoft.webiq.models.AutoEvidenceResult;
import com.microsoft.webiq.models.SearchAutoEvidenceResponse;
import com.microsoft.webiq.resources.AutoSearchOptions;
public class Auto {
public static void main(String[] args) {
try (WebIQClient client = WebIQClient.withApiKey(System.getenv("WEBIQ_API_KEY"))) {
SearchAutoEvidenceResponse evidence = client.auto.search(
"What are the latest developments in retrieval-augmented generation?",
AutoSearchOptions.builder()
.maxResponseLength(30000).maxCitations(5)
.timeout(java.time.Duration.ofSeconds(60)).build());
if (evidence.getResults() != null) {
for (AutoEvidenceResult result : evidence.getResults()) {
System.out.println(result.getEvidence());
if (result.getCitations() != null) {
for (AutoEvidenceCitation citation : result.getCitations()) {
System.out.println(citation.getTitle() + " " + citation.getUrl());
}
}
}
}
}
}
}
Speichern Sie im .NET Konsolenprojekt aus Schritt 2 dieses Beispiel als Program.cs und führen Sie dotnet run aus.
using Microsoft.WebIQ;
using System.Text.Json;
string apiKey = Environment.GetEnvironmentVariable("WEBIQ_API_KEY")
?? throw new InvalidOperationException("Set WEBIQ_API_KEY before running this example.");
using var client = new WebIQClient(apiKey);
var evidence = await client.Auto.SearchAsync(
"What are the latest developments in retrieval-augmented generation?",
request =>
{
request.MaxResponseLength = 30000;
request.MaxCitations = 5;
}, timeout: TimeSpan.FromSeconds(60));
foreach (var result in evidence.Results ?? [])
{
Console.WriteLine(JsonSerializer.Serialize(result.Evidence));
foreach (var citation in result.Citations ?? [])
Console.WriteLine($"{citation.Title} {citation.Url}");
}
import os
import json
import requests
response = requests.post(
"https://api.microsoft.ai/v3/auto",
headers={
"x-apikey": os.environ["WEBIQ_API_KEY"],
"content-type": "application/json",
},
json={
"query": "What are the latest developments in retrieval-augmented generation?",
"maxResponseLength": 30000,
"maxCitations": 5,
},
timeout=60,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))
Speichern Sie dieses Beispiel als auto.mjs und führen Sie es mit node auto.mjs.
const response = await fetch("https://api.microsoft.ai/v3/auto", {
method: "POST",
signal: AbortSignal.timeout(60_000),
headers: {
"x-apikey": process.env.WEBIQ_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
query: "What are the latest developments in retrieval-augmented generation?",
maxResponseLength: 30000,
maxCitations: 5,
}),
});
if (!response.ok) {
throw new Error(`Auto failed: ${response.status} ${await response.text()}`);
}
console.log(JSON.stringify(await response.json(), null, 2));
Eine erfolgreiche Antwort enthält ein results Array. Jedes Ergebnis koppelt ein typisiertes evidence Objekt mit dem zugehörigen citations. Ein leeres oder nicht vorhandenes results Array weist keine Evidenz für die Verarbeitung auf. Informationen zu Nachweistypen, Antwortbeispielen und Anforderungsgrenzwerten finden Sie in der Auto-API-Referenz .
Troubleshooting
| Status | Was soll überprüft werden? |
|---|---|
401 Unauthorized |
Bestätigen Sie, dass WEBIQ_API_KEY festgelegt ist und die Anforderung es im Header x-apikey sendet. |
415 Unsupported Media Type |
Senden content-type: application/json. |
429 Too Many Requests |
Warten Sie, bevor Sie es erneut versuchen und die Anforderungshäufigkeit verringern. |
Durchsuchen... 404 Not Found |
Bestätigen Sie, dass die URL öffentlich und gültig ist. Verwenden Sie liveCrawl: "fallback", wenn indizierte Inhalte möglicherweise nicht verfügbar sind. |
Durchsuchen... 202 Accepted |
Warten Sie, bis der in retryAfter angegebene Zeitpunkt (ein ISO 8601 UTC-Zeitstempel) erreicht ist, und senden Sie dann die gleiche Anforderung erneut. |
Automatische 403 Forbidden |
Überprüfen Sie, ob "Auto" unter "Zulässige Dienste " in der Profilverwaltung aufgeführt ist. Wenn das nicht der Fall ist, öffnen Sie eine Web IQ-Supportanfrage mit Ihrer AppID. |
Speichern Sie für andere Fehler die traceId, und lesen Sie Fehlerbehandlung. Um sich an den Web IQ-Support zu wenden, geben Sie die traceId und Ihre AppID oder Ihren Firmennamen und den Namen Ihrer Web IQ-Ressource an, wenn Sie nicht über die AppID verfügen.
Nächste Schritte
- Erkunden Sie die Websuche- und Browse-API-Verweise.
- Rufen Sie strukturierte lokale Geschäftsdaten mit Places ab, oder wählen Sie automatisch ausgewählte Nachweise mit "Auto" aus.
- Verwenden Sie die SDKs Python, TypeScript, Rust, Java und .NET.
- Installieren Sie den MCP-Server in Claude Code, Cursor oder VS Code.
- Einrichten der Produktionsauthentifizierung mit Microsoft Entra ID.
- Führen Sie vollständige Beispiele aus den Web IQ-Codebeispielen auf GitHub aus.
- Nutzen Sie das Schulungsmodul Integrieren sie webbasiertes Wissen in Ihren Agenten mit Web IQ.
- Sehen Sie sich Grounding-Agenten mit realer Intelligenz, der Web IQ-Episode der Microsoft IQ-Serie an.