Text Analysis Authoring - List Trained Models
Elenchi i modelli sottoposti a training appartenenti a un progetto.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models?top={top}&skip={skip}&maxpagesize={maxpagesize}&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). |
project
|
path | True |
string |
Nome del progetto da usare. |
api-version
|
query | True |
string |
Versione API client. |
maxpagesize
|
query |
integer int32 |
Numero massimo di risorse da includere in una singola risposta. |
|
skip
|
query |
integer int32 |
Offset nella raccolta della prima risorsa da restituire. |
|
top
|
query |
integer int32 |
Numero massimo di risorse da restituire dalla raccolta. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Elenco di tutti i modelli sottoposti a training. |
|
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.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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.
Type:
apiKey
In:
header
Esempio
Successful List Models
Sample Request
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models?api-version=2023-04-01
Sample Response
{
"value": [
{
"label": "model1",
"modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
"lastTrainedDateTime": "2022-04-18T15:47:49Z",
"lastTrainingDurationInSeconds": 186,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
},
{
"label": "model2",
"modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
"lastTrainedDateTime": "2022-04-18T17:25:22Z",
"lastTrainingDurationInSeconds": 192,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
}
],
"nextLink": null
}
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. |
Text |
Rappresenta un modello sottoposto a training. |
Text |
Rappresenta un elenco di modelli sottoposti a training recuperati. |
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. |
TextAnalysisAuthoringProjectTrainedModel
Rappresenta un modello sottoposto a training.
Nome | Tipo | Descrizione |
---|---|---|
hasSnapshot |
boolean |
Flag da indicare se il modello sottoposto a training ha uno snapshot pronto. |
label |
string |
Etichetta del modello con training. |
lastTrainedDateTime |
string |
Ultima data di training del modello. |
lastTrainingDurationInSeconds |
integer |
Durata dell'ultima richiesta di training del modello in secondi. |
modelExpirationDate |
string |
Data di scadenza del modello. |
modelId |
string |
L'ID modello. |
modelTrainingConfigVersion |
string |
Versione di configurazione del training del modello. |
TextAnalysisAuthoringProjectTrainedModels
Rappresenta un elenco di modelli sottoposti a training recuperati.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento alla pagina successiva. |
value |
Elenco dei processi recuperati. |