Compartilhar via


Text Analysis Authoring - Get Deployment Status

Obtém o status de um trabalho de implantação existente.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
deploymentName
path True

string

Representa o nome da implantação.

Endpoint
path True

string

url

Ponto de extremidade dos Serviços Cognitivos com suporte, por exemplo, https://.api.cognitiveservices.azure.com.

jobId
path True

string

A ID do trabalho.

projectName
path True

string

O novo nome do projeto.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

TextAnalysisAuthoringDeploymentJobState

A solicitação foi bem-sucedida.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

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

Successful Get Deployment Status

Solicitação de exemplo

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01

Resposta de exemplo

{
  "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
  "createdDateTime": "2022-04-18T15:52:48Z",
  "lastUpdatedDateTime": "2022-04-18T15:53:04Z",
  "expirationDateTime": "2022-04-25T15:52:48Z",
  "status": "succeeded"
}

Definições

Nome Description
Error

O objeto de erro.

ErrorCode

Código de erro legível por humanos.

ErrorResponse

Resposta de erro.

InnerErrorCode

Código de erro legível por humanos.

InnerErrorModel

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/Guidelines.md#7102-error-condition-responses.

JobStatus
TextAnalysisAuthoringDeploymentJobState

Representa o estado de um trabalho de implantação.

TextAnalysisAuthoringWarning

Representa um aviso encontrado durante a execução da solicitação.

Error

O objeto de erro.

Nome Tipo Description
code

ErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.

details

Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

innererror

InnerErrorModel

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.

ErrorCode

Código de erro legível por humanos.

Nome Tipo 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

Resposta de erro.

Nome Tipo Description
error

Error

O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Nome Tipo 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

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/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
code

InnerErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.

details

object

Detalhes do erro.

innererror

InnerErrorModel

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

message

string

Mensagem de erro.

target

string

Destino de erro.

JobStatus

Nome Tipo Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string

TextAnalysisAuthoringDeploymentJobState

Representa o estado de um trabalho de implantação.

Nome Tipo Description
createdDateTime

string

A hora da data de criação do trabalho.

errors

Error[]

Os erros encontrados durante a execução do trabalho.

expirationDateTime

string

A hora da data de validade do trabalho.

jobId

string

A ID do trabalho.

lastUpdatedDateTime

string

A hora da última data em que o trabalho foi atualizado.

status

JobStatus

O status do trabalho.

warnings

TextAnalysisAuthoringWarning[]

Os avisos que foram encontrados durante a execução do trabalho.

TextAnalysisAuthoringWarning

Representa um aviso encontrado durante a execução da solicitação.

Nome Tipo Description
code

string

O código de aviso.

message

string

A mensagem de aviso.