Consultar o seu modelo personalizado

Depois que a implantação for adicionada com êxito, você poderá consultá-la para extrair entidades do seu 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 reconhecimento de entidade personalizada e visualizar os resultados.

Para testar seus modelos implantados de dentro do Language Studio:

1. Selecione Testando implantações no menu do lado esquerdo.

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

3. Para projetos multilingues, na lista pendente de línguas, selecione a língua do texto que está a testar.

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

5. Pode introduzir o texto que pretende submeter ao pedido ou carregar um .txt ficheiro para utilizar.

6. Selecione Executar o teste no menu superior.

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

Enviar um pedido de reconhecimento de entidade para o seu modelo

Estúdio de Idiomas

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, sob o pivô Enviar, copie a URL e o corpo da solicitação de exemplo. 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 POST solicitação cURL no 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 extrato {JOB-ID} de operation-location, que tem o formato: {ENDPOINT}/language/analyze-text/jobs/<JOB-ID}>

5. Voltar ao Language Studio; selecione Recuperar pivô na mesma janela que você recebeu a solicitação de exemplo recebida anteriormente e copie a solicitação de exemplo em um editor de texto.

6. Adicione seu ID de trabalho depois /jobs/ ao URL, usando o ID extraído da etapa anterior.

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

API REST

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

1. Vá para a página de visão geral dos recursos no portal do Azure

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

   

Enviar uma tarefa personalizada do NER

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

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

Marcador de Posição	valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar 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 última versão lançada. Consulte Ciclo de vida do modelo para saber mais sobre outras versões de API disponíveis.	2022-05-01

Cabeçalhos

Key	valor
Ocp-Apim-Subscription-Key	A sua chave que fornece acesso a esta 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	Marcador de Posição	valor	Exemplo
displayName	{JOB-NAME}	O nome do seu trabalho.	MyJobName
documents	[{},{}]	Lista de documentos para executar tarefas.	[{},{}]
id	{DOC-ID}	Nome ou ID do documento.	doc1
language	{LANGUAGE-CODE}	Uma cadeia de caracteres especificando o código de idioma para o documento. Se essa chave não for especificada, o serviço assumirá o idioma padrão do projeto que foi selecionado durante a criação do projeto. Consulte Suporte a idiomas para obter uma lista de códigos de idiomas suportados.	en-us
text	{DOC-TEXT}	Documentar a tarefa na qual executar as tarefas.	Lorem ipsum dolor sit amet
tasks		Lista de tarefas que queremos realizar.	[]
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

Response

Você receberá uma resposta 202 indicando que sua tarefa foi enviada com sucesso. Nos cabeçalhos de resposta, extraia operation-location. operation-location está formatado assim:

{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 de tarefas

Use a seguinte solicitação GET para consultar o status/resultados da tarefa de reconhecimento de entidade personalizada.

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

Marcador de Posição	valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar 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 última versão lançada. Consulte Ciclo de vida do modelo para saber mais sobre outras versões de API disponíveis.	2022-05-01

Cabeçalhos

Key	valor
Ocp-Apim-Subscription-Key	A sua chave que fornece acesso a esta API.

Organismo de 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:

Obtenha a sua chave e o seu ponto final

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

1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

   

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

   

3. Transfira e instale o pacote de biblioteca de cliente para o idioma da sua escolha:

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

4. Depois de instalar a biblioteca do cliente, use os seguintes exemplos no GitHub para começar a chamar a API.

   • C#
   • Java
   • JavaScript
   • Python

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

   • C#
   • Java
   • JavaScript
   • Python

Próximos passos

• Perguntas mais frequentes