Knowledgebase - Download

Referentie

Service:: Azure AI Services

API-versie:: v5.0-preview.2

Download de knowledgebase.

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}/{environment}/qna

Met optionele parameters:

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}/{environment}/qna?source={source}&changedSince={changedSince}

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
environment	path	True	EnvironmentType	Hiermee geeft u op of de omgeving Test of Prod is.
kbId	path	True	string	Knowledgebase-id.
changedSince	query		string	Het laatst gewijzigde statuseigenschapsfilter dat moet worden toegepast.
source	query		string	Het broneigenschapsfilter dat moet worden toegepast.

Aanvraagkoptekst

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

Antwoorden

Name	Type	Description
200 OK	QnADocumentsDTO	Verzameling van alle Q-A in de knowledgebase.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/Test/qna

Voorbeeldrespons

Statuscode:: 200

{
  "qnaDocuments": [
    {
      "id": 1,
      "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": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "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": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 3,
            "displayText": "Update KB"
          }
        ]
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "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": "Editorial",
      "questions": [
        "How do I programmatically update my KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 4,
            "displayText": "Refresh Endpoint Keys"
          }
        ]
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "id": 4,
      "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",
      "source": "Editorial",
      "questions": [
        "How do I programmatically refresh endpoint keys?"
      ],
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    }
  ]
}

Definities

Name	Description
Context	Context die is gekoppeld aan Qna die moet worden bijgewerkt.
EnvironmentType	Hiermee geeft u op of de omgeving Test of Prod is.
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.
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.
PromptDTO	Vraag om een antwoord.
Qna	QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
QnADocumentsDTO	Lijst met QnADTO
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

EnvironmentType

Inventarisatie

Hiermee geeft u op of de omgeving Test of Prod is.

Waarde	Description
Prod
Test

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.

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.

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

QnADocumentsDTO

Object

Lijst met QnADTO

Name	Type	Description
qnaDocuments	QnADTO[]	Lijst met antwoorden.

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

Delen via

Knowledgebase - Download

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Successful query

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Context

EnvironmentType

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnADocumentsDTO

QnADTO

Aanvullende resources