API pré-criada
A API personalizada de resposta a perguntas pré-criada fornece a capacidade de responder a perguntas com base em uma passagem de texto sem ter que criar projetos, manter pares de perguntas e respostas ou incorrer em custos para infraestrutura subutilizada. Essa funcionalidade é fornecida como uma API e pode ser usada para atender às necessidades de perguntas e respostas sem ter que aprender os detalhes sobre a resposta personalizada a perguntas.
Dada uma consulta do usuário e um bloco de texto/passagem, a API retornará uma resposta e uma resposta precisa (se disponível).
Exemplo de uso da API
Imagine que tem um ou mais blocos de texto a partir dos quais gostaria de obter respostas para uma determinada pergunta. Normalmente, você teria que criar tantas fontes quanto o número de blocos de texto. No entanto, agora com a API pré-construída, você pode consultar os blocos de texto sem ter que definir fontes de conteúdo em um projeto.
Alguns outros cenários em que essa API pode ser usada são:
- Você está desenvolvendo um aplicativo leitor de ebook para usuários finais, que lhes permite destacar texto, inserir uma pergunta e encontrar respostas sobre uma passagem de texto destacada.
- Uma extensão do navegador que permite aos usuários fazer uma pergunta sobre o conteúdo que está sendo exibido atualmente na página do navegador.
- Um bot de integridade que recebe consultas dos usuários e fornece respostas com base no conteúdo médico que o bot identifica como mais relevante para a consulta do usuário.
Abaixo está um exemplo de uma solicitação de exemplo:
Pedido de amostra
POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text
Exemplo de consulta sobre um único bloco de texto
Corpo do Pedido
{
"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"
}
}
}
Resposta da amostra
No corpo da solicitação acima, consultamos sobre um único bloco de texto. Um exemplo de resposta recebida para a consulta acima é mostrado abaixo,
{
"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
}
]
}
}
}
Vemos que várias respostas são recebidas como parte da resposta da API. Cada resposta tem uma pontuação de confiança específica que ajuda a entender a relevância geral da resposta. A extensão da resposta representa se uma potencial resposta curta também foi detetada. Os usuários podem usar essa pontuação de confiança para determinar quais respostas fornecer em resposta à consulta.
Limites de API pré-criados
Limites de chamadas de API
Se você precisar usar documentos maiores do que o limite permite, você pode dividir o texto em pedaços menores de texto antes de enviá-los para a API. Neste contexto, um documento é uma única cadeia de caracteres de texto definida.
Esses números representam os limites de chamada de API por indivíduo:
- Número de documentos: 5.
- Tamanho máximo de um único documento: 5.120 caracteres.
- Máximo de três respostas por documento.
Códigos de idioma suportados
Os códigos de idioma a seguir são suportados pela API pré-criada. Estes códigos linguísticos estão de acordo com a norma de códigos ISO 639-1.
| Código de idioma | Idioma |
|---|---|
| AF | Afrikaans |
| sou | Amárico |
| ar | Árabe |
| como | Assamês |
| AZ | Azerbaijanês |
| ba | Basquir |
| ser | Bielorrusso |
| bg | Búlgaro |
| bn | Bengalês |
| ca | Catalão, Valenciano |
| CKB | Curdo Central |
| cs | Checo |
| cy | Galês |
| da | Dinamarquês |
| al | Alemão |
| el | Grego, Moderno (1453-) |
| in | Inglês |
| eo | Esperanto |
| es | Espanhol, Castelhano |
| et | Estónio |
| eu | Basco |
| FA | Persa |
| fi | Finlandês |
| fr | Francês |
| GA | Irlandês |
| gl | Galego |
| Gu | Guzerate |
| he | Hebraico |
| hi | Hindi |
| hr | Croata |
| hu | Húngaro |
| hy | Arménio |
| id | Indonésio |
| é | Islandês |
| it | Italiano |
| ja | Japonês |
| Ka | Georgiano |
| kk | Cazaque |
| km | Central Khmer |
| KN | Canarês |
| ko | Coreano |
| KY | Kirghiz, Quirguistão |
| la | Latim |
| lo | Laos |
| lt | Lituano |
| lv | Letão |
| Mk | Macedónio |
| ml | Malaiala |
| MN | Mongol |
| O Sr. | Marata |
| ms | Malaio |
| mt | Maltês |
| meu | Birmanês |
| ne | Nepalês |
| nl | Neerlandês, Flamengo |
| nn | Norueguês (Nynorsk) |
| não | Norueguês |
| ou | Odia |
| PA | Punjabi, Panjabi |
| pl | Polaco |
| PS | Pashto, Pushto |
| pt | Português |
| ro | Romeno |
| ru | Russo |
| SA | Sânscrito |
| SD | Sindhi |
| Si | Cingalês, cingalês |
| sk | Eslovaco |
| sl | Esloveno |
| sq | Albanês |
| SR | Sérvio |
| sv | Sueco |
| sw | Suaíli |
| ta | Tâmil |
| te | Telugu |
| TG | Tajique |
| th | Tailandês |
| tl | Tagalog |
| tr | Turco |
| TT | Tatar |
| ug | Uigure, Uigur |
| uk | Ucraniano |
| o seu | Urdu |
| UZ | Usbeque |
| vi | Vietnamita |
| Yi | Iídiche |
| zh | Chinês |
Referência de API pré-criada
Visite a documentação completa de exemplos de API pré-criada para entender os parâmetros de entrada e saída necessários para chamar a API.