Redigera API

  • Artikel

Den anpassade frågan som svarar på redigerings-API:et används för att automatisera vanliga uppgifter som att lägga till nya frågesvarspar, samt skapa, publicera och underhålla projekt.

Kommentar

Redigeringsfunktioner är tillgängliga via REST API och Authoring SDK (förhandsversion). Den här artikeln innehåller exempel på hur du använder REST API med cURL. Fullständig dokumentation om alla tillgängliga parametrar och funktioner finns i REST API-referensinnehållet.

Förutsättningar

  • Den aktuella versionen av cURL. Flera kommandoradsväxlar används i den här artikeln, som anges i cURL-dokumentationen.
  • Kommandona i den här artikeln är utformade för att köras i ett Bash-gränssnitt. Dessa kommandon fungerar inte alltid i en Windows-kommandotolk eller i PowerShell utan ändringar. Om du inte har ett Bash-gränssnitt installerat lokalt kan du använda Azure Cloud Shells bash-miljö.

Skapa ett projekt

Så här skapar du ett projekt programmatiskt:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det tidigare exemplet var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
NEW-PROJECT-NAME Namnet på ditt nya projekt för svar på anpassad fråga.

Du kan också justera ytterligare värden som projektspråket, standardsvaret som ges när inget svar hittas som uppfyller eller överskrider konfidenströskeln och om den här språkresursen stöder flera språk.

Exempelfrågeställning

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'

Exempelsvar

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

Ta bort projekt

Så här tar du bort ett projekt programmatiskt:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det tidigare exemplet var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ta bort.

Exempelfrågeställning

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'

Ett lyckat anrop för att ta bort ett projekt resulterar i att ett Operation-Location huvud returneras, vilket kan användas för att kontrollera statusen för borttagningsprojektets jobb. I de flesta av våra exempel har vi inte behövt titta på svarshuvudena och har därför inte visat dem. För att hämta svarsrubrikerna använder -ivårt curl-kommando . Utan den här parametern före slutpunktsadressen visas svaret på det här kommandot tomt som om inget svar inträffat.

Exempelsvar

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

Om projektet redan har tagits bort eller inte kunde hittas får du ett meddelande som:

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

Hämta status för borttagning av projekt

Så här kontrollerar du statusen för din borttagningsprojektbegäran:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill kontrollera distributionsstatusen för.
JOB-ID När du tar bort ett projekt programmässigt genereras ett som en JOB-ID del av operation-location svarshuvudet i borttagningsbegäran. JOB-ID är guid i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempelsvar

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

Hämta projektinställningar

Om du vill hämta information om ett visst projekt uppdaterar du följande värden i frågan nedan:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill hämta information om.

Exempelfrågeställning


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'

Exempelsvar

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

Hämta par för frågesvar

Om du vill hämta frågesvarspar och relaterad information för ett visst projekt uppdaterar du följande värden i frågan nedan:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill hämta alla frågesvarspar för.

Exempelfrågeställning

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'

Exempelsvar

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

Hämta källor

Om du vill hämta källorna och relaterad information för ett visst projekt uppdaterar du följande värden i frågan nedan:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill hämta all källinformation för.

Exempelfrågeställning

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'

Exempelsvar

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

Hämta synonymer

Om du vill hämta synonymer och relaterad information för ett visst projekt uppdaterar du följande värden i frågan nedan:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill hämta synonyminformation för.

Exempelfrågeställning


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'

Exempelsvar

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

Distribuera projekt

Om du vill distribuera ett projekt till produktion uppdaterar du följande värden i frågan nedan:

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill distribuera till produktion.

Exempelfrågeställning

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'

Ett lyckat anrop för att distribuera ett projekt resulterar i att en Operation-Location rubrik returneras som kan användas för att kontrollera status för distributionsjobbet. I de flesta av våra exempel har vi inte behövt titta på svarshuvudena och har därför inte visat dem. För att hämta svarsrubrikerna använder -ivårt curl-kommando . Utan den här parametern före slutpunktsadressen visas svaret på det här kommandot tomt som om inget svar inträffat.

Exempelsvar

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

Hämta projektdistributionsstatus

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill kontrollera distributionsstatusen för.
JOB-ID När du distribuerar ett projekt programmässigt genereras ett som en JOB-ID del av operation-location svarshuvudet i distributionsbegäran. JOB-ID är guid i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempelsvar

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

Exportera projektmetadata och tillgångar

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill exportera.

Exempelfrågeställning

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'

Exempelsvar

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

Kontrollera exportstatus

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill kontrollera exportstatusen för.
JOB-ID När du exporterar ett projekt programmässigt genereras ett som en JOB-ID del av operation-location svarshuvudet till exportbegäran. JOB-ID är guid i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempelsvar

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

