Question Answering Projects - Get Qnas

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2021-10-01

Obtiene todos los QnAs de un proyecto.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

Con parámetros opcionales:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

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://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.
maxpagesize	query		integer (int32)	Número máximo de recursos que se van a incluir en una única respuesta.
skip	query		integer (int32)	Desplazamiento en la colección del primer recurso que se va a devolver.
source	query		string	Origen de la QnA.
top	query		integer (int32)	Número máximo de recursos que se van a devolver de la colección.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	QnaAssets	Todas las QnAs de un proyecto.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": 1,
      "answer": "ans1",
      "source": "source1",
      "questions": [
        "question 1.1",
        "question 1.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 1.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 1.2"
          }
        ]
      },
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    },
    {
      "id": 2,
      "answer": "ans2",
      "source": "source2",
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    }
  ]
}

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
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.
QnaAssets	Todos los recursos de QnA del proyecto.
QnaDialog	Cuadro de diálogo asociado con el registro de QnA.
QnaPrompt	Solicitar una respuesta.
QnaRecord	Registro QnA.
RetrieveQnaRecord	Registro de QnA con la fecha y hora actualizadas por última vez.
SuggestedQuestion	Pregunta sugerida por la característica De aprendizaje activo.
SuggestedQuestionsCluster	Detalles del clúster de preguntas sugeridas de Active Learning.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	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.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

QnaAssets

Object

Todos los recursos de QnA del proyecto.

Nombre	Tipo	Description
nextLink	string
value	RetrieveQnaRecord[]	Lista de registros de QnA.

QnaDialog

Object

Cuadro de diálogo asociado con el registro de QnA.

Nombre	Tipo	Description
isContextOnly	boolean	Para marcar si una solicitud solo es relevante con una pregunta anterior o no. Si es true, no incluya esta QnA como respuesta para las consultas sin contexto; de lo contrario, omite el contexto e incluye esta QnA en respuestas.
prompts	QnaPrompt[]	Lista de mensajes asociados a la respuesta.

QnaPrompt

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 pregunta de seguimiento.
qna	QnaRecord	Registro QnA. El registro QnAId o QnA debe estar presente en un símbolo del sistema.
qnaId	integer (int32)	Identificador de la QnA correspondiente al símbolo del sistema.

QnaRecord

Object

Registro QnA.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para QnA.
answer	string minLength: 1 maxLength: 25000	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer (int32)	Identificador único de QnA.
metadata	object	Metadatos asociados a la respuesta, útiles para clasificar o filtrar respuestas a preguntas.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string maxLength: 300	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

Object

Registro de QnA con la fecha y hora actualizadas por última vez.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para QnA.
answer	string minLength: 1 maxLength: 25000	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer (int32)	Identificador único de QnA.
lastUpdatedDateTime	string (date-time)	Fecha y hora en que el QnA se actualizó por última vez.
metadata	object	Metadatos asociados a la respuesta, útiles para clasificar o filtrar respuestas a preguntas.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string maxLength: 300	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Pregunta sugerida por la característica De aprendizaje activo.

Nombre	Tipo	Description
autoSuggestedCount	integer (int32)	El número de veces que el algoritmo de Aprendizaje activo sugirió automáticamente la pregunta.
question	string	Pregunta sugerida por la característica De aprendizaje activo.
userSuggestedCount	integer (int32)	El usuario sugirió explícitamente el número de veces que el usuario sugirió la pregunta.

SuggestedQuestionsCluster

Object

Detalles del clúster de preguntas sugeridas de Active Learning.

Nombre	Tipo	Description
clusterHead	string	Pregunta elegida como encabezado del clúster de preguntas sugeridas por el algoritmo de agrupación en clústeres de Active Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas las preguntas sugeridas para el QnA.

Compartir a través de

Question Answering Projects - Get Qnas

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaAssets

QnaDialog

QnaPrompt

QnaRecord

RetrieveQnaRecord

SuggestedQuestion

SuggestedQuestionsCluster