Interfejs API tworzenia aplikacji

Artykuł
01/10/2024

Niestandardowy interfejs API odpowiadania na pytania jest używany do automatyzowania typowych zadań, takich jak dodawanie nowych par odpowiedzi na pytania, a także tworzenie, publikowanie i konserwowanie projektów.

Uwaga

Funkcje tworzenia są dostępne za pośrednictwem interfejsu API REST i zestawu SDK tworzenia (wersja zapoznawcza). Ten artykuł zawiera przykłady użycia interfejsu API REST z biblioteką cURL. Aby uzyskać pełną dokumentację wszystkich dostępnych parametrów i funkcji, zapoznaj się z zawartością referencyjną interfejsu API REST.

Wymagania wstępne

Bieżąca wersja programu cURL. W tym artykule jest używanych kilka przełączników wiersza polecenia, które zostały zanotowane w dokumentacji programu cURL.
Polecenia w tym artykule są przeznaczone do wykonywania w powłoce powłoki Bash. Te polecenia nie zawsze będą działać w wierszu polecenia systemu Windows lub w programie PowerShell bez modyfikacji. Jeśli nie masz zainstalowanej lokalnie powłoki Bash, możesz użyć środowiska powłoki Bash usługi Azure Cloud Shell.

Tworzenie projektu

Aby programowo utworzyć projekt:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli poprzedni przykład był punktem końcowym w poniższym przykładzie kodu, wystarczy dodać tylko część `southcentral` regionu, ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`NEW-PROJECT-NAME`	Nazwa nowego niestandardowego projektu odpowiadania na pytania.

Możesz również dostosować dodatkowe wartości, takie jak język projektu, domyślną odpowiedź podaną, gdy nie można znaleźć odpowiedzi, która spełnia lub przekracza próg ufności oraz czy ten zasób języka będzie obsługiwać wiele języków.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Usuwanie projektu

Aby programowo usunąć projekt:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli poprzedni przykład był punktem końcowym w poniższym przykładzie kodu, wystarczy dodać tylko część `southcentral` regionu, ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który chcesz usunąć.

Przykład kwerendy

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'

Pomyślne wywołanie w celu usunięcia projektu powoduje Operation-Location zwrócenie nagłówka, który może służyć do sprawdzania stanu zadania projektu usuwania. W większości naszych przykładów nie musieliśmy patrzeć na nagłówki odpowiedzi i w związku z tym nie były wyświetlane. Aby pobrać nagłówki odpowiedzi, nasze polecenie curl używa polecenia -i. Bez tego parametru przed adresem punktu końcowego odpowiedź na to polecenie będzie widoczna jako pusta, jakby nie wystąpiła odpowiedź.

Przykładowa odpowiedź

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

Jeśli projekt został już usunięty lub nie można go odnaleźć, zostanie wyświetlony komunikat podobny do następującego:

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

Pobieranie stanu usuwania projektu

Aby sprawdzić stan żądania usunięcia projektu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz sprawdzić stan wdrożenia.
`JOB-ID`	Po programowym `JOB-ID` usunięciu projektu element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania usunięcia. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Pobieranie ustawień projektu

Aby pobrać informacje o danym projekcie, zaktualizuj następujące wartości w poniższym zapytaniu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, o którym chcesz pobrać informacje.

Przykład kwerendy


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'

Przykładowa odpowiedź

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

Uzyskiwanie par odpowiedzi na pytania

Aby pobrać pary odpowiedzi na pytania i powiązane informacje dla danego projektu, zaktualizuj następujące wartości w poniższym zapytaniu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz pobrać wszystkie pary odpowiedzi na pytania.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Pobieranie źródeł

Aby pobrać źródła i powiązane informacje dla danego projektu, zaktualizuj następujące wartości w poniższym zapytaniu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz pobrać wszystkie informacje źródłowe.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Uzyskiwanie synonimów

Aby pobrać synonimy i powiązane informacje dla danego projektu, zaktualizuj następujące wartości w poniższym zapytaniu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz pobrać informacje o synonimach.

Przykład kwerendy


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'

Przykładowa odpowiedź

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

Wdrażanie projektu

Aby wdrożyć projekt w środowisku produkcyjnym, zaktualizuj następujące wartości w poniższym zapytaniu:

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który chcesz wdrożyć w środowisku produkcyjnym.

Przykład kwerendy

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'

