Question Answering Projects - Get Sources

Servicio:

Azure AI Services

Versión de la API:

2021-10-01

Obtiene todos los orígenes de un proyecto.

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

Con parámetros opcionales:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01&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.
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	QnaSources	Todos los orígenes 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/sources?api-version=2021-10-01

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

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.

QnaSourceRecord

Object

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 minLength: 1 maxLength: 200		Nombre descriptivo del origen.
lastUpdatedDateTime	string (date-time)		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 (uri)		Ubicación del URI para el archivo o la dirección URL.

QnaSources

Object

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

Enumeración

Tipo de estructura de contenido para orígenes.

Valor	Description
unstructured

sourceKind

Enumeración

Tipos de origen admitidos.

Valor	Description
file
url