API predefinita
L'API predefinita di risposta alla domanda personalizzata offre la possibilità di rispondere alle domande in base a un passaggio di testo senza dover creare progetti, gestire coppie di domande e risposte, o sostenere costi per l'infrastruttura sottoutilizzata. Questa funzionalità viene fornita come API e può essere usata per soddisfare le esigenze di domande e risposte senza dover ottenere informazioni dettagliate sulla risposta alla domanda personalizzata.
Dati una query utente e un blocco di testo/passaggio, l'API restituirà una risposta e una risposta precisa (se disponibile).
Esempio di utilizzo dell'API
Si supponga di avere uno o più blocchi di testo da cui si desidera ottenere risposte per una determinata domanda. Normalmente, sarebbe stato necessario creare tutte le origini del numero di blocchi di testo. Tuttavia, adesso con l'API predefinita è possibile eseguire query sui blocchi di testo senza dover definire origini di contenuto in un progetto.
Altri scenari in cui è possibile usare questa API sono:
- Sviluppo di un'app lettore di ebook per gli utenti finali, che consente loro di evidenziare il testo, immettere una domanda e trovare risposte su un passaggio evidenziato di testo.
- Estensione del browser che consente agli utenti di porre una domanda sul contenuto corrente visualizzato nella pagina del browser.
- Bot di integrità che esegue query dagli utenti e fornisce risposte in base al contenuto medico identificato dal bot come più rilevante per la query dell'utente.
Di seguito è riportato un esempio di richiesta di esempio:
Esempio di richiesta
POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text
Query di esempio su un singolo blocco di testo
Corpo della richiesta
{
"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"
}
}
}
Risposta di esempio
Nel corpo della richiesta precedente, viene eseguita una query su un singolo blocco di testo. Di seguito è riportata una risposta di esempio ricevuta per la query precedente.
{
"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
}
]
}
}
}
Si noterà che vengono ricevute più risposte come parte della risposta dell'API. Ogni risposta ha un punteggio di attendibilità specifico che consente di comprendere la rilevanza complessiva della risposta. L'intervallo di risposte indica se è stata rilevata anche una potenziale risposta breve. Gli utenti possono usare questo punteggio di attendibilità per determinare le risposte da fornire in risposta alla query.
Limiti dell'API predefinita
Limiti delle chiamate API
Se è necessario analizzare documenti di dimensioni maggiori rispetto al limite consentito, è possibile suddividere il testo in blocchi di testo più piccoli prima di inviarli all'API. In questo contesto, un documento è una singola stringa di caratteri di testo definita.
Questi numeri rappresentano i limiti delle singole chiamate API:
- Numero di documenti: 5.
- Dimensioni massime di un singolo documento: 5.120 caratteri.
- Massimo tre risposte per documento.
Codici di lingua supportati
I codici di lingua seguenti sono supportati dall'API predefinita. Questi codici linguistici sono conformi allo standard di codici ISO 639-1.
| Codice lingua | Lingua |
|---|---|
| af | Afrikaans |
| am | Amharico |
| ar | arabo |
| come | Assamese |
| az | Azero |
| ba | Baschiro |
| be | Bielorusso |
| bg | Bulgaro |
| bn | Bengalese |
| ca | Catalano, Valenciano |
| ckb | Curdo sorani |
| cs | Ceco |
| cy | Gallese |
| da | Danese |
| de | Tedesco |
| el | Greco, moderno (1453–) |
| en | Inglese |
| eo | Esperanto |
| es | Spagnolo, Castigliano |
| et | Estone |
| eu | Basco |
| fa | Persiano |
| fi | Finlandese |
| fr | Francese |
| ga | Irlandese |
| gl | Galiziano |
| gu | Gujarati |
| he | Ebraico |
| hi | Hindi |
| ora | Croato |
| hu | Ungherese |
| hy | Armeno |
| id | Indonesiano |
| is | Islandese |
| it | Italiano |
| ja | Giapponese |
| ka | Georgiano |
| kk | Kazako |
| km | Khmer centrale |
| kn | Kannada |
| ko | Coreano |
| ky | Kirghisi, Kirghiso |
| /a | Latino |
| lo | Lao |
| lt | Lituano |
| lv | Lettone |
| mk | Macedone |
| ml | Malayalam |
| mn | Mongolo |
| mr | Marathi |
| ms | Malese |
| mt | Maltese |
| my | Burmese |
| ne | Nepalese |
| nl | Olandese, fiammingo |
| nn | Norvegese Nynorsk |
| no | Norvegese |
| or | Odia |
| pa | Punjabi, Panjabi |
| pl | Polacco |
| ps | Pashto, Pushto |
| pt | Portoghese |
| ro | Romeno |
| ru | Russo |
| sa | Sanscrito |
| sd | Sindhi |
| si | Sinhala, Sinhalese |
| sk | Slovacco |
| sl | Sloveno |
| sq | Albanese |
| sr | Serbo |
| sv | Svedese |
| sw | Swahili |
| ta | Tamil |
| te | Telugu |
| tg | Tagico |
| th | Thai |
| tl | Tagalog |
| tr | Turco |
| tt | Tataro |
| ug | Uiguri, Uiguro |
| uk | Ucraino |
| ur | Urdu |
| uz | Uzbeco |
| vi | Vietnamita |
| yi | Yiddish |
| zh | Cinese |
Informazioni di riferimento sulle API predefinite
Visitare la documentazione completa degli esempi di API predefinite per comprendere i parametri di input e output necessari per chiamare l'API.