Knowledgebase - Create

  • Referens
Service:
Cognitive Services - QnA Maker
API Version:
v5.0-preview.2

Asynkron åtgärd för att skapa en ny kunskapsbas.

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create

URI-parametrar

Name I Obligatorisk Typ Description
Endpoint
 path True

string

Cognitive Services-slutpunkt som stöds (t.ex. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).

Begärandehuvud

Name Obligatorisk Typ Description
Ocp-Apim-Subscription-Key True

string

Begärandetext

Name Obligatorisk Typ Description
name True

string

Eget namn för kunskapsbasen.
defaultAnswer

string

Standardsvaret skickas till användaren om ingen bra matchning hittas i kb.
defaultAnswerUsedForExtraction

string

Textsträng som ska användas som svar i valfri Q-A som inte har något extraherat svar från dokumentet men som har en hierarki. Krävs när fältet EnableHierarchicalExtraction är inställt på Sant.
enableHierarchicalExtraction

boolean

Aktivera hierarkisk extrahering av Q-A från filer och URL:ar. Värde som ska betraktas som Falskt om det här fältet inte finns.
enableMultipleLanguages

boolean

Ställ in på sant för att aktivera skapande av KB:er på olika språk för samma resurs.
files

FileDTO[]

Lista över filer som Q-A ska extraheras från.
language

string

Kunskapsbasens språk. Här hittar du listan över språk som stöds.
qnaList

QnADTO[]

Lista över Q-A (QnADTO) som ska läggas till i kunskapsbasen. Q-A-ID:n tilldelas av tjänsten och bör utelämnas.
urls

string[]

Lista över URL:er som ska användas för att extrahera Q-A.

Svar

Name Typ Description
202 Accepted

Operation

Information om den asynkrona åtgärden.
Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

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

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

Definitioner

Name Description
Context

Kontext som är associerad med Qna som ska uppdateras.
CreateKbDTO

Publicera brödtextschema för åtgärden CreateKb.
Error

Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType

En av en serverdefinierad uppsättning felkoder.
ErrorResponse

Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO

DTO för att lagra information om uppladdade filer.
InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO

Namn – värdepar med metadata.
Operation

Registrera för att spåra långvariga åtgärder.
OperationStateType

Åtgärdstillstånd.
PromptDTO

Fråga efter ett svar.
Qna

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
QnADTO

Q-A-objekt.

Context

Kontext som är associerad med Qna som ska uppdateras.

Name Typ Description
isContextOnly

boolean

Markera om en fråga endast är relevant med en tidigare fråga eller inte. true – Inkludera inte denna QnA som sökresultat för frågor utan kontext falskt – ignorerar kontexten och inkluderar denna QnA i sökresultatet
promptsToAdd

PromptDTO[]

Lista över uppmaningar som ska läggas till i qna.
promptsToDelete

integer[]

Lista över frågor som är associerade med qna som ska tas bort

CreateKbDTO

Publicera brödtextschema för åtgärden CreateKb.

Name Typ Description
defaultAnswer

string

Standardsvaret skickas till användaren om ingen bra matchning hittas i kb.
defaultAnswerUsedForExtraction

string

Textsträng som ska användas som svar i valfri Q-A som inte har något extraherat svar från dokumentet men som har en hierarki. Krävs när fältet EnableHierarchicalExtraction är inställt på Sant.
enableHierarchicalExtraction

boolean

Aktivera hierarkisk extrahering av Q-A från filer och URL:ar. Värde som ska betraktas som Falskt om det här fältet inte finns.
enableMultipleLanguages

boolean

Ställ in på sant för att aktivera skapande av KB:er på olika språk för samma resurs.
files

FileDTO[]

Lista över filer som Q-A ska extraheras från.
language

string

Kunskapsbasens språk. Här hittar du listan över språk som stöds.
name

string

Eget namn för kunskapsbasen.
qnaList

QnADTO[]

Lista över Q-A (QnADTO) som ska läggas till i kunskapsbasen. Q-A-ID:n tilldelas av tjänsten och bör utelämnas.
urls

string[]

Lista över URL:er som ska användas för att extrahera Q-A.

Error

Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

ErrorCodeType

En av en serverdefinierad uppsättning felkoder.
details

Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.
innerError

InnerErrorModel

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

En läsbar återgivning av felet.
target

string

Målet för felet.

ErrorCodeType

En av en serverdefinierad uppsättning felkoder.

Name Typ 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

Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
error

Error

Felobjektet.

FileDTO

DTO för att lagra information om uppladdade filer.

Name Typ Description
fileName

string

Filnamn. Filtyper som stöds är ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri

string

Offentlig URI för filen.
isUnstructured

boolean

Valfri flagga för att ange om den angivna filen är ostrukturerad.

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.
innerError

InnerErrorModel

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

MetadataDTO

Namn – värdepar med metadata.

Name Typ Description
name

string

Metadatanamn.
value

string

Metadatavärde.

Operation

Registrera för att spåra långvariga åtgärder.

Name Typ Description
createdTimestamp

string

Tidsstämpel när åtgärden skapades.
errorResponse

ErrorResponse

Felinformation vid fel.
lastActionTimestamp

string

Tidsstämpel när det aktuella tillståndet angavs.
operationId

string

Åtgärds-ID.
operationState

OperationStateType

Åtgärdstillstånd.
resourceLocation

string

Relativ URI till målresursplatsen för slutförda resurser.
userId

string

Användar-ID

OperationStateType

Åtgärdstillstånd.

Name Typ Description
Failed

string

NotStarted

string

Running

string

Succeeded

string

PromptDTO

Fråga efter ett svar.

Name Typ Description
displayOrder

integer

Index för prompten – används i ordning för prompterna
displayText

string

Text som visas för att representera en fråga om uppföljning
qna

Qna

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
qnaId

integer

Qna-ID som motsvarar prompten – om QnaId finns ignoreras QnADTO-objektet.

Qna

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt

Name Typ Description
answer

string

Svara på sms
context

Context

Kontext för en QnA
id

integer

Unikt ID för Q-A.
lastUpdatedTimestamp

string

Tidsstämpel när QnA senast uppdaterades.
metadata

MetadataDTO[]

Lista över metadata som är associerade med svaret.
questions

string[]

Lista över frågor som är associerade med svaret.
source

string

Källa från vilken Q-A indexerades. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A-objekt.

Name Typ Description
answer

string

Svara på sms
context

Context

Kontext för en QnA
id

integer

Unikt ID för Q-A.
lastUpdatedTimestamp

string

Tidsstämpel när QnA senast uppdaterades.
metadata

MetadataDTO[]

Lista över metadata som är associerade med svaret.
questions

string[]

Lista över frågor som är associerade med svaret.
source

string

Källa från vilken Q-A indexerades. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs