Knowledgebase - Create
Yeni bir bilgi tabanı oluşturmak için zaman uyumsuz işlem.
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
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). |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
name | True |
string |
Bilgi bankası için kolay ad. |
defaultAnswer |
string |
KB'de iyi bir eşleşme bulunamazsa varsayılan yanıt kullanıcıya gönderilir. |
|
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. |
|
enableHierarchicalExtraction |
boolean |
Dosyalardan ve URL'lerden Q-A'nın hiyerarşik ayıklamasını etkinleştirin. Bu alan yoksa False olarak kabul edilecek değer. |
|
enableMultipleLanguages |
boolean |
Aynı kaynak için farklı dillerde KB oluşturmayı etkinleştirmek için true olarak ayarlayın. |
|
files |
FileDTO[] |
Q-A'nın ayıklandığı dosyaların listesi. |
|
language |
string |
Bilgi bankasının dili. Desteklenen dillerin listesini burada bulabilirsiniz. |
|
qnaList |
QnADTO[] |
Bilgi bankasına eklenecek Q-A (QnADTO) listesi. Q-A Kimlikleri hizmet tarafından atanır ve atlanmalıdır. |
|
urls |
string[] |
Q-A ayıklamak için kullanılacak URL'lerin listesi. |
Yanıtlar
Name | Tür | Description |
---|---|---|
202 Accepted |
Zaman uyumsuz işlemin ayrıntıları. |
|
Other Status Codes |
Hata yanıtı. |
Güvenlik
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Örnekler
Successful query
Sample Request
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
{
"name": "QnA Maker FAQ",
"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": []
},
{
"id": 0,
"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": [
"How do I programmatically create a KB?"
],
"metadata": [
{
"name": "category",
"value": "api"
}
],
"context": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"displayText": "Update KB",
"qna": {
"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",
"questions": [
"How do I programmatically update my KB?"
],
"metadata": [
{
"name": "category",
"value": "api"
}
],
"context": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"displayText": "Refresh Endpoint Keys",
"qna": {
"answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
"questions": [
"How do I programmatically refresh endpoint keys?"
]
}
}
]
}
}
}
]
}
}
],
"urls": [
"https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
"https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-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"
}
]
}
Sample Response
{
"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 |
---|---|
Context |
Güncelleştirilecek Qna ile ilişkili bağlam. |
Create |
CreateKb işlemi için gövde şeması gönderme. |
Error |
Hata nesnesi. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Error |
Sunucu tanımlı hata kodları kümesinden biri. |
Error |
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. |
Inner |
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. |
MetadataDTO |
Ad - meta verilerin değer çifti. |
Operation |
Uzun süre çalışan işlemi izlemek için kaydedin. |
Operation |
İşlem durumu. |
PromptDTO |
Bir yanıt iste. |
Qna |
QnADTO - QnaId veya QnADTO bir PromptDTO nesnesinde mevcut olmalıdır |
QnADTO |
Q-A nesnesi. |
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 |
Qna'ya eklenecek istemlerin listesi. |
|
promptsToDelete |
integer[] |
Silinecek qna ile ilişkili istemlerin listesi |
CreateKbDTO
CreateKb işlemi için gövde şeması gönderme.
Name | Tür | Description |
---|---|---|
defaultAnswer |
string |
KB'de iyi bir eşleşme bulunamazsa varsayılan yanıt kullanıcıya gönderilir. |
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. |
enableHierarchicalExtraction |
boolean |
Dosyalardan ve URL'lerden Q-A'nın hiyerarşik ayıklamasını etkinleştirin. Bu alan yoksa False olarak kabul edilecek değer. |
enableMultipleLanguages |
boolean |
Aynı kaynak için farklı dillerde KB oluşturmayı etkinleştirmek için true olarak ayarlayın. |
files |
FileDTO[] |
Q-A'nın ayıklandığı dosyaların listesi. |
language |
string |
Bilgi bankasının dili. Desteklenen dillerin listesini burada bulabilirsiniz. |
name |
string |
Bilgi bankası için kolay ad. |
qnaList |
QnADTO[] |
Bilgi bankasına eklenecek Q-A (QnADTO) listesi. Q-A Kimlikleri hizmet tarafından atanır ve atlanmalıdır. |
urls |
string[] |
Q-A ayıklamak için kullanılacak URL'lerin 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 |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
Error[] |
Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı. |
innerError |
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 |
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 |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
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 |
Hata durumunda hata ayrıntıları. |
|
lastActionTimestamp |
string |
Geçerli durumun girildiği zaman damgası. |
operationId |
string |
İşlem Kimliği. |
operationState |
İş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 |
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 |
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 |
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 |
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 |
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 |