Enviar solicitações de classificação de texto para seu modelo

Depois de implantar um modelo com êxito, você pode consultar a implantação para classificar o texto com base no modelo atribuído à implantação. Você pode consultar a implantação programaticamente usando a API de Previsão ou por meio das Bibliotecas de cliente (SDK do Azure).

Testar modelo implantado

Você pode usar o Language Studio para enviar a tarefa de classificação de textos personalizada e visualizar os resultados.

Para testar os modelos implantados de dentro do Language Studio:

1. Selecione Testar implantações no menu à esquerda.

2. Selecione a implantação que deseja testar. Você só pode testar modelos atribuídos a implantações.

3. Para projetos multilíngues, na lista suspensa de idiomas, selecione o idioma do texto que você está testando.

4. Selecione a implantação que deseja consultar/testar na lista suspensa.

5. É possível inserir o texto que deseja enviar à solicitação ou carregar um arquivo .txt a ser usado.

6. Selecione Executar o teste no menu superior.

7. Na guia Resultado, você pode ver as entidades extraídas de seu texto e seus tipos. Você também pode exibir a resposta JSON na guia JSON.

Enviar uma solicitação de classificação de texto ao modelo

Dica

É possível testar o modelo no Language Studio enviando o texto de exemplo para classificá-lo.

Language Studio

1. Depois que o trabalho de implantação for concluído com êxito, selecione a implantação que deseja usar e, no menu superior, selecione Obter URL de previsão.

   

2. Na janela exibida abaixo do pivô Enviar, copie a URL de solicitação de amostra e o corpo. Substitua os valores de espaço reservado, como YOUR_DOCUMENT_HERE e YOUR_DOCUMENT_LANGUAGE_HERE, pelo texto e idioma reais que você deseja processar.

3. Envie a solicitação cURL POST em seu terminal ou prompt de comando. Você receberá uma resposta 202 com os resultados da API se a solicitação for bem-sucedida.

4. No cabeçalho de resposta, você recebe a extração {JOB-ID} de operation-location, que tem o formato: {ENDPOINT}/language/analyze-text/jobs/<JOB-ID}>

5. De volta ao Language Studio; selecione o pivô Recuperar na mesma janela em que você obteve a solicitação de exemplo anterior e copie essa solicitação em um editor de texto.

6. Adicione sua ID de trabalho após /jobs/ à URL, usando a ID extraída da etapa anterior.

7. Envie a solicitação cURL GET em seu terminal ou prompt de comando.

REST API

Primeiro, você precisa obter sua chave de recurso e o ponto de extremidade:

1. No portal do Azure, vá para a página de visão geral do recurso

2. No menu do lado esquerdo, selecione Chaves e Ponto de Extremidade. Você usará o ponto de extremidade e a chave para as solicitações da API

   

Enviar uma tarefa de classificação de textos personalizada

Use esta solicitação POST para iniciar uma tarefa de classificação de textos.

{ENDPOINT}/language/analyze-text/jobs?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
{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

Chave	Valor
Ocp-Apim-Subscription-Key	Sua chave que fornece acesso a essa API.

Corpo

Classificação de vários rótulos

{
  "displayName": "Classifying documents",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
     {
      "kind": "CustomMultiLabelClassification",
      "taskName": "Multi Label Classification",
      "parameters": {
        "projectName": "{PROJECT-NAME}",
        "deploymentName": "{DEPLOYMENT-NAME}"
      }
    }
  ]
}

Chave	Espaço reservado	Valor	Exemplo
displayName	{JOB-NAME}	O nome do seu trabalho.	MyJobName
documents	[{},{}]	Lista de documentos nos quais executar tarefas.	[{},{}]
id	{DOC-ID}	Nome ou ID do documento.	doc1
language	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de idioma do documento. Caso essa chave não seja especificada, o serviço assume o idioma padrão do projeto que foi selecionado durante a criação do projeto. Confira Suporte ao idioma para obter uma lista de todos os códigos de idioma com suporte.	en-us
text	{DOC-TEXT}	Tarefa do documento para executar as tarefas.	Lorem ipsum dolor sit amet
tasks		Lista de tarefas que queremos executar.	[]
taskName	CustomMultiLabelClassification	O nome da tarefa	CustomMultiLabelClassification
parameters		Lista de parâmetros a serem passados para a tarefa.
project-name	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
deployment-name	{DEPLOYMENT-NAME}	O nome da sua implantação. Esse valor diferencia maiúsculas de minúsculas.	prod

