Vordefinierte API

Artikel
09/04/2024

Die vorgefertigte API für benutzerdefinierte Fragen und Antworten bietet Ihnen die Möglichkeit, Fragen auf der Grundlage einer Textpassage zu beantworten, ohne Projekte erstellen, Frage-Antwort-Paare verwalten oder Kosten für eine nicht ausgelastete Infrastruktur aufbringen zu müssen. Diese Funktionalität wird als API zur Verfügung gestellt und kann verwendet werden, um die Anforderungen an die Beantwortung von Fragen zu erfüllen, ohne sich mit den Einzelheiten von benutzerdefinierten Fragen und Antworten vertraut machen zu müssen.

Bei einer Abfrage des Benutzers und einem Block bzw. einer Passage mit Text gibt die API eine Antwort und (falls verfügbar) eine präzise Antwort zurück.

Beispiel für die API-Verwendung

Angenommen, Sie haben einen oder mehrere Textblöcke, denen Sie Antworten auf eine bestimmte Frage entnehmen möchten. Normalerweise hätten Sie so viele Quellen erstellen müssen, wie es Textblöcke gibt. Mit der vorgefertigten API können Sie nun die Textblöcke abfragen, ohne Inhaltsquellen in einem Projekt definieren zu müssen.

Einige andere Szenarien, in denen diese API verwendet werden kann, sind:

Sie entwickeln eine E-Book-Reader-App für Endbenutzer, die es ihnen ermöglicht, Text zu markieren, eine Frage einzugeben und Antworten über eine markierte Textpassage zu finden.
Eine Browsererweiterung, die es den Nutzern ermöglicht, eine Frage über den Inhalt zu stellen, der gerade auf der Browserseite angezeigt wird.
Ein Gesundheits-Bot, der Anfragen von Nutzern entgegennimmt und Antworten auf der Grundlage der medizinischen Inhalte gibt, die der Bot als besonders relevant für die Nutzeranfrage identifiziert.

Im Folgenden finden Sie ein Beispiel einer Anforderung:

Beispiel für eine Anforderung

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

Beispielabfrage über einen einzelnen Textblock

Anforderungstext

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

Beispiel für eine Antwort

Im obigen Anforderungstext fragen wir einen einzelnen Textblock ab. Eine Beispielantwort der obigen Abfrage ist unten dargestellt:

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

Wir sehen, dass mehrere Antworten als Teil der API-Antwort empfangen werden. Jede Antwort hat eine bestimmte Zuverlässigkeitsbewertung, die ihnen hilft, die Gesamtrelevanz der Antwort zu verstehen. Die Antwortspanne gibt an, ob auch eine mögliche kurze Antwort erkannt wurde. Die Benutzer können anhand dieses Vertrauenswertes bestimmen, welche Antworten sie auf die Anfrage geben sollen.

Vorgefertigte API-Grenzwerte

Grenzwerte für API-Aufrufe

Wenn Sie größere Dokumente verwenden müssen, als der Grenzwert zulässt, können Sie den Text in kleinere Textabschnitte aufteilen, bevor Sie ihn an die API senden. In diesem Zusammenhang ist ein Dokument eine definierte einzelne Zeichenfolge von Text.

Diese Zahlen stellen die Grenzen für jeden einzelnen API-Aufruf dar:

Anzahl der Dokumente: 5.
Maximale Größe eines einzelnen Dokuments: 5.120 Zeichen.
Maximal drei Antworten pro Dokument

Unterstützte Sprachcodes

Die folgenden Sprachcodes werden von der vordefinierten API unterstützt. Diese Sprachcodes entsprechen dem ISO 639-1-Codes-Standard.

Sprachcode	Sprache
af	Afrikaans
am	Amharisch
ar	Arabisch
as	Assamesisch
az	Aserbaidschanisch
ba	Baschkirisch
be	Belarussisch
bg	Bulgarisch
bn	Bengali
ca	Katalanisch, Valencianisch
ckb	Zentralkurdisch
cs	Tschechisch
cy	Walisisch
da	Dänisch
de	Deutsch
el	Griechisch, Neu (1453–)
en	Englisch
eo	Esperanto
es	Spanisch, Kastilisch
et	Estnisch
eu	Baskisch
fa	Persisch
fi	Finnisch
fr	Französisch
ga	Irisch
gl	Galizisch
gu	Gujarati
er	Hebräisch
hi	Hindi
Std.	Kroatisch
hu	Ungarisch
hy	Armenisch
id	Indonesisch
is	Isländisch
it	Italienisch
ja	Japanisch
ka	Georgisch
kk	Kasachisch
km	Khmer
kn	Kannada
ko	Koreanisch
ky	Kirgisisch
la	Lateinisch
lo	Laotisch
lt	Litauisch
lv	Lettisch
mk	Mazedonisch
ml	Malayalam
mn	Mongolisch
mr	Marathi
ms	Malaiisch
Mt	Maltesisch
my	Birmanisch
ne	Nepalesisch
nl	Niederländisch, Flämisch
nn	Norwegisch Nynorsk
nein	Norwegisch
oder	Odia
pa	Punjabi, Panjabi
pl	Polnisch
ps	Paschtu, Pushto
pt	Portugiesisch
ro	Rumänisch
ru	Russisch
sa	Sanskrit
SD	Sindhi
si	Singhalesisch
sk	Slowakisch
sl	Slowenisch
sq	Albanisch
sr	Serbisch
sv	Schwedisch
sw	Suaheli
ta	Tamilisch
te	Telugu
tg	Tadschikisch
th	Thailändisch
tl	Tagalog
tr	Türkisch
tt	Tatarisch
ug	Uigurisch, Uyghur
uk	Ukrainisch
ur	Urdu
uz	Usbekisch
vi	Vietnamesisch
yi	Jiddisch
zh	Chinesisch

Referenz zur vordefinierten API

Lesen Sie die vollständige Dokumentation der vorgefertigten API-Beispiele, um die für den Aufruf der API erforderlichen Eingabe- und Ausgabeparameter zu verstehen.

Freigeben über