Share via

Authoring-API

  • Artikel

De aangepaste vraag die de ontwerp-API beantwoordt, wordt gebruikt om algemene taken te automatiseren, zoals het toevoegen van nieuwe vraagantwoordparen, en het maken, publiceren en onderhouden van projecten.

Notitie

Ontwerpfunctionaliteit is beschikbaar via de REST API en Authoring SDK (preview). Dit artikel bevat voorbeelden van het gebruik van de REST API met cURL. Raadpleeg de REST API-referentie-inhoud voor volledige documentatie over alle parameters en functionaliteit die beschikbaar is.

Vereisten

  • De huidige versie van cURL. In dit artikel worden verschillende opdrachtregelopties gebruikt, die worden vermeld in de cURL-documentatie.
  • De opdrachten in dit artikel zijn ontworpen om te worden uitgevoerd in een Bash-shell. Deze opdrachten werken niet altijd in een Windows-opdrachtprompt of in PowerShell zonder wijzigingen. Als u geen Bash-shell lokaal hebt geïnstalleerd, kunt u de bash-omgeving van Azure Cloud Shell gebruiken.

Een project maken

Een project programmatisch maken:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van>de voorspellings-URL van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als het vorige voorbeeld uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral omdat de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van>de voorspellings-URL van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
NEW-PROJECT-NAME De naam voor uw nieuwe aangepaste vraagantwoordproject.

U kunt ook aanvullende waarden aanpassen, zoals de projecttaal, het standaardantwoord dat wordt gegeven wanneer er geen antwoord kan worden gevonden dat voldoet aan of de betrouwbaarheidsdrempel overschrijdt en of deze taalresource meerdere talen ondersteunt.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Project verwijderen

Een project programmatisch verwijderen:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als het vorige voorbeeld uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral omdat de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project dat u wilt verwijderen.

Voorbeeldquery

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'

Een geslaagde aanroep voor het verwijderen van een project resulteert in een Operation-Location koptekst die kan worden gebruikt om de status van de verwijderprojecttaak te controleren. In de meeste voorbeelden hebben we de antwoordheaders niet hoeven te bekijken en ze dus niet weergegeven. Voor het ophalen van de antwoordheaders gebruikt -ionze curl-opdracht. Zonder deze parameter vóór het eindpuntadres zou het antwoord op deze opdracht leeg lijken alsof er geen reactie is opgetreden.

Voorbeeld van een antwoord

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

Als het project al is verwijderd of niet is gevonden, ontvangt u een bericht zoals:

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

Status van projectverwijdering ophalen

Ga als volgt te werk om de status van uw verwijderprojectaanvraag te controleren:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van>de voorspellings-URL van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u de implementatiestatus wilt controleren.
JOB-ID Wanneer u een project programmatisch verwijdert, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader voor de verwijderingsaanvraag. De JOB-ID guid aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Projectinstellingen ophalen

Werk de volgende waarden in de onderstaande query bij om informatie over een bepaald project op te halen:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarover u informatie wilt ophalen.

Voorbeeldquery


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'

Voorbeeld van een antwoord

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

Vraag-antwoordparen ophalen

Werk de volgende waarden in de onderstaande query bij om vraagantwoordparen en gerelateerde informatie voor een bepaald project op te halen:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u alle vraag-antwoordparen wilt ophalen.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Bronnen ophalen

Werk de volgende waarden in de onderstaande query bij om de bronnen en gerelateerde informatie voor een bepaald project op te halen:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u alle brongegevens wilt ophalen.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Synoniemen ophalen

Als u synoniemen en gerelateerde informatie voor een bepaald project wilt ophalen, werkt u de volgende waarden bij in de onderstaande query:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u synonieminformatie wilt ophalen.

Voorbeeldquery


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'

Voorbeeld van een antwoord

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

Project implementeren

Werk de volgende waarden in de onderstaande query bij om een project in productie te implementeren:

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project dat u wilt implementeren in productie.

Voorbeeldquery

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'

Een geslaagde aanroep voor het implementeren van een project resulteert in een Operation-Location header die kan worden gebruikt om de status van de implementatietaak te controleren. In de meeste voorbeelden hebben we de antwoordheaders niet hoeven te bekijken en ze dus niet weergegeven. Voor het ophalen van de antwoordheaders gebruikt -ionze curl-opdracht. Zonder deze parameter vóór het eindpuntadres zou het antwoord op deze opdracht leeg lijken alsof er geen reactie is opgetreden.

Voorbeeld van een antwoord

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

Projectimplementatiestatus ophalen

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u de implementatiestatus wilt controleren.
JOB-ID Wanneer u een project programmatisch implementeert, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader voor de implementatieaanvraag. De JOB-ID guid aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Projectmetagegevens en -assets exporteren

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project dat u wilt exporteren.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Exportstatus controleren

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u de exportstatus wilt controleren.
JOB-ID Wanneer u een project programmatisch exporteert, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader naar de exportaanvraag. De JOB-ID guid aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Als u rechtstreeks toegang probeert te krijgen tot het resultUrl, krijgt u een 404-fout. U moet aan het pad toevoegen ?api-version=2021-10-01 om het toegankelijk te maken door een geverifieerde aanvraag: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Project importeren

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming voor de import wilt zijn.
FILE-URI-PATH Wanneer u een project programmatisch exporteert en vervolgens controleert u de status waarvan de export wordt resultUrl gegenereerd als onderdeel van het antwoord. U kunt bijvoorbeeld "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" de resultUrl gebruiken met de API-versie die als bronbestand is toegevoegd om een project te importeren uit: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Voorbeeldquery

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'

