Question Answering Projects - Get Qnas

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-04-15-preview

Obtiene todos los QnAs de un proyecto.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview

Con parámetros opcionales:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
projectName	path	True	string	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.

Respuestas

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

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso de sdk web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Actualmente, Azure Active Directory v1.0 o v2.0 admite cuentas profesionales, educativas e invitados, pero no admite cuentas personales.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-15-preview

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

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

Código de error legible para personas.

Nombre	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Código de error legible para personas.

Nombre	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

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

Todos los recursos de QnA del proyecto.

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

QnaDialog

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

Solicitar una respuesta.

Nombre	Tipo	Description
displayOrder	integer	Índice del símbolo del sistema. Se usa para ordenar las solicitudes.
displayText	string	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	Identificador de la QnA correspondiente al símbolo del sistema.

QnaRecord

Registro QnA.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para QnA.
answer	string	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer	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	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

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	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer	Identificador único de QnA.
lastUpdatedDateTime	string	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	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Pregunta sugerida por la característica De aprendizaje activo.

Nombre	Tipo	Description
autoSuggestedCount	integer	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	El usuario sugirió explícitamente el número de veces que el usuario sugirió la pregunta.

SuggestedQuestionsCluster

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