Text Analysis Authoring - List Training Jobs

Referentie

Service:: Cognitive Services - Language

API-versie:: 2023-04-01

Lijsten de niet-verlopen trainingstaken die voor een project zijn gemaakt.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?api-version=2023-04-01

Met optionele parameters:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.
maxpagesize	query		integer int32	Het maximum aantal resources dat in één antwoord moet worden opgenomen.
skip	query		integer int32	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
top	query		integer int32	Het maximum aantal resources dat uit de verzameling moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	TextAnalysisAuthoringTrainingJobs	Lijst met de trainingstaken.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful List Training Jobs

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs?api-version=2023-04-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "result": {
        "modelLabel": "model1",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:45:06.8190649Z",
          "endDateTime": "2022-04-18T15:47:19.2639682Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:47:19.2734976Z",
          "endDateTime": "2022-04-18T15:47:23.8378892Z",
          "status": "succeeded"
        }
      },
      "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
      "createdDateTime": "2022-04-18T15:44:44Z",
      "lastUpdatedDateTime": "2022-04-18T15:47:50Z",
      "expirationDateTime": "2022-04-25T15:44:44Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:22:39.3663023Z",
          "endDateTime": "2022-04-18T17:24:51.9440947Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:24:51.9571747Z",
          "endDateTime": "2022-04-18T17:24:58.1427823Z",
          "status": "succeeded"
        }
      },
      "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000",
      "createdDateTime": "2022-04-18T17:22:11Z",
      "lastUpdatedDateTime": "2022-04-18T17:25:23Z",
      "expirationDateTime": "2022-04-25T17:22:11Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:44:41.388358Z",
          "endDateTime": "2022-04-18T17:50:29.5675101Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:50:29.5808461Z",
          "endDateTime": "2022-04-18T17:50:35.3482185Z",
          "status": "succeeded"
        }
      },
      "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000",
      "createdDateTime": "2022-04-18T17:44:04Z",
      "lastUpdatedDateTime": "2022-04-18T17:51:11Z",
      "expirationDateTime": "2022-04-25T17:44:04Z",
      "status": "succeeded"
    }
  ],
  "nextLink": null
}

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere 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.
JobStatus	De taakstatus.
TextAnalysisAuthoringSubTrainingJobState	Vertegenwoordigt de gedetailleerde status van een trainingssubbewerking.
TextAnalysisAuthoringTrainingJobResult	Vertegenwoordigt de uitvoer van een trainingstaak.
TextAnalysisAuthoringTrainingJobs	Vertegenwoordigt een lijst met opgehaalde trainingstaken.
TextAnalysisAuthoringTrainingJobState	Vertegenwoordigt de status van een trainingstaak.
TextAnalysisAuthoringWarning	Vertegenwoordigt een waarschuwing die is opgetreden tijdens het uitvoeren van de aanvraag.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Door mensen 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	Error	Het foutobject.

InnerErrorCode

Door mensen 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 specifiekere 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	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

JobStatus

De taakstatus.

Name	Type	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

Vertegenwoordigt de gedetailleerde status van een trainingssubbewerking.

Name	Type	Description
endDateTime	string	Vertegenwoordigt de einddatumtijd.
percentComplete	integer	Vertegenwoordigt voortgangspercentage.
startDateTime	string	Vertegenwoordigt de begindatum van de tijd.
status	JobStatus	Vertegenwoordigt de status van de subbewerking.

TextAnalysisAuthoringTrainingJobResult

Vertegenwoordigt de uitvoer van een trainingstaak.

Name	Type	Description
estimatedEndDateTime	string	Vertegenwoordigt de geschatte einddatum voor training en evaluatie.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Vertegenwoordigt de evaluatiestatus van het model.
modelLabel	string	Vertegenwoordigt het getrainde modellabel.
trainingConfigVersion	string	Vertegenwoordigt de configuratieversie van de training.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Vertegenwoordigt de status van de modeltrein.

TextAnalysisAuthoringTrainingJobs

Vertegenwoordigt een lijst met opgehaalde trainingstaken.

Name	Type	Description
nextLink	string	De koppeling naar de volgende pagina.
value	TextAnalysisAuthoringTrainingJobState[]	De lijst met taken.

TextAnalysisAuthoringTrainingJobState

Vertegenwoordigt de status van een trainingstaak.

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.
result	TextAnalysisAuthoringTrainingJobResult	Vertegenwoordigt het gedetailleerde resultaat van trainingstaken.
status	JobStatus	De taakstatus.
warnings	TextAnalysisAuthoringWarning[]	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.

Delen via