Question Answering Projects - Export

Servicio:

Azure AI Services

Versión de la API:

2021-10-01

Exportar los metadatos y los recursos del proyecto.

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01

Con parámetros opcionales:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}

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.
assetKind	query		string	Tipo de recurso del proyecto.
format	query		format	Formato de importación o exportación de la base de conocimiento.

Encabezado de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	ExportJobState	Exporte el estado del trabajo, los metadatos del proyecto y los recursos.
202 Accepted		Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/query-knowledgebases/projects/proj1/:export?api-version=2021-10-01

Respuesta de muestra

status code:

200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2021-10-01"
}

status code:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
ExportJobState	Exporte el estado del trabajo, los metadatos del proyecto y los recursos.
format	Formato de importación o exportación de la base de conocimiento.
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.
jobStatus	Estado del trabajo.

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.

ExportJobState

Object

Exporte el estado del trabajo, los metadatos del proyecto y los recursos.

Nombre	Tipo	Description
createdDateTime	string (date-time)
errors	Error[]	Objeto de error.
expirationDateTime	string (date-time)
jobId	string
lastUpdatedDateTime	string (date-time)
resultUrl	string	Dirección URL para descargar el resultado del trabajo de exportación.
status	jobStatus	Estado del trabajo.

format

Enumeración

Formato de importación o exportación de la base de conocimiento.

Valor	Description
excel	Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato Tsv.
json	Exporte o importe recursos de QnA en formato JSON.
tsv	Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato excel.

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.

jobStatus

Enumeración

Estado del trabajo.

Valor	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded