Delen via

Knowledgebase - Create

  • Referentie
Service:
Azure AI Services
API-versie:
v5.0-preview.2

Asynchrone bewerking voor het maken van een nieuwe knowledgebase.

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

minLength: 1
maxLength: 100

Beschrijvende naam voor de knowledgebase.
defaultAnswer

string

minLength: 1
maxLength: 300

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

string

minLength: 1
maxLength: 300

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

boolean

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

boolean

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

FileDTO[]

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

string

minLength: 1
maxLength: 100

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

QnADTO[]

Lijst met Q-A (QnADTO) die moet worden toegevoegd aan de knowledgebase. 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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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

Het 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 meer specifieke 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 met metagegevens.
Operation

Record voor het bijhouden van langdurige bewerkingen.
OperationStateType

Bewerkingsstatus.
PromptDTO

Vraag om een antwoord.
Qna

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

Q-A-object.

Context

Object

Context die is gekoppeld aan Qna die moet worden bijgewerkt.

Name Type Description
isContextOnly

boolean

Als u wilt markeren of een prompt alleen relevant is voor een vorige vraag of niet. true - Neem deze QnA niet op als zoekresultaat voor query's zonder context false - negeert context en bevat deze QnA in het zoekresultaat
promptsToAdd

PromptDTO[]

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

integer[] (int32)

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

CreateKbDTO

Object

Het hoofdtekstschema voor de bewerking CreateKb.

Name Type Description
defaultAnswer

string

minLength: 1
maxLength: 300

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

string

minLength: 1
maxLength: 300

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

boolean

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

boolean

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

FileDTO[]

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

string

minLength: 1
maxLength: 100

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

string

minLength: 1
maxLength: 100

Beschrijvende naam voor de knowledgebase.
qnaList

QnADTO[]

Lijst met Q-A (QnADTO) die moet worden toegevoegd aan de knowledgebase. 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

Object

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 hebben geleid tot deze gemelde fout.
innerError

InnerErrorModel

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

string

Een leesbare weergave van de fout.
target

string

Het doel van de fout.

ErrorCodeType

Inventarisatie

Een van een door de server gedefinieerde set foutcodes.

Waarde Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

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

Object

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

Name Type Description
fileName

string

minLength: 1
maxLength: 200

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

Object

Een object met meer specifieke 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 bijbehorende fout.
innerError

InnerErrorModel

Een object met meer specifieke informatie dan het huidige object over de fout.

MetadataDTO

Object

Naam: waardepaar met metagegevens.

Name Type Description
name

string

minLength: 1
maxLength: 100

Naam van metagegevens.
value

string

minLength: 1
maxLength: 500

Metagegevenswaarde.

Operation

Object

Record voor het bijhouden van langdurige bewerkingen.

Name Type Description
createdTimestamp

string

Tijdstempel toen de bewerking werd gemaakt.
errorResponse

ErrorResponse

Foutdetails in geval van fouten.
lastActionTimestamp

string

Tijdstempel toen de huidige status werd ingevoerd.
operationId

string

Bewerkings-id.
operationState

OperationStateType

Bewerkingsstatus.
resourceLocation

string

Relatieve URI naar de doelresourcelocatie voor voltooide resources.
userId

string

Gebruikers-ID

OperationStateType

Inventarisatie

Bewerkingsstatus.

Waarde Description
Failed
NotStarted
Running
Succeeded

PromptDTO

Object

Vraag om een antwoord.

Name Type Description
displayOrder

integer (int32)

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

string

maxLength: 200

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 (int32)

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

Qna

Object

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

Name Type Description
answer

string

minLength: 1
maxLength: 25000

Antwoordtekst
context

Context

Context van een QnA
id

integer (int32)

Unieke id voor de Q-A.
lastUpdatedTimestamp

string

maxLength: 300

Tijdstempel waarop de QnA voor het laatst is bijgewerkt.
metadata

MetadataDTO[]

Lijst met metagegevens die aan het antwoord zijn gekoppeld.
questions

string[]

Lijst met vragen die aan het antwoord zijn gekoppeld.
source

string

maxLength: 300

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

QnADTO

Object

Q-A-object.

Name Type Description
answer

string

minLength: 1
maxLength: 25000

Antwoordtekst
context

Context

Context van een QnA
id

integer (int32)

Unieke id voor de Q-A.
lastUpdatedTimestamp

string

maxLength: 300

Tijdstempel waarop de QnA voor het laatst is bijgewerkt.
metadata

MetadataDTO[]

Lijst met metagegevens die aan het antwoord zijn gekoppeld.
questions

string[]

Lijst met vragen die aan het antwoord zijn gekoppeld.
source

string

maxLength: 300

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