Runtime - Generate Answer

Referencia

Servicio:: Azure AI Services

Versión de la API:: 4.0

Llamada a GenerateAnswer para consultar la base de conocimiento.

POST {RuntimeEndpoint}/qnamaker/knowledgebases/{kbId}/generateAnswer

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
kbId	path	True	string	Id. de la base de conocimiento.
RuntimeEndpoint	path	True	string	Punto de conexión de App Service de QnA Maker (por ejemplo: https://{qnaservice-hostname}.azurewebsites.net).

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string

Cuerpo de la solicitud

Nombre	Tipo	Description
context	Context	Objeto de contexto con la información de QnA anterior.
isTest	boolean	Consulta en el índice de prueba.
qnaId	string	QnaId exacto para capturar de la base de conocimiento, este campo tiene prioridad sobre la pregunta.
question	string	Pregunta del usuario para consultar en la base de conocimiento.
rankerType	string	Campo opcional. Establézcalo en "QuestionOnly" para usar un clasificador de preguntas.
scoreThreshold	number	Umbral de respuestas devueltas en función de la puntuación.
strictFilters	MetadataDTO[]	Busque solo respuestas que contengan estos metadatos.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Campo opcional. Establézcalo en OR para usar OR como operación para filtros estrictos.
top	integer (int32)	Número máximo de respuestas que se devolverán para la pregunta.
userId	string	Identificador único del usuario. Parámetro opcional para la telemetría. Para obtener más información, consulte Análisis y telemetría.

Respuestas

Nombre	Tipo	Description
200 OK	QnASearchResultList	GenerateAnswer call response (Respuesta de llamada de GenerateAnswer).
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Authorization

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {RuntimeEndpoint}/qnamaker/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/generateAnswer


{
  "question": "qna maker and luis",
  "top": 6,
  "isTest": true,
  "scoreThreshold": 20,
  "strictFilters": [
    {
      "name": "category",
      "value": "api"
    }
  ],
  "userId": "sd53lsY="
}

Respuesta de muestra

status code:: 200

{
  "answers": [
    {
      "score": 28.54820341616869,
      "id": 20,
      "answer": "There is no direct integration of LUIS with QnA Maker. But, in your bot code, you can use LUIS and QnA Maker together.",
      "source": "Custom Editorial",
      "questions": [
        "How can I integrate LUIS with QnA Maker?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
Context	Contexto de una QnA
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.
ErrorCodeType	Uno de un conjunto definido por el servidor de códigos de error.
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.
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.
MetadataDTO	Nombre: par de valores de metadatos.
PromptDTO	Solicitar una respuesta.
Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO
QnASearchResult	Representa el resultado de la búsqueda.
QnASearchResultList	Representa la lista de respuestas a preguntas.
QueryDTO	Esquema del cuerpo POST para consultar la base de conocimiento.
StrictFiltersCompoundOperationType	Campo opcional. Establézcalo en OR para usar OR como operación para filtros estrictos.

Context

Object

Contexto de una QnA

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 false: omite el contexto e incluye este QnA en el resultado de la búsqueda.
prompts	PromptDTO[]	Lista de mensajes asociados a la respuesta.

Error

Object

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	ErrorCodeType	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	InnerErrorModel	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

Enumeración

Uno de un conjunto definido por el servidor de códigos de error.

Valor	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

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	Error	Objeto de error.

InnerErrorModel

Object

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	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.

MetadataDTO

Object

Nombre: par de valores de metadatos.

Nombre	Tipo	Description
name	string minLength: 1 maxLength: 100	Nombre de metadatos.
value	string minLength: 1 maxLength: 500	Valor de metadatos.

PromptDTO

Object

Solicitar una respuesta.

Nombre	Tipo	Description
displayOrder	integer (int32)	Índice del símbolo del sistema: se usa para ordenar las solicitudes
displayText	string maxLength: 200	Texto que se muestra para representar un mensaje de preguntas de seguimiento
qna	Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO
qnaId	integer (int32)	Qna id correspondiente al símbolo del sistema: si QnaId está presente, se omite el objeto QnADTO.

Qna

Object

QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO

Nombre	Tipo	Description
answer	string minLength: 1 maxLength: 25000	Texto de respuesta
context	Context	Contexto de una QnA
id	integer (int32)	Identificador único para el Q-A.
metadata	MetadataDTO[]	Lista de metadatos asociados a la respuesta.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string maxLength: 300	Origen del que se indizó Q-A. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Object

Representa el resultado de la búsqueda.

Nombre	Tipo	Description
answer	string	Respuesta.
context	Context	Objeto context del QnA
id	integer (int32)	Identificador del resultado de QnA.
metadata	MetadataDTO[]	Lista de metadatos.
questions	string[]	Lista de preguntas.
score	number	Puntuación de resultados de búsqueda.
source	string	Origen del resultado de QnA.

QnASearchResultList

Object

Representa la lista de respuestas a preguntas.

Nombre	Tipo	Description
answers	QnASearchResult[]	Representa la lista de resultados de búsqueda.

QueryDTO

Object

Esquema del cuerpo POST para consultar la base de conocimiento.

Nombre	Tipo	Description
context	Context	Objeto de contexto con la información de QnA anterior.
isTest	boolean	Consulta en el índice de prueba.
qnaId	string	QnaId exacto para capturar de la base de conocimiento, este campo tiene prioridad sobre la pregunta.
question	string	Pregunta del usuario para consultar en la base de conocimiento.
rankerType	string	Campo opcional. Establézcalo en "QuestionOnly" para usar un clasificador de preguntas.
scoreThreshold	number	Umbral de respuestas devueltas en función de la puntuación.
strictFilters	MetadataDTO[]	Busque solo respuestas que contengan estos metadatos.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Campo opcional. Establézcalo en OR para usar OR como operación para filtros estrictos.
top	integer (int32)	Número máximo de respuestas que se devolverán para la pregunta.
userId	string	Identificador único del usuario. Parámetro opcional para la telemetría. Para obtener más información, consulte Análisis y telemetría.

StrictFiltersCompoundOperationType

Enumeración

Campo opcional. Establézcalo en OR para usar OR como operación para filtros estrictos.

Valor	Description
AND
OR

Compartir a través de

Runtime - Generate Answer

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Context

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnASearchResult

QnASearchResultList

QueryDTO

StrictFiltersCompoundOperationType

Recursos adicionales