Předem připravené rozhraní API
Vlastní rozhraní API pro odpovědi na otázky poskytuje možnost odpovídat na otázky na základě úseku textu, aniž byste museli vytvářet projekty, udržovat páry otázek a odpovědí nebo mít náklady na nedostatečně využitou infrastrukturu. Tato funkce je poskytována jako rozhraní API a dá se použít ke splnění potřeb otázek a odpovědí, aniž byste se museli dozvědět podrobnosti o vlastní odpovědi na otázky.
Vzhledem k uživatelskému dotazu a bloku textu nebo průchodu rozhraní API vrátí odpověď a přesnou odpověď (pokud je k dispozici).
Ukázkové využití rozhraní API
Představte si, že máte jeden nebo více bloků textu, ze kterého chcete získat odpovědi na danou otázku. Normálně byste museli vytvořit tolik zdrojů jako počet bloků textu. Teď ale s předem vytvořeným rozhraním API můžete dotazovat bloky textu, aniž byste museli definovat zdroje obsahu v projektu.
Mezi další scénáře, ve kterých se toto rozhraní API dá použít, jsou:
- Vyvíjíte aplikaci pro čtečku elektronických knih pro koncové uživatele, která jim umožňuje zvýraznit text, zadat otázku a najít odpovědi nad zvýrazněným úsekem textu.
- Rozšíření prohlížeče, které uživatelům umožňuje položit otázku nad obsahem, který se právě zobrazuje na stránce prohlížeče.
- Robot stavu, který přijímá dotazy od uživatelů a poskytuje odpovědi na základě lékařského obsahu, který robot identifikuje jako nejrelevavantnější pro dotaz uživatele.
Níže je příklad ukázkové žádosti:
Ukázkový požadavek
POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text
Ukázkový dotaz na jeden blok textu
Text požadavku
{
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"Content-Type": "application/json",
"api-version": "2021-10-01",
"stringIndexType": "TextElements_v8",
"textQueryOptions": {
"question": "how long it takes to charge surface?",
"records": [
{
"id": "1",
"text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
},
{
"id": "2",
"text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
}
],
"language": "en"
}
}
}
Ukázková odpověď
Ve výše uvedeném textu požadavku se dotazujeme na jeden blok textu. Níže je uvedena ukázková odpověď přijatá pro výše uvedený dotaz.
{
"responses": {
"200": {
"headers": {},
"body": {
"answers": [
{
"answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
"confidenceScore": 0.93,
"id": "1",
"answerSpan": {
"text": "two to four hours",
"confidenceScore": 0,
"offset": 28,
"length": 45
},
"offset": 0,
"length": 224
},
{
"answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
"confidenceScore": 0.92,
"id": "1",
"answerSpan": {
"text": "two to four hours",
"confidenceScore": 0,
"offset": 8,
"length": 25
},
"offset": 20,
"length": 224
},
{
"answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
"confidenceScore": 0.05,
"id": "1",
"answerSpan": null,
"offset": 110,
"length": 244
}
]
}
}
}
Vidíme, že jako součást odpovědi rozhraní API se přijímá více odpovědí. Každá odpověď má konkrétní skóre spolehlivosti, které pomáhá pochopit celkovou důležitost odpovědi. Rozsah odpovědí představuje, jestli byla zjištěna také potenciální krátká odpověď. Uživatelé můžou toto skóre spolehlivosti využít k určení odpovědí, které se mají poskytnout v reakci na dotaz.
Předem připravené limity rozhraní API
Limity volání rozhraní API
Pokud potřebujete použít větší dokumenty, než umožňuje limit, můžete text před odesláním do rozhraní API rozdělit na menší bloky textu. V tomto kontextu je dokument definovaný jeden řetězec textových znaků.
Tato čísla představují omezení jednotlivých volání rozhraní API:
- Počet dokumentů: 5.
- Maximální velikost jednoho dokumentu: 5 120 znaků
- Maximální počet tří odpovědí na dokument
Podporované jazykové kódy
Předem připravené rozhraní API podporuje následující kódy jazyků. Tyto kódy jazyka jsou v souladu se standardem ISO 639-1.
| Kód jazyka | Jazyk |
|---|---|
| af | Afrikánština |
| americium | Amharština |
| ar | Arabština |
| as | Ásámština |
| Az | Ázerbájdžánština |
| ba | Baškirština |
| be | Běloruština |
| bg | Bulharština |
| Bn | Bengálština |
| ca | Katalánština, Valencie |
| ckb | Centrální středodušský |
| cs | Čeština |
| Cy | Velština |
| da | Dánština |
| de | Němčina |
| el | Řečtina, moderní (1453–) |
| en | Angličtina |
| eo | Esperanto |
| es | Španělština, Kastilština |
| et | Estonština |
| eu | Baskičtina |
| fa | Perština |
| fi | Finština |
| fr | Francouzština |
| Ghanština | Irština |
| gl | Galicijština |
| Gu | Gudžarátština |
| he | Hebrejština |
| hi | Hindština |
| hod | Chorvatština |
| hu | Maďarština |
| hy | Arménština |
| ID | Indonéština |
| is | Islandština |
| it | Italština |
| ja | Japonština |
| Ka | Gruzínština |
| kk | Kazaština |
| kilometr | Centrální khmer |
| kn | Kannadština |
| ko | Korejština |
| Ky | Kirghiz, Kyrgyz |
| la | Latina |
| hle | Laoština |
| lt | Litevština |
| lv | Lotyština |
| mk | Makedonština |
| ml | Malajalámština |
| Mn | Mongolština |
| pan | Maráthština |
| sl. | Malajština |
| mt | Maltština |
| moje | Barmština |
| ne | Nepálština |
| nl | Nizozemština, Flemish |
| nn | Norština (Nynorsk) |
| ne | Norština |
| nebo | Udijština |
| taťka | Pažábi, Panjabi |
| pl | Polština |
| PS | Pashto, Pushto |
| pt | Portugalština |
| ro | Rumunština |
| ru | Ruština |
| přidružení zabezpečení | Sanskrt |
| Sd | Sindhština |
| si | Sinhala, Sinhalština |
| sk | Slovenština |
| sl | Slovinština |
| sq | Albánština |
| sr | Srbština |
| sv | Švédština |
| sw | Svahilština |
| ta | Tamilština |
| te | Telugština |
| Tg | Tádžičtina |
| th | Thajština |
| Tl | Tagalog |
| tr | Turečtina |
| TT | Tatarština |
| Ug | Uighur, Uyghur |
| uk | Ukrajinština |
| ur | Urdština |
| uz | Uzbečtina |
| vi | Vietnamština |
| yi | Jidiš |
| zh | Čínština |