تأليف واجهة برمجة تطبيقات

  • مقالة
  • قراءة خلال 26 دقائق

يتم استخدام واجهة برمجة تطبيقات التأليف للإجابة على الأسئلة لأتمتة المهام الشائعة مثل إضافة أزواج إجابات أسئلة جديدة ، بالإضافة إلى إنشاء ونشر وصيانة المشاريع / قواعد المعرفة.

ملاحظة

لا تتوفر وظيفة التأليف حاليا إلا عبر واجهة برمجة تطبيقات REST. توفر هذه المقالة أمثلة على استخدام واجهة برمجة تطبيقات REST مع cURL. للحصول على وثائق كاملة لجميع المعلمات والوظائف المتاحة ، راجع المحتوى المرجعي لواجهة برمجة تطبيقات REST.

المتطلبات الأساسية

  • الإصدار الحالي من ⁧⁩cURL⁧⁩. يتم استخدام العديد من رموز تبديل سطر الأوامر في هذه المقالة، والتي تتم الإشارة إليها في ⁧⁩وثائق cURL⁧⁩.
  • تم تصميم الأوامر الواردة في هذه المقالة ليتم تنفيذها في قذيفة باش. لن تعمل هذه الأوامر دائما في موجه أوامر Windows أو في PowerShell دون تعديل. إذا لم يكن لديك Bash shell مثبتا محليا، فيمكنك استخدام بيئة bash الخاصة ب Azure Cloud Shell.

إنشاء مشروع

لإنشاء مشروع/قاعدة معارف برمجيا:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioالإجابة>على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كان المثال السابق هو نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة نظرا لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioالإجابة>على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
NEW-PROJECT-NAME اسم مشروع/قاعدة معارف الإجابة على سؤالك الجديد.

يمكنك أيضا ضبط قيم إضافية مثل لغة المشروع، والإجابة الافتراضية المقدمة عندما لا يمكن العثور على إجابة تلبي عتبة الثقة أو تتجاوزها، وما إذا كان مورد اللغة هذا سيدعم لغات متعددة.

نموذج استعلام

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'

مثال على الاستجابة

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

حذف Project

لحذف مشروع/قاعدة معارف برمجيا:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كان المثال السابق هو نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة نظرا لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في حذفه.

نموذج استعلام

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'

تؤدي Operation-Location المكالمة الناجحة لحذف مشروع إلى إرجاع رأس، والذي يمكن استخدامه للتحقق من حالة مهمة حذف المشروع. في معظم الأمثلة، لم نكن بحاجة إلى إلقاء نظرة على رؤوس الاستجابة، وبالتالي لم نعرضها. لاسترداد رؤوس الاستجابة ، يستخدم -iأمر curl الخاص بنا . بدون هذه المعلمة قبل عنوان نقطة النهاية، ستظهر الاستجابة لهذا الأمر فارغة كما لو لم تحدث استجابة.

مثال على الاستجابة

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

إذا تم حذف المشروع بالفعل أو تعذر العثور عليه ، فستتلقى رسالة مثل:

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

الحصول على حالة حذف المشروع

للتحقق من حالة طلب حذف المشروع:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioالإجابة>على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع/قاعدة معارف الذي ترغب في التحقق من حالة النشر الخاصة به.
JOB-ID عند حذف مشروع/قاعدة معارف برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب الحذف. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على الاستجابة

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

الحصول على إعدادات المشروع

لاسترداد معلومات حول مشروع/قاعدة معارف معين، قم بتحديث القيم التالية في الاستعلام أدناه:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في استرداد المعلومات عنه.

نموذج استعلام


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'

مثال على الاستجابة

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

الحصول على أزواج إجابات الأسئلة

لاسترداد أزواج إجابات الأسئلة والمعلومات ذات الصلة بمشروع/قاعدة معارف معين، قم بتحديث القيم التالية في الاستعلام أدناه:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في استرداد جميع أزواج إجابات الأسئلة الخاصة به.

نموذج استعلام

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'

مثال على الاستجابة

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

الحصول على المصادر

لاسترداد المصادر والمعلومات ذات الصلة لمشروع / قاعدة معارف معين، قم بتحديث القيم التالية في الاستعلام أدناه:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في استرداد جميع معلومات المصدر الخاصة به.

نموذج استعلام

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'

مثال على الاستجابة

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

الحصول على مرادفات

لاسترداد المرادفات والمعلومات ذات الصلة لمشروع / قاعدة معارف معين، قم بتحديث القيم التالية في الاستعلام أدناه:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في استرداد معلومات مرادف لها.

نموذج استعلام


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'

مثال على الاستجابة

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

نشر المشروع

لنشر مشروع/قاعدة معارف إلى الإنتاج، قم بتحديث القيم التالية في الاستعلام أدناه:

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع/قاعدة معارف ترغب في نشره في الإنتاج.

نموذج استعلام

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'

تؤدي Operation-Location المكالمة الناجحة لنشر مشروع إلى إرجاع رأس يمكن استخدامه للتحقق من حالة مهمة النشر. في معظم الأمثلة، لم نكن بحاجة إلى إلقاء نظرة على رؤوس الاستجابة، وبالتالي لم نعرضها. لاسترداد رؤوس الاستجابة ، يستخدم -iأمر curl الخاص بنا . بدون هذه المعلمة قبل عنوان نقطة النهاية، ستظهر الاستجابة لهذا الأمر فارغة كما لو لم تحدث استجابة.

مثال على الاستجابة

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

الحصول على حالة نشر المشروع

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع/قاعدة معارف الذي ترغب في التحقق من حالة النشر الخاصة به.
JOB-ID عند نشر مشروع/قاعدة معارف برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب النشر. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على الاستجابة

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

تصدير البيانات الوصفية للمشروع والأصول

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في تصديره.

نموذج استعلام

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'

مثال على الاستجابة

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

التحقق من حالة التصدير

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في التحقق من حالة التصدير الخاصة به.
JOB-ID عند تصدير مشروع/قاعدة معارف برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب التصدير. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على الاستجابة

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

إذا حاولت الوصول إلى النتيجةUrl مباشرة ، فستحصل على خطأ 404. يجب عليك إلحاق ?api-version=2021-10-01 المسار لجعله قابلا للوصول إليه من خلال طلب مصادق عليه: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

استيراد مشروع

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة الاستيراد.
FILE-URI-PATH عند تصدير مشروع/قاعدة معارف برمجيا، ثم تحقق من الحالة التي يتم إنشاء تصدير a resultUrl كجزء من الاستجابة. على سبيل المثال: يمكنك استخدام resultUrl مع إصدار واجهة برمجة التطبيقات الملحق كملف مصدر لاستيراد مشروع من: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01.

نموذج استعلام

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "ImportJobOptions": {"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'

تؤدي Operation-Location المكالمة الناجحة لنشر مشروع إلى إرجاع رأس، والذي يمكن استخدامه للتحقق من حالة مهمة الاستيراد. في العديد من الأمثلة، لم نكن بحاجة إلى إلقاء نظرة على رؤوس الاستجابة، وبالتالي لم نعرضها. لاسترداد رؤوس الاستجابة ، يستخدم -iأمر curl الخاص بنا . بدون هذه المعلمة الإضافية قبل عنوان نقطة النهاية، ستظهر الاستجابة لهذا الأمر فارغة كما لو لم تحدث استجابة.

مثال على الاستجابة

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

التحقق من حالة الاستيراد

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة الاستيراد.
JOB-ID عند استيراد مشروع/قاعدة معارف برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب التصدير. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على استجابة الاستعلام

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

عمليات نشر القوائم

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع/قاعدة معارف الذي ترغب في إنشاء قائمة نشر له.

نموذج استعلام

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'

مثال على الاستجابة

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

قائمة المشاريع

استرجع قائمة بجميع مشاريع الإجابة على الأسئلة التي يمكن لحسابك الوصول إليها.

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.

نموذج استعلام

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'

مثال على الاستجابة

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

تحديث المصادر

في هذا المثال، سنضيف مصدرا جديدا إلى مشروع موجود. يمكنك أيضا استبدال المصادر الموجودة وحذفها باستخدام هذا الأمر استنادا إلى نوع العمليات التي تمررها كجزء من نص الاستعلام.

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع/قاعدة معارف المكان الذي ترغب في تحديث المصادر فيه.

نموذج استعلام

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'

تؤدي Operation-Location المكالمة الناجحة لتحديث مصدر إلى إرجاع رأس يمكن استخدامه للتحقق من حالة مهمة الاستيراد. في العديد من الأمثلة، لم نكن بحاجة إلى النظر إلى رؤوس الاستجابات، وبالتالي لم نكن نعرضها دائما. لاسترداد رؤوس الاستجابة ، يستخدم -iأمر curl الخاص بنا . بدون هذه المعلمة قبل عنوان نقطة النهاية، ستظهر الاستجابة لهذا الأمر فارغة كما لو لم تحدث استجابة.

مثال على الاستجابة

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

الحصول على حالة مصدر التحديث

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioالإجابة>على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة الاستيراد.
JOB-ID عند تحديث مصدر برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب مصدر التحديث. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على الاستجابة

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

تحديث أزواج الأسئلة والأجوبة

في هذا المثال، سنضيف زوج إجابات أسئلة إلى مصدر موجود. يمكنك أيضا تعديل أو حذف أزواج إجابات الأسئلة الموجودة مع هذا الاستعلام استنادا إلى العملية التي تمررها في نص الاستعلام. إذا لم يكن لديك مصدر مسمى source5، فسوف يفشل استعلام المثال هذا. يمكنك ضبط قيمة المصدر في نص الاستعلام إلى مصدر موجود للمشروع المستهدف.

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة الاستيراد. 
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'

تؤدي Operation-Location المكالمة الناجحة لتحديث زوج إجابات الأسئلة إلى إرجاع رأس يمكن استخدامه للتحقق من حالة مهمة التحديث. في العديد من الأمثلة، لم نكن بحاجة إلى النظر إلى رؤوس الاستجابات، وبالتالي لم نكن نعرضها دائما. لاسترداد رؤوس الاستجابة ، يستخدم -iأمر curl الخاص بنا . بدون هذه المعلمة قبل عنوان نقطة النهاية، ستظهر الاستجابة لهذا الأمر فارغة كما لو لم تحدث استجابة.

مثال على الاستجابة

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

الحصول على تحديث حالة أزواج إجابات الأسئلة

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة لإجابات السؤال يقرن التحديثات.
JOB-ID عند تحديث زوج إجابات سؤال برمجيا، يتم إنشاء a JOB-ID كجزء من operation-location رأس الاستجابة لطلب التحديث. ال JOB-ID هو المعرف الفريد العمومي في نهاية operation-location. على سبيل المثال:operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

نموذج استعلام

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'

مثال على الاستجابة

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

تحديث المرادفات

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في إضافة مرادفات.

نموذج استعلام

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'

مثال على الاستجابة

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

تحديث ملاحظات التعلم النشط

اسم المتغير القيمة
ENDPOINT يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. مثال على نقطة النهاية هو: https://southcentralus.api.cognitive.microsoft.com/. إذا كانت هذه هي نقطة النهاية في نموذج التعليمات البرمجية أدناه، فستحتاج فقط إلى إضافة جزء محدد من southcentral المنطقة لأن بقية مسار نقطة النهاية موجود بالفعل.
API-KEY يمكن العثور على هذه القيمة في قسم نقطة نهاية المفاتيح & عند فحص المورد الخاص بك من مدخل Azure. يمكنك استخدام Key1 أو Key2. يسمح وجود مفتاحين صالحين دائما بتدوير المفتاح الآمن بدون توقف. بدلا من ذلك، يمكنك العثور على القيمة في Language Studioإجابة> على الأسئلةنشر>قاعدة معارف>الحصول على عنوان URL للتنبؤ. القيمة الرئيسية هي جزء من طلب العينة.
PROJECT-NAME اسم المشروع / قاعدة معارف ترغب في أن تكون وجهة لتحديثات ملاحظات التعلم النشط.

نموذج استعلام

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'

مثال على الاستجابة

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