Text Analysis Authoring - Get Training Status
Hämtar status för ett träningsjobb.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
Jobb-ID:t. |
project
|
path | True |
string |
Namnet på det projekt som ska användas. |
api-version
|
query | True |
string |
Klient-API-version. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resultatet av träningsjobbet. |
|
Other Status Codes |
Felsvar. |
Säkerhet
AADToken
Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
En prenumerationsnyckel för en språktjänstresurs.
Typ:
apiKey
I:
header
Exempel
Successful Get Train Status
Exempelbegäran
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01
Exempelsvar
{
"result": {
"modelLabel": "model1",
"trainingConfigVersion": "2022-05-01",
"estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
"trainingStatus": {
"percentComplete": 3,
"startDateTime": "2022-04-18T15:45:06.8190649Z",
"status": "running"
},
"evaluationStatus": {
"percentComplete": 0,
"status": "notStarted"
}
},
"jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
"createdDateTime": "2022-04-18T15:44:44Z",
"lastUpdatedDateTime": "2022-04-18T15:45:48Z",
"expirationDateTime": "2022-04-25T15:44:44Z",
"status": "running"
}
Definitioner
Name | Description |
---|---|
Error |
Felobjektet. |
Error |
Felkod som kan läsas av människor. |
Error |
Felsvar. |
Inner |
Felkod som kan läsas av människor. |
Inner |
Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
Jobbstatus. |
Text |
Representerar det detaljerade tillståndet för en underåtgärd för träning. |
Text |
Representerar utdata från ett träningsjobb. |
Text |
Representerar tillståndet för ett träningsjobb. |
Text |
Representerar en varning som påträffades när begäran kördes. |
Error
Felobjektet.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
Error[] |
En matris med information om specifika fel som ledde till det rapporterade felet. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
En läsbar återgivning av felet. |
target |
string |
Målet för felet. |
ErrorCode
Felkod som kan läsas av människor.
Name | Typ | 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
Felsvar.
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
InnerErrorCode
Felkod som kan läsas av människor.
Name | Typ | 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
Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
object |
Felinformation. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
Felmeddelande. |
target |
string |
Felmål. |
JobStatus
Jobbstatus.
Name | Typ | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSubTrainingJobState
Representerar det detaljerade tillståndet för en underåtgärd för träning.
Name | Typ | Description |
---|---|---|
endDateTime |
string |
Representerar slutdatumtiden. |
percentComplete |
integer |
Representerar förloppsprocent. |
startDateTime |
string |
Representerar startdatumtiden. |
status |
Representerar status för underåtgärden. |
TextAnalysisAuthoringTrainingJobResult
Representerar utdata från ett träningsjobb.
Name | Typ | Description |
---|---|---|
estimatedEndDateTime |
string |
Representerar uppskattningens slutdatum för träning och utvärdering. |
evaluationStatus |
Representerar modellutvärderingsstatus. |
|
modelLabel |
string |
Representerar den tränade modelletiketten. |
trainingConfigVersion |
string |
Representerar träningskonfigurationsversion. |
trainingStatus |
Representerar modelltågstatus. |
TextAnalysisAuthoringTrainingJobState
Representerar tillståndet för ett träningsjobb.
Name | Typ | Description |
---|---|---|
createdDateTime |
string |
Skapandedatumtiden för jobbet. |
errors |
Error[] |
Felen påträffades när jobbet kördes. |
expirationDateTime |
string |
Förfallodatum för jobbet. |
jobId |
string |
Jobb-ID:t. |
lastUpdatedDateTime |
string |
Senaste datum då jobbet uppdaterades. |
result |
Representerar ett detaljerat resultat för träningsaktiviteter. |
|
status |
Jobbstatus. |
|
warnings |
Varningarna som påträffades när jobbet kördes. |
TextAnalysisAuthoringWarning
Representerar en varning som påträffades när begäran kördes.
Name | Typ | Description |
---|---|---|
code |
string |
Varningskoden. |
message |
string |
Varningsmeddelandet. |