Knowledgebase - Create
Operación asincrónica para crear una nueva base de conocimiento.
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Punto de conexión de Cognitive Services compatible (por ejemplo, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com). |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
name | True |
string |
Nombre descriptivo de la base de conocimiento. |
defaultAnswer |
string |
Respuesta predeterminada enviada al usuario si no se encuentra ninguna buena coincidencia en la KB. |
|
defaultAnswerUsedForExtraction |
string |
Cadena de texto que se va a usar como respuesta en cualquier Q-A que no tenga respuesta extraída del documento, pero que tenga una jerarquía. Obligatorio cuando el campo EnableHierarchicalExtraction está establecido en True. |
|
enableHierarchicalExtraction |
boolean |
Habilite la extracción jerárquica de Q-A desde archivos y direcciones URL. Valor que se va a considerar False si este campo no está presente. |
|
enableMultipleLanguages |
boolean |
Establézcalo en true para habilitar la creación de kb en distintos idiomas para el mismo recurso. |
|
files |
FileDTO[] |
Lista de archivos de los que se va a extraer Q-A. |
|
language |
string |
Idioma de la base de conocimiento. Busque aquí la lista de idiomas admitidos. |
|
qnaList |
QnADTO[] |
Lista de Q-A (QnADTO) que se va a agregar a la base de conocimiento. El servicio asigna los identificadores de Q-A y se debe omitir. |
|
urls |
string[] |
Lista de direcciones URL que se usarán para extraer Q-A. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
202 Accepted |
Detalles de la operación asincrónica. |
|
Other Status Codes |
Respuesta de error. |
Seguridad
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Ejemplos
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
{
"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"
}
Definiciones
Nombre | Description |
---|---|
Context |
Contexto asociado a Qna que se va a actualizar. |
Create |
Esquema posterior al cuerpo para la operación CreateKb. |
Error |
Objeto de error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Error |
Uno de un conjunto definido por el servidor de códigos de error. |
Error |
Respuesta de error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
FileDTO |
DTO para contener los detalles de los archivos cargados. |
Inner |
Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
MetadataDTO |
Nombre: par de valores de metadatos. |
Operation |
Registro para realizar un seguimiento de la operación de larga duración. |
Operation |
Estado de la operación. |
PromptDTO |
Pida una respuesta. |
Qna |
QnADTO: QnaId o QnADTO debe estar presente en un objeto PromptDTO. |
QnADTO |
Objeto Q-A. |
Context
Contexto asociado a Qna que se va a actualizar.
Nombre | Tipo | Description |
---|---|---|
isContextOnly |
boolean |
Para marcar si una solicitud solo es relevante con una pregunta anterior o no. true: no incluya esta QnA como resultado de búsqueda para consultas sin contexto falso: omite el contexto e incluye este QnA en el resultado de la búsqueda. |
promptsToAdd |
Lista de mensajes que se van a agregar a qna. |
|
promptsToDelete |
integer[] |
Lista de mensajes asociados a qna que se van a eliminar |
CreateKbDTO
Esquema posterior al cuerpo para la operación CreateKb.
Nombre | Tipo | Description |
---|---|---|
defaultAnswer |
string |
Respuesta predeterminada enviada al usuario si no se encuentra ninguna buena coincidencia en la KB. |
defaultAnswerUsedForExtraction |
string |
Cadena de texto que se va a usar como respuesta en cualquier Q-A que no tenga respuesta extraída del documento, pero que tenga una jerarquía. Obligatorio cuando el campo EnableHierarchicalExtraction está establecido en True. |
enableHierarchicalExtraction |
boolean |
Habilite la extracción jerárquica de Q-A desde archivos y direcciones URL. Valor que se va a considerar False si este campo no está presente. |
enableMultipleLanguages |
boolean |
Establézcalo en true para habilitar la creación de kb en distintos idiomas para el mismo recurso. |
files |
FileDTO[] |
Lista de archivos de los que se va a extraer Q-A. |
language |
string |
Idioma de la base de conocimiento. Busque aquí la lista de idiomas admitidos. |
name |
string |
Nombre descriptivo de la base de conocimiento. |
qnaList |
QnADTO[] |
Lista de Q-A (QnADTO) que se va a agregar a la base de conocimiento. El servicio asigna los identificadores de Q-A y se debe omitir. |
urls |
string[] |
Lista de direcciones URL que se usarán para extraer Q-A. |
Error
Objeto de error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nombre | Tipo | Description |
---|---|---|
code |
Uno de un conjunto definido por el servidor de códigos de error. |
|
details |
Error[] |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
innerError |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
message |
string |
Representación legible del error. |
target |
string |
Destino del error. |
ErrorCodeType
Uno de un conjunto definido por el servidor de códigos de error.
Nombre | Tipo | Description |
---|---|---|
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
Respuesta de error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
FileDTO
DTO para contener los detalles de los archivos cargados.
Nombre | Tipo | Description |
---|---|---|
fileName |
string |
Nombre de archivo. Los tipos de archivo admitidos son ".tsv", ".pdf", ".txt", ".docx", ".xlsx". |
fileUri |
string |
URI público del archivo. |
isUnstructured |
boolean |
Marca opcional para especificar si el archivo especificado es No estructurado. |
InnerErrorModel
Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error más específico del proporcionado por el error contenedor. |
innerError |
Objeto que contiene información más específica que el objeto actual sobre el error. |
MetadataDTO
Nombre: par de valores de metadatos.
Nombre | Tipo | Description |
---|---|---|
name |
string |
nombre de los metadatos. |
value |
string |
valor de los metadatos. |
Operation
Registro para realizar un seguimiento de la operación de larga duración.
Nombre | Tipo | Description |
---|---|---|
createdTimestamp |
string |
Marca de tiempo cuando se creó la operación. |
errorResponse |
Detalles del error en caso de errores. |
|
lastActionTimestamp |
string |
Marca de tiempo cuando se especificó el estado actual. |
operationId |
string |
Identificador de operación. |
operationState |
Estado de la operación. |
|
resourceLocation |
string |
URI relativo a la ubicación del recurso de destino para los recursos completados. |
userId |
string |
Id. de usuario |
OperationStateType
Estado de la operación.
Nombre | Tipo | Description |
---|---|---|
Failed |
string |
|
NotStarted |
string |
|
Running |
string |
|
Succeeded |
string |
PromptDTO
Pida una respuesta.
Nombre | Tipo | Description |
---|---|---|
displayOrder |
integer |
Índice del símbolo del sistema: se usa para ordenar las indicaciones |
displayText |
string |
Texto que se muestra para representar un mensaje de pregunta de seguimiento |
qna |
QnADTO: QnaId o QnADTO debe estar presente en un objeto PromptDTO. |
|
qnaId |
integer |
Identificador de Qna correspondiente al símbolo del sistema: si QnaId está presente, se omite el objeto QnADTO. |
Qna
QnADTO: QnaId o QnADTO debe estar presente en un objeto PromptDTO.
Nombre | Tipo | Description |
---|---|---|
answer |
string |
Texto de respuesta |
context |
Contexto de una QnA |
|
id |
integer |
Identificador único para Q-A. |
lastUpdatedTimestamp |
string |
Marca de tiempo en la que se actualizó por última vez la QnA. |
metadata |
Lista de metadatos asociados a la respuesta. |
|
questions |
string[] |
Lista de preguntas asociadas a la respuesta. |
source |
string |
Origen desde el que se indizó Q-A. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs |
QnADTO
Objeto Q-A.
Nombre | Tipo | Description |
---|---|---|
answer |
string |
Texto de respuesta |
context |
Contexto de una QnA |
|
id |
integer |
Identificador único para Q-A. |
lastUpdatedTimestamp |
string |
Marca de tiempo en la que se actualizó por última vez la QnA. |
metadata |
Lista de metadatos asociados a la respuesta. |
|
questions |
string[] |
Lista de preguntas asociadas a la respuesta. |
source |
string |
Origen desde el que se indizó Q-A. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs |