DocumentModelAdministrationClient class
Um cliente para interagir com os recursos de gerenciamento de modelos do serviço Reconhecimento de Formulários, como criar, ler, listar, excluir e copiar modelos.
Exemplos:
Azure Active Directory
import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new DocumentModelAdministrationClient(endpoint, credential);
Chave de API (Chave de Assinatura)
import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new DocumentModelAdministrationClient(endpoint, credential);
Construtores
| Document |
Criar uma instância de DocumentModelAdministrationClient de um ponto de extremidade de recurso e uma chave de API estática ( Exemplo: |
| Document |
Crie uma instância documentModelAdministrationClient de um ponto de extremidade de recurso e uma identidade Consulte o pacote para obter mais informações sobre como autenticar com o Exemplo: |
Métodos
| begin |
Crie um novo classificador de documento com a ID do classificador e os tipos de documento fornecidos. A ID do classificador deve ser exclusiva entre os classificadores dentro do recurso. Os tipos de documento são fornecidos como um objeto que mapeia o nome do tipo de documento para o conjunto de dados de treinamento para esse tipo de documento. Há suporte para dois métodos de entrada de dados de treinamento:
O serviço Reconhecimento de Formulários lê o conjunto de dados de treinamento de um contêiner do Armazenamento do Azure, fornecido como uma URL para o contêiner com um token SAS que permite que o back-end de serviço se comunique com o contêiner. No mínimo, as permissões "leitura" e "lista" são necessárias. Além disso, os dados no contêiner especificado devem ser organizados de acordo com uma convenção específica, que está documentada na documentação do serviço para a criação de classificadores de documentos personalizados. Exemplo |
| begin |
Crie um novo modelo com uma determinada ID de uma fonte de conteúdo de modelo. A ID do Modelo pode consistir em qualquer texto, desde que não comece com "prebuilt-" (pois esses modelos se referem a modelos de Reconhecimento de Formulários predefinidos que são comuns a todos os recursos) e desde que ainda não existam dentro do recurso. A fonte de conteúdo descreve o mecanismo que o serviço usará para ler os dados de treinamento de entrada. Consulte o <xref:DocumentModelContentSource> tipo para obter mais informações. Exemplo |
| begin |
Crie um novo modelo com uma determinada ID de um conjunto de documentos de entrada e campos rotulados. A ID do Modelo pode consistir em qualquer texto, desde que não comece com "prebuilt-" (pois esses modelos se referem a modelos de Reconhecimento de Formulários predefinidos que são comuns a todos os recursos) e desde que ainda não existam dentro do recurso. O serviço Reconhecimento de Formulários lê o conjunto de dados de treinamento de um contêiner do Armazenamento do Azure, fornecido como uma URL para o contêiner com um token SAS que permite que o back-end de serviço se comunique com o contêiner. No mínimo, as permissões "leitura" e "lista" são necessárias. Além disso, os dados no contêiner especificado devem ser organizados de acordo com uma convenção específica, que está documentada na documentação do serviço para a criação de modelos personalizados. Exemplo |
| begin |
Cria um único modelo composto de vários submodels pré-existentes. O modelo composto resultante combina os tipos de documento de seus modelos de componente e insere uma etapa de classificação no pipeline de extração para determinar qual de seus submodels de componente é mais apropriado para a entrada fornecida. Exemplo |
| begin |
Copia um modelo com a ID fornecida para o recurso e a ID do modelo codificados por uma determinada autorização de cópia. Consulte CopyAuthorization e getCopyAuthorization. Exemplo |
| delete |
Exclui um classificador com a ID fornecida do recurso do cliente, se ele existir. Esta operação NÃO PODE ser revertida. Exemplo |
| delete |
Exclui um modelo com a ID fornecida do recurso do cliente, se ele existir. Esta operação NÃO PODE ser revertida. Exemplo |
| get |
Cria uma autorização para copiar um modelo para o recurso, usado com o O Exemplo |
| get |
Recupera informações sobre um classificador (DocumentClassifierDetails) por ID. Exemplo |
| get |
Recupera informações sobre um modelo (DocumentModelDetails) por ID. Esse método pode recuperar informações sobre modelos personalizados e predefinidos. Alteração interruptivaEm versões anteriores do Reconhecimento de Formulários a API REST e o SDK, o Exemplo |
| get |
Recupera informações sobre uma operação ( As operações representam tarefas que não são de análise, como criar, redigir ou copiar um modelo. |
| get |
Recupere informações básicas sobre o recurso desse cliente. Exemplo |
| list |
Listar detalhes sobre classificadores no recurso. Essa operação dá suporte à paginação. ExemplosIteração assíncronaPor Página |
| list |
Listar resumos de modelos no recurso. Modelos personalizados e predefinidos serão incluídos. Essa operação dá suporte à paginação. O resumo do modelo (DocumentModelSummary) inclui apenas as informações básicas sobre o modelo e não inclui informações sobre os tipos de documento no modelo (como os esquemas de campo e valores de confiança). Para acessar as informações completas sobre o modelo, use getDocumentModel. Alteração interruptivaNas versões anteriores do Reconhecimento de Formulários a API REST e o SDK, o ExemplosIteração assíncronaPor Página |
| list |
Listar operações de criação de modelo no recurso. Isso produzirá todas as operações, incluindo operações que não conseguiram criar modelos com êxito. Essa operação dá suporte à paginação. ExemplosIteração assíncronaPor Página |
Detalhes do construtor
DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)
Criar uma instância de DocumentModelAdministrationClient de um ponto de extremidade de recurso e uma chave de API estática (KeyCredential),
Exemplo:
import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new DocumentModelAdministrationClient(endpoint, credential);
new DocumentModelAdministrationClient(endpoint: string, credential: KeyCredential, options?: DocumentModelAdministrationClientOptions)Parâmetros
- endpoint
-
string
a URL do ponto de extremidade de uma instância dos Serviços Cognitivos do Azure
- credential
- KeyCredential
um KeyCredential que contém a chave de assinatura da instância dos Serviços Cognitivos
configurações opcionais para configurar todos os métodos no cliente
DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)
Crie uma instância documentModelAdministrationClient de um ponto de extremidade de recurso e uma identidade TokenCredentialdo Azure .
Consulte o pacote para obter mais informações sobre como autenticar com o @azure/identity Azure Active Directory.
Exemplo:
import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new DocumentModelAdministrationClient(endpoint, credential);
new DocumentModelAdministrationClient(endpoint: string, credential: TokenCredential, options?: DocumentModelAdministrationClientOptions)Parâmetros
- endpoint
-
string
a URL do ponto de extremidade de uma instância dos Serviços Cognitivos do Azure
- credential
- TokenCredential
uma instância TokenCredential do @azure/identity pacote
configurações opcionais para configurar todos os métodos no cliente
Detalhes do método
beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)
Crie um novo classificador de documento com a ID do classificador e os tipos de documento fornecidos.
A ID do classificador deve ser exclusiva entre os classificadores dentro do recurso.
Os tipos de documento são fornecidos como um objeto que mapeia o nome do tipo de documento para o conjunto de dados de treinamento para esse tipo de documento. Há suporte para dois métodos de entrada de dados de treinamento:
azureBlobSource, que treina um classificador usando os dados no contêiner de Armazenamento de Blobs do Azure determinado.azureBlobFileListSource, que é semelhante aazureBlobSource, mas permite um controle mais refinado sobre os arquivos incluídos no conjunto de dados de treinamento usando uma lista de arquivos formatada em JSONL.
O serviço Reconhecimento de Formulários lê o conjunto de dados de treinamento de um contêiner do Armazenamento do Azure, fornecido como uma URL para o contêiner com um token SAS que permite que o back-end de serviço se comunique com o contêiner. No mínimo, as permissões "leitura" e "lista" são necessárias. Além disso, os dados no contêiner especificado devem ser organizados de acordo com uma convenção específica, que está documentada na documentação do serviço para a criação de classificadores de documentos personalizados.
Exemplo
const classifierId = "aNewClassifier";
const containerUrl1 = "<training data container SAS URL 1>";
const containerUrl2 = "<training data container SAS URL 2>";
const poller = await client.beginBuildDocumentClassifier(
classifierId,
{
// The document types. Each entry in this object should map a document type name to a
// `ClassifierDocumentTypeDetails` object
"formX": {
azureBlobSource: {
containerUrl: containerUrl1,
}
},
"formY": {
azureBlobFileListSource: {
containerUrl: containerUrl2,
fileList: "path/to/fileList.jsonl"
}
},
},
{
// Optionally, a text description may be attached to the classifier
description: "This is an example classifier!"
}
);
// Classifier building, like model creation operations, returns a poller that eventually produces a
// DocumentClassifierDetails object
const classifierDetails = await poller.pollUntilDone();
const {
classifierId, // identical to the classifierId given when creating the classifier
description, // identical to the description given when creating the classifier (if any)
createdOn, // the Date (timestamp) that the classifier was created
docTypes // information about the document types in the classifier and their details
} = classifierDetails;
function beginBuildDocumentClassifier(classifierId: string, docTypeSources: DocumentClassifierDocumentTypeSources, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>Parâmetros
- classifierId
-
string
a ID exclusiva do classificador a ser criado
- docTypeSources
- DocumentClassifierDocumentTypeSources
os tipos de documento a serem incluídos no classificador e suas fontes (um mapa de nomes de tipo de documento para ClassifierDocumentTypeDetails)
configurações opcionais para a operação de build do classificador
Retornos
Promise<DocumentClassifierPoller>
uma operação de execução longa (poller) que eventualmente produzirá os detalhes do classificador criado ou um erro
beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)
Crie um novo modelo com uma determinada ID de uma fonte de conteúdo de modelo.
A ID do Modelo pode consistir em qualquer texto, desde que não comece com "prebuilt-" (pois esses modelos se referem a modelos de Reconhecimento de Formulários predefinidos que são comuns a todos os recursos) e desde que ainda não existam dentro do recurso.
A fonte de conteúdo descreve o mecanismo que o serviço usará para ler os dados de treinamento de entrada. Consulte o <xref:DocumentModelContentSource> tipo para obter mais informações.
Exemplo
const modelId = "aNewModel";
const poller = await client.beginBuildDocumentModel(modelId, { containerUrl: "<SAS-encoded blob container URL>" }, {
// Optionally, a text description may be attached to the model
description: "This is an example model!"
});
// Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();
const {
modelId, // identical to the modelId given when creating the model
description, // identical to the description given when creating the model
createdOn, // the Date (timestamp) that the model was created
docTypes // information about the document types in the model and their field schemas
} = modelDetails;
function beginBuildDocumentModel(modelId: string, contentSource: DocumentModelSource, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>Parâmetros
- modelId
-
string
a ID exclusiva do modelo a ser criado
- contentSource
- DocumentModelSource
uma fonte de conteúdo que fornece os dados de treinamento para esse modelo
- buildMode
-
DocumentModelBuildMode
o modo a ser usado ao criar o modelo (consulte DocumentModelBuildMode)
- options
- BeginBuildDocumentModelOptions
configurações opcionais para a operação de build do modelo
Retornos
Promise<DocumentModelPoller>
uma operação de execução longa (poller) que eventualmente produzirá as informações de modelo criadas ou um erro
beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)
Crie um novo modelo com uma determinada ID de um conjunto de documentos de entrada e campos rotulados.
A ID do Modelo pode consistir em qualquer texto, desde que não comece com "prebuilt-" (pois esses modelos se referem a modelos de Reconhecimento de Formulários predefinidos que são comuns a todos os recursos) e desde que ainda não existam dentro do recurso.
O serviço Reconhecimento de Formulários lê o conjunto de dados de treinamento de um contêiner do Armazenamento do Azure, fornecido como uma URL para o contêiner com um token SAS que permite que o back-end de serviço se comunique com o contêiner. No mínimo, as permissões "leitura" e "lista" são necessárias. Além disso, os dados no contêiner especificado devem ser organizados de acordo com uma convenção específica, que está documentada na documentação do serviço para a criação de modelos personalizados.
Exemplo
const modelId = "aNewModel";
const containerUrl = "<training data container SAS URL>";
const poller = await client.beginBuildDocumentModel(modelId, containerUrl, {
// Optionally, a text description may be attached to the model
description: "This is an example model!"
});
// Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();
const {
modelId, // identical to the modelId given when creating the model
description, // identical to the description given when creating the model
createdOn, // the Date (timestamp) that the model was created
docTypes // information about the document types in the model and their field schemas
} = modelDetails;
function beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>Parâmetros
- modelId
-
string
a ID exclusiva do modelo a ser criado
- containerUrl
-
string
URL codificada por SAS para um contêiner do Armazenamento do Azure que contém o conjunto de dados de treinamento
- buildMode
-
DocumentModelBuildMode
o modo a ser usado ao criar o modelo (consulte DocumentModelBuildMode)
- options
- BeginBuildDocumentModelOptions
configurações opcionais para a operação de build de modelo
Retornos
Promise<DocumentModelPoller>
uma operação de longa execução (poller) que eventualmente produzirá as informações de modelo criadas ou um erro
beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)
Cria um único modelo composto de vários submodels pré-existentes.
O modelo composto resultante combina os tipos de documento de seus modelos de componente e insere uma etapa de classificação no pipeline de extração para determinar qual de seus submodels de componente é mais apropriado para a entrada fornecida.
Exemplo
const modelId = "aNewComposedModel";
const subModelIds = [
"documentType1Model",
"documentType2Model",
"documentType3Model"
];
// The resulting composed model can classify and extract data from documents
// conforming to any of the above document types
const poller = await client.beginComposeDocumentModel(modelId, subModelIds, {
description: "This is a composed model that can handle several document types."
});
// Model composition, like all other model creation operations, returns a poller that eventually produces a
// ModelDetails object
const modelDetails = await poller.pollUntilDone();
const {
modelId, // identical to the modelId given when creating the model
description, // identical to the description given when creating the model
createdOn, // the Date (timestamp) that the model was created
docTypes // information about the document types of the composed submodels
} = modelDetails;
function beginComposeDocumentModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeDocumentModelOptions): Promise<DocumentModelPoller>Parâmetros
- modelId
-
string
a ID exclusiva do modelo a ser criado
- componentModelIds
-
Iterable<string>
um Iterável de cadeias de caracteres que representam as IDs de modelo exclusivas dos modelos a serem redigidos
- options
- BeginComposeDocumentModelOptions
configurações opcionais para criação de modelo
Retornos
Promise<DocumentModelPoller>
uma operação de longa execução (poller) que eventualmente produzirá as informações de modelo criadas ou um erro
beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)
Copia um modelo com a ID fornecida para o recurso e a ID do modelo codificados por uma determinada autorização de cópia.
Consulte CopyAuthorization e getCopyAuthorization.
Exemplo
// We need a client for the source model's resource
const sourceEndpoint = "https://<source resource name>.cognitiveservices.azure.com";
const sourceCredential = new AzureKeyCredential("<source api key>");
const sourceClient = new DocumentModelAdministrationClient(sourceEndpoint, sourceCredential);
// We create the copy authorization using a client authenticated with the destination resource. Note that these two
// resources can be the same (you can copy a model to a new ID in the same resource).
const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");
// Finally, use the _source_ client to copy the model and await the copy operation
const poller = await sourceClient.beginCopyModelTo("<source model ID>");
// Model copying, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();
const {
modelId, // identical to the modelId given when creating the copy authorization
description, // identical to the description given when creating the copy authorization
createdOn, // the Date (timestamp) that the model was created
docTypes // information about the document types of the model (identical to the original, source model)
} = modelDetails;
function beginCopyModelTo(sourceModelId: string, authorization: CopyAuthorization, options?: BeginCopyModelOptions): Promise<DocumentModelPoller>Parâmetros
- sourceModelId
-
string
a ID exclusiva do modelo de origem que será copiada
- authorization
- CopyAuthorization
uma autorização para copiar o modelo, criada usando getCopyAuthorization
- options
- BeginCopyModelOptions
configurações opcionais para
Retornos
Promise<DocumentModelPoller>
uma operação de longa execução (poller) que eventualmente produzirá as informações de modelo copiadas ou um erro
deleteDocumentClassifier(string, OperationOptions)
Exclui um classificador com a ID fornecida do recurso do cliente, se ele existir. Esta operação NÃO PODE ser revertida.
Exemplo
await client.deleteDocumentClassifier("<classifier ID to delete>"));
function deleteDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<void>Parâmetros
- classifierId
-
string
a ID exclusiva do classificador a ser excluída do recurso
- options
- OperationOptions
configurações opcionais para a solicitação
Retornos
Promise<void>
deleteDocumentModel(string, DeleteDocumentModelOptions)
Exclui um modelo com a ID fornecida do recurso do cliente, se ele existir. Esta operação NÃO PODE ser revertida.
Exemplo
await client.deleteDocumentModel("<model ID to delete>"));
function deleteDocumentModel(modelId: string, options?: DeleteDocumentModelOptions): Promise<void>Parâmetros
- modelId
-
string
a ID exclusiva do modelo a ser excluída do recurso
- options
- DeleteDocumentModelOptions
configurações opcionais para a solicitação
Retornos
Promise<void>
getCopyAuthorization(string, GetCopyAuthorizationOptions)
Cria uma autorização para copiar um modelo para o recurso, usado com o beginCopyModelTo método .
O CopyAuthorization concede a outro recurso de serviço cognitivo o direito de criar um modelo no recurso desse cliente com a ID do modelo e a descrição opcional codificadas na autorização.
Exemplo
// The copyAuthorization data structure stored below grants any cognitive services resource the right to copy a
// model into the client's resource with the given destination model ID.
const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");
function getCopyAuthorization(destinationModelId: string, options?: GetCopyAuthorizationOptions): Promise<CopyAuthorization>Parâmetros
- destinationModelId
-
string
a ID exclusiva do modelo de destino (a ID para a qual copiar o modelo)
- options
- GetCopyAuthorizationOptions
configurações opcionais para criar a autorização de cópia
Retornos
Promise<CopyAuthorization>
uma autorização de cópia que codifica a modelId fornecida e a descrição opcional
getDocumentClassifier(string, OperationOptions)
Recupera informações sobre um classificador (DocumentClassifierDetails) por ID.
Exemplo
const classifierId = "<classifier ID";
const {
classifierId, // identical to the ID given when calling `getDocumentClassifier`
description, // a textual description of the classifier, if provided during classifier creation
createdOn, // the Date (timestamp) that the classifier was created
// information about the document types in the classifier and their corresponding traning data
docTypes
} = await client.getDocumentClassifier(classifierId);
// The `docTypes` property is a map of document type names to information about the training data
// for that document type.
for (const [docTypeName, classifierDocTypeDetails] of Object.entries(docTypes)) {
console.log(`- '${docTypeName}': `, classifierDocTypeDetails);
}
function getDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<DocumentClassifierDetails>Parâmetros
- classifierId
-
string
a ID exclusiva do classificador a ser consultada
- options
- OperationOptions
configurações opcionais para a solicitação
Retornos
Promise<DocumentClassifierDetails>
informações sobre o classificador com a ID fornecida
getDocumentModel(string, GetModelOptions)
Recupera informações sobre um modelo (DocumentModelDetails) por ID.
Esse método pode recuperar informações sobre modelos personalizados e predefinidos.
Alteração interruptiva
Em versões anteriores do Reconhecimento de Formulários a API REST e o SDK, o getModel método poderia retornar qualquer modelo, mesmo um que não foi criado devido a erros. Nas novas versões de serviço, getDocumentModel e listDocumentModelsproduzem apenas modelos criados com êxito (ou seja, modelos que estão "prontos" para uso). Os modelos com falha agora são recuperados por meio das APIs de "operações", consulte getOperation e listOperations.
Exemplo
// The ID of the prebuilt business card model
const modelId = "prebuilt-businessCard";
const {
modelId, // identical to the modelId given when calling `getDocumentModel`
description, // a textual description of the model, if provided during model creation
createdOn, // the Date (timestamp) that the model was created
// information about the document types in the model and their field schemas
docTypes: {
// the document type of the prebuilt business card model
"prebuilt:businesscard": {
// an optional, textual description of this document type
description,
// the schema of the fields in this document type, see the FieldSchema type
fieldSchema,
// the service's confidences in the fields (an object with field names as properties and numeric confidence
// values)
fieldConfidence
}
}
} = await client.getDocumentModel(modelId);
function getDocumentModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>Parâmetros
- modelId
-
string
a ID exclusiva do modelo a ser consultada
- options
- GetModelOptions
configurações opcionais para a solicitação
Retornos
Promise<DocumentModelDetails>
informações sobre o modelo com a ID fornecida
getOperation(string, GetOperationOptions)
Recupera informações sobre uma operação (OperationDetails) por sua ID.
As operações representam tarefas que não são de análise, como criar, redigir ou copiar um modelo.
function getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationDetails>Parâmetros
- operationId
-
string
a ID da operação a ser consultada
- options
- GetOperationOptions
configurações opcionais para a solicitação
Retornos
Promise<OperationDetails>
informações sobre a operação com a ID fornecida
Exemplo
// The ID of the operation, which should be a GUID
const operationId = "<operation GUID>";
const {
operationId, // identical to the operationId given when calling `getOperation`
kind, // the operation kind, one of "documentModelBuild", "documentModelCompose", or "documentModelCopyTo"
status, // the status of the operation, one of "notStarted", "running", "failed", "succeeded", or "canceled"
percentCompleted, // a number between 0 and 100 representing the progress of the operation
createdOn, // a Date object that reflects the time when the operation was started
lastUpdatedOn, // a Date object that reflects the time when the operation state was last modified
} = await client.getOperation(operationId);
getResourceDetails(GetResourceDetailsOptions)
Recupere informações básicas sobre o recurso desse cliente.
Exemplo
const {
// Information about the custom models in the current resource
customDocumentModelDetails: {
// The number of custom models in the current resource
count,
// The maximum number of models that the current resource can support
limit
}
} = await client.getResourceDetails();
function getResourceDetails(options?: GetResourceDetailsOptions): Promise<ResourceDetails>Parâmetros
- options
- GetResourceDetailsOptions
configurações opcionais para a solicitação
Retornos
Promise<ResourceDetails>
informações básicas sobre o recurso deste cliente
listDocumentClassifiers(ListModelsOptions)
Listar detalhes sobre classificadores no recurso. Essa operação dá suporte à paginação.
Exemplos
Iteração assíncrona
for await (const details of client.listDocumentClassifiers()) {
const {
classifierId, // The classifier's unique ID
description, // a textual description of the classifier, if provided during creation
docTypes, // information about the document types in the classifier and their corresponding traning data
} = details;
}
Por Página
// The listDocumentClassifiers method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listDocumentClassifiers().byPage();
for await (const page of pages) {
// Each page is an array of classifiers and can be iterated synchronously
for (const details of page) {
const {
classifierId, // The classifier's unique ID
description, // a textual description of the classifier, if provided during creation
docTypes, // information about the document types in the classifier and their corresponding traning data
} = details;
}
}
function listDocumentClassifiers(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentClassifierDetails, DocumentClassifierDetails[], PageSettings>Parâmetros
- options
- ListModelsOptions
configurações opcionais para as solicitações do classificador
Retornos
uma iterável assíncrona de detalhes do classificador que dá suporte à paginação
listDocumentModels(ListModelsOptions)
Listar resumos de modelos no recurso. Modelos personalizados e predefinidos serão incluídos. Essa operação dá suporte à paginação.
O resumo do modelo (DocumentModelSummary) inclui apenas as informações básicas sobre o modelo e não inclui informações sobre os tipos de documento no modelo (como os esquemas de campo e valores de confiança).
Para acessar as informações completas sobre o modelo, use getDocumentModel.
Alteração interruptiva
Nas versões anteriores do Reconhecimento de Formulários a API REST e o SDK, o listModels método retornaria todos os modelos, mesmo aqueles que não foram criados devido a erros. Nas novas versões de serviço, listDocumentModels e getDocumentModelproduzem apenas modelos criados com êxito (ou seja, modelos que estão "prontos" para uso). Os modelos com falha agora são recuperados por meio das APIs de "operações", consulte getOperation e listOperations.
Exemplos
Iteração assíncrona
for await (const summary of client.listDocumentModels()) {
const {
modelId, // The model's unique ID
description, // a textual description of the model, if provided during model creation
} = summary;
// You can get the full model info using `getDocumentModel`
const model = await client.getDocumentModel(modelId);
}
Por Página
// The listDocumentModels method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listDocumentModels().byPage();
for await (const page of pages) {
// Each page is an array of models and can be iterated synchronously
for (const model of page) {
const {
modelId, // The model's unique ID
description, // a textual description of the model, if provided during model creation
} = summary;
// You can get the full model info using `getDocumentModel`
const model = await client.getDocumentModel(modelId);
}
}
function listDocumentModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary, DocumentModelSummary[], PageSettings>Parâmetros
- options
- ListModelsOptions
configurações opcionais para as solicitações de modelo
Retornos
um iterável assíncrono de resumos de modelo que dá suporte à paginação
listOperations(ListOperationsOptions)
Listar operações de criação de modelo no recurso. Isso produzirá todas as operações, incluindo operações que não conseguiram criar modelos com êxito. Essa operação dá suporte à paginação.
Exemplos
Iteração assíncrona
for await (const operation of client.listOperations()) {
const {
operationId, // the operation's GUID
status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
percentCompleted // the progress of the operation, from 0 to 100
} = operation;
}
Por Página
// The listOperations method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listOperations().byPage();
for await (const page of pages) {
// Each page is an array of operation info objects and can be iterated synchronously
for (const operation of page) {
const {
operationId, // the operation's GUID
status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
percentCompleted // the progress of the operation, from 0 to 100
} = operation;
}
}
function listOperations(options?: ListOperationsOptions): PagedAsyncIterableIterator<OperationSummary, OperationSummary[], PageSettings>Parâmetros
- options
- ListOperationsOptions
configurações opcionais para as solicitações de operação
Retornos
um iterável assíncrono de objetos de informações de operação que dão suporte à paginação