Authoring API

  • Artikel
  • 25 menit untuk membaca

API Penulisan jawaban atas pertanyaan digunakan untuk mengotomatiskan tugas umum seperti menambahkan pasangan jawaban pertanyaan baru, serta membuat, menerbitkan, dan memelihara proyek/pangkalan pengetahuan.

Catatan

Fungsionalitas penulisan tersedia melalui REST API dan Penulisan SDK (pratinjau). Artikel ini memberikan contoh menggunakan REST API dengan cURL. Untuk dokumentasi lengkap dari semua parameter dan fungsionalitas yang tersedia, baca konten referensi REST API.

Prasyarat

  • Versi cURL saat ini. Beberapa sakelar baris perintah digunakan dalam artikel ini, yang tercatat dalam dokumentasi cURL.
  • Perintah dalam artikel ini dirancang untuk dieksekusi dalam shell Bash. Perintah ini tidak akan selalu berfungsi dalam perintah Windows atau di PowerShell tanpa modifikasi. Jika tidak memiliki shell Bash yang diinstal secara lokal, Anda dapat menggunakan lingkungan bash Azure Cloud Shell.

Membuat proyek

Untuk membuat proyek/pangkalan pengetahuan secara terprogram:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilai tersebut di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contoh sebelumnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilai tersebut di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
NEW-PROJECT-NAME Nama untuk proyek/pangkalan pengetahuan jawaban atas pertanyaan baru Anda.

Anda juga dapat menyesuaikan nilai tambahan seperti bahasa proyek, jawaban default yang diberikan ketika tidak ada jawaban yang dapat ditemukan yang memenuhi atau melebihi ambang keyakinan, dan apakah sumber daya bahasa ini akan mendukung beberapa bahasa.

Kueri contoh

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 knowledge base."
      },
      "multilingualResource": true
    }
  }'  'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{NEW-PROJECT-NAME}?api-version=2021-10-01'

Contoh respons

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

Menghapus Proyek

Untuk menghapus pangkalan pengetahuan/proyek secara terprogram:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contoh sebelumnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda hapus.

Kueri contoh

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'

Panggilan yang berhasil untuk menghapus proyek menghasilkan ditampilkannya header Operation-Location, yang dapat digunakan untuk memeriksa status hapus pekerjaan proyek. Dalam sebagian besar contoh kami, kami tidak perlu melihat header respons sehingga kami belum menampilkannya. Untuk mengambil header respons, perintah curl kami menggunakan -i. Tanpa parameter ini sebelum alamat titik akhir, respons terhadap perintah ini akan tampak kosong seolah-olah tidak ada respons yang terjadi.

Contoh respons

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

Jika proyek sudah dihapus atau tidak dapat ditemukan, Anda akan menerima pesan seperti:

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

Mendapatkan status penghapusan proyek

Untuk memeriksa status hapus permintaan proyek Anda:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilai tersebut di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda periksa status penyebarannya.
JOB-ID Saat Anda menghapus pangkalan pengetahuan/proyek secara terprogram, JOB-ID dihasilkan sebagai bagian dari operation-location header respons untuk permintaan penghapusan. JOB-ID adalah guid di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons

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

Mendapatkan pengaturan proyek

Untuk mengambil informasi tentang pangkalan pengetahuan/ proyek tertentu, perbarui nilai-nilai berikut dalam kueri di bawah:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda ambil informasinya.

Kueri contoh


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'

Contoh respons

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

Mendapatkan pasangan jawaban pertanyaan

Untuk mengambil pasangan jawaban pertanyaan dan informasi terkait untuk pangkalan pengetahuan/proyek tertentu, perbarui nilai-nilai berikut dalam kueri di bawah:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda ambil semua pasangan jawaban pertanyaan.

Kueri contoh

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'

Contoh respons

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

Mendapatkan sumber

Untuk mengambil sumber dan informasi terkait untuk pangkalan pengetahuan/proyek tertentu, perbarui nilai-nilai berikut dalam kueri di bawah:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan untuk mengambil semua informasi sumber.

Kueri contoh

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'

Contoh respons

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "displayName": "source1",
            "sourceUri": "https://docs.microsoft.com/azure/cognitive-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"
          }
        ]
      }
    }
  }

Mendapatkan sinonim

Untuk mengambil sinonim dan informasi terkait untuk pangkalan pengetahuan/proyek tertentu, perbarui nilai-nilai berikut dalam kueri di bawah:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda ambil informasi sinonimnya.

Kueri contoh


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'

Contoh respons

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

Menyebarkan proyek

Untuk menyebarkan pangkalan pengetahuan/proyek ke produksi, perbarui nilai-nilai berikut dalam kueri di bawah:

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda sebarkan ke produksi.

Kueri contoh

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'

Panggilan yang berhasil untuk menyebarkan proyek membuat header Operation-Location ditampilkan, yang dapat digunakan untuk memeriksa status pekerjaan proyek. Dalam sebagian besar contoh kami, kami tidak perlu melihat header respons sehingga kami belum menampilkannya. Untuk mengambil header respons, perintah curl kami menggunakan -i. Tanpa parameter ini sebelum alamat titik akhir, respons terhadap perintah ini akan tampak kosong seolah-olah tidak ada respons yang terjadi.

Contoh respons

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

Mendapatkan status penyebaran

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda periksa status penyebarannya.
JOB-ID Saat Anda menyebarkan pangkalan pengetahuan/proyek secara terprogram, JOB-ID dihasilkan sebagai bagian dari header respons operation-location untuk permintaan penyebaran. JOB-ID adalah guid di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons

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

Mengekspor metadata dan aset proyek

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda ekspor.

Kueri contoh

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'

Contoh respons

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

Memeriksa status ekspor

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama basis pangkalan pengetahuan/proyek yang ingin Anda periksa status ekspornya.
JOB-ID Saat Anda menghapus pangkalan pengetahuan/proyek secara terprogram, JOB-ID dihasilkan sebagai bagian dari header respons operation-location terhadap permintaan ekspor. JOB-ID adalah guid di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons

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

Jika Anda mencoba mengakses langsung resultUrl, Anda akan mendapati kesalahan 404. Anda harus menambahkan ?api-version=2021-10-01 ke jalur titik akhir tersebut agar dapat diakses oleh permintaan yang diautentikasi: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Impor proyek

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan untuk menjadi tujuan impor.
FILE-URI-PATH Saat Anda mengekspor pangkalan pengetahuan/proyek secara terprogram, lalu memeriksa status ekspor, resultUrl dihasilkan sebagai bagian dari respons. Misalnya: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" Anda dapat menggunakan resultUrl dengan versi API yang ditambahkan sebagai file sumber untuk mengimpor proyek dari: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01.

Kueri contoh

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'

Panggilan yang berhasil untuk menyebarkan hasil proyek di Operation-Location header yang sedang ditampilkan, yang dapat digunakan untuk memeriksa status pekerjaan impor. Dalam sebagian besar contoh kami, kami tidak perlu melihat header respons sehingga kami belum menampilkannya. Untuk mengambil header respons, perintah curl kami menggunakan -i. Tanpa parameter tambahan ini sebelum alamat titik akhir, respons terhadap perintah ini akan tampak kosong seolah-olah tidak ada respons yang terjadi.

Contoh respons

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

Memeriksa status impor

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan untuk menjadi tujuan impor.
JOB-ID Saat Anda mengimpor pangkalan pengetahuan/proyek secara terprogram, JOB-ID dihasilkan sebagai bagian dari header respons operation-location terhadap permintaan ekspor. JOB-ID adalah GUID di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons kueri

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

Membuat daftar penyebaran

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda buat daftar penyebarannya.

Kueri contoh

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'

Contoh respons

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

Membuat Daftar Proyek

Ambil daftar semua proyek jawaban atas pertanyaan yang dapat diakses akun Anda.

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.

Kueri contoh

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'

Contoh respons

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

Memperbarui sumber

