Text Analysis Authoring - Get Swap Deployments Status
Ottiene lo stato di un processo di distribuzione di scambio esistente.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}?api-version=2023-04-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
ID processo. |
project
|
path | True |
string |
Nome del progetto da usare. |
api-version
|
query | True |
string |
Versione API client. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Risultato del processo di distribuzione dello scambio. |
|
Other Status Codes |
Risposta di errore. |
Sicurezza
AADToken
Si tratta dei flussi OAuth2 di Azure Active Directory . Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.
Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.
L'oggetto Authorization URL
è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di Azure Active Directory.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
* L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli account Personali.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Chiave di sottoscrizione per una risorsa del servizio lingua.
Tipo:
apiKey
In:
header
Esempio
Successful Get Swap Deployments Status
Esempio di richiesta
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01
Risposta di esempio
{
"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"
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Oggetto error. |
Error |
Codice di errore leggibile dall'utente. |
Error |
Risposta di errore. |
Inner |
Codice di errore leggibile dall'utente. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
Stato del processo. |
Text |
Rappresenta lo stato di un processo di distribuzione. |
Text |
Rappresenta un avviso rilevato durante l'esecuzione della richiesta. |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno di un set definito dal server di codici di errore. |
|
details |
Error[] |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Rappresentazione leggibile dell'errore. |
target |
string |
Destinazione dell'errore. |
ErrorCode
Codice di errore leggibile dall'utente.
Nome | Tipo | Descrizione |
---|---|---|
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
Risposta di errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
InnerErrorCode
Codice di errore leggibile dall'utente.
Nome | Tipo | Descrizione |
---|---|---|
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
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno di un set definito dal server di codici di errore. |
|
details |
object |
Dettagli degli errori. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione errore. |
JobStatus
Stato del processo.
Nome | Tipo | Descrizione |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringDeploymentJobState
Rappresenta lo stato di un processo di distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
createdDateTime |
string |
Data di creazione del processo. |
errors |
Error[] |
Gli errori riscontrati durante l'esecuzione del processo. |
expirationDateTime |
string |
Data di scadenza del processo. |
jobId |
string |
ID processo. |
lastUpdatedDateTime |
string |
L'ultima data di aggiornamento del processo. |
status |
Stato del processo. |
|
warnings |
Avvisi rilevati durante l'esecuzione del processo. |
TextAnalysisAuthoringWarning
Rappresenta un avviso rilevato durante l'esecuzione della richiesta.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di avviso. |
message |
string |
Messaggio di avviso. |