Knowledgebase - Update

Başvuru

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Bir bilgi bankasını değiştirmek için zaman uyumsuz işlem.

PATCH {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktası (örn. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Bilgi Bankası kimliği.

İstek Başlığı

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

İstek Gövdesi

Name	Tür	Description
add	Add	Ekleme işlemi için CreateKbInputDTO örneği
defaultAnswerUsedForExtraction	string	Belgeden ayıklanmış yanıtı olmayan ancak hiyerarşisi olan herhangi bir Q-A'da yanıt olarak kullanılacak metin dizesi. EnableHierarchicalExtraction alanı True olarak ayarlandığında gereklidir.
delete	Delete	Silme İşlemi için bir DeleteKbContentsDTO örneği
enableHierarchicalExtraction	boolean	Dosyalardan ve URL'lerden Q-A'nın hiyerarşik ayıklamasını etkinleştirin. Bu alan yoksa, KB oluşturma sırasında ayarlanan değer kullanılır.
update	Update	Güncelleştirme İşlemi için UpdateKbContentsDTO örneği

Yanıtlar

Name	Tür	Description
202 Accepted	Operation	Zaman uyumsuz işlemin ayrıntıları. Headers Location: string
Other Status Codes	ErrorResponse	Hata yanıtı.

Name

Tür

Description

202 Accepted

Operation

Zaman uyumsuz işlemin ayrıntıları.

Headers

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}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


{
  "add": {
    "qnaList": [
      {
        "id": 0,
        "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
        "source": "Custom Editorial",
        "questions": [
          "How can I change the default message from QnA Maker?"
        ],
        "metadata": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
    ],
    "files": [
      {
        "fileName": "SurfaceManual.pdf",
        "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "id": 2,
        "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "id": 3,
        "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

Sample Response

Status code:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Tanımlar

Name	Description
Add	Ekleme işlemi için CreateKbInputDTO örneği
Context	Güncelleştirilecek Qna ile ilişkili bağlam.
Delete	Silme İşlemi için bir DeleteKbContentsDTO örneği
Error	Hata nesnesi. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Sunucu tanımlı hata kodları kümesinden biri.
ErrorResponse	Hata yanıtı. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	Karşıya yüklenen dosyaların ayrıntılarını tutmak için DTO.
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.
Metadata	Güncelleştirilecek yanıtla ilişkilendirilmiş meta verilerin listesi
MetadataDTO	Ad - meta verilerin değer çifti.
Operation	Uzun süre çalışan işlemi izlemek için kaydedin.
OperationStateType	İşlem durumu.
PromptDTO	Bir yanıt iste.
Qna	QnADTO - QnaId veya QnADTO bir PromptDTO nesnesinde mevcut olmalıdır
QnADTO	Q-A nesnesi.
Questions	Yanıtla ilişkili soruların listesi.
Update	Güncelleştirme İşlemi için UpdateKbContentsDTO örneği
UpdateKbOperationDTO	Güncelleştirilecek Soru-Cevap listesini içerir
UpdateQnaDTO	Güncelleştirme Soru-Cevap Listesi için PATCH Gövde şeması

Add

Ekleme işlemi için CreateKbInputDTO örneği

Name	Tür	Description
files	FileDTO[]	Bilgi bankasına eklenecek dosyaların listesi.
qnaList	QnADTO[]	Dizine eklenecek QNA listesi. Kimlikler hizmet tarafından oluşturulur ve atlanmalıdır.
urls	string[]	Bilgi bankasına eklenecek URL'lerin listesi.

Context

Güncelleştirilecek Qna ile ilişkili bağlam.

Name	Tür	Description
isContextOnly	boolean	Bir istemin yalnızca önceki bir soruyla ilgili olup olmadığını işaretlemek için. true - Bu Soru-Cevap'ı bağlam false olmayan sorgular için arama sonucu olarak eklemeyin; bağlamı yoksayar ve bu Soru-Cevap'ı arama sonucuna ekler
promptsToAdd	PromptDTO[]	Qna'ya eklenecek istemlerin listesi.
promptsToDelete	integer[]	Silinecek qna ile ilişkili istemlerin listesi

Delete

Silme İşlemi için bir DeleteKbContentsDTO örneği

Name	Tür	Description
ids	integer[]	Silinecek Soru-Cevap Kimliklerinin listesi
sources	string[]	Bilgi bankasından silinecek kaynakların listesi.

Error

Hata nesnesi. 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	ErrorCodeType	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.

ErrorCodeType

Sunucu tanımlı hata kodları kümesinden biri.

Name	Tür	Description
BadArgument	string
EndpointKeysError	string
ExtractionFailure	string
Forbidden	string
KbNotFound	string
NotFound	string
OperationNotFound	string
QnaRuntimeError	string
QuotaExceeded	string
SKULimitExceeded	string
ServiceError	string
Unauthorized	string
Unspecified	string
ValidationFailure	string

ErrorResponse

Hata yanıtı. 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
error	Error	Hata nesnesi.

FileDTO

Karşıya yüklenen dosyaların ayrıntılarını tutmak için DTO.

Name	Tür	Description
fileName	string	Dosya adı. Desteklenen dosya türleri şunlardır: ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	Dosyanın genel URI'sini seçin.
isUnstructured	boolean	Verilen dosyanın Yapılandırılmamış olup olmadığını belirtmek için İsteğe Bağlı Bayrak.

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	string	İçeren hata tarafından sağlanandan daha özel bir hata kodu.
innerError	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.

Metadata

Güncelleştirilecek yanıtla ilişkilendirilmiş meta verilerin listesi

Name	Tür	Description
add	MetadataDTO[]	Eklenecek yanıtla ilişkilendirilmiş meta verilerin listesi
delete	MetadataDTO[]	Silinecek yanıtla ilişkilendirilmiş Meta Veriler listesi

MetadataDTO

Ad - meta verilerin değer çifti.

Name	Tür	Description
name	string	Meta veri adı.
value	string	Meta veri değeri.

Operation

Uzun süre çalışan işlemi izlemek için kaydedin.

Name	Tür	Description
createdTimestamp	string	İşlemin oluşturulduğu zaman damgası.
errorResponse	ErrorResponse	Hata durumunda hata ayrıntıları.
lastActionTimestamp	string	Geçerli durumun girildiği zaman damgası.
operationId	string	İşlem Kimliği.
operationState	OperationStateType	İşlem durumu.
resourceLocation	string	Tamamlanan kaynaklar için hedef kaynak konumuna göreli URI.
userId	string	Kullanıcı Kimliği

OperationStateType

İşlem durumu.

Name	Tür	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

Bir yanıt iste.

Name	Tür	Description
displayOrder	integer	İstem dizini - istemlerin sırasına göre kullanılır
displayText	string	İzleme soru istemini temsil etmek için görüntülenen metin
qna	Qna	QnADTO - QnaId veya QnADTO bir PromptDTO nesnesinde mevcut olmalıdır
qnaId	integer	istemine karşılık gelen Qna kimliği - QnaId varsa, QnADTO nesnesi yoksayılır.

Qna

QnADTO - QnaId veya QnADTO bir PromptDTO nesnesinde mevcut olmalıdır

Name	Tür	Description
answer	string	Kısa mesajı yanıtlama
context	Context	Soru-Cevap Bağlamı
id	integer	Soru-Cevap için benzersiz kimlik.
lastUpdatedTimestamp	string	Soru-Cevap'ın son güncelleştirildiği zaman damgası.
metadata	MetadataDTO[]	Yanıtla ilişkilendirilmiş meta verilerin listesi.
questions	string[]	Yanıtla ilişkili soruların listesi.
source	string	Q-A'nın dizinlendiği kaynak. Örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A nesnesi.

Name	Tür	Description
answer	string	Kısa mesajı yanıtlama
context	Context	Soru-Cevap Bağlamı
id	integer	Soru-Cevap için benzersiz kimlik.
lastUpdatedTimestamp	string	Soru-Cevap'ın son güncelleştirildiği zaman damgası.
metadata	MetadataDTO[]	Yanıtla ilişkilendirilmiş meta verilerin listesi.
questions	string[]	Yanıtla ilişkili soruların listesi.
source	string	Q-A'nın dizinlendiği kaynak. Örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Yanıtla ilişkili soruların listesi.

Name	Tür	Description
add	string[]	Eklenecek soruların listesi
delete	string[]	Silinecek soruların listesi.

Update

Güncelleştirme İşlemi için UpdateKbContentsDTO örneği

Name	Tür	Description
defaultAnswer	string	KB'de iyi bir eşleşme bulunamazsa varsayılan yanıt kullanıcıya gönderilir.
name	string	Bilgi bankası için kolay ad.
qnaList	UpdateQnaDTO[]	Bilgi bankasına eklenecek Q-A (UpdateQnaDTO) listesi.
urls	string[]	Yenilenecek mevcut URL'lerin listesi. İçerik yeniden ayıklanır ve yeniden dizinlenir.

UpdateKbOperationDTO

Güncelleştirilecek Soru-Cevap listesini içerir

Name	Tür	Description
add	Add	Ekleme işlemi için CreateKbInputDTO örneği
defaultAnswerUsedForExtraction	string	Belgeden ayıklanmış yanıtı olmayan ancak hiyerarşisi olan herhangi bir Q-A'da yanıt olarak kullanılacak metin dizesi. EnableHierarchicalExtraction alanı True olarak ayarlandığında gereklidir.
delete	Delete	Silme İşlemi için bir DeleteKbContentsDTO örneği
enableHierarchicalExtraction	boolean	Dosyalardan ve URL'lerden Q-A'nın hiyerarşik ayıklamasını etkinleştirin. Bu alan yoksa, KB oluşturma sırasında ayarlanan değer kullanılır.
update	Update	Güncelleştirme İşlemi için UpdateKbContentsDTO örneği

UpdateQnaDTO

Güncelleştirme Soru-Cevap Listesi için PATCH Gövde şeması

Name	Tür	Description
answer	string	Kısa mesajı yanıtlama
context	Context	Güncelleştirilecek Qna ile ilişkili bağlam.
id	integer	Soru-Cevap için benzersiz kimlik
metadata	Metadata	Güncelleştirilecek yanıtla ilişkilendirilmiş meta verilerin listesi
questions	Questions	Yanıtla ilişkili soruların listesi.
source	string	Q-A'nın dizinlendiği kaynak. Örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Knowledgebase - Update

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

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Ek kaynaklar