Compartir a través de


Question Answering Projects - Export

Exportar los metadatos y los recursos del proyecto.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview
POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview&format={format}&assetKind={assetKind}

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.

assetKind
query

assetKind

Tipo de recurso del proyecto.

format
query

format

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

Respuestas

Nombre Tipo Description
200 OK

ExportJobState

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

202 Accepted

Resultados de una llamada correcta con un encabezado Operation-Location usado para comprobar el estado del trabajo.

Encabezados

Operation-Location: string

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

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-15-preview

Respuesta de muestra

{
  "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=2023-04-15-preview"
}
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-15-preview

Definiciones

Nombre Description
assetKind

Tipo de recurso del proyecto.

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.

assetKind

Tipo de recurso del proyecto.

Nombre Tipo Description
qnas

string

synonyms

string

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.

ExportJobState

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

Nombre Tipo Description
createdDateTime

string

errors

Error[]

Objeto de error.

expirationDateTime

string

jobId

string

lastUpdatedDateTime

string

resultUrl

string

Dirección URL para descargar el resultado del trabajo de exportación.

status

jobStatus

Estado del trabajo.

format

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

Nombre Tipo Description
excel

string

Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato Tsv.

json

string

Exporte o importe recursos de QnA en formato JSON.

tsv

string

Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato excel.

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.

jobStatus

Estado del trabajo.

Nombre Tipo Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string