Text Analysis Authoring List Training Jobs - Text Analysis Authoring List Training Jobs

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

Lista os trabalhos de treinamento não expirados criados para um projeto.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string (url)	Ponto de extremidade dos Serviços Cognitivos com suporte, por exemplo, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	O novo nome do projeto.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
maxpagesize	query		integer (int32)	O número máximo de itens de resultado por página.
skip	query		integer (int32)	O número de itens de resultado a serem ignoradas.
top	query		integer (int32)	O número de itens de resultado a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	PagedTextAnalysisAuthoringTrainingJobState	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

PagedTextAnalysisAuthoringTrainingJobState

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

SuccessfulListTrainingJobs

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
JobStatus
PagedTextAnalysisAuthoringTrainingJobState	Coleção paged de itens TextAnalysisAuthoringTrainingJobState
TextAnalysisAuthoringSubTrainingJobState	Representa o estado detalhado de uma sub-operação de treinamento.
TextAnalysisAuthoringTrainingJobResult	Representa a saída de um trabalho de treinamento.
TextAnalysisAuthoringTrainingJobState	Representa o estado de um trabalho de treinamento.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

JobStatus

Enumeração

Valor	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

PagedTextAnalysisAuthoringTrainingJobState

Objeto

Coleção paged de itens TextAnalysisAuthoringTrainingJobState

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	TextAnalysisAuthoringTrainingJobState[]	Os itens TextAnalysisAuthoringTrainingJobState nesta página

TextAnalysisAuthoringSubTrainingJobState

Objeto

Representa o estado detalhado de uma sub-operação de treinamento.

Nome	Tipo	Description
endDateTime	string (date-time)	Representa a hora da data de término.
percentComplete	integer (int32)	Representa a porcentagem de progresso.
startDateTime	string (date-time)	Representa a data de início.
status	JobStatus	Representa o status da sub-operação.

TextAnalysisAuthoringTrainingJobResult

Objeto

Representa a saída de um trabalho de treinamento.

Nome	Tipo	Description
estimatedEndDateTime	string (date-time)	Representa a data de término da estimativa para treinamento e avaliação.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Representa o status de avaliação do modelo.
modelLabel	string	Representa o rótulo de modelo treinado.
trainingConfigVersion	string	Representa a versão de configuração de treinamento.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Representa o status do treinamento de modelo.

TextAnalysisAuthoringTrainingJobState

Objeto

Representa o estado de um trabalho de treinamento.

Nome	Tipo	Description
createdDateTime	string (date-time)	A hora da data de criação do trabalho.
errors	Azure.Core.Foundations.Error[]	Os erros encontrados durante a execução do trabalho.
expirationDateTime	string (date-time)	A hora da data de validade do trabalho.
jobId	string	A ID do trabalho.
lastUpdatedDateTime	string (date-time)	A hora da última data em que o trabalho foi atualizado.
result	TextAnalysisAuthoringTrainingJobResult	Representa o resultado detalhado das tarefas de treinamento.
status	JobStatus	O status do trabalho.
warnings	Azure.Core.Foundations.Error[]	Os avisos que foram encontrados durante a execução do trabalho.

Compartilhar via

Text Analysis Authoring List Training Jobs - Text Analysis Authoring List Training Jobs

Parâmetros de URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

SuccessfulListTrainingJobs

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

JobStatus

PagedTextAnalysisAuthoringTrainingJobState

TextAnalysisAuthoringSubTrainingJobState

TextAnalysisAuthoringTrainingJobResult

TextAnalysisAuthoringTrainingJobState