Como criar projetos de classificação personalizada de texto

Neste artigo, saiba como configurar os requisitos para iniciar com classificação de textos personalizada e criar um projeto.

Pré-requisitos

Antes de começar a usar a classificação personalizada de texto, será necessária:

• Uma assinatura do Azure – Crie uma gratuitamente.

Criar um recurso de Linguagem

Antes de começar a usar a classificação de texto personalizado, será necessário um recurso da Linguagem de IA do Azure. É recomendável criar o recurso de Linguagem e conectar uma conta de armazenamento a ele no portal do Azure. A criação de um recurso no portal do Azure permite criar uma conta de armazenamento do Azure ao mesmo tempo, com todas as permissões necessárias pré-configuradas. Também é possível continuar a leitura do artigo para aprender a usar um recurso pré-existente e configurá-lo para trabalhar com a classificação personalizada de texto.

Você também precisará de uma conta de armazenamento do Azure para carregar seus documentos .txt que serão usados no treinamento de um modelo para classificar o texto.

Observação

• Você precisa ter uma função de proprietário atribuída no grupo de recursos para criar um recurso de Linguagem.
• Se você conectar uma conta de armazenamento pré-existente, deverá ter uma função de proprietário atribuída.

Criar recurso de Linguagem e conectar conta de armazenamento

Observação

Você não deve mover a conta de armazenamento para um grupo de recursos ou uma assinatura diferente depois dela estar vinculada ao recurso de Idioma.

Azure portal

Criar um recurso usando o portal do Azure

1. Vá para o portal do Azure para criar um novo recurso de Linguagem da IA do Azure.

2. Na janela exibida, selecione Classificação de textos personalizada e reconhecimento de entidade nomeada personalizada nos recursos personalizados. Selecione Continuar para criar seu recurso na parte inferior da tela.

   

3. Crie um recurso de Linguagem com os seguintes detalhes.

   Nome	Valor obrigatório
   Subscription	Sua assinatura do Azure.
   Resource group	O grupo de recursos que conterá seu recurso. É possível usar um grupo existente ou criar um do zero.
   Região	Uma das regiões com suporte. Por exemplo, "Oeste dos EUA 2".
   Nome	Um nome para seu recurso.
   Tipo de preço	Um dos tipos de preços com suporte. Use a camada Gratuita (F0) para experimentar o serviço.

   Se você receber uma mensagem dizendo que "sua conta de logon não é uma proprietária do grupo de recursos da conta de armazenamento selecionada", sua conta precisará ter uma função de proprietário atribuída no grupo de recursos antes de criar um recurso de linguagem. Entre em contato com o proprietário da assinatura do Azure para obter ajuda.

   Determine o proprietário da assinatura do Azure pesquisando seu grupo de recursos e seguindo o link para a assinatura associada. Em seguida:

   1. Selecione a guia Controle de Acesso (IAM)
   2. Selecione Atribuições de função
   3. Filtrar por Função:Proprietário.

4. Na seção Classificação de textos personalizada e reconhecimento de entidade nomeada personalizada, selecione uma conta de armazenamento existente ou Nova conta de armazenamento. Observe que esses valores são para ajudar você a começar a usar o recurso, e não são necessariamente os valores de conta de armazenamento que você usará nos ambientes de produção. Para evitar latência durante a criação do projeto, conecte-se às contas de armazenamento na mesma região que o recurso de Linguagem.

   Valor de conta de armazenamento	Valor recomendado
   Nome da conta de armazenamento	Qualquer nome
   Tipo de conta de armazenamento	LRS Padrão

5. Verifique se a opção Aviso de IA Responsável está marcada. Selecione Revisar + criar na parte inferior da página.

Language Studio

Criar um novo recurso de Linguagem no Language Studio

Se for seu primeiro login, você verá uma janela no Language Studio para escolher um recurso de Linguagem existente ou criar um novo. Também é possível criar um recurso clicando no ícone de configurações no canto superior direito, selecionando Recursos e, em seguida, Criar um novo recurso.

Crie um recurso de Linguagem com os seguintes detalhes.

Detalhes da instância	Valor obrigatório
Assinatura do Azure	sua assinatura do Azure
Grupo de recursos do Azure	O grupo de recursos do Azure
Nome do recurso do Azure	O nome do recurso do Azure
Location	A região do recurso de Linguagem.
Tipo de preço	O tipo de preço do recurso de Linguagem.

Importante

• Verifique se você habilitou a Identidade Gerenciada ao criar um recurso de idioma.
• Ler e confirmar aviso de IA Responsável

Para usar a classificação de texto personalizada, você precisará conectar seu recurso a uma conta de armazenamento. Se você não tiver uma, poderá criar uma conta de Armazenamento do Azure. Use as etapas a seguir para criar seu primeiro projeto e conectar sua conta de armazenamento.

1. Entre no Language Studio. Uma janela será exibida para permitir que você selecione sua assinatura e o recurso idioma. Selecione o recurso de idioma.

2. Na seção Classificar textos do Language Studio, selecione Classificação de textos personalizada.

   

3. Selecione Criar projeto no menu superior na página de projetos. A criação de um projeto permitirá que você rotule dados, treine, avalie, melhore e implante seus modelos.

   

4. Depois de clicar em Criar projeto, uma janela será exibida para permitir que você conecte sua conta de armazenamento. Se você já tiver conectado uma conta de armazenamento, verá o armazenamento conectado. Caso contrário, escolha a conta de armazenamento na lista suspensa que aparece e selecione Conectar conta de armazenamento. Isso definirá as funções necessárias para a sua conta de armazenamento. É possível que essa etapa retorne um erro se você não for atribuído como proprietário na conta de armazenamento.

   Observação

   • Você só precisa fazer essa etapa uma vez para cada novo recurso de linguagem usado.
   • Esse processo é irreversível, se você conectar uma conta de armazenamento ao recurso de idioma, não poderá desconectá-la posteriormente.
   • É possível conectar o recurso de idioma a apenas uma conta de armazenamento.

   

5. Selecione o tipo de projeto. Você pode criar um projeto de classificação de vários rótulos em que cada documento pode pertencer a uma ou mais classes ou um projeto de classificação de rótulo único em que cada documento pode pertencer a apenas uma classe. O tipo selecionado não poderá ser alterado mais tarde. Saiba mais sobre os tipos de projeto

   

6. Insira as informações do projeto, incluindo um nome, uma descrição e o idioma dos documentos em seu projeto. Se você estiver usando o conjunto de dados de exemplo, selecione Inglês. Você não poderá alterar o nome do projeto mais tarde. Selecione Avançar.

   Dica

   Seu conjunto de dados não precisa estar totalmente no mesmo idioma. Você pode ter vários documentos, cada um com diferentes idiomas compatíveis. Se o conjunto de dados contiver documentos de idiomas diferentes ou se você esperar um texto de diferentes idiomas durante o runtime, selecione Habilitar conjunto de dados multilíngue ao inserir as informações básicas no projeto. Essa opção pode ser habilitada posteriormente na página Configurações do projeto.

7. Selecione o contêiner em que você carregou o conjunto de dados.

   Observação

   Se você já rotulou os dados, verifique se eles seguem o formato com suporte e selecione Sim, meus documentos já estão rotulados e formatei o arquivo de rótulos JSON e selecione o arquivo de rótulos no menu suspenso.

   Se você estiver usando um dos conjuntos de dados de exemplo, use o arquivo JSON webOfScience_labelsFile ou movieLabels incluído. Em seguida, selecione Avançar.

8. Revise os dados inseridos e selecione Criar Projeto.

Usando o PowerShell do Azure

É possível criar um novo recurso e uma conta de armazenamento usando o modelo de CLI e os arquivos de parâmetros a seguir, que estão hospedados no GitHub.

Edite os seguintes valores no arquivo de parâmetros:

