Miscellaneous Operations - Get Document Model Copy To Operation

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-30

Obtém informações da operação.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentModelCopyToOperation&api-version=2024-11-30

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	O ponto de extremidade do serviço de Inteligência de Documentos.
operationId	path	True	string	ID da operação
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessá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

Name	Tipo	Description
200 OK	DocumentModelCopyToOperationDetails	O pedido foi bem-sucedido. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

DocumentModelCopyToOperationDetails

O pedido foi bem-sucedido.

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
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Get Operation - Document Model Copy To

Pedido de amostra

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentModelCopyToOperation&api-version=2024-11-30

Resposta da amostra

Código de estado:: 200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelCopyTo",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-11-30"
  }
}

Definições

Name	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
DocumentAnalysisFeature	Recursos de análise de documentos para habilitar.
DocumentBuildMode	Modo de construção de modelo de documento personalizado.
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	Estado da operação.
DocumentIntelligenceWarning	O objeto de erro.
DocumentModelCopyToOperationDetails	Obter objeto de resposta Operation.
DocumentModelDetails	Informações do modelo do documento.
DocumentTypeDetails	Informações sobre o tipo de documento.
OperationKind	Tipo de operação.
SplitMode	Comportamento de divisão de ficheiros.

AzureBlobContentSource

Object

Conteúdo do Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string (uri)	URL do contêiner de Armazenamento de Blobs do Azure.
prefix	string	Prefixo do nome do blob.

AzureBlobFileListContentSource

Object

Lista de ficheiros no Armazenamento de Blobs do Azure.

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

DocumentAnalysisFeature

Enumeração

Recursos de análise de documentos para habilitar.

Valor	Description
barcodes	Habilite a deteção de códigos de barras no documento.
formulas	Permitir a deteção de expressões matemáticas no documento.
keyValuePairs	Habilite a deteção de pares de valores de chave gerais (campos de formulário) no documento.
languages	Habilite a deteção do idioma do conteúdo de texto.
ocrHighResolution	Execute OCR em uma resolução mais alta para lidar com documentos com letras miúdas.
queryFields	Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.
styleFont	Permitir o reconhecimento de vários estilos de fonte.

DocumentBuildMode

Enumeração

Modo de construção de modelo de documento personalizado.

Valor	Description
neural	Documentos de suporte com diversos modelos visuais.
template	Documentos de destino com modelos visuais semelhantes.

DocumentFieldSchema

Object

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

Name	Tipo	Description
description	string maxLength: 4096	Descrição do campo.
example	string	Exemplo de conteúdo do campo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento da matriz.
properties	<string, DocumentFieldSchema>	Subcampos nomeados do campo de objeto.
type	DocumentFieldType	Tipo de dados semânticos do valor do campo.

DocumentFieldType

Enumeração

Tipo de dados semânticos do valor do campo.

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

DocumentIntelligenceError

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Object

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

Object

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

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

DocumentIntelligenceOperationStatus

Enumeração

Estado da operação.

Valor	Description
canceled	A operação foi cancelada.
failed	A operação falhou.
notStarted	A operação ainda não começou.
running	A operação está em curso.
skipped	A operação foi ignorada.
succeeded	A operação foi bem sucedida.

DocumentIntelligenceWarning

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de aviso definido pelo servidor.
message	string	Uma representação legível por humanos do aviso.
target	string	O alvo do erro.

DocumentModelCopyToOperationDetails

Object

Obter objeto de resposta Operation.

Name	Tipo	Description
apiVersion	string	Versão da API usada para criar esta operação.
createdDateTime	string (date-time)	Data e hora (UTC) em que a operação foi criada.
error	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelCopyTo	Tipo de operação.
lastUpdatedDateTime	string (date-time)	Data e hora (UTC) em que o estado foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer (int32) minimum: 0 maximum: 100	Progresso da operação (0-100).
resourceLocation	string (uri)	URL do recurso visado por esta operação.
result	DocumentModelDetails	Resultado da operação após o sucesso.
status	DocumentIntelligenceOperationStatus	Estado da operação. notIniciado, em execução, concluído ou com falha
tags	object	Lista de atributos de tag chave-valor associados ao modelo de documento.

DocumentModelDetails

Object

Informações do modelo do documento.

Name	Tipo	Default value	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 construção de modelo de documento personalizado.
classifierId	string		Para modelos compostos, o classificador personalizado para dividir e classificar o arquivo de entrada.
createdDateTime	string (date-time)		Data e hora (UTC) em que o modelo de documento foi criado.
description	string maxLength: 4096		Descrição do modelo do documento.
docTypes	<string, DocumentTypeDetails>		Tipos de documentos suportados.
expirationDateTime	string (date-time)		Data e hora (UTC) em que o modelo de documento expirará.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nome exclusivo do modelo de documento.
modifiedDateTime	string (date-time)		Data e hora (UTC) em que 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 tag chave-valor associados ao modelo de documento.
trainingHours	number (float)		Número de horas de GPU equivalente a V100 consumidas para treinamento de modelos.
warnings	DocumentIntelligenceWarning[]		Lista de avisos encontrados durante a criação do modelo.

DocumentTypeDetails

Object

Informações sobre o tipo de documento.

Name	Tipo	Description
buildMode	DocumentBuildMode	Modo de construção de modelo de documento personalizado.
confidenceThreshold	number (float)	Execute a análise apenas se a confiança docType estiver acima do limite.
description	string maxLength: 4096	Descrição do modelo do 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 (int32)	Número máximo de documentos do tipo especificado para analisar. Padrão = todos.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Modelo de documento a ser usado para analisar documentos com o tipo especificado.
queryFields	string[]	Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"

OperationKind

Enumeração

Tipo de operação.

Valor	Description
documentClassifierBuild	Crie um novo modelo de classificador personalizado.
documentClassifierCopyTo	Copie um classificador de documentos existente para um recurso, região ou assinatura potencialmente diferente.
documentModelBuild	Crie um novo modelo de documento personalizado.
documentModelCompose	Componha um novo modelo de documento personalizado a partir de modelos existentes.
documentModelCopyTo	Copie um modelo de documento existente para potencialmente um recurso, região ou assinatura diferente.

SplitMode

Enumeração

Comportamento de divisão de ficheiros.

Valor	Description
auto	Divida automaticamente o arquivo em documentos.
none	Trate todo o arquivo como um único documento.
perPage	Trate cada página do arquivo como um documento separado.

Partilhar via

Miscellaneous Operations - Get Document Model Copy To Operation

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Get Operation - Document Model Copy To

Pedido de amostra

Resposta da amostra

Definições

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceOperationStatus

DocumentIntelligenceWarning

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

OperationKind

SplitMode

Recursos adicionais