Erstellungs-API

  • Artikel

Die „Benutzerdefinierte Fragen und Antworten“-API zur Dokumenterstellung wird dazu verwendet, allgemeine Aufgaben wie das Hinzufügen neuer Frage/Antwort-Paare sowie das Erstellen, Veröffentlichen und Verwalten von Projekten zu automatisieren.

Hinweis

Die Dokumenterstellungsfunktionalität ist über die REST-API und das Authoring SDK (Vorschau) verfügbar. Dieser Artikel enthält Beispiele für die Verwendung der REST-API mit cURL. Eine vollständige Dokumentation aller verfügbaren Parameter und Funktionen finden Sie im REST-API-Referenzinhalt.

Voraussetzungen

  • Aktuelle Version von cURL. In diesem Artikel werden mehrere Befehlszeilenoptionen verwendet. Diese sind in der cURL-Dokumentation angegeben.
  • Die Befehle in diesem Artikel sind für die Ausführung in einer Bash-Shell konzipiert. Diese Befehle funktionieren nicht immer ohne Anpassungen in einer Windows-Eingabeaufforderung oder in PowerShell. Wenn Sie lokal keine Bash-Shell installiert haben, können Sie die Bash-Umgebung von Azure Cloud Shell verwenden.

Erstellen eines Projekts

So erstellen Sie ein Projekt programmgesteuert:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn das vorherige Beispiel Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
NEW-PROJECT-NAME Der Name Ihres neuen „Benutzerdefinierten Fragen und Antworten“-Projekts.

Sie können auch zusätzliche Werte anpassen, z. B. die Projektsprache, die Standardantwort (wenn keine Antwort gefunden wird, die den Vertrauensschwellenwert erfüllt oder überschreitet) und ob diese Sprachressource mehrere Sprachen unterstützt.

Beispielabfrage

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "description": "proj1 is a test project.",
      "language": "en",
      "settings": {
        "defaultAnswer": "No good match found for your question in the project."
      },
      "multilingualResource": true
    }
  }'  'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{NEW-PROJECT-NAME}?api-version=2021-10-01'

Beispielantwort

{
 "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "multilingualResource": true,
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
 }
}

Löscht ein Projekt.

So löschen Sie ein Projekt programmgesteuert:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn das vorherige Beispiel Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das Sie löschen möchten.

Beispielabfrage

curl -X DELETE -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

Ein erfolgreicher Aufruf zum Löschen eines Projekts führt dazu, dass ein Operation-Location-Header zurückgegeben wird, der zum Überprüfen des Status des Löschauftrags für das Projekt verwendet werden kann. In den meisten Beispielen mussten Sie die Antwortheader nicht überprüfen und daher auch nicht anzeigen. Zum Abrufen der Antwortheader verwenden Sie im cURL-Befehl -i. Ohne diesen Parameter vor der Endpunktadresse würde die Antwort auf diesen Befehl leer sein – so als ob keine Antwort vorgekommen wäre.

Beispielantwort

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 324
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:56:18 GMT

Wenn das Projekt bereits gelöscht wurde oder nicht gefunden werden konnte, erhalten Sie eine Meldung ähnlich der folgenden:

{
  "error": {
    "code": "ProjectNotFound",
    "message": "The specified project was not found.",
    "details": [
      {
        "code": "ProjectNotFound",
        "message": "{GUID}"
      }
    ]
  }
}

Abrufen Status der Projektlöschung

So überprüfen Sie den Status Ihrer Löschanforderung für das Projekt

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, für das Sie den Bereitstellungsstatus überprüfen möchten.
JOB-ID Wenn Sie ein Projekt programmgesteuert löschen, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Löschanforderung generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/deletion-jobs/{JOB-ID}?api-version=2021-10-01'

Beispielantwort

{
  "createdDateTime": "2021-11-23T20:56:18+00:00",
  "expirationDateTime": "2021-11-24T02:56:18+00:00",
  "jobId": "GUID",
  "lastUpdatedDateTime": "2021-11-23T20:56:18+00:00",
  "status": "succeeded"
}

Abrufen von Projekteinstellungen

Aktualisieren Sie die folgenden Werte in der Abfrage unten, um Informationen zu einem bestimmten Projekt abzurufen:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, zu dem Sie Informationen abrufen möchten.

Beispielabfrage


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

Beispielantwort

 {
    "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
    }
  }

Abrufen von Frage-Antwort-Paaren

Aktualisieren Sie die folgenden Werte in der Abfrage unten, um Frage/Antwort-Paare mit den zugehörigen Informationen für ein bestimmtes Projekt abzurufen:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, für das Sie alle Frage/Antwort-Paare abrufen möchten.

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

Beispielantwort

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "id": 1,
            "answer": "ans1",
            "source": "source1",
            "questions": [
              "question 1.1",
              "question 1.2"
            ],
            "metadata": {
              "k1": "v1",
              "k2": "v2"
            },
            "dialog": {
              "isContextOnly": false,
              "prompts": [
                {
                  "displayOrder": 1,
                  "qnaId": 11,
                  "displayText": "prompt 1.1"
                },
                {
                  "displayOrder": 2,
                  "qnaId": 21,
                  "displayText": "prompt 1.2"
                }
              ]
            },
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          },
          {
            "id": 2,
            "answer": "ans2",
            "source": "source2",
            "questions": [
              "question 2.1",
              "question 2.2"
            ],
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          }
        ]
      }
    }
  }

Abrufen von Quellen

Aktualisieren Sie die folgenden Werte in der Abfrage unten, um die Quellen mit den zugehörigen Informationen zu einem bestimmten Projekt abzurufen:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, zu dem Sie alle Quellinformationen abrufen möchten.

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT_NAME}/sources?api-version=2021-10-01'

Beispielantwort

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "displayName": "source1",
            "sourceUri": "https://learn.microsoft.com/azure/ai-services/qnamaker/overview/overview",
            "sourceKind": "url",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          },
          {
            "displayName": "source2",
            "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
            "sourceKind": "file",
            "contentStructureKind": "unstructured",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          }
        ]
      }
    }
  }

Abrufen von Synonymen

Aktualisieren Sie die folgenden Werte in der Abfrage unten, um Synonyme mit den zugehörigen Informationen zu einem bestimmten Projekt abzurufen:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, zu dem Sie Synonyminformationen abrufen möchten.

Beispielabfrage


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

Beispielantwort

 {
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "alterations": [
              "qnamaker",
              "qna maker"
            ]
          },
          {
            "alterations": [
              "botframework",
              "bot framework"
            ]
          }
        ]
      }
    }
  }

Projekt bereitstellen

Aktualisieren Sie die folgenden Werte in der Abfrage unten, um ein Projekt in der Produktion bereitzustellen:

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das Sie in der Produktion bereitstellen möchten.

Beispielabfrage

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production?api-version=2021-10-01'

Ein erfolgreicher Aufruf zum Bereitstellen eines Projekts führt dazu, dass ein Operation-Location-Header zurückgegeben wird, der zum Überprüfen des Status des Bereitstellungsauftrags verwendet werden kann. In den meisten Beispielen mussten Sie die Antwortheader nicht überprüfen und daher auch nicht anzeigen. Zum Abrufen der Antwortheader verwenden Sie im cURL-Befehl -i. Ohne diesen Parameter vor der Endpunktadresse würde die Antwort auf diesen Befehl leer sein – so als ob keine Antwort vorgekommen wäre.

Beispielantwort

0HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 31
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:35:00 GMT

Abrufen des Status der Projektbereitstellung

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, für das Sie den Bereitstellungsstatus überprüfen möchten.
JOB-ID Wenn Sie ein Projekt programmgesteuert bereitstellen, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Bereitstellungsanforderung generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production/jobs/{JOB-ID}?api-version=2021-10-01'

Beispielantwort

    {
    "200": {
      "headers": {},
      "body": {
        "errors": [],
        "createdDateTime": "2021-05-01T17:21:14Z",
        "expirationDateTime": "2021-05-01T17:21:14Z",
        "jobId": "{JOB-ID-GUID}",
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "status": "succeeded"
      }
    }
  }

Exportieren von Projektmetadaten und -ressourcen

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das Sie exportieren möchten.

Beispielabfrage

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{exportAssetTypes": ["qnas","synonyms"]}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:export?api-version=2021-10-01&format=tsv'

Beispielantwort

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/export/jobs/{JOB-ID_GUID}
x-envoy-upstream-service-time: 214
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 21:24:03 GMT

Überprüfen des Exportstatus

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, für das Sie den Exportstatus überprüfen möchten.
JOB-ID Wenn Sie ein Projekt programmgesteuert exportieren, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Exportanforderung generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID}?api-version=2021-10-01'

Beispielantwort

{
  "createdDateTime": "2021-11-23T21:24:03+00:00",
  "expirationDateTime": "2021-11-24T03:24:03+00:00",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-11-23T21:24:08+00:00",
  "status": "succeeded",
  "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"
}