Nome do parâmetro	Descrição do valor
name	Nome do recurso do Language
location	A região que hospeda o recurso. Consulte o suporte à região para obter mais informações.
sku	O tipo de preço do recurso. Confira limites do serviço para obter mais informações.
storageResourceName	O nome da conta de armazenamento
storageLocation	Região na qual sua conta de armazenamento está hospedada.
storageSkuType	SKU da conta de armazenamento.
storageResourceGroupName	Grupo de recursos da conta de armazenamento

Use o comando do PowerShell a seguir para implantar o modelo do ARM (Azure Resource Manager) com os arquivos que você editou.

New-AzResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateFile <path-to-arm-template> `
  -TemplateParameterFile <path-to-parameters-file>

Consulte a documentação do modelo do ARM para saber como implantar modelos e arquivos de parâmetro.

Observação

• O processo de conexão de uma conta de armazenamento ao recurso de Linguagem é irreversível, não pode ser desconectado posteriormente.
• É possível conectar o recurso de linguagem a apenas uma conta de armazenamento.

Usando um recurso de Linguagem pré-existente

Requisito	Descrição
Regiões	Verifique se o recurso existente está provisionado em uma das regiões com suporte. Se você não tiver um recurso, precisará criar um novo em uma região com suporte.
Tipo de preço	O tipo de preço do seu recurso.
Identidade gerenciada	Habilite a configuração da identidade gerenciada do recurso. Se ela não estiver habilitada, veja a próxima seção.

Para usar a classificação de texto personalizado, crie uma conta de armazenamento do Azure se você ainda não tiver uma.

Habilitar o gerenciamento de identidade para o recurso

Azure portal

O recurso de Linguagem deve ter gerenciamento de identidade, para habilitá-lo usando o portal do Azure:

1. Acesse o recurso de Linguagem
2. No menu à esquerda, na seção Gerenciamento de Recursos, selecione Identidade
3. Na guia Atribuído pelo sistema, defina o Status como Ativado

Language Studio

O recurso de Linguagem deve ter gerenciamento de identidade, para habilitá-lo usando o Language Studio:

1. Clique no ícone configurações no canto superior direito da tela
2. Selecione Recursos
3. Marque a caixa de seleção Identidade Gerenciada do recurso de Linguagem de IA do Azure.

Habilitar o recurso de classificação de texto personalizado

Habilite o recurso Classificação de textos personalizada/Reconhecimento de entidade nomeada personalizada no portal do Azure.

1. Acesse o recurso de Linguagem no portal do Azure
2. No menu do lado esquerdo, na seção Gerenciamento de Recursos, selecione Recursos
3. Habilite o recurso Classificação de textos personalizada / Reconhecimento de entidade nomeada personalizada
4. Conecte-se à conta de armazenamento
5. Selecione Aplicar.

Importante

• Verifique se o recurso de Linguagem tem a função de colaborador de dados do blob de armazenamento atribuída na conta de armazenamento que você está conectando.

Definir funções para o recurso de Linguagem da IA do Azure e a conta de armazenamento

Use as etapas a seguir para definir as funções necessárias do recurso de Linguagem e a conta de armazenamento.

Funções para o recurso de Linguagem de IA do Azure

1. Acesse a conta de armazenamento e o recurso de Linguagem no portal do Azure.

2. Selecione Controle de acesso (IAM) no menu de navegação à esquerda.

3. Selecione Adicionar para Adicionar Atribuições de Função e escolha a função apropriada para a conta.

   Você precisa ter a função de proprietário ou colaborador atribuída no recurso de Linguagem.

4. Em Atribuir acesso a, selecione Usuário, grupo ou entidade de serviço

5. Selecione Selecionar membros

6. Selecione o nome de usuário. É possível pesquisar nomes de usuário no campo Selecionar. Repita isso para todas as funções.

7. Repita essas etapas para todas as contas de usuário que precisam de acesso a esse recurso.

Funções para sua conta de armazenamento

1. Acesse a página da conta de armazenamento no portal do Azure.
2. Selecione Controle de acesso (IAM) no menu de navegação à esquerda.
3. Selecione Adicionar para Adicionar Atribuições de Função e escolha a função de Colaborador de dados do blob Armazenamento na conta de armazenamento.
4. Em Atribuir acesso a, selecione Identidade Gerenciada.
5. Selecione Selecionar membros
6. Selecione a assinatura e Linguagem como a identidade gerenciada. É possível pesquisar nomes de usuário no campo Selecionar.

Importante

Se você tiver uma rede virtual ou um ponto de extremidade privado, selecione Permitir que os serviços do Azure na lista de serviços confiáveis acessem essa conta de armazenamento no portal do Azure.

Habilite o CORS para sua conta de armazenamento

Permita os métodos (GET, PUT, DELETE) ao habilitar o CORS (compartilhamento de recursos entre origens). Defina o campo de origens permitido como https://language.cognitive.azure.com. Permita todo o cabeçalho adicionando * aos valores de cabeçalho permitidos e defina a idade máxima como 500.

Criar um projeto de classificação de textos personalizada

Após configurar o recurso e o contêiner de armazenamento, crie um projeto de classificação de textos personalizada. Um projeto é uma área de trabalho para a criação de modelos de IA personalizados com base em seus dados. Seu projeto só pode ser acessado por você e por outras pessoas que têm acesso ao recurso do Azure que está sendo usado. Se você rotulou os dados, pode importá-los para começar.

Language Studio

1. Entre no Language Studio. Uma janela será exibida para permitir que você selecione sua assinatura e o recurso idioma. Selecione o recurso de idioma.

2. Na seção Classificar textos do Language Studio, selecione Classificação de textos personalizada.

   

3. Selecione Criar projeto no menu superior na página de projetos. A criação de um projeto permitirá que você rotule dados, treine, avalie, melhore e implante seus modelos.

   

4. Depois de clicar em Criar projeto, uma janela será exibida para permitir que você conecte sua conta de armazenamento. Se você já tiver conectado uma conta de armazenamento, verá o armazenamento conectado. Caso contrário, escolha a conta de armazenamento na lista suspensa que aparece e selecione Conectar conta de armazenamento. Isso definirá as funções necessárias para a sua conta de armazenamento. É possível que essa etapa retorne um erro se você não for atribuído como proprietário na conta de armazenamento.

   Observação

   • Você só precisa fazer essa etapa uma vez para cada novo recurso de linguagem usado.
   • Esse processo é irreversível, se você conectar uma conta de armazenamento ao recurso de idioma, não poderá desconectá-la posteriormente.
   • É possível conectar o recurso de idioma a apenas uma conta de armazenamento.

   

5. Selecione o tipo de projeto. Você pode criar um projeto de classificação de vários rótulos em que cada documento pode pertencer a uma ou mais classes ou um projeto de classificação de rótulo único em que cada documento pode pertencer a apenas uma classe. O tipo selecionado não poderá ser alterado mais tarde. Saiba mais sobre os tipos de projeto

   

6. Insira as informações do projeto, incluindo um nome, uma descrição e o idioma dos documentos em seu projeto. Se você estiver usando o conjunto de dados de exemplo, selecione Inglês. Você não poderá alterar o nome do projeto mais tarde. Selecione Avançar.

   Dica

   Seu conjunto de dados não precisa estar totalmente no mesmo idioma. Você pode ter vários documentos, cada um com diferentes idiomas compatíveis. Se o conjunto de dados contiver documentos de idiomas diferentes ou se você esperar um texto de diferentes idiomas durante o runtime, selecione Habilitar conjunto de dados multilíngue ao inserir as informações básicas no projeto. Essa opção pode ser habilitada posteriormente na página Configurações do projeto.

7. Selecione o contêiner em que você carregou o conjunto de dados.

   Observação

   Se você já rotulou os dados, verifique se eles seguem o formato com suporte e selecione Sim, meus documentos já estão rotulados e formatei o arquivo de rótulos JSON e selecione o arquivo de rótulos no menu suspenso.

   Se você estiver usando um dos conjuntos de dados de exemplo, use o arquivo JSON webOfScience_labelsFile ou movieLabels incluído. Em seguida, selecione Avançar.

8. Revise os dados inseridos e selecione Criar Projeto.

APIs REST

Para começar a criar um modelo de classificação de textos personalizada, você precisa criar um projeto. A criação de um projeto permitirá que você rotule dados, treine, avalie, melhore e implante seus modelos.

Observação

O nome do projeto diferencia maiúsculas e minúsculas em todas as operações.

Crie uma solicitação PATCH usando a URL, os cabeçalhos e o corpo JSON a seguir para criar seu projeto.

URL da solicitação

Use a URL a seguir para criar um projeto. Substitua os valores dos espaços reservados abaixo pelos seus próprios valores.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version={API-VERSION}

Espaço reservado	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticação de sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando. O valor referenciado aqui é para a versão mais recente lançada. Consulte o Ciclo de vida do modelo para saber mais sobre outras versões de API disponíveis.	2022-05-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave	Valor
Ocp-Apim-Subscription-Key	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo

Use o JSON a seguir em sua solicitação. Substitua os valores dos espaços reservados abaixo pelos seus próprios valores.

Classificação de vários rótulos

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "customMultiLabelClassification",
  "description": "Project description",
  "multilingual": "True",
  "storageInputContainerName": "{CONTAINER-NAME}"
}

Chave	Espaço reservado	Valor	Exemplo
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
Linguagem	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de linguagem para os documentos usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos documentos. Confira Suporte de idioma para saber mais sobre os códigos de idioma compatíveis.	en-us
projectKind	customMultiLabelClassification	O tipo de projeto.	customMultiLabelClassification
multilíngue	true	Um valor booliano que permite ter documentos em várias linguagens no conjunto de dados e, quando o modelo é implantado, é possível consultar o modelo em qualquer linguagem com suporte, não necessariamente incluída nos documentos de treinamento. Confira suporte de idioma para saber mais sobre o suporte multilíngue.	true
storageInputContainerName	{CONTAINER-NAME}	O nome do contêiner de armazenamento do Azure em que você carregou os documentos.	myContainer

Classificação de rótulo único

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "customSingleLabelClassification",
  "description": "Project description",
  "multilingual": "True",
  "storageInputContainerName": "{CONTAINER-NAME}"
}

Chave	Espaço reservado	Valor	Exemplo
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
Linguagem	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de linguagem para os documentos usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos documentos. Confira Suporte de idioma para saber mais sobre os códigos de idioma compatíveis.	en-us
projectKind	customSingleLabelClassification	O tipo de projeto.	customSingleLabelClassification
multilíngue	true	Um valor booliano que permite ter documentos em várias linguagens no conjunto de dados e, quando o modelo é implantado, é possível consultar o modelo em qualquer linguagem com suporte, não necessariamente incluída nos documentos de treinamento. Confira suporte de idioma para saber mais sobre o suporte multilíngue.	true
storageInputContainerName	{CONTAINER-NAME}	O nome do contêiner de armazenamento do Azure em que você carregou os documentos.	myContainer

Esta solicitação retornará uma resposta de 201, o que significa que o projeto foi criado.

Essa solicitação retornará um erro se:

• O recurso selecionado não tem a permissão apropriada para a conta de armazenamento.

Importar um projeto de classificação de textos personalizada

Se você já rotulou os dados, pode usá-los para começar a usar o serviço. Verifique se os dados rotulados seguem os formatos de dados aceitos.

Language Studio

1. Entre no Language Studio. Uma janela será exibida para permitir que você selecione sua assinatura e o recurso idioma. Selecione o recurso de idioma.

2. Na seção Classificar textos do Language Studio, selecione Classificação de textos personalizada.

   

3. Selecione Criar projeto no menu superior na página de projetos. A criação de um projeto permitirá que você rotule dados, treine, avalie, melhore e implante seus modelos.

   

4. Depois de selecionar Criar projeto, uma tela será exibida para permitir que você conecte sua conta de armazenamento. Se você não conseguir encontrar a sua conta de armazenamento, verifique se você criou um recurso seguindo as etapas recomendadas. Se você já tiver conectado uma conta de armazenamento ao recurso de Linguagem, verá a conta de armazenamento conectada.

   Observação

   • Você só precisa fazer essa etapa uma vez para cada novo recurso de linguagem usado.
   • Esse processo é irreversível, se você conectar uma conta de armazenamento ao recurso de idioma, não poderá desconectá-la posteriormente.
   • É possível conectar o recurso de idioma a apenas uma conta de armazenamento.

   

5. Selecione o tipo de projeto. Você pode criar um projeto de classificação de vários rótulos em que cada documento pode pertencer a uma ou mais classes ou um projeto de classificação de rótulo único em que cada documento pode pertencer a apenas uma classe. O tipo selecionado não poderá ser alterado mais tarde.

   

6. Insira as informações do projeto, incluindo um nome, uma descrição e o idioma dos documentos em seu projeto. Você não poderá alterar o nome do projeto mais tarde. Selecione Avançar.

   Dica

   Seu conjunto de dados não precisa estar totalmente no mesmo idioma. Você pode ter vários documentos, cada um com diferentes idiomas compatíveis. Se o conjunto de dados contiver documentos de idiomas diferentes ou se você esperar um texto de diferentes idiomas durante o runtime, selecione Habilitar conjunto de dados multilíngue ao inserir as informações básicas no projeto. Essa opção pode ser habilitada posteriormente na página Configurações do projeto.

7. Selecione o contêiner em que você carregou o conjunto de dados.

8. Clique em Sim, meus documentos já estão rotulados e formatei o arquivo de rótulos JSON e selecione o arquivo de rótulos no menu suspenso abaixo para importar o arquivo de rótulos JSON. Verifique se ele segue o formato com suporte.

9. Selecione Avançar.

10. Revise os dados inseridos e selecione Criar Projeto.

APIs REST

Envie uma solicitaçãoPOST usando o URL, os cabeçalhos e o corpo JSON a seguir para importar o arquivo de rótulos. Verifique se o arquivo de rótulos segue o formato de arquivo aceito.

Se já existir um projeto com o mesmo nome, os dados desse projeto serão substituídos.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?api-version={API-VERSION}

Espaço reservado	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticação de sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando. O valor referenciado aqui é para a versão mais recente lançada. Saiba mais sobre as outras versões de API disponíveis	2022-05-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave	Valor
Ocp-Apim-Subscription-Key	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo

Use o JSON a seguir em sua solicitação. Substitua os valores dos espaços reservados abaixo pelos seus próprios valores.

Classificação de vários rótulos

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectName": "{PROJECT-NAME}",
    "storageInputContainerName": "{CONTAINER-NAME}",
    "projectKind": "customMultiLabelClassification",
    "description": "Trying out custom multi label text classification",
    "language": "{LANGUAGE-CODE}",
    "multilingual": true,
    "settings": {}
  },
  "assets": {
    "projectKind": "customMultiLabelClassification",
    "classes": [
      {
        "category": "Class1"
      },
      {
        "category": "Class2"
      }
    ],
    "documents": [
      {
        "location": "{DOCUMENT-NAME}",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "classes": [
          {
            "category": "Class1"
          },
          {
            "category": "Class2"
          }
        ]
      },
      {
        "location": "{DOCUMENT-NAME}",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "classes": [
          {
            "category": "Class2"
          }
        ]
      }
    ]
  }
}

Chave	Espaço reservado	Valor	Exemplo
api-version	{API-VERSION}	A versão da API que você está chamando. A versão usada aqui precisa ser a mesma versão da API na URL. Saiba mais sobre as outras versões de API disponíveis	2022-05-01
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
projectKind	customMultiLabelClassification	O tipo de projeto.	customMultiLabelClassification
Linguagem	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de linguagem para os documentos usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos documentos. Confira suporte de idioma para saber mais sobre o suporte multilíngue.	en-us
multilíngue	true	Um valor booliano que permite ter documentos em várias linguagens no conjunto de dados e, quando o modelo é implantado, é possível consultar o modelo em qualquer linguagem com suporte, não necessariamente incluída nos documentos de treinamento. Confira suporte de idioma para saber mais sobre o suporte multilíngue.	true
storageInputContainerName	{CONTAINER-NAME}	O nome do contêiner de armazenamento do Azure em que você carregou os documentos.	myContainer
classes	[]	Matriz que contém todas as classes presentes no projeto. São as classes em que você deseja classificar seus documentos.	[]
documentos	[]	Matriz que contém todos os documentos no projeto e quais são as classes rotuladas para este documento.	[]
local	{DOCUMENT-NAME}	O local dos documentos no contêiner de armazenamento. Como todos os documentos estão na raiz do contêiner, esse deve ser o nome do documento.	doc1.txt
dataset	{DATASET}	O conjunto de teste para o qual esse documento será exibido, quando dividido antes do treinamento. Confira Como treinar um modelo para obter mais informações sobre divisão de dados. Os valores possíveis para esse campo são Train e Test.	Train

Classificação de rótulo único

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectName": "{PROJECT-NAME}",
    "storageInputContainerName": "{CONTAINER-NAME}",
    "projectKind": "customSingleLabelClassification",
    "description": "Trying out custom multi label text classification",
    "language": "{LANGUAGE-CODE}",
    "multilingual": true,
    "settings": {}
  },
  "assets": {
    "projectKind": "customSingleLabelClassification",
        "classes": [
            {
                "category": "Class1"
            },
            {
                "category": "Class2"
            }
        ],
        "documents": [
            {
                "location": "{DOCUMENT-NAME}",
                "language": "{LANGUAGE-CODE}",
                "dataset": "{DATASET}",
                "class": {
                    "category": "Class2"
                }
            },
            {
                "location": "{DOCUMENT-NAME}",
                "language": "{LANGUAGE-CODE}",
                "dataset": "{DATASET}",
                "class": {
                    "category": "Class1"
                }
            }
        ]
    }
}

Chave	Espaço reservado	Valor	Exemplo
api-version	{API-VERSION}	A versão da API que você está chamando. A versão usada aqui precisa ser a mesma versão da API na URL.	2022-05-01
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
projectKind	customSingleLabelClassification	O tipo de projeto.	customSingleLabelClassification
Linguagem	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de linguagem para os documentos usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos documentos. Confira Suporte de idioma para saber mais sobre os códigos de idioma compatíveis.	en-us
multilíngue	true	Um valor booliano que permite ter documentos em várias linguagens no conjunto de dados e, quando o modelo é implantado, é possível consultar o modelo em qualquer linguagem com suporte, não necessariamente incluída nos documentos de treinamento. Confira suporte de idioma para saber mais sobre o suporte multilíngue.	true
storageInputContainerName	{CONTAINER-NAME}	O nome do contêiner de armazenamento do Azure em que você carregou os documentos.	myContainer
classes	[]	Matriz que contém todas as classes presentes no projeto. São as classes em que você deseja classificar seus documentos.	[]
documentos	[]	Matriz que contém todos os documentos no projeto e a qual classe este documento pertence.	[]
local	{DOCUMENT-NAME}	O local dos documentos no contêiner de armazenamento. Como todos os documentos estão na raiz do contêiner, esse deve ser o nome do documento.	doc1.txt
dataset	{DATASET}	O conjunto de teste para o qual esse documento será exibido, quando dividido antes do treinamento. Confira Como treinar um modelo para saber mais sobre a divisão de dados. Os valores possíveis para esse campo são Train e Test.	Train

Depois de enviar a solicitação à API, você receberá uma resposta 202 indicando que o trabalho foi enviado corretamente. Nos cabeçalhos de resposta, extraia o valor operation-location. A formatação ficará da seguinte maneira:

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}

{JOB-ID} é usado para identificar sua solicitação, pois essa operação é assíncrona. Você usará essa URL para obter o status do trabalho de importação.

Possíveis cenários de erro para esta solicitação:

• O recurso selecionado não tem as permissões apropriadas para a conta de armazenamento.
• O storageInputContainerName especificado não existe.
• Um código de idioma inválido foi usado ou o tipo de código de idioma não é cadeia de caracteres.
• O valor multilingual é uma cadeia de caracteres e não um booliano.

Obter os detalhes do projeto

Language Studio

1. Acesse a página de configurações do projeto no Language Studio.

2. Você pode ver os detalhes do projeto.

3. Nesta página, você pode atualizar a descrição do projeto e habilitar/desabilitar o conjunto de dados multilíngue nas configurações do projeto.

4. Você também pode exibir a conta de armazenamento conectada e o contêiner para o recurso de Linguagem.

5. Você também pode recuperar a chave de recurso primária nesta página.

   

APIs REST

Para obter detalhes do projeto de classificação de textos personalizada, envie uma solicitação GET usando a URL e os cabeçalhos a seguir. Substitua os valores do espaço reservado pelos seus.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}?api-version={API-VERSION}

Espaço reservado	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticação de sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando. O valor referenciado aqui é para a versão do modelo mais recente.	2022-05-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave	Valor
Ocp-Apim-Subscription-Key	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo da resposta

Depois de enviar a solicitação, você receberá a seguinte resposta.

{
  "createdDateTime": "2022-04-23T13:39:09.384Z",
  "lastModifiedDateTime": "2022-04-23T13:39:09.384Z",
  "lastTrainedDateTime": "2022-04-23T13:39:09.384Z",
  "lastDeployedDateTime": "2022-04-23T13:39:09.384Z",
  "projectKind": "customSingleLabelClassification",
  "storageInputContainerName": "{CONTAINER-NAME}",
  "projectName": "{PROJECT-NAME}",
  "multilingual": true,
  "description": "Project description",
  "language": "{LANGUAGE-CODE}"
}

Valor	espaço reservado	Descrição	Exemplo
projectKind	customSingleLabelClassification	O tipo de projeto.	Esse valor pode ser customSingleLabelClassification ou customMultiLabelClassification.
storageInputContainerName	{CONTAINER-NAME}	O nome do contêiner de armazenamento do Azure em que você carregou os documentos.	myContainer
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
multilingual		Um valor booliano que permite que você tenha documentos em vários idiomas em seu conjunto de dados. Quando o modelo é implantado, você pode consultar o modelo em qualquer idioma com suporte (não necessariamente incluído em seus documentos de treinamento). Para obter mais informações sobre suporte multilíngue, confira Suporte de linguagem.	true
language	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de idioma para os documentos usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos documentos. Confira Suporte de idioma para saber mais sobre os códigos de idioma compatíveis.	en-us

Depois de enviar a solicitação da API, você receberá uma resposta 200 indicando o êxito e o corpo da resposta JSON com os detalhes do projeto.

Excluir projeto

Language Studio

Quando não precisar mais do seu projeto, poderá excluí-lo do projeto usando o Language Studio. Selecione a Classificação de texto personalizada na parte superior e, em seguida, selecione o projeto que você deseja excluir. Selecione Excluir no menu superior para excluir o projeto.

APIs REST

Quando você não precisar mais do seu projeto, poderá excluí-lo com a seguinte solicitação de DELETE. Substitua os valores do espaço reservado pelos seus.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version={API-VERSION}

Espaço reservado	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticação de sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando. O valor referenciado aqui é para a versão mais recente lançada. Saiba mais sobre as outras versões de API disponíveis	2022-05-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave	Valor
Ocp-Apim-Subscription-Key	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Depois de enviar a solicitação da API, você receberá uma resposta 202 indicando êxito, o que significa que o projeto foi excluído. Uma chamada bem-sucedida resulta em um cabeçalho Operation-Location usado para verificar o status do trabalho.

Próximas etapas

• É necessário ter uma noção do esquema de projeto que será usado para rotular os dados.

• Depois que seu projeto for criado, será possível começar a rotular seus dados, o que informará ao modelo de classificação de texto como interpretar o texto, e usá-lo para treinamento e avaliação.