Pomyślne wywołanie wdrożenia projektu powoduje Operation-Location zwrócenie nagłówka, który może służyć do sprawdzania stanu zadania wdrożenia. W większości naszych przykładów nie musieliśmy patrzeć na nagłówki odpowiedzi i w związku z tym nie były wyświetlane. Aby pobrać nagłówki odpowiedzi, nasze polecenie curl używa polecenia -i. Bez tego parametru przed adresem punktu końcowego odpowiedź na to polecenie będzie widoczna jako pusta, jakby nie wystąpiła odpowiedź.

Przykładowa odpowiedź

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

Pobieranie stanu wdrożenia projektu

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz sprawdzić stan wdrożenia.
`JOB-ID`	Podczas programowego `JOB-ID` wdrażania projektu element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania wdrożenia. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Eksportowanie metadanych i zasobów projektu

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który chcesz wyeksportować.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Sprawdzanie stanu eksportu

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz sprawdzić stan eksportu.
`JOB-ID`	Podczas programowego `JOB-ID` eksportowania projektu element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania eksportu. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Jeśli spróbujesz uzyskać bezpośredni dostęp do elementu resultUrl, zostanie wyświetlony błąd 404. Musisz dołączyć ?api-version=2021-10-01 do ścieżki, aby była dostępna dla uwierzytelnionego żądania: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Importowanie projektu

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym importu.
`FILE-URI-PATH`	Podczas programowego eksportowania projektu, a następnie sprawdź stan, w którym eksport `resultUrl` jest generowany jako część odpowiedzi. Na przykład: `"resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"` możesz użyć elementu resultUrl z wersją interfejsu API dołączoną jako plik źródłowy, aby zaimportować projekt z: `https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01`.

Przykład kwerendy

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'

Pomyślne wywołanie importowania projektu powoduje Operation-Location zwrócenie nagłówka, którego można użyć do sprawdzenia stanu zadania importu. W wielu naszych przykładach nie musieliśmy patrzeć na nagłówki odpowiedzi i w związku z tym nie wyświetlaliśmy ich. Aby pobrać nagłówki odpowiedzi, nasze polecenie curl używa polecenia -i. Bez tego dodatkowego parametru przed adresem punktu końcowego odpowiedź na to polecenie będzie widoczna jako pusta, jakby nie wystąpiła odpowiedź.

Przykładowa odpowiedź

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

Sprawdzanie stanu importu

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym importu.
`JOB-ID`	Podczas programowego `JOB-ID` importowania projektu element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania eksportu. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź na zapytanie

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

Wyświetlanie listy wdrożeń

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, dla którego chcesz wygenerować listę wdrożeń.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Lista projektów

Pobierz listę wszystkich projektów odpowiedzi na pytania, do których twoje konto ma dostęp.

Nazwa zmiennej Wartość

ENDPOINT Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: https://southcentralus.api.cognitive.microsoft.com/. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, southcentral ponieważ pozostała część ścieżki punktu końcowego jest już obecna.

API-KEY Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Aktualizuj źródła

W tym przykładzie dodamy nowe źródło do istniejącego projektu. Możesz również zastąpić i usunąć istniejące źródła za pomocą tego polecenia w zależności od rodzaju operacji przekazywanych w ramach treści zapytania.

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, w którym chcesz zaktualizować źródła.
`METHOD`	PATCH

Przykład kwerendy

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'

Pomyślne wywołanie w celu zaktualizowania źródła powoduje Operation-Location zwrócenie nagłówka, który może służyć do sprawdzania stanu zadania importu. W wielu naszych przykładach nie musieliśmy patrzeć na nagłówki odpowiedzi i w ten sposób nie zawsze były wyświetlane. Aby pobrać nagłówki odpowiedzi, nasze polecenie curl używa polecenia -i. Bez tego parametru przed adresem punktu końcowego odpowiedź na to polecenie będzie widoczna jako pusta, jakby nie wystąpiła odpowiedź.

Przykładowa odpowiedź

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

Pobieranie stanu źródła aktualizacji

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym importu.
`JOB-ID`	Podczas programowego `JOB-ID` aktualizowania źródła element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania źródła aktualizacji. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Aktualizowanie par pytań i odpowiedzi

W tym przykładzie dodamy parę odpowiedzi na pytanie do istniejącego źródła. Możesz również zmodyfikować lub usunąć istniejące pary odpowiedzi na pytania z tym zapytaniem w zależności od operacji przekazanej w treści zapytania. Jeśli nie masz źródła o nazwie source5, to przykładowe zapytanie zakończy się niepowodzeniem. Wartość źródłową można dostosować w treści zapytania do źródła, które istnieje dla projektu docelowego.

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym importu.

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'