Dalam contoh ini, kita akan menambahkan sumber baru ke proyek yang sudah ada. Anda juga dapat mengganti dan menghapus sumber yang ada dengan perintah ini bergantung pada jenis operasi yang Anda teruskan sebagai bagian dari isi kueri Anda.

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek tempat Anda ingin memperbarui sumber.

Kueri contoh

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 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/sources?api-version=2021-10-01'

Panggilan yang berhasil untuk memperbarui hasil proyek di Operation-Location header yang sedang ditampilkan, yang dapat digunakan untuk memeriksa status pekerjaan impor. Dalam sebagian besar contoh kami, kami tidak perlu melihat header respons, sehingga kami tidak selalu menampilkannya. Untuk mengambil header respons, perintah curl kami menggunakan -i. Tanpa parameter ini sebelum alamat titik akhir, respons terhadap perintah ini akan tampak kosong seolah-olah tidak ada respons yang terjadi.

Contoh respons

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

Dapatkan status sumber pembaruan

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilai tersebut di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan untuk menjadi tujuan impor.
JOB-ID Saat Anda memperbarui sumber secara terprogram, JOB-ID dibuat sebagai bagian dari header respons operation-location terhadap permintaan sumber pembaruan. JOB-ID adalah GUID di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons

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

Memperbarui pasangan pertanyaan dan jawaban

Dalam contoh ini, kita akan menambahkan pasangan jawaban pertanyaan ke sumber yang ada. Anda juga dapat mengubah, atau menghapus pasangan jawaban pertanyaan yang ada dengan kueri ini bergantung pada operasi yang Anda teruskan dalam isi kueri. Jika Anda tidak memiliki sumber bernama source5, kueri contoh ini akan gagal. Anda dapat menyesuaikan nilai sumber dalam isi kueri ke sumber yang ada untuk proyek target Anda.

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan untuk menjadi tujuan impor. 
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://docs.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'

Panggilan yang berhasil untuk memperbarui hasil proyek di Operation-Location header yang sedang ditampilkan, yang dapat digunakan untuk memeriksa status pekerjaan pembaruan. Dalam sebagian besar contoh kami, kami tidak perlu melihat header respons, sehingga kami tidak selalu menampilkannya. Untuk mengambil header respons, perintah curl kami menggunakan -i. Tanpa parameter ini sebelum alamat titik akhir, respons terhadap perintah ini akan tampak kosong seolah-olah tidak ada respons yang terjadi.

Contoh respons

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

Dapatkan status pasangan jawaban pertanyaan pembaruan

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda jadikan tujuan pembaruan pasangan jawaban pertanyaan.
JOB-ID Saat Anda memperbarui pasangan jawaban pertanyaan secara terprogram, JOB-ID dibuat sebagai bagian dari header respons operation-location terhadap permintaan pembaruan. JOB-ID adalah GUID di akhir operation-location. Misalnya: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

Kueri contoh

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'

Contoh respons

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

Memperbarui Sinonim

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang ingin Anda tambahkan sinonim.

Kueri contoh

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'

Contoh respons

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

Memperbarui umpan balik pembelajaran aktif

Nama variabel Nilai
ENDPOINT Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Contoh titik akhir adalah: https://southcentralus.api.cognitive.microsoft.com/. Jika contohnya adalah titik akhir Anda dalam sampel kode di bawah, Anda hanya perlu menambahkan bagian southcentral khusus wilayah karena jalur titik akhir lainnya sudah ada.
API-KEY Nilai ini dapat ditemukan di bagian Kunci & Titik Akhir saat memeriksa sumber daya dari portal Azure. Anda dapat menggunakan Key1 atau Key2. Dengan selalu memiliki dua kunci valid, Anda dapat memperoleh rotasi kunci yang aman dengan waktu henti nol. Atau, Anda dapat menemukan nilainya di Language Studio>jawaban atas pertanyaan>Menyebarkan pangkalan pengetahuan>Mendapatkan URL prediksi. Nilai kunci adalah bagian dari permintaan sampel.
PROJECT-NAME Nama pangkalan pengetahuan/proyek yang Anda inginkan menjadi tujuan untuk pembaruan umpan balik pembelajaran aktif.

Kueri contoh

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'

Contoh respons

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