Vooraf gedefinieerde API

Artikel
03/06/2024

De aangepaste vraag die vooraf gedefinieerde API beantwoordt, biedt u de mogelijkheid om vragen te beantwoorden op basis van een passage met tekst zonder dat u projecten hoeft te maken, vraag- en antwoordparen hoeft te onderhouden of kosten maakt voor onderbenutte infrastructuur. Deze functionaliteit wordt geleverd als EEN API en kan worden gebruikt om te voldoen aan de vraag- en antwoordbehoeften zonder dat u meer hoeft te weten te komen over het beantwoorden van aangepaste vragen.

Op basis van een gebruikersquery en een blok tekst/passage retourneert de API een antwoord en nauwkeurig antwoord (indien beschikbaar).

Voorbeeld van API-gebruik

Stel dat u een of meer tekstblokken hebt waaruit u antwoorden wilt krijgen voor een bepaalde vraag. Normaal gesproken had u zoveel bronnen moeten maken als het aantal tekstblokken. Nu met de vooraf gedefinieerde API kunt u echter query's uitvoeren op de tekstblokken zonder dat u inhoudsbronnen in een project hoeft te definiëren.

Enkele andere scenario's waarin deze API kan worden gebruikt, zijn:

U ontwikkelt een ebooklezer-app voor eindgebruikers, waarmee ze tekst kunnen markeren, een vraag kunnen invoeren en antwoorden kunnen vinden over een gemarkeerde passage van tekst.
Een browserextensie waarmee gebruikers een vraag kunnen stellen over de inhoud die momenteel wordt weergegeven op de browserpagina.
Een statusbot die query's van gebruikers neemt en antwoorden geeft op basis van de medische inhoud die de bot identificeert als meest relevant voor de gebruikersquery.

Hieronder ziet u een voorbeeld van een voorbeeldaanvraag:

Voorbeeldaanvraag

POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text

Voorbeeldquery over één blok tekst

Aanvraagbody

{
  "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"
    }
  }
}

Voorbeeldrespons

In de bovenstaande aanvraagtekst voeren we een query uit op één tekstblok. Hieronder ziet u een voorbeeldantwoord dat is ontvangen voor de bovenstaande query.

{
"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
          }
        ]
      }
    }
  }

We zien dat er meerdere antwoorden worden ontvangen als onderdeel van het API-antwoord. Elk antwoord heeft een specifieke betrouwbaarheidsscore die inzicht biedt in de algehele relevantie van het antwoord. Antwoordbereik geeft aan of er ook een mogelijk kort antwoord is gedetecteerd. Gebruikers kunnen deze betrouwbaarheidsscore gebruiken om te bepalen welke antwoorden moeten worden geboden als reactie op de query.