Share via

Knowledgebase - Create

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

Asynchrone bewerking voor het maken van een nieuwe knowledge base.

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

URI-parameters

Name In Vereist Type Description
Endpoint
 path True

string

Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).

Aanvraagkoptekst

Name Vereist Type Description
Ocp-Apim-Subscription-Key True

string

Aanvraagbody

Name Vereist Type Description
name True

string

Beschrijvende naam voor de knowledge base.
defaultAnswer

string

Standaardantwoord dat naar de gebruiker wordt verzonden als er geen goede overeenkomst is gevonden in de KB.
defaultAnswerUsedForExtraction

string

Teksttekenreeks die moet worden gebruikt als het antwoord in een Q-A die geen geëxtraheerd antwoord uit het document heeft, maar wel een hiërarchie heeft. Vereist wanneer het veld EnableHierarchicalExtraction is ingesteld op True.
enableHierarchicalExtraction

boolean

Schakel hiërarchische extractie van Q-A uit bestanden en URL's in. Waarde die als Onwaar moet worden beschouwd als dit veld niet aanwezig is.
enableMultipleLanguages

boolean

Stel in op true om het maken van KB's in verschillende talen voor dezelfde resource mogelijk te maken.
files

FileDTO[]

Lijst met bestanden waaruit Q-A moet worden geëxtraheerd.
language

string

Taal van de knowledge base. Hier vindt u de lijst met ondersteunde talen.
qnaList

QnADTO[]

Lijst met Q-A (QnADTO) die moet worden toegevoegd aan de Knowledge Base. Q-A-id's worden toegewezen door de service en moeten worden weggelaten.
urls

string[]

Lijst met URL's die moeten worden gebruikt voor het extraheren van Q-A.

Antwoorden

Name Type Description
202 Accepted

Operation

Details van de asynchrone bewerking.
Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

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

Definities

Name Description
Context

Context die is gekoppeld aan Qna die moet worden bijgewerkt.
CreateKbDTO

Post-hoofdtekstschema voor de bewerking CreateKb.
Error

Het foutobject. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType

Een van een door de server gedefinieerde set foutcodes.
ErrorResponse

Foutreactie. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO

DTO voor het opslaan van details van geüploade bestanden.
InnerErrorModel

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO

Naam: waardepaar van metagegevens.
Operation

Neem op om langdurige bewerkingen bij te houden.
OperationStateType

Bewerkingsstatus.
PromptDTO

Vragen om een antwoord.
Qna

QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
QnADTO

Q-A-object.

Context

Context die is gekoppeld aan Qna die moet worden bijgewerkt.

Name Type Description
isContextOnly

boolean

Markeren of een prompt alleen relevant is voor een eerdere vraag of niet. true- Neem deze QnA niet op als zoekresultaat voor query's zonder context false - negeert context en neemt deze QnA op in het zoekresultaat
promptsToAdd

PromptDTO[]

Lijst met prompts die moeten worden toegevoegd aan de qna.
promptsToDelete

integer[]

Lijst met prompts die zijn gekoppeld aan qna die moeten worden verwijderd

CreateKbDTO

Post-hoofdtekstschema voor de bewerking CreateKb.

Name Type Description
defaultAnswer

string

Standaardantwoord dat naar de gebruiker wordt verzonden als er geen goede overeenkomst is gevonden in de KB.
defaultAnswerUsedForExtraction

string

Teksttekenreeks die moet worden gebruikt als het antwoord in een Q-A die geen geëxtraheerd antwoord uit het document heeft, maar wel een hiërarchie heeft. Vereist wanneer het veld EnableHierarchicalExtraction is ingesteld op True.
enableHierarchicalExtraction

boolean

Schakel hiërarchische extractie van Q-A uit bestanden en URL's in. Waarde die als Onwaar moet worden beschouwd als dit veld niet aanwezig is.
enableMultipleLanguages

boolean

Stel in op true om het maken van KB's in verschillende talen voor dezelfde resource mogelijk te maken.
files

FileDTO[]

Lijst met bestanden waaruit Q-A moet worden geëxtraheerd.
language

string

Taal van de knowledge base. Hier vindt u de lijst met ondersteunde talen.
name

string

Beschrijvende naam voor de knowledge base.
qnaList

QnADTO[]

Lijst met Q-A (QnADTO) die moet worden toegevoegd aan de Knowledge Base. Q-A-id's worden toegewezen door de service en moeten worden weggelaten.
urls

string[]

Lijst met URL's die moeten worden gebruikt voor het extraheren van Q-A.

Error

Het foutobject. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

ErrorCodeType

Een van een door de server gedefinieerde set foutcodes.
details

Error[]

Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innerError

InnerErrorModel

Een object met specifiekere informatie dan het huidige object over de fout.
message

string

Een door mensen leesbare weergave van de fout.
target

string

Het doel van de fout.

ErrorCodeType

Een van een door de server gedefinieerde set foutcodes.

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

Foutreactie. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
error

Error

Het foutobject.

FileDTO

DTO voor het opslaan van details van geüploade bestanden.

Name Type Description
fileName

string

Bestandsnaam. Ondersteunde bestandstypen zijn '.tsv', '.pdf', '.txt', '.docx', '.xlsx'.
fileUri

string

Openbare URI van het bestand.
isUnstructured

boolean

Optionele vlag om op te geven of het opgegeven bestand ongestructureerd is.

InnerErrorModel

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

Een specifiekere foutcode dan is opgegeven door de betreffende fout.
innerError

InnerErrorModel

Een object met specifiekere informatie dan het huidige object over de fout.

MetadataDTO

Naam: waardepaar van metagegevens.

Name Type Description
name

string

Naam van metagegevens.
value

string

Metagegevenswaarde.

Operation

Neem op om langdurige bewerkingen bij te houden.

Name Type Description
createdTimestamp

string

Tijdstempel toen de bewerking is gemaakt.
errorResponse

ErrorResponse

Foutdetails in het geval van fouten.
lastActionTimestamp

string

Tijdstempel wanneer de huidige status is ingevoerd.
operationId

string

Bewerkings-id.
operationState

OperationStateType

Bewerkingsstatus.
resourceLocation

string

Relatieve URI aan de doelresourcelocatie voor voltooide resources.
userId

string

Gebruikersnaam

OperationStateType

Bewerkingsstatus.

Name Type Description
Failed

string

NotStarted

string

Running

string

Succeeded

string

PromptDTO

Vragen om een antwoord.

Name Type Description
displayOrder

integer

Index van de prompt - gebruikt in de volgorde van de prompts
displayText

string

Tekst die wordt weergegeven om een vervolgvraagprompt weer te geven
qna

Qna

QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
qnaId

integer

Qna-id die overeenkomt met de prompt: als QnaId aanwezig is, wordt het QnADTO-object genegeerd.

Qna

QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object

Name Type Description
answer

string

Sms beantwoorden
context

Context

Context van een QnA
id

integer

Unieke id voor de Q-A.
lastUpdatedTimestamp

string

Tijdstempel wanneer de QnA voor het laatst is bijgewerkt.
metadata

MetadataDTO[]

Lijst met metagegevens die zijn gekoppeld aan het antwoord.
questions

string[]

Lijst met vragen die zijn gekoppeld aan het antwoord.
source

string

Bron van waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A-object.

Name Type Description
answer

string

Sms beantwoorden
context

Context

Context van een QnA
id

integer

Unieke id voor de Q-A.
lastUpdatedTimestamp

string

Tijdstempel wanneer de QnA voor het laatst is bijgewerkt.
metadata

MetadataDTO[]

Lijst met metagegevens die zijn gekoppeld aan het antwoord.
questions

string[]

Lijst met vragen die zijn gekoppeld aan het antwoord.
source

string

Bron van waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs