Text Analysis Authoring - Get Export Status
Dışarı aktarma işinin durumunu alır. İş tamamlandıktan sonra proje meta verilerini ve varlıkları döndürür.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}?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). |
job
|
path | True |
string |
İş kimliği. |
project
|
path | True |
string |
Kullanılacak projenin adı. |
api-version
|
query | True |
string |
İstemci API sürümü. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Uzun süre çalışan işlemin durumu. |
|
Other Status Codes |
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-id
gerektirir. 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.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Dil hizmeti kaynağı için abonelik anahtarı.
Tür:
apiKey
İçinde:
header
Örnekler
Successful Get Export Status
Örnek isteği
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01
Örnek yanıt
{
"resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-01",
"jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
"createdDateTime": "2022-04-18T15:23:07Z",
"lastUpdatedDateTime": "2022-04-18T15:23:08Z",
"expirationDateTime": "2022-04-25T15:23:07Z",
"status": "succeeded"
}
Tanımlar
Name | Description |
---|---|
Error |
Hata nesnesi. |
Error |
İnsan tarafından okunabilir hata kodu. |
Error |
Hata yanıtı. |
Inner |
İnsan tarafından okunabilir hata kodu. |
Inner |
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. |
Job |
İş durumu. |
Text |
Dışarı aktarma işinin durumunu temsil eder. |
Text |
İstek yürütülürken karşılaşılan bir uyarıyı temsil eder. |
Error
Hata nesnesi.
Name | Tür | Description |
---|---|---|
code |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
Error[] |
Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi. |
innererror |
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 |
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 |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
object |
Hata ayrıntıları. |
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
JobStatus
İş durumu.
Name | Tür | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringExportProjectJobState
Dışarı aktarma işinin durumunu temsil eder.
Name | Tür | Description |
---|---|---|
createdDateTime |
string |
İşin oluşturma tarihi saati. |
errors |
Error[] |
İş yürütülürken karşılaşılan hatalar. |
expirationDateTime |
string |
İşin sona erme tarihi saati. |
jobId |
string |
İş kimliği. |
lastUpdatedDateTime |
string |
İşin güncelleştirilmiş olduğu son tarih. |
resultUrl |
string |
Dışarı aktarılan projeyi indirmek için kullanılacak URL. |
status |
İş durumu. |
|
warnings |
İş yürütülürken karşılaşılan uyarılar. |
TextAnalysisAuthoringWarning
İstek yürütülürken karşılaşılan bir uyarıyı temsil eder.
Name | Tür | Description |
---|---|---|
code |
string |
Uyarı kodu. |
message |
string |
Uyarı iletisi. |