Consultar seu modelo personalizado

Depois que a implantação for adicionada com êxito, você poderá consultar a implantação para extrair entidades do texto de acordo com o 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 reconhecimento de entidade 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 reconhecimento de entidade para seu modelo

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 a tarefa do NER 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

{
  "displayName": "Extracting entities",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
     {
      "kind": "CustomEntityRecognition",
      "taskName": "Entity Recognition",
      "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	CustomEntityRecognition	O nome da tarefa	CustomEntityRecognition
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 que sua tarefa foi enviada com êxito. 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 solicitação GET a seguir para consultar status/resultados da tarefa de reconhecimento de entidade personalizada.

{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 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 da resposta

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

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxx-xxxxx-xxxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "EntityRecognitionLROResults",
        "taskName": "Recognize Entities",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "entities": [
                {
                  "category": "Event",
                  "confidenceScore": 0.61,
                  "length": 4,
                  "offset": 18,
                  "text": "trip"
                },
                {
                  "category": "Location",
                  "confidenceScore": 0.82,
                  "length": 7,
                  "offset": 26,
                  "subcategory": "GPE",
                  "text": "Seattle"
                },
                {
                  "category": "DateTime",
                  "confidenceScore": 0.8,
                  "length": 9,
                  "offset": 34,
                  "subcategory": "DateRange",
                  "text": "last week"
                }
              ],
              "id": "1",
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

Bibliotecas de cliente (SDK do Azure)

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

Obter chave e ponto de extremidade

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você vai colar a chave e o ponto de extremidade no código mais adiante no guia de início rápido.

1. Após a implantação bem-sucedida do recurso de linguagem, clique no botão Acessar recurso em Próximas etapas.

   

2. Na tela do recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma das chaves e o ponto de extremidade nas etapas abaixo.

   

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.

   • 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

• Perguntas frequentes