Text Analysis Authoring - Export

Serviço:

Azure AI Services

Versão da API:

2023-04-01

Aciona um trabalho para exportar os dados de um projeto.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string url	Ponto de extremidade de Serviços Cognitivos suportado, por exemplo, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	A versão da API a ser usada para esta operação.
stringIndexType	query	True	StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
assetKind	query		string	Tipo de ativo a exportar.
trainedModelLabel	query		string	Modelo treinado de etiqueta para exportação. Se o trainedModelLabel for null, o comportamento padrão será exportar a cópia de trabalho atual.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Successful Export Project

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

202

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

Definições

Name	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Código de erro legível por humanos.

Name	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

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Name	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

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

StringIndexType

Name	Tipo	Description
Utf16CodeUnit	string	Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Java, JavaScript.