Wenn Sie versuchen, direkt auf resultUrl zuzugreifen, erhalten Sie den Fehler 404. Sie müssen ?api-version=2021-10-01 an den Pfad anfügen, damit über eine authentifizierte Anforderung darauf zugegriffen werden kann: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Importieren des Projekts

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für den Import verwendet werden soll.
FILE-URI-PATH Wenn Sie ein Projekt programmgesteuert exportieren und anschließend den Status des Exports überprüfen, wird als Teil der Antwort eine resultUrl generiert. Beispiel: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" Sie können die resultUrl mit der als Quelldatei angefügten API-Version verwenden, um ein Projekt aus https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01 zu importieren.

Beispielabfrage

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "fileUri": "FILE-URI-PATH"
  }' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:import?api-version=2021-10-01&format=tsv'

Ein erfolgreicher Aufruf zum Importieren eines Projekts führt dazu, dass ein Operation-Location-Header zurückgegeben wird, der zum Überprüfen des Status des Importauftrags verwendet werden kann. In vielen Beispielen mussten Sie die Antwortheader nicht überprüfen und daher auch nicht anzeigen. Zum Abrufen der Antwortheader verwenden Sie im cURL-Befehl -i. Ohne diesen zusätzlichen Parameter vor der Endpunktadresse würde die Antwort auf diesen Befehl leer sein – so als ob keine Antwort vorgekommen wäre.

Beispielantwort

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/import/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 417
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 00:35:11 GMT

Überprüfen des Importstatus

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für den Import verwendet werden soll.
JOB-ID Wenn Sie ein Projekt programmgesteuert importieren, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Importanforderung generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME/import/jobs/{JOB-ID-GUID}?api-version=2021-10-01'

Beispielantwort auf eine Abfrage

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

Bereitstellungen auflisten

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, für das Sie eine Bereitstellungsliste generieren möchten.

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments?api-version=2021-10-01'

Beispielantwort

[
  {
    "deploymentName": "production",
    "lastDeployedDateTime": "2021-10-26T15:12:02Z"
  }
]

Auflisten von Projekten

Rufen Sie eine Liste aller Fragen und Antworten-Projekte ab, auf die Ihr Konto Zugriff hat.

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects?api-version=2021-10-01'

Beispielantwort

{
  "value": [
    {
      "projectName": "Sample-project",
      "description": "My first question answering project",
      "language": "en",
      "multilingualResource": false,
      "createdDateTime": "2021-10-07T04:51:15Z",
      "lastModifiedDateTime": "2021-10-27T00:42:01Z",
      "lastDeployedDateTime": "2021-11-24T01:34:18Z",
      "settings": {
        "defaultAnswer": "No good match found in KB"
      }
    }
  ]
}

Updatequellen

In diesem Beispiel fügen Sie einem vorhandenen Projekt eine neue Quelle hinzu. Sie können vorhandene Quellen auch mit diesem Befehl ersetzen und löschen, je nachdem, welchen Typ von Vorgängen Sie als Teil des Abfragetexts übergeben.

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, in dem Sie Quellen aktualisieren möchten.
METHOD PATCH

Beispielabfrage

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
  {
    "op": "add",
    "value": {
      "displayName": "source5",
      "sourceKind": "url",
      "sourceUri": "https://download.microsoft.com/download/7/B/1/7B10C82E-F520-4080-8516-5CF0D803EEE0/surface-book-user-guide-EN.pdf",
      "sourceContentStructureKind": "semistructured"
    }
  }
]'  -i '{LanguageServiceName}.cognitiveservices.azure.com//language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01'

Ein erfolgreicher Aufruf zum Aktualisieren einer Quelle führt dazu, dass ein Operation-Location-Header zurückgegeben wird, der zum Überprüfen des Status des Importauftrags verwendet werden kann. In vielen Beispielen mussten Sie die Antwortheader nicht überprüfen und daher auch nicht immer anzeigen. Zum Abrufen der Antwortheader verwenden Sie im cURL-Befehl -i. Ohne diesen Parameter vor der Endpunktadresse würde die Antwort auf diesen Befehl leer sein – so als ob keine Antwort vorgekommen wäre.

Beispielantwort

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/sources/jobs/{JOB_ID_GUID}
x-envoy-upstream-service-time: 412
apim-request-id: dda23d2b-f110-4645-8bce-1a6f8d504b33
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 02:47:53 GMT

Abrufen des Aktualisierungsstatus der Quelle

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für den Import verwendet werden soll.
JOB-ID Wenn Sie eine Quelle programmgesteuert aktualisieren, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Aktualisierungsanforderung für die Quelle generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/sources/jobs/{JOB-ID}?api-version=2021-10-01'

