Text Analysis Authoring - Export

Service:

Cognitive Services - Language

API Version:

2023-04-01

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

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktası (ör. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Kullanılacak projenin adı.
api-version	query	True	string	İstemci 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		Başarılı bir çağrı, işin durumunu denetlemek için kullanılan bir Operation-Location üst bilgisi ile sonuçlanır. Headers operation-location: string
Other Status Codes	ErrorResponse	Hata yanıtı.

Güvenlik

AADToken

Bunlar Azure Active Directory OAuth2 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.

Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.

Notlar

• Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını x-ms-client-idgerektirir. Bu, Haritalar yönetim API'sinden alınabilir.

Authorization URL, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Azure Active Directory yapılandırmaları vardır. * Azure rol tabanlı erişim denetimi azure yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla yapılandırılır. * Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.

• Şu anda Azure Active Directory v1.0 veya v2.0 , İş, Okul ve Konuklar'ı destekler ancak Kişisel hesapları desteklemez.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Dil hizmeti kaynağı için abonelik anahtarı.

Type: apiKey
In: header

Örnekler

Successful Export Project

Sample Request

HTTP

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

Sample Response

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

Tanımlar

Name	Description
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilir hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilir 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	Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. .

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 hatalarla ilgili ayrıntılar dizisi.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

İnsan tarafından okunabilir 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 okunabilir 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 özel bilgiler içeren bir nesne.
message	string	Hata iletisi.
target	string	Hata hedefi.

StringIndexType

Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. .

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.