Knowledgebase - Create

Riferimento

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Operazione asincrona per creare una nuova knowledge base.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Nome descrittivo per la knowledge base.
defaultAnswer		string	Risposta predefinita inviata all'utente se non viene trovata alcuna corrispondenza valida nella Knowledge Base.
defaultAnswerUsedForExtraction		string	Stringa di testo da usare come risposta in qualsiasi Q-A che non ha risposte estratte dal documento ma ha una gerarchia. Obbligatorio quando il campo EnableHierarchicalExtraction è impostato su True.
enableHierarchicalExtraction		boolean	Abilitare l'estrazione gerarchica di Q-A da file e URL. Valore da considerare False se questo campo non è presente.
enableMultipleLanguages		boolean	Impostare su true per abilitare la creazione di kb in lingue diverse per la stessa risorsa.
files		FileDTO[]	Elenco di file da cui estrarre Q-A.
language		string	Lingua della knowledge base. L'elenco delle lingue supportate è disponibile qui.
qnaList		QnADTO[]	Elenco di Q-A (QnADTO) da aggiungere alla knowledge base. Gli ID Q-A vengono assegnati dal servizio e devono essere omessi.
urls		string[]	Elenco di URL da usare per l'estrazione di Q-A.

Risposte

Nome	Tipo	Descrizione
202 Accepted	Operation	Dettagli dell'operazione asincrona.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Esempio

Successful query

Sample Request

HTTP

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

Definizioni

Nome	Descrizione
Context	Contesto associato a Qna da aggiornare.
CreateKbDTO	Schema post body per l'operazione CreateKb.
Error	Oggetto error. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Uno dei set definiti dal server di codici di errore.
ErrorResponse	Risposta di errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO per contenere i dettagli dei file caricati.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Nome: coppia valore di metadati.
Operation	Registrare per tenere traccia dell'operazione a esecuzione prolungata.
OperationStateType	Stato dell'operazione.
PromptDTO	Richiedere una risposta.
Qna	QnADTO : QnaId o QnADTO deve essere presente in un oggetto PromptDTO
QnADTO	Oggetto Q-A.

Context

Contesto associato a Qna da aggiornare.

Nome	Tipo	Descrizione
isContextOnly	boolean	Per contrassegnare se una richiesta è rilevante solo con una domanda precedente o meno. true : non includere questo QnA come risultato della ricerca per le query senza contesto false. Ignora il contesto e include questo QnA nei risultati della ricerca
promptsToAdd	PromptDTO[]	Elenco di richieste da aggiungere alla qna.
promptsToDelete	integer[]	Elenco di richieste associate a qna da eliminare

CreateKbDTO

Schema post body per l'operazione CreateKb.

Nome	Tipo	Descrizione
defaultAnswer	string	Risposta predefinita inviata all'utente se non viene trovata alcuna corrispondenza valida nella Knowledge Base.
defaultAnswerUsedForExtraction	string	Stringa di testo da usare come risposta in qualsiasi Q-A che non ha risposte estratte dal documento ma ha una gerarchia. Obbligatorio quando il campo EnableHierarchicalExtraction è impostato su True.
enableHierarchicalExtraction	boolean	Abilitare l'estrazione gerarchica di Q-A da file e URL. Valore da considerare False se questo campo non è presente.
enableMultipleLanguages	boolean	Impostare su true per abilitare la creazione di kb in lingue diverse per la stessa risorsa.
files	FileDTO[]	Elenco di file da cui estrarre Q-A.
language	string	Lingua della knowledge base. L'elenco delle lingue supportate è disponibile qui.
name	string	Nome descrittivo per la knowledge base.
qnaList	QnADTO[]	Elenco di Q-A (QnADTO) da aggiungere alla knowledge base. Gli ID Q-A vengono assegnati dal servizio e devono essere omessi.
urls	string[]	Elenco di URL da usare per l'estrazione di Q-A.

Error

Oggetto error. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	ErrorCodeType	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innerError	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCodeType

Uno dei set definiti dal server di codici di errore.

Nome	Tipo	Descrizione
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

Risposta di errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

FileDTO

DTO per contenere i dettagli dei file caricati.

Nome	Tipo	Descrizione
fileName	string	Nome file. I tipi di file supportati sono ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	URI pubblico del file.
isUnstructured	boolean	Flag facoltativo per specificare se il file specificato è Non strutturato.

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore che lo contiene.
innerError	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

MetadataDTO

Nome: coppia valore di metadati.

Nome	Tipo	Descrizione
name	string	nome dei metadati.
value	string	valore dei metadati.

Operation

Registrare per tenere traccia dell'operazione a esecuzione prolungata.

Nome	Tipo	Descrizione
createdTimestamp	string	Timestamp al momento della creazione dell'operazione.
errorResponse	ErrorResponse	Dettagli dell'errore in caso di errori.
lastActionTimestamp	string	Timestamp quando è stato immesso lo stato corrente.
operationId	string	ID dell'operazione.
operationState	OperationStateType	Stato dell'operazione.
resourceLocation	string	URI relativo alla posizione della risorsa di destinazione per le risorse completate.
userId	string	User Id

OperationStateType

Stato dell'operazione.

Nome	Tipo	Descrizione
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

Richiedere una risposta.

Nome	Tipo	Descrizione
displayOrder	integer	Indice del prompt : usato nell'ordinamento delle richieste
displayText	string	Testo visualizzato per rappresentare una richiesta di domande di completamento
qna	Qna	QnADTO : QnaId o QnADTO deve essere presente in un oggetto PromptDTO
qnaId	integer	ID Qna corrispondente al prompt: se QnaId è presente, l'oggetto QnADTO viene ignorato.

Qna

QnADTO : QnaId o QnADTO deve essere presente in un oggetto PromptDTO

Nome	Tipo	Descrizione
answer	string	Testo della risposta
context	Context	Contesto di un QnA
id	integer	ID univoco per Q-A.
lastUpdatedTimestamp	string	Timestamp dell'ultimo aggiornamento del QnA.
metadata	MetadataDTO[]	Elenco di metadati associati alla risposta.
questions	string[]	Elenco di domande associate alla risposta.
source	string	Origine da cui è stata indicizzata la Q-A. Ad esempio. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Oggetto Q-A.

Nome	Tipo	Descrizione
answer	string	Testo della risposta
context	Context	Contesto di un QnA
id	integer	ID univoco per Q-A.
lastUpdatedTimestamp	string	Timestamp dell'ultimo aggiornamento del QnA.
metadata	MetadataDTO[]	Elenco di metadati associati alla risposta.
questions	string[]	Elenco di domande associate alla risposta.
source	string	Origine da cui è stata indicizzata la Q-A. Ad esempio. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs