DocumentAnalysisPollOperationState interface

Pacote:

@azure/ai-form-recognizer

O estado de uma operação de análise, que eventualmente produzirá o tipo de resultado que corresponde ao modelo.

Extends

@azure/core-lro.PollOperationState<Result>

Propriedades

createdOn	A data e a hora em que a operação foi criada.
lastUpdatedOn	A data & hora em que o estado da operação foi modificado pela última vez.
modelId	A ID do modelo que a operação de análise usará para produzir o resultado.
operationLocation	A URL da operação.
status	O status da operação. Um de: "notStarted" "em execução" "bem-sucedido" "Falha"

Propriedades herdadas

error	Existirá se a operação tiver encontrado algum erro.
isCancelled	True se a operação tiver sido cancelada.
isCompleted	True se a operação tiver sido concluída.
isStarted	True se a operação tiver sido iniciada.
result	Existirá se a operação for concluída em um resultado de um tipo esperado.

Detalhes da propriedade

createdOn

A data e a hora em que a operação foi criada.

createdOn: Date

Valor da propriedade

Date

lastUpdatedOn

A data & hora em que o estado da operação foi modificado pela última vez.

lastUpdatedOn: Date

Valor da propriedade

Date

modelId

A ID do modelo que a operação de análise usará para produzir o resultado.

modelId: string

Valor da propriedade

string

operationLocation

A URL da operação.

operationLocation: string

Valor da propriedade

string

status

O status da operação. Um de:

• "notStarted"
• "em execução"
• "bem-sucedido"
• "Falha"

status: AnalyzeResultOperationStatus

Valor da propriedade

AnalyzeResultOperationStatus

Detalhes das propriedades herdadas

error

Existirá se a operação tiver encontrado algum erro.

error?: Error

Valor da propriedade

Error

Herdado de PollOperationState.error

isCancelled

True se a operação tiver sido cancelada.

isCancelled?: boolean

Valor da propriedade

boolean

Herdado de PollOperationState.isCancelled

isCompleted

True se a operação tiver sido concluída.

isCompleted?: boolean

Valor da propriedade

boolean

Herdado de PollOperationState.isCompleted

isStarted

True se a operação tiver sido iniciada.

isStarted?: boolean

Valor da propriedade

boolean

Herdado de PollOperationState.isStarted

result

Existirá se a operação for concluída em um resultado de um tipo esperado.

result?: Result

Valor da propriedade

Result

Herdado de PollOperationState.result