Custom Models - Train

Serviço:

Azure AI Services

Versão da API:

2.1

Criar e treinar um modelo personalizado. A solicitação deve incluir um parâmetro de origem que seja um URI de contêiner do Azure Storage Blob acessível externamente (de preferência, um URI de Assinatura de Acesso Compartilhado) ou um caminho válido para uma pasta de dados em uma unidade montada localmente. Quando caminhos locais são especificados, eles devem seguir o formato de caminho do Linux/UNIX e ser um caminho absoluto com raiz para o valor da configuração de montagem de entrada, por exemplo, se o valor da definição de configuração '{Mounts:Input}' for '/input', um caminho de origem válido será '/input/contosodataset'. Espera-se que todos os dados a serem treinados estejam sob a pasta de origem ou subpastas abaixo dela. Os modelos são treinados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' ou 'image/bmp'. Outro tipo de conteúdo é ignorado.

POST {endpoint}/formrecognizer/v2.1/custom/models

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
source	True	string	Caminho de origem que contém os documentos de treinamento.
modelName		string	Nome do modelo definido pelo usuário opcional (comprimento máximo: 1024).
sourceFilter		TrainSourceFilter	Filtre para aplicar aos documentos no caminho de origem para treinamento.
useLabelFile		boolean	Use o arquivo de rótulo para treinar um modelo.

Respostas

Nome	Tipo	Description
201 Created		A solicitação é enfileirada com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Train custom model

Train custom model with subfolder filter options

Train custom model

Solicitação de exemplo

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models


{
  "source": "{azure_blob_endpoint}/input/data1?sasToken"
}

Resposta de exemplo

Código de status:

201

Location: {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Train custom model with subfolder filter options

Solicitação de exemplo

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models


{
  "source": "{azure_blob_endpoint}/input/data1?sasToken",
  "sourceFilter": {
    "prefix": "",
    "includeSubFolders": false
  },
  "useLabelFile": false
}

Resposta de exemplo

Código de status:

201

Location: {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Definições

Nome	Description
ErrorInformation
ErrorResponse
TrainRequest	Parâmetro de solicitação para treinar um novo modelo personalizado.
TrainSourceFilter	Filtre para aplicar aos documentos no caminho de origem para treinamento.

ErrorInformation

Nome	Tipo	Description
code	string
message	string

ErrorResponse

Nome	Tipo	Description
error	ErrorInformation

TrainRequest

Parâmetro de solicitação para treinar um novo modelo personalizado.

Nome	Tipo	Valor padrão	Description
modelName	string		Nome do modelo definido pelo usuário opcional (comprimento máximo: 1024).
source	string		Caminho de origem que contém os documentos de treinamento.
sourceFilter	TrainSourceFilter		Filtre para aplicar aos documentos no caminho de origem para treinamento.
useLabelFile	boolean	False	Use o arquivo de rótulo para treinar um modelo.

TrainSourceFilter

Filtre para aplicar aos documentos no caminho de origem para treinamento.

Nome	Tipo	Valor padrão	Description
includeSubFolders	boolean	False	Um sinalizador para indicar se as subpastas dentro do conjunto de pastas de prefixo também precisarão ser incluídas ao pesquisar o conteúdo a ser pré-processado.
prefix	string		Uma cadeia de caracteres de prefixo que diferencia maiúsculas de minúsculas para filtrar documentos no caminho de origem para treinamento. Por exemplo, ao usar um URI de blob de armazenamento do Azure, use o prefixo para restringir subpastas para treinamento.