Classificação de rótulo único

{
  "displayName": "Classifying documents",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
    {
      "kind": "CustomSingleLabelClassification",
      "taskName": "Single Classification Label",
      "parameters": {
        "projectName": "{PROJECT-NAME}",
        "deploymentName": "{DEPLOYMENT-NAME}"
      }
    }
  ]
}

Chave	Espaço reservado	Valor	Exemplo
displayName	{JOB-NAME}	O nome do seu trabalho.	MyJobName
documentos		Lista de documentos nos quais executar tarefas.
id	{DOC-ID}	Nome ou ID do documento.	doc1
language	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de idioma do documento. Caso essa chave não seja especificada, o serviço assume o idioma padrão do projeto que foi selecionado durante a criação do projeto. Confira Suporte ao idioma para obter uma lista de todos os códigos de idioma com suporte.	en-us
text	{DOC-TEXT}	Tarefa do documento para executar as tarefas.	Lorem ipsum dolor sit amet
taskName	CustomSingleLabelClassification	O nome da tarefa	CustomSingleLabelClassification
tasks	[]	Matriz de tarefas a serem executadas.	[]
parameters		Lista de parâmetros a serem passados para a tarefa.
project-name	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
deployment-name	{DEPLOYMENT-NAME}	O nome da sua implantação. Esse valor diferencia maiúsculas de minúsculas.	prod

Resposta

Você receberá uma resposta 202 indicando sucesso. Nos cabeçalhos da resposta, extraia operation-location. operation-location é formatado da seguinte maneira:

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}

Você pode usar essa URL para consultar o status de conclusão da tarefa e obter os resultados quando a tarefa for concluída.

Obter resultados da tarefa

Use a seguinte solicitação GET para consultar o status/resultados da tarefa de classificação de textos.

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?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
{API-VERSION}	A versão da API que você está chamando. O valor referenciado aqui é para a versão do modelo lançada mais recentemente.	2022-05-01

Cabeçalhos

Chave	Valor
Ocp-Apim-Subscription-Key	Sua chave que fornece acesso a essa API.

Corpo da resposta

A resposta será um documento JSON com os seguintes parâmetros.

Classificação de vários rótulos

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxxxx-xxxxx-xxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "customMultiClassificationTasks",
        "taskName": "Classify documents",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "{DOC-ID}",
              "classes": [
                  {
                      "category": "Class_1",
                      "confidenceScore": 0.0551877357
                  }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

Classificação de rótulo único

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxxxx-xxxxx-xxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "customSingleClassificationTasks",
        "taskName": "Classify documents",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "{DOC-ID}",
              "class": [
                  {
                      "category": "Class_1",
                      "confidenceScore": 0.0551877357
                  }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

Bibliotecas de cliente (SDK do Azure)

Primeiro, você precisará obter sua chave de recurso e o ponto de extremidade:

• No portal do Azure, vá para a página de visão geral do recurso

• No menu do lado esquerdo, selecione Chaves e Ponto de Extremidade. Você usará o ponto de extremidade e a chave para as solicitações de API

3. Baixe e instale o pacote de biblioteca de clientes para sua linguagem de escolha:

   Idioma	Versão do pacote
   .NET	5.2.0-beta.3
   Java	5.2.0-beta.3
   JavaScript	6.0.0-beta.1
   Python	5.2.0b4

4. Após instalar a biblioteca de clientes, use os exemplos a seguir no GitHub para iniciar a chamada à API.

   Classificação de rótulo único:

   • C#
   • Java
   • JavaScript
   • Python

   Classificação de vários rótulos:

   • C#
   • Java
   • JavaScript
   • Python

5. Confira a documentação de referência a seguir para obter mais informações sobre o cliente e retornar o objeto:

   • C#
   • Java
   • JavaScript
   • Python

Próximas etapas

• Visão geral de classificação de texto personalizada