Consultar o modelo personalizado

Depois de a implementação ser adicionada com êxito, pode consultar a implementação para extrair entidades do seu texto com base no modelo que atribuiu à implementação. Pode consultar a implementação através de programação com a API de Predição ou através das bibliotecas de cliente (SDK do Azure).

Testar o modelo implementado

Pode utilizar o Language Studio para submeter a tarefa de reconhecimento de entidades personalizada e visualizar os resultados.

Para testar os modelos implementados a partir do Language Studio:

1. Selecione Testar implementações no menu esquerdo.

2. Selecione a implementação que pretende testar. Só pode testar modelos atribuídos a implementações.

3. Para projetos multilingues, na lista pendente de idiomas, selecione o idioma do texto que está a testar.

4. Selecione a implementação que pretende consultar/testar na lista pendente.

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

6. Selecione Executar o teste no menu superior.

7. No separador Resultado , pode ver as entidades extraídas do seu texto e os respetivos tipos. Também pode ver a resposta JSON no separador JSON .

Enviar um pedido de reconhecimento de entidades para o seu modelo

Language Studio

1. Depois de concluída a tarefa de implementação com êxito, selecione a implementação que pretende utilizar e, no menu superior, selecione Obter URL de predição.

   

2. Na janela apresentada, no pivô Submeter , copie o URL e o corpo do pedido de exemplo. Substitua os valores do marcador de posição, como YOUR_DOCUMENT_HERE e YOUR_DOCUMENT_LANGUAGE_HERE pelo texto e idioma reais que pretende processar.

3. Submeta o POST pedido cURL no terminal ou na linha de comandos. Receberá uma resposta 202 com os resultados da API se o pedido tiver sido efetuado com êxito.

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

5. Voltar ao Language Studio; selecione Obter pivot na mesma janela que recebeu o pedido de exemplo que recebeu anteriormente e copie o pedido de exemplo para um editor de texto.

6. Adicione o ID da tarefa depois /jobs/ ao URL com o ID que extraiu do passo anterior.

7. Submeta o GET pedido cURL no terminal ou na linha de comandos.

API REST

Primeiro, tem de obter a chave de recurso e o ponto final:

1. Aceda à página de descrição geral do recurso no portal do Azure

2. No menu do lado esquerdo, selecione Chaves e Ponto Final. Irá utilizar o ponto final e a chave para os pedidos da API

   

Submeter uma tarefa NER personalizada

Utilize este pedido POST para iniciar uma tarefa de classificação de textos.

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

Marcador de posição	Valor	Exemplo
{ENDPOINT}	O ponto final para autenticar o pedido da API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION}	A versão da API que está a chamar. O valor aqui referenciado destina-se à versão mais recente lançada. Veja 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	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 da sua tarefa.	MyJobName
documents	[{},{}]	Lista de documentos em que as tarefas são executadas.	[{},{}]
id	{DOC-ID}	Nome ou ID do documento.	doc1
language	{LANGUAGE-CODE}	Uma cadeia que especifica o código de idioma do documento. Se esta chave não for especificada, o serviço assumirá o idioma predefinido do projeto que foi selecionado durante a criação do projeto. Veja o suporte de idiomas para obter uma lista de códigos de idioma suportados.	en-us
text	{DOC-TEXT}	Documente a tarefa para executar as tarefas.	Lorem ipsum dolor sit amet
tasks		Lista de tarefas que queremos efetuar.	[]
taskName	CustomEntityRecognition	O nome da tarefa	CustomEntityRecognition
parameters		Lista de parâmetros a transmitir para a tarefa.
project-name	{PROJECT-NAME}	O nome do seu projeto. Este valor é sensível às maiúsculas e minúsculas.	myProject
deployment-name	{DEPLOYMENT-NAME}	O nome da sua implementação. Este valor é sensível às maiúsculas e minúsculas.	prod

Resposta

Receberá uma resposta 202 a indicar que a sua tarefa foi submetida com êxito. Nos cabeçalhos de resposta, extraia operation-location. operation-location está formatado da seguinte forma:

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

Pode utilizar este URL para consultar o estado de conclusão da tarefa e obter os resultados quando a tarefa estiver concluída.

Obter resultados da tarefa

Utilize o seguinte pedido GET para consultar o estado/resultados da tarefa de reconhecimento de entidades personalizada.

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

Marcador de posição	Valor	Exemplo
{ENDPOINT}	O ponto final para autenticar o pedido da API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION}	A versão da API que está a chamar. O valor aqui referenciado destina-se à versão mais recente lançada. Veja 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	A sua chave que fornece acesso a esta 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, tem de obter a chave de recurso e o ponto final:

Obter a chave e o ponto final

Em seguida, precisará da chave e do ponto final do recurso para ligar a sua aplicação à API. Irá colar a chave e o ponto final no código mais tarde no início rápido.

1. Depois de o recurso Idioma ser implementado com êxito, clique no botão Ir para Recurso em Passos Seguintes.

   

2. No ecrã do recurso, selecione Chaves e ponto final no menu de navegação esquerdo. Irá utilizar uma das chaves e o ponto final nos passos abaixo.

   

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

   Linguagem	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 de cliente, utilize os seguintes exemplos no GitHub para começar a chamar a API.

   • C#
   • Java
   • JavaScript
   • Python

5. Veja a seguinte documentação de referência para obter mais informações sobre o cliente e devolver o objeto:

   • C#
   • Java
   • JavaScript
   • Python

Passos seguintes

• Perguntas mais frequentes