Miscellaneous Operations - List Operations

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Lista todas as operações.

GET {endpoint}/documentintelligence/operations?api-version=2024-11-30

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PagedDocumentIntelligenceOperationDetails	A solicitação foi bem-sucedida. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	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

Get Operations

Solicitação de exemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-11-30

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Definições

Nome	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de arquivos no Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentAnalysisFeature	Recursos de análise de documentos a serem habilitados.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta da Operação.
DocumentClassifierCopyToOperationDetails	Obter objeto de resposta da Operação.
DocumentClassifierDetails	Informações do classificador de documento.
DocumentFieldSchema	Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.
DocumentFieldType	Tipo de dados semânticos do valor do campo.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
DocumentIntelligenceOperationStatus	Status da operação.
DocumentIntelligenceWarning	O objeto de erro.
DocumentModelBuildOperationDetails	Obter objeto de resposta da Operação.
DocumentModelComposeOperationDetails	Obter objeto de resposta da Operação.
DocumentModelCopyToOperationDetails	Obter objeto de resposta da Operação.
DocumentModelDetails	Informações do modelo de documento.
DocumentTypeDetails	Informações de tipo de documento.
OperationKind	Tipo de operação.
PagedDocumentIntelligenceOperationDetails	Coleção de páginas de itens DocumentIntelligenceOperationDetails
SplitMode	Comportamento de divisão de arquivos.

AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

Nome	Tipo	Description
containerUrl	string	URL do contêiner do Armazenamento de Blobs do Azure.
prefix	string	Prefixo de nome de blob.

AzureBlobFileListContentSource

Lista de arquivos no Armazenamento de Blobs do Azure.

Nome	Tipo	Description
containerUrl	string	URL do contêiner do Armazenamento de Blobs do Azure.
fileList	string	Caminho para um arquivo JSONL dentro do contêiner especificando um subconjunto de documentos.

ClassifierDocumentTypeDetails

Informações de tipo de documento do classificador.

Nome	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource	Local do Armazenamento de Blobs do Azure que contém os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
sourceKind	ContentSourceKind	Tipo de fonte de dados de treinamento.

ContentSourceKind

Tipo de fonte de conteúdo.

Nome	Tipo	Description
azureBlob	string	Arquivos em um caminho dentro de um contêiner do Armazenamento de Blobs do Azure.
azureBlobFileList	string	Uma lista de arquivos que especifica arquivos individuais em um contêiner do Armazenamento de Blobs do Azure.
base64	string	Conteúdo representado por meio da codificação Base64.
url	string	Conteúdo em uma URL específica.

DocumentAnalysisFeature

Recursos de análise de documentos a serem habilitados.

Nome	Tipo	Description
barcodes	string	Habilite a detecção de códigos de barras no documento.
formulas	string	Habilite a detecção de expressões matemáticas no documento.
keyValuePairs	string	Habilite a detecção de pares de valor de chave geral (campos de formulário) no documento.
languages	string	Habilite a detecção do idioma de conteúdo de texto.
ocrHighResolution	string	Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina.
queryFields	string	Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.
styleFont	string	Habilite o reconhecimento de vários estilos de fonte.

DocumentBuildMode

Modo de build do modelo de documento personalizado.

Nome	Tipo	Description
neural	string	Suporte a documentos com modelos visuais diversos.
template	string	Documentos de destino com modelos visuais semelhantes.

DocumentClassifierBuildOperationDetails

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentClassifierBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentClassifierDetails	Resultado da operação após o êxito.
status	DocumentIntelligenceOperationStatus	Status da operação. notStarted, running, completed ou failed
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentClassifierCopyToOperationDetails

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentClassifierCopyTo	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentClassifierDetails	Resultado da operação após o êxito.
status	DocumentIntelligenceOperationStatus	Status da operação. notStarted, running, completed ou failed
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentClassifierDetails

Informações do classificador de documento.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documento.
baseClassifierId	string	ClassifierId base na parte superior da qual o classificador foi treinado.
classifierId	string	Nome do classificador de documento exclusivo.
createdDateTime	string	Data e hora (UTC) quando o classificador de documento foi criado.
description	string	Descrição do classificador de documento.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documento expirará.
modifiedDateTime	string	Data e hora (UTC) quando o modelo de documento foi modificado pela última vez.
warnings	DocumentIntelligenceWarning[]	Lista de avisos encontrados durante a criação do classificador.

DocumentFieldSchema

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

Nome	Tipo	Description
description	string	Descrição do campo.
example	string	Conteúdo de campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string,  DocumentFieldSchema>	Sub-campos nomeados do campo de objeto.
type	DocumentFieldType	Tipo de dados semânticos do valor do campo.

DocumentFieldType

Tipo de dados semânticos do valor do campo.

Nome	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booliano normalizado como verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato alfa-3 ISO 3166-1 (por exemplo, EUA).
currency	string	Valor de moeda com símbolo e unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (YYYY-MM-DD).
integer	string	Número inteiro, normalizado para inteiro com sinal de 64 bits.
number	string	Número de ponto flutuante normalizado para ponto flutuante de precisão dupla.
object	string	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de telefone normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadeia de caracteres selecionados.
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto sem formatação.
time	string	Hora, normalizada para o formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Nome	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

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

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

DocumentIntelligenceOperationStatus

Status da operação.

Nome	Tipo	Description
canceled	string	A operação foi cancelada.
failed	string	A operação falhou.
notStarted	string	A operação ainda não foi iniciada.
running	string	A operação está em andamento.
skipped	string	A operação foi ignorada.
succeeded	string	A operação foi bem-sucedida.

DocumentIntelligenceWarning

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de aviso.
message	string	Uma representação legível pelo ser humano do aviso.
target	string	O destino do erro.

DocumentModelBuildOperationDetails

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	DocumentIntelligenceOperationStatus	Status da operação. notStarted, running, completed ou failed
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelComposeOperationDetails

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelCompose	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	DocumentIntelligenceOperationStatus	Status da operação. notStarted, running, completed ou failed
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelCopyToOperationDetails

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelCopyTo	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	DocumentIntelligenceOperationStatus	Status da operação. notStarted, running, completed ou failed
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelDetails

Informações do modelo de documento.

Nome	Tipo	Valor padrão	Description
apiVersion	string		Versão da API usada para criar este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource		Local do Armazenamento de Blobs do Azure que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
buildMode	DocumentBuildMode		Modo de build do modelo de documento personalizado.
classifierId	string		Para modelos compostos, o classificador personalizado para dividir e classificar o arquivo de entrada.
createdDateTime	string		Data e hora (UTC) quando o modelo de documento foi criado.
description	string		Descrição do modelo de documento.
docTypes	<string,  DocumentTypeDetails>		Tipos de documento com suporte.
expirationDateTime	string		Data e hora (UTC) em que o modelo de documento expirará.
modelId	string		Nome exclusivo do modelo de documento.
modifiedDateTime	string		Data e hora (UTC) quando o modelo de documento foi modificado pela última vez.
split	SplitMode	none	Para modelos compostos, o comportamento de divisão de arquivos.
tags	object		Lista de atributos de marca chave-valor associados ao modelo de documento.
trainingHours	number		Número de horas de GPU equivalentes à V100 consumidas para treinamento de modelo.
warnings	DocumentIntelligenceWarning[]		Lista de avisos encontrados durante a criação do modelo.

DocumentTypeDetails

Informações de tipo de documento.

Nome	Tipo	Description
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
confidenceThreshold	number	Somente execute a análise se a confiança docType estiver acima do limite.
description	string	Descrição do modelo de documento.
features	DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
fieldConfidence	object	Confiança estimada para cada campo.
fieldSchema	<string,  DocumentFieldSchema>	Descrição do esquema semântico do documento usando uma sintaxe de estilo de esquema JSON.
maxDocumentsToAnalyze	integer	Número máximo de documentos do tipo especificado a serem analisados. Default=all.
modelId	string	Modelo de documento a ser usado para analisar documentos com o tipo especificado.
queryFields	string[]	Lista de campos adicionais a serem extraídos. Ex. "NumberOfGuests,StoreNumber"

OperationKind

Tipo de operação.

Nome	Tipo	Description
documentClassifierBuild	string	Crie um novo modelo de classificador personalizado.
documentClassifierCopyTo	string	Copie um classificador de documento existente para potencialmente um recurso, uma região ou uma assinatura diferente.
documentModelBuild	string	Crie um novo modelo de documento personalizado.
documentModelCompose	string	Redigir um novo modelo de documento personalizado de modelos existentes.
documentModelCopyTo	string	Copie um modelo de documento existente para potencialmente um recurso, uma região ou uma assinatura diferente.

PagedDocumentIntelligenceOperationDetails

Coleção de páginas de itens DocumentIntelligenceOperationDetails

Nome	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	DocumentIntelligenceOperationDetails[]: DocumentClassifierBuildOperationDetails[] DocumentClassifierCopyToOperationDetails[] DocumentModelBuildOperationDetails[] DocumentModelComposeOperationDetails[] DocumentModelCopyToOperationDetails[]	Os itens DocumentIntelligenceOperationDetails nesta página

SplitMode

Comportamento de divisão de arquivos.

Nome	Tipo	Description
auto	string	Divida automaticamente o arquivo em documentos.
none	string	Trate todo o arquivo como um único documento.
perPage	string	Trate cada página no arquivo como um documento separado.