Miscellaneous Operations - List Operations

Referência

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Listas todas as operações.

GET {endpoint}/documentintelligence/operations?api-version=2024-02-29-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	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	PagedOperationDetails	A solicitação foi bem-sucedida. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Description

200 OK

PagedOperationDetails

A solicitação foi bem-sucedida.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Exemplos

Get Operations

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-02-29-preview

Sample Response

Status code:: 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-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Definições

Nome	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de arquivos em Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta operação.
DocumentClassifierDetails	Informações do classificador de documentos.
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.
DocumentModelBuildOperationDetails	Obter objeto de resposta operação.
DocumentModelComposeOperationDetails	Obter objeto de resposta operação.
DocumentModelCopyToOperationDetails	Obter objeto de resposta operação.
DocumentModelDetails	Informações do modelo de documento.
DocumentTypeDetails	Informações de tipo de documento.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
OperationKind	Tipo de operação.
OperationStatus	Status da operação.
PagedOperationDetails	Coleção paginada de itens OperationDetails
Warning	O objeto de erro.

AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

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

AzureBlobFileListContentSource

Lista de arquivos em Armazenamento de Blobs do Azure.

Nome	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contêiner.
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	Armazenamento de Blobs do Azure lista de arquivos que especifica os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure local 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 Armazenamento de Blobs do Azure.
azureBlobFileList	string	Uma lista de arquivos que especifica arquivos individuais em um contêiner de 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.

DocumentBuildMode

Modo de build do modelo de documento personalizado.

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

DocumentClassifierBuildOperationDetails

Obter objeto de resposta 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	Error	Erro encontrado.
kind	string: documentClassifierBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentClassifierDetails	Resultado da operação após o êxito.
status	OperationStatus	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 documentos.

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 documentos.
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á.
warnings	Warning[]	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 do campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string, DocumentFieldSchema>	Subcampos 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 true ou false.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA).
currency	string	Conversor de Moedas quantidade com o símbolo e a unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (YYY-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).

DocumentModelBuildOperationDetails

Obter objeto de resposta 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	Error	Erro encontrado.
kind	string: documentModelBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	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 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	Error	Erro encontrado.
kind	string: documentModelCompose	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	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 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	Error	Erro encontrado.
kind	string: documentModelCopyTo	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	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	Description
apiVersion	string	Versão da API usada para criar este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource	Armazenamento de Blobs do Azure lista de arquivos que especifica os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure local que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
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.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.
warnings	Warning[]	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.
description	string	Descrição do modelo de documento.
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.

Error

O objeto de erro.

Nome	Tipo	Description
code	string	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	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 homem do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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	InnerError	Erro interno.
message	string	Uma representação legível pelo homem do erro.

OperationKind

Tipo de operação.

Nome	Tipo	Description
documentClassifierBuild	string	Crie um novo modelo de classificador personalizado.
documentModelBuild	string	Crie um novo modelo de documento personalizado.
documentModelCompose	string	Compor 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.

OperationStatus

Status da operação.

Nome	Tipo	Description
canceled	string	A operação foi cancelada.
completed	string	A operação foi concluída.
failed	string	A operação falhou.
notStarted	string	A operação ainda não foi iniciada.
running	string	A operação está em andamento.
succeeded	string	Êxito na operação.

PagedOperationDetails

Coleção paginada de itens OperationDetails

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

Warning

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 por humanos do aviso.
target	string	O destino do erro.

Compartilhar via

Miscellaneous Operations - List Operations

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Exemplos

Get Operations

Sample Request

Sample Response

Definições

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

PagedOperationDetails

Warning

Recursos adicionais