Text Analysis Authoring - Get Swap Deployments Status
Hiermee haalt u de status van een bestaande swap-implementatietaak op.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}?api-version=2023-04-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
De taak-id. |
project
|
path | True |
string |
De naam van het nieuwe project. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De aanvraag is voltooid. |
|
Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
accessCode
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token-URL:
https://login.microsoftonline.com/common/oauth2/token
Bereiken
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Voorbeelden
SuccessfulGetSwapDeploymentsStatus
Voorbeeldaanvraag
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01
Voorbeeldrespons
{
"jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000",
"createdDateTime": "2022-04-18T16:09:50Z",
"lastUpdatedDateTime": "2022-04-18T16:09:58Z",
"expirationDateTime": "2022-04-25T16:09:50Z",
"status": "succeeded"
}
Definities
Name | Description |
---|---|
Error |
Het foutobject. |
Error |
Leesbare foutcode. |
Error |
Foutreactie. |
Inner |
Leesbare foutcode. |
Inner |
Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
|
Text |
Vertegenwoordigt de status van een implementatietaak. |
Text |
Vertegenwoordigt een waarschuwing die is opgetreden tijdens het uitvoeren van de aanvraag. |
Error
Het foutobject.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
Error[] |
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout. |
innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
message |
string |
Een leesbare weergave van de fout. |
target |
string |
Het doel van de fout. |
ErrorCode
Leesbare foutcode.
Name | Type | 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
Foutreactie.
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
InnerErrorCode
Leesbare foutcode.
Name | Type | 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
Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
object |
Foutdetails. |
innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
message |
string |
Foutmelding. |
target |
string |
Foutdoel. |
JobStatus
Name | Type | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSwapDeploymentsJobState
Vertegenwoordigt de status van een implementatietaak.
Name | Type | Description |
---|---|---|
createdDateTime |
string |
De aanmaakdatum van de taak. |
errors |
Error[] |
De fouten die zijn opgetreden tijdens het uitvoeren van de taak. |
expirationDateTime |
string |
De vervaldatum van de taak. |
jobId |
string |
De taak-id. |
lastUpdatedDateTime |
string |
De laatste datum waarop de taak is bijgewerkt. |
status |
De taakstatus. |
|
warnings |
De waarschuwingen die zijn opgetreden tijdens het uitvoeren van de taak. |
TextAnalysisAuthoringWarning
Vertegenwoordigt een waarschuwing die is opgetreden tijdens het uitvoeren van de aanvraag.
Name | Type | Description |
---|---|---|
code |
string |
De waarschuwingscode. |
message |
string |
Het waarschuwingsbericht. |