Text Analysis Authoring - Export

Servicio:

Azure AI Services

Versión de la API:

2023-04-01

Desencadena un trabajo para exportar los datos de un proyecto.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Con parámetros opcionales:

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string url	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
stringIndexType	query	True	StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.
assetKind	query		string	Tipo de recurso que se va a exportar.
trainedModelLabel	query		string	Etiqueta de modelo entrenada para exportar. Si trainedModelLabel es NULL, el comportamiento predeterminado es exportar la copia de trabajo actual.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

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

Ámbitos

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

Ejemplos

Successful Export Project

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Respuesta de muestra

status code:

202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

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

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.

StringIndexType

Nombre	Tipo	Description
Utf16CodeUnit	string	Los valores de desplazamiento y longitud se corresponden con unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.