Pomyślne wywołanie aktualizacji pary odpowiedzi na pytanie powoduje Operation-Location zwrócenie nagłówka, który może służyć do sprawdzania stanu zadania aktualizacji. W wielu naszych przykładach nie musieliśmy patrzeć na nagłówki odpowiedzi i w ten sposób nie zawsze były wyświetlane. Aby pobrać nagłówki odpowiedzi, nasze polecenie curl używa polecenia -i. Bez tego parametru przed adresem punktu końcowego odpowiedź na to polecenie będzie widoczna jako pusta, jakby nie wystąpiła odpowiedź.

Przykładowa odpowiedź

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

Uzyskiwanie stanu par odpowiedzi na pytania aktualizacji

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym aktualizacji par odpowiedzi na pytanie.
`JOB-ID`	Podczas programowego `JOB-ID` aktualizowania pary odpowiedzi na pytanie element jest generowany jako część `operation-location` nagłówka odpowiedzi do żądania aktualizacji. Jest `JOB-ID` to identyfikator GUID na końcu .`operation-location` Na przykład: `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}`.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Aktualizowanie synonimów

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który chcesz dodać synonimy.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Aktualizowanie aktywnych opinii dotyczących uczenia

Nazwa zmiennej	Wartość
`ENDPOINT`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Przykładowy punkt końcowy to: `https://southcentralus.api.cognitive.microsoft.com/`. Jeśli był to punkt końcowy w poniższym przykładzie kodu, wystarczy dodać tylko część regionu, `southcentral` ponieważ pozostała część ścieżki punktu końcowego jest już obecna.
`API-KEY`	Tę wartość można znaleźć w sekcji Klucze i punkt końcowy podczas badania zasobu z poziomu witryny Azure Portal. Możesz użyć klawisza Key1 lub Key2. Zawsze posiadanie dwóch prawidłowych kluczy umożliwia bezpieczną rotację kluczy z zerowym przestojem. Alternatywnie możesz znaleźć wartość w artykule Language Studio>question answering>Deploy project Get prediction URL (Wdrażanie projektu>Uzyskiwanie adresu URL przewidywania). Wartość klucza jest częścią przykładowego żądania.
`PROJECT-NAME`	Nazwa projektu, który ma być miejscem docelowym aktualizacji aktywnych opinii szkoleniowych.

Przykład kwerendy

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'

Przykładowa odpowiedź

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

Udostępnij za pośrednictwem

Interfejs API tworzenia aplikacji

Wymagania wstępne

Tworzenie projektu

Przykład kwerendy

Przykładowa odpowiedź

Usuwanie projektu

Przykład kwerendy

Przykładowa odpowiedź

Pobieranie stanu usuwania projektu

Przykład kwerendy

Przykładowa odpowiedź

Pobieranie ustawień projektu

Przykład kwerendy

Przykładowa odpowiedź

Uzyskiwanie par odpowiedzi na pytania

Przykład kwerendy

Przykładowa odpowiedź

Pobieranie źródeł

Przykład kwerendy

Przykładowa odpowiedź

Uzyskiwanie synonimów

Przykład kwerendy

Przykładowa odpowiedź

Wdrażanie projektu

Przykład kwerendy

Przykładowa odpowiedź

Pobieranie stanu wdrożenia projektu

Przykład kwerendy

Przykładowa odpowiedź

Eksportowanie metadanych i zasobów projektu

Przykład kwerendy

Przykładowa odpowiedź

Sprawdzanie stanu eksportu

Przykład kwerendy

Przykładowa odpowiedź

Importowanie projektu

Przykład kwerendy

Przykładowa odpowiedź

Sprawdzanie stanu importu

Przykład kwerendy

Przykładowa odpowiedź na zapytanie

Wyświetlanie listy wdrożeń

Przykład kwerendy

Przykładowa odpowiedź

Lista projektów

Przykład kwerendy

Przykładowa odpowiedź

Aktualizuj źródła

Przykład kwerendy

Przykładowa odpowiedź

Pobieranie stanu źródła aktualizacji

Przykład kwerendy

Przykładowa odpowiedź

Aktualizowanie par pytań i odpowiedzi

Przykładowa odpowiedź

Uzyskiwanie stanu par odpowiedzi na pytania aktualizacji

Przykład kwerendy

Przykładowa odpowiedź

Aktualizowanie synonimów

Przykład kwerendy

Przykładowa odpowiedź

Aktualizowanie aktywnych opinii dotyczących uczenia

Przykład kwerendy

Przykładowa odpowiedź

Dodatkowe zasoby