Question Answering Projects - Get Sources

Referencia

Servicio:: Azure AI Services

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

Obtiene todos los orígenes de un proyecto.

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

Con parámetros opcionales:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-15-preview&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.
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	QnaSources	Todos los orígenes 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/sources?api-version=2023-04-15-preview

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "displayName": "source1",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    },
    {
      "displayName": "source2",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
      "sourceKind": "file",
      "contentStructureKind": "unstructured",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "surface-guide.pdf"
    }
  ]
}

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.
QnaSourceRecord	Registro de origen personalizado con la fecha y hora actualizadas por última vez.
QnaSources	Todos los orígenes de QnA del proyecto.
sourceContentStructureKind	Tipo de estructura de contenido para orígenes.
sourceKind	Tipos de origen admitidos.

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.

QnaSourceRecord

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

Nombre	Tipo	Valor predeterminado	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Tipo de estructura de contenido para orígenes.
displayName	string		Nombre descriptivo del origen.
lastUpdatedDateTime	string		Fecha y hora en que el QnA se actualizó por última vez.
source	string		Identificador de origen único. Nombre del archivo si es un origen de 'archivo'; de lo contrario, la dirección URL completa si es un origen "url".
sourceKind	sourceKind	url	Tipos de origen admitidos.
sourceUri	string		Ubicación del URI para el archivo o la dirección URL.

QnaSources

Todos los orígenes de QnA del proyecto.

Nombre	Tipo	Description
nextLink	string
value	QnaSourceRecord[]	Orígenes personalizados de los que se extrajeron o agregaron explícitamente los QnAs al proyecto.

sourceContentStructureKind

Tipo de estructura de contenido para orígenes.

Nombre	Tipo	Description
unstructured	string

sourceKind

Tipos de origen admitidos.

Nombre	Tipo	Description
file	string
url	string

Compartir a través de