Knowledgebase - Download

  • Odwołanie
Service:
Cognitive Services - QnA Maker
API Version:
v5.0-preview.1

Pobierz bazę wiedzy.

GET {Endpoint}/qnamaker/v5.0-preview.1/knowledgebases/{kbId}/{environment}/qna
With optional parameters: 
GET {Endpoint}/qnamaker/v5.0-preview.1/knowledgebases/{kbId}/{environment}/qna?source={source}&changedSince={changedSince}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
Endpoint
 path True

string

Obsługiwany punkt końcowy usług Cognitive Services (np. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
environment
 path True

EnvironmentType

Określa, czy środowisko jest testowe, czy prod.
kbId
 path True

string

Identyfikator bazy wiedzy.
changedSince
 query

string

Ostatnio zmieniony filtr właściwości stanu do zastosowania.
source
 query

string

Filtr właściwości źródłowej do zastosowania.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Ocp-Apim-Subscription-Key True

string

Odpowiedzi

Nazwa Typ Opis
200 OK

QnADocumentsDTO

Kolekcja wszystkich pytań i pytań w bazie wiedzy.
Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Przykłady

Successful query

Sample Request

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

Sample Response

Status code:
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"
    }
  ]
}

Definicje

Nazwa Opis
Context

Kontekst skojarzony z usługą Qna do zaktualizowania.
EnvironmentType

Określa, czy środowisko jest testowe, czy prod.
Error

Obiekt error. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
ErrorResponse

Odpowiedź na błąd. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO

Name — para wartości metadanych.
PromptDTO

Monituj o odpowiedź.
Qna

QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
QnADocumentsDTO

Lista funkcji QnADTO
QnADTO

Obiekt Q-A.

Context

Kontekst skojarzony z usługą Qna do zaktualizowania.

Nazwa Typ Opis
isContextOnly

boolean

Aby zaznaczyć, czy monit ma zastosowanie tylko z poprzednim pytaniem, czy nie. true — nie dołączaj tej pytań i odpowiedzi jako wyników wyszukiwania dla zapytań bez wartości false kontekstu — ignoruje kontekst i dołącza tę funkcję pytań i odpowiedzi w wynikach wyszukiwania
promptsToAdd

PromptDTO[]

Lista monitów do dodania do qna.
promptsToDelete

integer[]

Lista monitów skojarzonych z funkcją qna do usunięcia

EnvironmentType

Określa, czy środowisko jest testowe, czy prod.

Nazwa Typ Opis
Prod

string

Test

string

Error

Obiekt error. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa Typ Opis
code

ErrorCodeType

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details

Error[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message

string

Czytelna dla człowieka reprezentacja błędu.
target

string

Element docelowy błędu.

ErrorCodeType

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

Nazwa Typ Opis
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

Odpowiedź na błąd. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa Typ Opis
error

Error

Obiekt error.

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa Typ Opis
code

string

Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innerError

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

MetadataDTO

Name — para wartości metadanych.

Nazwa Typ Opis
name

string

Nazwa metadanych.
value

string

Wartość metadanych.

PromptDTO

Monituj o odpowiedź.

Nazwa Typ Opis
displayOrder

integer

Indeks monitu — używany w kolejności monitów
displayText

string

Tekst wyświetlany do reprezentowania monitu o pytanie
qna

Qna

QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
qnaId

integer

Identyfikator Qna odpowiadający monitowi — jeśli jest obecny identyfikator QnaId, obiekt QnADTO jest ignorowany.

Qna

QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO

Nazwa Typ Opis
answer

string

Tekst odpowiedzi
context

Context

Kontekst pytań i pytań
id

integer

Unikatowy identyfikator Q-A.
lastUpdatedTimestamp

string

Sygnatura czasowa ostatniej aktualizacji pytań i pytań i pytań.
metadata

MetadataDTO[]

Lista metadanych skojarzonych z odpowiedzią.
questions

string[]

Lista pytań skojarzonych z odpowiedzią.
source

string

Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADocumentsDTO

Lista funkcji QnADTO

Nazwa Typ Opis
qnaDocuments

QnADTO[]

Lista odpowiedzi.

QnADTO

Obiekt Q-A.

Nazwa Typ Opis
answer

string

Tekst odpowiedzi
context

Context

Kontekst pytań i pytań
id

integer

Unikatowy identyfikator Q-A.
lastUpdatedTimestamp

string

Sygnatura czasowa ostatniej aktualizacji pytań i pytań i pytań.
metadata

MetadataDTO[]

Lista metadanych skojarzonych z odpowiedzią.
questions

string[]

Lista pytań skojarzonych z odpowiedzią.
source

string

Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs