Question Answering Projects - Update Qnas

Başvuru

Service:: Cognitive Services

API Version:: 2021-10-01

Projenin Soru-Cevaplarını Güncelleştirmeler.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktası (ör. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Kullanılacak projenin adı.
api-version	query	True	string	İstemci API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Ocp-Apim-Subscription-Key	True	string

İstek Gövdesi

Name	Tür	Description
body	UpdateQnaRecord[]	Projenin Soru-Cevap parametrelerini güncelleştirin.

Yanıtlar

Name	Tür	Description
202 Accepted		başarılı bir çağrı, işin durumunu denetlemek için kullanılan bir Operation-Location üst bilgisi ile sonuçlanır. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Hata yanıtı.

Name

Tür

Description

202 Accepted

başarılı bir çağrı, işin durumunu denetlemek için kullanılan bir Operation-Location üst bilgisi ile sonuçlanır.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Örnekler

Successful query

Sample Request

HTTP

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-01


[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

Sample Response

Status code:: 202

Operation-Location: job1

Tanımlar

Name	Description
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilir hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilir hata kodu.
InnerErrorModel	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	Soru-Cevap Kaydı ile ilişkili iletişim kutusu.
QnaPrompt	Bir yanıt iste.
QnaRecord	Soru-Cevap kaydı.
SuggestedQuestion	Etkin Öğrenme özelliği tarafından önerilen soru.
SuggestedQuestionsCluster	Active Learning ile ilgili önerilen sorular küme ayrıntıları.
updateOperationKind	Varlıklar için güncelleştirme işlemi türü.
UpdateQnaRecord	Güncelleştirilecek Soru-Cevap kaydı.

Error

Hata nesnesi.

Name	Tür	Description
code	ErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

İnsan tarafından okunabilir hata kodu.

Name	Tür	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

InnerErrorCode

İnsan tarafından okunabilir hata kodu.

Name	Tür	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	InnerErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	object	Hata ayrıntıları.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hata iletisi.
target	string	Hata hedefi.

QnaDialog

Soru-Cevap Kaydı ile ilişkili iletişim kutusu.

Name	Tür	Description
isContextOnly	boolean	Bir istemin yalnızca önceki bir soruyla ilgili olup olmadığını işaretlemek için. Doğruysa, bağlamı olmayan sorgular için yanıt olarak bu Soru-Cevap'ı eklemeyin; aksi takdirde bağlamı yoksayar ve yanıtlarda bu Soru-Cevap'ı içerir.
prompts	QnaPrompt[]	Yanıtla ilişkili istemlerin listesi.

QnaPrompt

Bir yanıt iste.

Name	Tür	Description
displayOrder	integer	İstem dizini. İstemleri sıralamak için kullanılır.
displayText	string	İzleme sorusu istemini temsil etmek için görüntülenen metin.
qna	QnaRecord	Soru-Cevap kaydı. Soru-Cevap veya Soru-Cevap kaydının bir İstemde mevcut olması gerekir.
qnaId	integer	soru işaretine karşılık gelen Soru-Cevap kimliği.

QnaRecord

Soru-Cevap kaydı.

Name	Tür	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Soru-Cevap için Etkin Öğrenme önerilerinin listesi.
answer	string	Yanıt metni.
dialog	QnaDialog	Soru-Cevap bağlamı.
id	integer	Soru-Cevap için benzersiz kimlik.
metadata	object	Yanıtla ilişkili meta veriler; soru yanıtlarını kategorilere ayırmak veya filtrelemek için kullanışlıdır.
questions	string[]	Yanıtla ilişkili soruların listesi.
source	string	Soru-Cevap'ın dizine alındığı kaynak; örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

SuggestedQuestion

Etkin Öğrenme özelliği tarafından önerilen soru.

Name	Tür	Description
autoSuggestedCount	integer	Sorunun Active Learning algoritması tarafından otomatik olarak önerildiği sayıdır.
question	string	Etkin Öğrenme özelliği tarafından önerilen soru.
userSuggestedCount	integer	Sorunun kullanıcı tarafından açıkça önerildiği sayıdır.

SuggestedQuestionsCluster

Active Learning ile ilgili önerilen sorular küme ayrıntıları.

Name	Tür	Description
clusterHead	string	Active Learning kümeleme algoritması tarafından önerilen sorular kümesinin başı olarak seçilen soru.
suggestedQuestions	SuggestedQuestion[]	Soru-Cevap için önerilen tüm soruların listesi.

updateOperationKind

Varlıklar için güncelleştirme işlemi türü.

Name	Tür	Description
add	string
delete	string
replace	string

UpdateQnaRecord

Güncelleştirilecek Soru-Cevap kaydı.

Name	Tür	Description
op	updateOperationKind	Varlıklar için güncelleştirme işlemi türü.
value	QnaRecord	Soru-Cevap kaydı.

Aracılığıyla paylaş

Question Answering Projects - Update Qnas

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

Örnekler

Successful query

Sample Request

Sample Response

Tanımlar

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord

Ek kaynaklar