Beispielantwort

{
  "createdDateTime": "2021-11-24T02:47:53+00:00",
  "expirationDateTime": "2021-11-24T08:47:53+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T02:47:56+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"
}

Aktualisieren von Frage-Antwort-Paaren

In diesem Beispiel fügen Sie einer vorhandenen Quelle ein Frage-Antwort-Paar hinzu. Sie können auch vorhandene Frage-Antwort-Paare mit dieser Abfrage ändern oder löschen, je nachdem, welchen Vorgang Sie im Abfragetext übergeben. Wenn Sie keine Quelle mit dem Namen source5 haben, führt diese Beispielabfrage zu einem Fehler. Sie können den Quellwert im Text der Abfrage an eine Quelle für Ihr Zielprojekt anpassen.

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für den Import verwendet werden soll. 
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
    {
        "op": "add",
        "value":{
            "id": 1,
            "answer": "The latest question answering docs are on https://learn.microsoft.com",
            "source": "source5",
            "questions": [
                "Where do I find docs for question answering?"
            ],
            "metadata": {},
            "dialog": {
                "isContextOnly": false,
                "prompts": []
            }
        }
    }
]'  -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

Ein erfolgreicher Aufruf zum Aktualisieren eines Frage-Antwort-Paars führt dazu, dass ein Operation-Location-Header zurückgegeben wird, der zum Überprüfen des Status des Aktualisierungsauftrags verwendet werden kann. In vielen Beispielen mussten Sie die Antwortheader nicht überprüfen und daher auch nicht immer anzeigen. Zum Abrufen der Antwortheader verwenden Sie im cURL-Befehl -i. Ohne diesen Parameter vor der Endpunktadresse würde die Antwort auf diesen Befehl leer sein – so als ob keine Antwort vorgekommen wäre.

Beispielantwort

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/qnas/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 507
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:16:01 GMT

Abrufen des Status der Aktualisierung von Frage-Antwort-Paaren

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für Aktualisierungen von Frage/Antwort-Paaren verwendet werden soll.
JOB-ID Wenn Sie ein Frage-Antwort-Paar programmgesteuert aktualisieren, wird als Teil des operation-location-Antwortheaders eine JOB-ID für die Aktualisierungsanforderung generiert. Die JOB-ID die GUID am Ende von operation-location. Beispiel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

Beispielabfrage

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas/jobs/{JOB-ID}?api-version=2021-10-01'

Beispielantwort

  "createdDateTime": "2021-11-24T03:16:01+00:00",
  "expirationDateTime": "2021-11-24T09:16:01+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T03:16:06+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"

Aktualisieren von Synonymen

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, zu dem Sie Synonyme hinzufügen möchten.

Beispielabfrage

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

Beispielantwort

0HTTP/2 200
content-length: 17
content-type: application/json; charset=utf-8
x-envoy-upstream-service-time: 39
apim-request-id: 5deb2692-dac8-43a8-82fe-36476e407ef6
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:59:09 GMT

{
  "value": []
}

Aktualisieren des Feedbacks für aktives Lernen

Variablenname Wert
ENDPOINT Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Ein Beispielendpunkt ist https://southcentralus.api.cognitive.microsoft.com/. Wenn dies Ihr Endpunkt im folgenden Codebeispiel wäre, müssten Sie nur den regionsspezifischen Teil von southcentral hinzufügen, da der übrige Endpunktpfad bereits vorhanden ist.
API-KEY Diesen Wert finden Sie im Abschnitt Schlüssel und Endpunkt, wenn Sie die Ressource über das Azure-Portal untersuchen. Sie können entweder „Schlüssel1“ oder „Schlüssel2“ verwenden. Mit zwei gültigen Schlüsseln ist jederzeit eine sichere Schlüsselrotation ohne Downtime möglich. Alternativ finden Sie den Wert unter Language-Studio>Fragen und Antworten>Projekt bereitstellen>Vorhersage-URL abrufen. Der Schlüsselwert ist Teil der Beispielanforderung.
PROJECT-NAME Der Name des Projekts, das als Ziel für Feedbackaktualisierungen für aktives Lernen verwendet werden soll.

Beispielabfrage

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
records": [
    {
      "userId": "user1",
      "userQuestion": "hi",
      "qnaId": 1
    },
    {
      "userId": "user1",
      "userQuestion": "hello",
      "qnaId": 2
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/feedback?api-version=2021-10-01'

Beispielantwort

HTTP/2 204
x-envoy-upstream-service-time: 37
apim-request-id: 92225e03-e83f-4c7f-b35a-223b1b0f29dd
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 04:02:56 GMT