Om du försöker komma åt resultUrl direkt får du ett 404-fel. Du måste lägga ?api-version=2021-10-01 till sökvägen för att göra den tillgänglig för en autentiserad begäran: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Importera projekt

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för importen.
FILE-URI-PATH När du exporterar ett projekt programmatiskt och sedan kontrollerar statusen som exporten genereras som en resultUrl del av svaret. Till exempel: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" du kan använda resultUrl med API-versionen som läggs till som en källfil för att importera ett projekt från: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01.

Exempelfrågeställning

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'

Ett lyckat anrop för att importera ett projekt resulterar i att ett Operation-Location huvud returneras, vilket kan användas för att kontrollera status för importjobbet. I många av våra exempel har vi inte behövt titta på svarshuvudena och har därför inte visat dem. För att hämta svarsrubrikerna använder -ivårt curl-kommando . Utan den här ytterligare parametern före slutpunktsadressen visas svaret på det här kommandot tomt som om inget svar inträffat.

Exempelsvar

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

Kontrollera importstatus

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för importen.
JOB-ID När du importerar ett projekt programmässigt genereras en som en JOB-ID del av operation-location svarshuvudet till exportbegäran. JOB-ID är GUID i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempel på frågesvar

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

Lista distributioner

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill generera en distributionslista för.

Exempelfrågeställning

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'

Exempelsvar

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

Lista projekt

Hämta en lista över alla frågor som besvarar projekt som ditt konto har åtkomst till.

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.

Exempelfrågeställning

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'

Exempelsvar

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

Uppdatera källor

I det här exemplet lägger vi till en ny källa i ett befintligt projekt. Du kan också ersätta och ta bort befintliga källor med det här kommandot beroende på vilken typ av åtgärder du skickar som en del av frågetexten.

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet där du vill uppdatera källor.
METHOD PATCH

Exempelfrågeställning

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'

Ett lyckat anrop för att uppdatera en källa resulterar i att en Operation-Location rubrik returneras som kan användas för att kontrollera status för importjobbet. I många av våra exempel har vi inte behövt titta på svarshuvudena och har därför inte alltid visat dem. För att hämta svarsrubrikerna använder -ivårt curl-kommando . Utan den här parametern före slutpunktsadressen visas svaret på det här kommandot tomt som om inget svar inträffat.

Exempelsvar

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

Hämta uppdateringskällans status

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för importen.
JOB-ID När du uppdaterar en källa programmatiskt genereras en som en JOB-ID del av operation-location svarshuvudet till begäran om uppdateringskällan. JOB-ID är GUID i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempelsvar

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

Uppdatera par för frågor och svar

I det här exemplet lägger vi till ett frågesvarspar till en befintlig källa. Du kan också ändra eller ta bort befintliga frågesvarspar med den här frågan beroende på vilken åtgärd du skickar i frågetexten. Om du inte har någon källa med namnet source5misslyckas den här exempelfrågan. Du kan justera källvärdet i frågetexten till en källa som finns för målprojektet.

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för importen. 
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'

Ett lyckat anrop för att uppdatera ett frågesvarspar resulterar i att en Operation-Location rubrik returneras som kan användas för att kontrollera status för uppdateringsjobbet. I många av våra exempel har vi inte behövt titta på svarshuvudena och har därför inte alltid visat dem. För att hämta svarsrubrikerna använder -ivårt curl-kommando . Utan den här parametern före slutpunktsadressen visas svaret på det här kommandot tomt som om inget svar inträffat.

Exempelsvar

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

Hämta status för uppdateringsfrågans svarspar

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för uppdateringarna av frågesvarsparen.
JOB-ID När du uppdaterar ett frågesvarspar programmatiskt genereras en som en JOB-ID del av operation-location svarshuvudet i uppdateringsbegäran. JOB-ID är GUID i slutet av operation-location. Till exempel: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

Exempelfrågeställning

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'

Exempelsvar

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

Uppdatera synonymer

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill lägga till synonymer.

Exempelfrågeställning

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'

Exempelsvar

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

Uppdatera feedback om aktiv inlärning

Variabelnamn Värde
ENDPOINT Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. En exempelslutpunkt är: https://southcentralus.api.cognitive.microsoft.com/. Om det här var slutpunkten i kodexemplet nedan behöver du bara lägga till den regionspecifika delen av southcentral eftersom resten av slutpunktssökvägen redan finns.
API-KEY Det här värdet finns i avsnittet Nycklar och slutpunkt när du undersöker resursen från Azure-portalen. Du kan använda antingen Key1 eller Key2. Att alltid ha två giltiga nycklar möjliggör säker nyckelrotation utan stilleståndstid. Du kan också hitta värdet i Language Studio-frågan>som>svarar på Distribuera projektet>Hämta förutsägelse-URL. Nyckelvärdet är en del av exempelbegäran.
PROJECT-NAME Namnet på projektet som du vill ska vara målet för uppdateringar av aktiv inlärningsfeedback.

Exempelfrågeställning

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'

Exempelsvar

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