Text Analysis Authoring - Get Deployment Status
Mevcut bir dağıtım işinin durumunu alır.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}?api-version=2023-04-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
Dağıtım adını temsil eder. |
Endpoint
|
path | True |
string url |
Desteklenen Bilişsel Hizmetler uç noktası (örneğin, https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
İş kimliği. |
project
|
path | True |
string |
Yeni proje adı. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
İstek başarılı oldu. |
|
Other Status Codes |
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 Get Deployment Status
Örnek isteği
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01
Örnek yanıt
{
"jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
"createdDateTime": "2022-04-18T15:52:48Z",
"lastUpdatedDateTime": "2022-04-18T15:53:04Z",
"expirationDateTime": "2022-04-25T15:52:48Z",
"status": "succeeded"
}
Tanımlar
Name | Description |
---|---|
Error |
Hata nesnesi. |
Error |
İnsan tarafından okunabilen hata kodu. |
Error |
Hata yanıtı. |
Inner |
İnsan tarafından okunabilen 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 |
|
Text |
Dağıtım 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 hatalar hakkında bir dizi ayrıntı. |
innererror |
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 |
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 |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
object |
Hata ayrıntıları. |
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
|
message |
string |
Hata mesajı. |
target |
string |
Hata hedefi. |
JobStatus
Name | Tür | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringDeploymentJobState
Dağıtım işinin durumunu temsil eder.
Name | Tür | Description |
---|---|---|
createdDateTime |
string |
İşin oluşturma tarihi. |
errors |
Error[] |
İş yürütülürken karşılaşılan hatalar. |
expirationDateTime |
string |
İşin son kullanma tarihi. |
jobId |
string |
İş kimliği. |
lastUpdatedDateTime |
string |
İşin son güncelleştirildiği tarih. |
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. |