Text Analysis Authoring - Export

Hizmet:

Azure AI Services

API Sürümü:

2023-04-01

Projenin verilerini dışarı aktarmak için bir işi tetikler.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string url	Desteklenen Bilişsel Hizmetler uç noktası (örneğin, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Kullanılacak projenin adı.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
stringIndexType	query	True	StringIndexType	Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz. https://aka.ms/text-analytics-offsets.
assetKind	query		string	Dışarı aktaracak varlık türü.
trainedModelLabel	query		string	Dışarı aktarmak için eğitilen model etiketi. TrainedModelLabel null ise, varsayılan davranış geçerli çalışma kopyasını dışarı aktarmaktır.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Üst Bilgiler Operation-Location: string
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

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

Örnekler

Successful Export Project

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

202

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

Tanımlar

Name	Description
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilen hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilen hata kodu.
InnerErrorModel	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType

Error

Hata nesnesi.

Name	Tür	Description
code	ErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

İnsan tarafından okunabilen hata kodu.

Name	Tür	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

Hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

InnerErrorCode

İnsan tarafından okunabilen hata kodu.

Name	Tür	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

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	InnerErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	object	Hata ayrıntıları.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hata mesajı.
target	string	Hata hedefi.

StringIndexType

Name	Tür	Description
Utf16CodeUnit	string	Uzaklık ve uzunluk değerleri UTF-16 kod birimlerine karşılık gelir. Uygulamanız Java, JavaScript gibi Unicode'u destekleyen bir dilde yazılmışsa bu seçeneği kullanın.