Share via

Knowledgebase - Create

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

Operacja asynchroniczna w celu utworzenia nowej bazy wiedzy.

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

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).

Nagłówek żądania

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

string

Treść żądania

Nazwa Wymagane Typ Opis
name True

string

Przyjazna nazwa bazy wiedzy.
defaultAnswer

string

Domyślna odpowiedź wysłana do użytkownika, jeśli w bazie wiedzy nie znaleziono żadnego dopasowania.
defaultAnswerUsedForExtraction

string

Ciąg tekstowy, który ma być używany jako odpowiedź w dowolnym języku Q-A, który nie ma wyodrębnionej odpowiedzi z dokumentu, ale ma hierarchię. Wymagane, gdy pole EnableHierarchicalExtraction ma wartość True.
enableHierarchicalExtraction

boolean

Włącz hierarchiczne wyodrębnianie Q-A z plików i adresów URL. Wartość, która ma być uważana za fałsz, jeśli to pole nie jest obecne.
enableMultipleLanguages

boolean

Ustaw wartość true, aby włączyć tworzenie baz danych w różnych językach dla tego samego zasobu.
files

FileDTO[]

Lista plików, z których ma być wyodrębnione Q-A.
language

string

Język bazy wiedzy. Znajdź listę obsługiwanych języków tutaj.
qnaList

QnADTO[]

Lista Q-A (QnADTO) do dodania do bazy wiedzy. Identyfikatory Q-A są przypisywane przez usługę i powinny zostać pominięte.
urls

string[]

Lista adresów URL, które mają być używane do wyodrębniania pytań i odpowiedzi.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Operation

Szczegóły operacji asynchronicznej.
Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa Opis
Context

Kontekst skojarzony z Qna do zaktualizowania.
CreateKbDTO

Schemat treści po operacji CreateKb.
Error

Obiekt błędu. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — 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 API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO

DTO do przechowywania szczegółów przekazanych plików.
InnerErrorModel

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

Name — para wartości metadanych.
Operation

Zapisz rekord, aby śledzić długotrwałą operację.
OperationStateType

Stan operacji.
PromptDTO

Monituj o odpowiedź.
Qna

QnADTO — wartość QnaId lub QnADTO musi znajdować się w obiekcie PromptDTO
QnADTO

Obiekt Q-A.

Context

Kontekst skojarzony z Qna do zaktualizowania.

Nazwa Typ Opis
isContextOnly

boolean

Aby zaznaczyć, czy monit jest istotny tylko z poprzednim pytaniem, czy nie. true — nie należy uwzględniać tej funkcji QnA jako wyniku wyszukiwania dla zapytań bez wartości false kontekstu — ignoruje kontekst i uwzględnia tę funkcję QnA w wynikach wyszukiwania
promptsToAdd

PromptDTO[]

Lista monitów do dodania do qna.
promptsToDelete

integer[]

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

CreateKbDTO

Schemat treści po operacji CreateKb.

Nazwa Typ Opis
defaultAnswer

string

Domyślna odpowiedź wysłana do użytkownika, jeśli w bazie wiedzy nie znaleziono żadnego dopasowania.
defaultAnswerUsedForExtraction

string

Ciąg tekstowy, który ma być używany jako odpowiedź w dowolnym języku Q-A, który nie ma wyodrębnionej odpowiedzi z dokumentu, ale ma hierarchię. Wymagane, gdy pole EnableHierarchicalExtraction ma wartość True.
enableHierarchicalExtraction

boolean

Włącz hierarchiczne wyodrębnianie Q-A z plików i adresów URL. Wartość, która ma być uważana za fałsz, jeśli to pole nie jest obecne.
enableMultipleLanguages

boolean

Ustaw wartość true, aby włączyć tworzenie baz danych w różnych językach dla tego samego zasobu.
files

FileDTO[]

Lista plików, z których ma być wyodrębnione Q-A.
language

string

Język bazy wiedzy. Znajdź listę obsługiwanych języków tutaj.
name

string

Przyjazna nazwa bazy wiedzy.
qnaList

QnADTO[]

Lista Q-A (QnADTO) do dodania do bazy wiedzy. Identyfikatory Q-A są przypisywane przez usługę i powinny zostać pominięte.
urls

string[]

Lista adresów URL, które mają być używane do wyodrębniania pytań i odpowiedzi.

Error

Obiekt błędu. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — 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 API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa Typ Opis
error

Error

Obiekt błędu.

FileDTO

DTO do przechowywania szczegółów przekazanych plików.

Nazwa Typ Opis
fileName

string

Nazwa pliku. Obsługiwane typy plików to ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri

string

Publiczny identyfikator URI pliku.
isUnstructured

boolean

Opcjonalna flaga określająca, czy dany plik jest nieustrukturyzowany.

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — 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.

Operation

Zapisz rekord, aby śledzić długotrwałą operację.

Nazwa Typ Opis
createdTimestamp

string

Sygnatura czasowa utworzenia operacji.
errorResponse

ErrorResponse

Szczegóły błędu w przypadku awarii.
lastActionTimestamp

string

Sygnatura czasowa po wprowadzeniu bieżącego stanu.
operationId

string

Identyfikator operacji.
operationState

OperationStateType

Stan operacji.
resourceLocation

string

Względny identyfikator URI do docelowej lokalizacji zasobu dla ukończonych zasobów.
userId

string

Identyfikator użytkownika

OperationStateType

Stan operacji.

Nazwa Typ Opis
Failed

string

NotStarted

string

Running

string

Succeeded

string

PromptDTO

Monituj o odpowiedź.

Nazwa Typ Opis
displayOrder

integer

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

string

Tekst wyświetlany w celu reprezentowania monitu o pytanie
qna

Qna

QnADTO — wartość QnaId lub QnADTO musi znajdować się 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 znajdować się w obiekcie PromptDTO

Nazwa Typ Opis
answer

string

Tekst odpowiedzi
context

Context

Kontekst pytań i odpowiedzi
id

integer

Unikatowy identyfikator Q-A.
lastUpdatedTimestamp

string

Sygnatura czasowa ostatniej aktualizacji usługi QnA.
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

QnADTO

Obiekt Q-A.

Nazwa Typ Opis
answer

string

Tekst odpowiedzi
context

Context

Kontekst pytań i odpowiedzi
id

integer

Unikatowy identyfikator Q-A.
lastUpdatedTimestamp

string

Sygnatura czasowa ostatniej aktualizacji usługi QnA.
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