Een geslaagde aanroep voor het importeren van een project resulteert in een Operation-Location koptekst die kan worden gebruikt om de status van de importtaak te controleren. In veel van onze voorbeelden hebben we de antwoordheaders niet hoeven te bekijken en ze dus niet weergegeven. Voor het ophalen van de antwoordheaders gebruikt -ionze curl-opdracht. Zonder deze extra parameter vóór het eindpuntadres zou het antwoord op deze opdracht leeg lijken alsof er geen reactie is opgetreden.

Voorbeeld van een antwoord

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

Importstatus controleren

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming voor de import wilt zijn.
JOB-ID Wanneer u een project programmatisch importeert, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader naar de exportaanvraag. De JOB-ID GUID aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een queryantwoord

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

Implementaties vermelden

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvoor u een implementatielijst wilt genereren.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Projecten vermelden

Haal een lijst op met alle vraagantwoordprojecten waar uw account toegang toe heeft.

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Bronnen bijwerken

In dit voorbeeld voegen we een nieuwe bron toe aan een bestaand project. U kunt bestaande bronnen ook vervangen en verwijderen door deze opdracht, afhankelijk van het type bewerkingen dat u doorgeeft als onderdeel van de hoofdtekst van de query.

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarin u bronnen wilt bijwerken.
METHOD PATCH

Voorbeeldquery

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'

Een geslaagde aanroep om een bronresultaat bij te werken in een Operation-Location header die kan worden gebruikt om de status van de importtaak te controleren. In veel van onze voorbeelden hebben we de antwoordheaders niet hoeven te bekijken en ze dus niet altijd weergegeven. Voor het ophalen van de antwoordheaders gebruikt -ionze curl-opdracht. Zonder deze parameter vóór het eindpuntadres zou het antwoord op deze opdracht leeg lijken alsof er geen reactie is opgetreden.

Voorbeeld van een antwoord

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

Updatebronstatus ophalen

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van>de voorspellings-URL van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming voor de import wilt zijn.
JOB-ID Wanneer u programmatisch een bron bijwerkt, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader voor de aanvraag voor de updatebron. De JOB-ID GUID aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Vraag- en antwoordparen bijwerken

In dit voorbeeld voegen we een vraag-antwoordpaar toe aan een bestaande bron. U kunt ook bestaande vraagantwoordparen met deze query wijzigen of verwijderen, afhankelijk van de bewerking die u in de hoofdtekst van de query doorgeeft. Als u geen bron met de naam source5hebt, mislukt deze voorbeeldquery. U kunt de bronwaarde in de hoofdtekst van de query aanpassen aan een bron die bestaat voor uw doelproject.

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming voor de import wilt zijn. 
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'

Een geslaagde aanroep voor het bijwerken van een vraag-antwoordpaar resulteert in een Operation-Location header die kan worden gebruikt om de status van de updatetaak te controleren. In veel van onze voorbeelden hebben we de antwoordheaders niet hoeven te bekijken en ze dus niet altijd weergegeven. Voor het ophalen van de antwoordheaders gebruikt -ionze curl-opdracht. Zonder deze parameter vóór het eindpuntadres zou het antwoord op deze opdracht leeg lijken alsof er geen reactie is opgetreden.

Voorbeeld van een antwoord

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

Status van vraag-antwoordparen ophalen

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming wilt zijn voor de updates voor vraag-antwoordparen.
JOB-ID Wanneer u een vraag-antwoordpaar programmatisch bijwerkt, wordt er een JOB-ID gegenereerd als onderdeel van de operation-location antwoordheader voor de updateaanvraag. De JOB-ID GUID aan het einde van de operation-location. Bijvoorbeeld: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

Voorbeeldquery

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'

Voorbeeld van een antwoord

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

Synoniemen bijwerken

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waaraan u synoniemen wilt toevoegen.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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": []
}

Actieve trainingsfeedback bijwerken

Naam van de variabele Waarde
ENDPOINT Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. Een voorbeeldeindpunt is: https://southcentralus.api.cognitive.microsoft.com/. Als dit uw eindpunt was in het onderstaande codevoorbeeld, hoeft u alleen het regiospecifieke gedeelte toe te voegen, southcentral aangezien de rest van het eindpuntpad al aanwezig is.
API-KEY Deze waarde vindt u in de sectie Sleutels en eindpunt bij het onderzoeken van uw resource vanuit de Azure Portal. U kunt Key1 of Key2 gebruiken. Als u altijd twee geldige sleutels hebt, kunt u sleutelrotatie beveiligen zonder uitvaltijd. U kunt ook de waarde vinden in Language Studio-vraag>over het beantwoorden van de voorspellings-URL> van Deploy project>Get. De sleutelwaarde maakt deel uit van de voorbeeldaanvraag.
PROJECT-NAME De naam van het project waarvan u de bestemming wilt zijn voor de actieve updates voor feedback over leren.

Voorbeeldquery

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'

Voorbeeld van een antwoord

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